+ Bases: Exception
Base exception for all nzb exceptions
+ + +InvalidNZBError(message: str)
+
+ Bases: NZBException
Invalid NZB
+ +src/nzb/_exceptions.pyInitialize the NZBMetaEditor instance.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
nzb |
+
+ str
+ |
+
+
+
+ NZB content as a string. + |
+ + required + | +
encoding |
+
+ str
+ |
+
+
+
+ Encoding of the NZB content, defaults to |
+
+ 'utf-8'
+ |
+
Raises:
+| Type | +Description | +
|---|---|
+ InvalidNZBError
+ |
+
+
+
+ Raised if the input is not valid XML. +However, being valid XML doesn't guarantee it's a correctly structured NZB. + |
+
src/nzb/_core.pyappend(*, title: str | None = None, passwords: CollectionOf[str] | str | None = None, tags: CollectionOf[str] | str | None = None, category: str | None = None) -> Self
+Append metadata fields to the existing metadata in the NZB.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
title |
+
+ str
+ |
+
+
+
+ The title metadata field. + |
+
+ None
+ |
+
passwords |
+
+ CollectionOf[str] | str
+ |
+
+
+
+ Password(s) for the NZB file. + |
+
+ None
+ |
+
tags |
+
+ CollectionOf[str] | str
+ |
+
+
+
+ Tag(s) associated with the NZB file. + |
+
+ None
+ |
+
category |
+
+ str
+ |
+
+
+
+ Category of the NZB file. + |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Self
+ |
+
+
+
+ Returns itself. + |
+
src/nzb/_core.pyclear() -> Self
+Clear all metadata fields from the NZB.
+ + +Returns:
+| Type | +Description | +
|---|---|
+ Self
+ |
+
+
+
+ Returns itself. + |
+
src/nzb/_core.pyclassmethod
+
+
+Create an NZBMetaEditor instance from an NZB file path.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
nzb |
+
+ str | Path
+ |
+
+
+
+ File path to the NZB. + |
+ + required + | +
encoding |
+
+ str
+ |
+
+
+
+ Encoding of the NZB, defaults to |
+
+ 'utf-8'
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Self
+ |
+
+
+
+ Returns itself. + |
+
src/nzb/_core.pyRemove a metadata field from the NZB. +If the same field is present multiple times, this will remove them all.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
key |
+
+ Literal['title', 'password', 'tag', 'category'] | str
+ |
+
+
+
+ The metadata field to remove. + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Self
+ |
+
+
+
+ Returns itself. + |
+
src/nzb/_core.pySave the edited NZB to a file.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
filename |
+
+ str | Path
+ |
+
+
+
+ Destination path for saving the NZB. +If not provided, uses the original file path if available. +This will also create the path if it doesn't exist already. + |
+
+ None
+ |
+
overwrite |
+
+ bool
+ |
+
+
+
+ Whether to overwrite the file if it exists, defaults to |
+
+ False
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Path
+ |
+
+
+
+ The path to the saved file. + |
+
Raises:
+| Type | +Description | +
|---|---|
+ FileNotFoundError
+ |
+
+
+
+ If no filename is specified and the original file path is unknown. + |
+
+ FileExistsError
+ |
+
+
+
+ If the file exists and overwrite is |
+
src/nzb/_core.pyset(*, title: str | None = None, passwords: CollectionOf[str] | str | None = None, tags: CollectionOf[str] | str | None = None, category: str | None = None) -> Self
+Set metadata fields in the NZB. +This will also remove all existing metadata fields.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
title |
+
+ str
+ |
+
+
+
+ The title metadata field. + |
+
+ None
+ |
+
passwords |
+
+ CollectionOf[str] | str
+ |
+
+
+
+ Password(s) for the NZB file. + |
+
+ None
+ |
+
tags |
+
+ CollectionOf[str] | str
+ |
+
+
+
+ Tag(s) associated with the NZB file. + |
+
+ None
+ |
+
category |
+
+ str
+ |
+
+
+
+ Category of the NZB file. + |
+
+ None
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ Self
+ |
+
+
+
+ Returns itself. + |
+
src/nzb/_core.py
+ Bases: ParentModel
Represents a complete NZB file.
+ + + + +cached
+ property
+
+
+file: File
+The main content file (episode, movie, etc) in the NZB.
+instance-attribute
+
+
+File objects representing the files included in the NZB.
+cached
+ property
+
+
+Tuple of unique groups across all the files in the NZB.
+class-attribute
+ instance-attribute
+
+
+Optional creator-definable metadata for the contents of the NZB.
+cached
+ property
+
+
+Tuple of unique file names across all the files in the NZB. +May return an empty tuple if it fails to extract the name for every file.
+cached
+ property
+
+
+Tuple of unique posters across all the files in the NZB.
+cached
+ property
+
+
+size: ByteSize
+Total size of all the files in the NZB.
+cached
+ property
+
+
+Tuple of unique file stems (basename) across all the files in the NZB. +May return an empty tuple if it fails to extract the stem for every file.
+cached
+ property
+
+
+Tuple of unique file extensions across all the files in the NZB. +May return an empty tuple if it fails to extract the extension for every file.
+get_par2_percentage() -> float
+Percentage of recovery based on the total .par2 size divided by the total size of all files.
has_par2() -> bool
+Return True if there's at least one .par2 file in the NZB, False otherwise.
has_rar() -> bool
+Return True if any file in the NZB is a .rar file, False otherwise.
is_obfuscated() -> bool
+Return True if any file in the NZB is obfuscated, False otherwise.
is_rar() -> bool
+Return True if all files in the NZB are .rar files, False otherwise.
+ Bases: ParentModel
Optional creator-definable metadata for the contents of the NZB.
+ + + + +class-attribute
+ instance-attribute
+
+
+category: str | None = None
+Category.
+cached
+ property
+
+
+password: str | None
+Return the first password from Metadata.passwords
+if it exists, None otherwise.
This is essentially just syntactic sugar for password = passwords[0] if passwords else None
+because although the spec allows multiple passwords, single passwords are far more common.
class-attribute
+ instance-attribute
+
+
+Password(s).
+cached
+ property
+
+
+tag: str | None
+The first tag from Metadata.tags
+if it exists, None otherwise.
This is essentially just syntactic sugar for tag = tags[0] if tags else None
+because although the spec allows multiple tags, single tags are far more common.
class-attribute
+ instance-attribute
+
+
+Tag(s).
+class-attribute
+ instance-attribute
+
+
+title: str | None = None
+Title.
+
+ Bases: ParentModel
One part segment of a file.
+ + + + +instance-attribute
+
+
+message_id: str
+Message ID of the segment.
+instance-attribute
+
+
+number: int
+Number of the segment.
+instance-attribute
+
+
+size: ByteSize
+Size of the segment.
+
+ Bases: ParentModel
Represents a complete file, consisting of segments that make up a file.
+ + + + +instance-attribute
+
+
+datetime: UTCDateTime
+The date and time when the file was posted, in UTC.
+instance-attribute
+
+
+Groups that reference the file.
+cached
+ property
+
+
+name: str
+Complete name of the file with it's extension extracted from the subject. +May return an empty string if it fails to extract the name.
+instance-attribute
+
+
+poster: str
+The poster of the file.
+instance-attribute
+
+
+Segments that make up the file.
+cached
+ property
+
+
+size: ByteSize
+Size of the file calculated from the sum of segment sizes.
+cached
+ property
+
+
+stem: str
+Base name of the file without it's extension extracted from the File.name.
+May return an empty string if it fails to extract the stem.
instance-attribute
+
+
+subject: str
+The subject of the file.
+cached
+ property
+
+
+suffix: str
+Extension of the file extracted from the File.name.
+May return an empty string if it fails to extract the extension.
is_obfuscated() -> bool
+is_par2() -> bool
+is_rar() -> bool
+Initialize the NZBParser instance.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
nzb |
+
+ str
+ |
+
+
+
+ NZB content as a string. + |
+ + required + | +
encoding |
+
+ str
+ |
+
+
+
+ Encoding of the NZB content, defaults to |
+
+ 'utf-8'
+ |
+
Raises:
+| Type | +Description | +
|---|---|
+ InvalidNZBError
+ |
+
+
+
+ Raised if the input is not valid XML. +However, being valid XML doesn't guarantee it's a correctly structured NZB. + |
+
src/nzb/_core.pyclassmethod
+
+
+Create an NZBParser instance from an NZB file path.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
nzb |
+
+ str | Path
+ |
+
+
+
+ File path to the NZB. + |
+ + required + | +
encoding |
+
+ str
+ |
+
+
+
+ Encoding of the NZB, defaults to |
+
+ 'utf-8'
+ |
+
Returns:
+| Type | +Description | +
|---|---|
+ NZBParser
+ |
+
+
+
+ An NZBParser instance initialized with the content of the specified NZB file. + |
+
src/nzb/_core.pyparse() -> 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. + |
+
src/nzb/_core.pymodule-attribute
+
+
+UTCDateTime = Annotated[datetime, AfterValidator(to_utc)]
+datetime that's always in UTC.
+