BaseHandler

XmlError

Bases: Exception

Class for an XML error.

BaseMetadataHandler

Bases: ABC

Abstract base class for metadata handlers.

Provides common functionality for converting between Metadata objects and XML representations. Subclasses must implement the specific conversion logic for their XML format.

Functions

metadata_from_string(xml_string: str) -> Metadata abstractmethod

Convert an XML string to a Metadata object.

PARAMETER	DESCRIPTION
xml_string	The XML string to be converted. TYPE: str

RETURNS	DESCRIPTION
Metadata	The resulting Metadata object.

read_xml(filename: Path) -> Metadata

Read Metadata from an external file in XML format.

PARAMETER	DESCRIPTION
filename	The path to the XML file to read. TYPE: Path

RETURNS	DESCRIPTION
Metadata	The resulting Metadata object.

string_from_metadata(metadata: Metadata, xml_bytes: bytes = b'') -> str abstractmethod

Convert a Metadata object to an XML string.

PARAMETER	DESCRIPTION
metadata	The Metadata object to convert. TYPE: Metadata
xml_bytes	Optional XML bytes to include. TYPE: bytes DEFAULT: b''

RETURNS	DESCRIPTION
str	The resulting XML string.

write_xml(filename: Path, metadata: Metadata, xml_bytes: bytes = b'') -> None

Write Metadata to an external file in XML format.

PARAMETER	DESCRIPTION
filename	The path to the file where the XML will be written. TYPE: Path
metadata	The Metadata object to write to the file. TYPE: Metadata
xml_bytes	Additional XML content, defaults to an empty byte string. TYPE: bytes DEFAULT: b''