Skip to content

Parser

NZBParser 

NZBParser(nzb: str, *, encoding: str | None = 'utf-8')

Initialize the NZBParser.

Parameters:

Name Type Description Default
nzb str

NZB content as a string.

 required
encoding str

Encoding of the NZB content.

 'utf-8'
Source code in src/nzb/_core.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
def __init__(self, nzb: str, *, encoding: str | None = "utf-8") -> None:
    """
    Initialize the NZBParser.

    Parameters
    ----------
    nzb : str
        NZB content as a string.
    encoding : str, optional
        Encoding of the NZB content.
    """
    self.__nzb = nzb
    self.__encoding = encoding

from_file classmethod 

from_file(nzb: StrPath, *, encoding: str | None = 'utf-8') -> Self

Create an NZBParser instance from an NZB file path.

Parameters:

Name Type Description Default
nzb StrPath

File path to the NZB.

 required
encoding str

Encoding of the NZB, defaults to utf-8.

 'utf-8'

Returns:

Type Description
NZBParser

An NZBParser instance initialized with the content of the specified NZB file.
Source code in src/nzb/_core.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
@classmethod
def from_file(cls, nzb: StrPath, *, encoding: str | None = "utf-8") -> Self:
    """
    Create an NZBParser instance from an NZB file path.

    Parameters
    ----------
    nzb : StrPath
        File path to the NZB.
    encoding : str, optional
        Encoding of the NZB, defaults to `utf-8`.

    Returns
    -------
    NZBParser
        An NZBParser instance initialized with the content of the specified NZB file.
    """
    nzb = realpath(nzb).read_text(encoding=encoding)
    return cls(nzb, encoding=encoding)

parse 

parse() -> NZB

Parse the NZB.

Returns:

Type Description
NZB

NZB object representing the parsed NZB file.

Raises:

Type Description
InvalidNZBError

Raised if the input is not valid NZB.
Source code in src/nzb/_core.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def parse(self) -> NZB:
    """
    Parse the NZB.

    Returns
    -------
    NZB
        NZB object representing the parsed NZB file.

    Raises
    ------
    InvalidNZBError
        Raised if the input is not valid NZB.
    """
    try:
        nzbdict = xmltodict_parse(self.__nzb, encoding=self.__encoding)
    except ExpatError as error:
        raise InvalidNZBError(error.args[0])

    meta = parse_metadata(nzbdict)
    files = parse_files(nzbdict)

    return NZB(meta=meta, files=files)