dockeruser
/
sabnzbd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Add more typing to nzbstuff functions

pull/1920/head
Safihre 4 years ago
parent
2d195e9584
commit
be5a71ce47
4 changed files with 75 additions and 71 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 28
      sabnzbd/__init__.py
  2. 68
      sabnzbd/nzbparser.py
  3. 48
      sabnzbd/nzbstuff.py
  4. 2
      tests/test_nzbstuff.py

28
sabnzbd/__init__.py
View File

@ -25,11 +25,12 @@ import gzip
import time import time
import socket import socket
import cherrypy import cherrypy
import cherrypy._cpreqbody
import platform import platform
import sys import sys
import ssl import ssl
from threading import Lock, Thread, Condition from threading import Lock, Thread, Condition
from typing import Any, AnyStr from typing import Any, AnyStr, Optional, Union
############################################################################## ##############################################################################
# Determine platform flags # Determine platform flags
@ -123,6 +124,7 @@ from sabnzbd.constants import (
QUEUE_FILE_NAME, QUEUE_FILE_NAME,
QUEUE_VERSION, QUEUE_VERSION,
QUEUE_FILE_TMPL, QUEUE_FILE_TMPL,
Status,
) )
import sabnzbd.utils.ssdp import sabnzbd.utils.ssdp
@ -635,19 +637,19 @@ def save_compressed(folder: str, filename: str, data: AnyStr):
def add_nzbfile( def add_nzbfile(
nzbfile, nzbfile: Union[str, cherrypy._cpreqbody.Part],
pp=None, pp: Optional[Union[int, str]] = None,
script=None, script: Optional[str] = None,
cat=None, cat: Optional[str] = None,
catdir=None, catdir: Optional[str] = None,
priority=DEFAULT_PRIORITY, priority: Optional[Union[Status, str]] = DEFAULT_PRIORITY,
nzbname=None, nzbname: Optional[str] = None,
nzo_info=None, nzo_info=None,
url=None, url: Optional[str] = None,
keep=None, keep: Optional[bool] = None,
reuse=None, reuse: Optional[str] = None,
password=None, password: Optional[str] = None,
nzo_id=None, nzo_id: Optional[str] = None,
): ):
"""Add file, either a single NZB-file or an archive. """Add file, either a single NZB-file or an archive.
All other parameters are passed to the NZO-creation. All other parameters are passed to the NZO-creation.

68
sabnzbd/nzbparser.py
View File

@ -26,9 +26,11 @@ import logging
import hashlib import hashlib
import xml.etree.ElementTree import xml.etree.ElementTree
import datetime import datetime
from typing import Optional, Dict, Any, Union
import sabnzbd import sabnzbd
from sabnzbd import filesystem, nzbstuff from sabnzbd import filesystem, nzbstuff
from sabnzbd.constants import Status
from sabnzbd.encoding import utob, correct_unknown_encoding from sabnzbd.encoding import utob, correct_unknown_encoding
from sabnzbd.filesystem import is_archive, get_filename from sabnzbd.filesystem import is_archive, get_filename
from sabnzbd.misc import name_to_cat from sabnzbd.misc import name_to_cat
@ -154,21 +156,21 @@ def nzbfile_parser(raw_data, nzo):
def process_nzb_archive_file( def process_nzb_archive_file(
filename, filename: str,
path, path: str,
pp=None, pp: Optional[int] = None,
script=None, script: Optional[str] = None,
cat=None, cat: Optional[str] = None,
catdir=None, catdir: Optional[str] = None,
keep=False, keep: bool = False,
priority=None, priority: Optional[Union[Status, str]] = None,
nzbname=None, nzbname: Optional[str] = None,
reuse=None, reuse: Optional[str] = None,
nzo_info=None, nzo_info: Optional[Dict[str, Any]] = None,
dup_check=True, dup_check: bool = True,
url=None, url: Optional[str] = None,
password=None, password: Optional[str] = None,
nzo_id=None, nzo_id: Optional[str] = None,
): ):
"""Analyse ZIP file and create job(s). """Analyse ZIP file and create job(s).
Accepts ZIP files with ONLY nzb/nfo/folder files in it. Accepts ZIP files with ONLY nzb/nfo/folder files in it.
@ -214,7 +216,7 @@ def process_nzb_archive_file(
name, name,
pp=pp, pp=pp,
script=script, script=script,
nzb=data, nzb_data=data,
cat=cat, cat=cat,
url=url, url=url,
priority=priority, priority=priority,
@ -255,21 +257,21 @@ def process_nzb_archive_file(
def process_single_nzb( def process_single_nzb(
filename, filename: str,
path, path: str,
pp=None, pp: Optional[int] = None,
script=None, script: Optional[str] = None,
cat=None, cat: Optional[str] = None,
catdir=None, catdir: Optional[str] = None,
keep=False, keep: bool = False,
priority=None, priority: Optional[Union[Status, str]] = None,
nzbname=None, nzbname: Optional[str] = None,
reuse=None, reuse: Optional[str] = None,
nzo_info=None, nzo_info: Optional[Dict[str, Any]] = None,
dup_check=True, dup_check: bool = True,
url=None, url: Optional[str] = None,
password=None, password: Optional[str] = None,
nzo_id=None, nzo_id: Optional[str] = None,
): ):
"""Analyze file and create a job from it """Analyze file and create a job from it
Supports NZB, NZB.BZ2, NZB.GZ and GZ.NZB-in-disguise Supports NZB, NZB.BZ2, NZB.GZ and GZ.NZB-in-disguise
@ -316,7 +318,7 @@ def process_single_nzb(
filename, filename,
pp=pp, pp=pp,
script=script, script=script,
nzb=data, nzb_data=data,
cat=cat, cat=cat,
url=url, url=url,
priority=priority, priority=priority,
@ -349,7 +351,7 @@ def process_single_nzb(
# Re-use existing nzo_id, when a "future" job gets it payload # Re-use existing nzo_id, when a "future" job gets it payload
sabnzbd.NzbQueue.remove(nzo_id, delete_all_data=False) sabnzbd.NzbQueue.remove(nzo_id, delete_all_data=False)
nzo.nzo_id = nzo_id nzo.nzo_id = nzo_id
nzo_ids.append(sabnzbd.NzbQueue.add(nzo, quiet=reuse)) nzo_ids.append(sabnzbd.NzbQueue.add(nzo, quiet=bool(reuse)))
nzo.update_rating() nzo.update_rating()
try: try:

48
sabnzbd/nzbstuff.py
View File

@ -26,7 +26,7 @@ import datetime
import threading import threading
import functools import functools
import difflib import difflib
from typing import List, Dict, Any, Tuple, Optional from typing import List, Dict, Any, Tuple, Optional, Union
# SABnzbd modules # SABnzbd modules
import sabnzbd import sabnzbd
@ -585,30 +585,30 @@ NZO_LOCK = threading.RLock()
class NzbObject(TryList): class NzbObject(TryList):
def __init__( def __init__(
self, self,
filename, filename: str,
pp=None, pp: Optional[int] = None,
script=None, script: Optional[str] = None,
nzb=None, nzb_data: Optional[str] = None,
futuretype=False, futuretype: bool = False,
cat=None, cat: Optional[str] = None,
url=None, url: Optional[str] = None,
priority=DEFAULT_PRIORITY, priority: Optional[Union[Status, str]] = DEFAULT_PRIORITY,
nzbname=None, nzbname: Optional[str] = None,
status=Status.QUEUED, status: Status = Status.QUEUED,
nzo_info=None, nzo_info: Optional[Dict[str, Any]] = None,
reuse=None, reuse: Optional[str] = None,
dup_check=True, dup_check: bool = True,
): ):
super().__init__() super().__init__()
self.filename = filename # Original filename self.filename = filename # Original filename
if nzbname and nzb: if nzbname and nzb_data:
self.work_name = nzbname # Use nzbname if set and only for non-future slot self.work_name = nzbname # Use nzbname if set and only for non-future slot
else: else:
self.work_name = filename self.work_name = filename
# For future-slots we keep the name given by URLGrabber # For future-slots we keep the name given by URLGrabber
if nzb is None: if nzb_data is None:
self.final_name = self.work_name = filename self.final_name = self.work_name = filename
else: else:
# Remove trailing .nzb and .par(2) # Remove trailing .nzb and .par(2)
@ -724,7 +724,7 @@ class NzbObject(TryList):
self.pp_active = False # Signals active post-processing (not saved) self.pp_active = False # Signals active post-processing (not saved)
self.md5sum: Optional[bytes] = None self.md5sum: Optional[bytes] = None
if nzb is None and not reuse: if nzb_data is None and not reuse:
# This is a slot for a future NZB, ready now # This is a slot for a future NZB, ready now
# It can also be a retry of a failed job with no extra NZB-file # It can also be a retry of a failed job with no extra NZB-file
return return
@ -738,7 +738,7 @@ class NzbObject(TryList):
self.final_name = self.final_name.replace(".", " ") self.final_name = self.final_name.replace(".", " ")
# Check against identical checksum or series/season/episode # Check against identical checksum or series/season/episode
if (not reuse) and nzb and dup_check and self.priority != REPAIR_PRIORITY: if (not reuse) and nzb_data and dup_check and self.priority != REPAIR_PRIORITY:
duplicate, series = self.has_duplicates() duplicate, series = self.has_duplicates()
else: else:
duplicate = series = 0 duplicate = series = 0
@ -764,9 +764,9 @@ class NzbObject(TryList):
remove_all(admin_dir, "SABnzbd_nz?_*", keep_folder=True) remove_all(admin_dir, "SABnzbd_nz?_*", keep_folder=True)
remove_all(admin_dir, "SABnzbd_article_*", keep_folder=True) remove_all(admin_dir, "SABnzbd_article_*", keep_folder=True)
if nzb and "<nzb" in nzb: if nzb_data and "<nzb" in nzb_data:
try: try:
sabnzbd.nzbparser.nzbfile_parser(nzb, self) sabnzbd.nzbparser.nzbfile_parser(nzb_data, self)
except Exception as err: except Exception as err:
self.incomplete = True self.incomplete = True
logging.warning(T("Invalid NZB file %s, skipping (reason=%s, line=%s)"), filename, err, "1") logging.warning(T("Invalid NZB file %s, skipping (reason=%s, line=%s)"), filename, err, "1")
@ -779,8 +779,8 @@ class NzbObject(TryList):
self.purge_data() self.purge_data()
raise ValueError raise ValueError
sabnzbd.backup_nzb(filename, nzb) sabnzbd.backup_nzb(filename, nzb_data)
sabnzbd.save_compressed(admin_dir, filename, nzb) sabnzbd.save_compressed(admin_dir, filename, nzb_data)
if not self.files and not reuse: if not self.files and not reuse:
self.purge_data() self.purge_data()
@ -1310,7 +1310,7 @@ class NzbObject(TryList):
if not self.unpack: if not self.unpack:
self.abort_direct_unpacker() self.abort_direct_unpacker()
def set_priority(self, value: Any): def set_priority(self, value: Optional[Union[Status, str]]):
"""Check if this is a valid priority""" """Check if this is a valid priority"""
# When unknown (0 is a known one), set to DEFAULT # When unknown (0 is a known one), set to DEFAULT
if value == "" or value is None: if value == "" or value is None:
@ -1336,7 +1336,7 @@ class NzbObject(TryList):
# Invalid value, set to normal priority # Invalid value, set to normal priority
self.priority = NORMAL_PRIORITY self.priority = NORMAL_PRIORITY
def set_stateless_priority(self, category: str) -> int: def set_stateless_priority(self, category: str):
"""Find a priority that doesn't set a job state, starting from the given category, """Find a priority that doesn't set a job state, starting from the given category,
for jobs to fall back to after their priority was set to PAUSED or DUP. The fallback for jobs to fall back to after their priority was set to PAUSED or DUP. The fallback
priority cannot be another state-setting priority or FORCE; the latter could override priority cannot be another state-setting priority or FORCE; the latter could override

2
tests/test_nzbstuff.py
View File

@ -27,7 +27,7 @@ class TestNZO:
nzb_data = create_and_read_nzb("basic_rar5") nzb_data = create_and_read_nzb("basic_rar5")
# Very basic test of NZO creation with data # Very basic test of NZO creation with data
nzo = nzbstuff.NzbObject("test_basic_data", nzb=nzb_data) nzo = nzbstuff.NzbObject("test_basic_data", nzb_data=nzb_data)
assert nzo.final_name == "test_basic_data" assert nzo.final_name == "test_basic_data"
assert nzo.files assert nzo.files
assert nzo.files[0].filename == "testfile.rar" assert nzo.files[0].filename == "testfile.rar"

Write Preview
Loading…
Cancel
Save