jetblack_serialization¶

module jetblack_serialization.xml ¶

Summary¶

XML Serialization

function jetblack_serialization.xml.deserialize ¶

Summary¶

Convert XML to an object

jetblack_serialization.xml.deserialize(

text: str | bytes | bytearray,

annotation: Annotation,

config: SerializerConfig,

decode: XMLDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

The XML string

annotation: Annotation

The type annotation

config: SerializerConfig

The serializer configuration

decode: XMLDecoder | None (optional)

Returns¶

Any: The deserialized object.

function jetblack_serialization.xml.deserialize_typed ¶

Summary¶

Convert XML to an object

jetblack_serialization.xml.deserialize_typed(

text: str | bytes | bytearray,

annotation: str,

config: jetblack_serialization.config.SerializerConfig | None,

decode: XMLDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

The XML string

annotation: str

The type annotation

config: jetblack_serialization.config.SerializerConfig | None (optional)

decode: XMLDecoder | None (optional)

Returns¶

Any: The deserialized object.

function jetblack_serialization.xml.deserialize_untyped ¶

Summary¶

Deserialize XML without type information

jetblack_serialization.xml.deserialize_untyped(

text: str | bytes | bytearray,

config: jetblack_serialization.config.SerializerConfig | None,

decode: XMLDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

The XML string

config: jetblack_serialization.config.SerializerConfig | None (optional)

decode: XMLDecoder | None (optional)

Returns¶

Any: The deserialized object.

function jetblack_serialization.xml.serialize ¶

Summary¶

Convert the object to JSON

jetblack_serialization.xml.serialize(

obj: Any,

annotation: Annotation,

config: SerializerConfig,

encode: XMLEncoder | None

) -> str

Parameters¶

obj: Any

The object to convert

annotation: Annotation

The type annotation

config: SerializerConfig

The serializer configuration

encode: XMLEncoder | None (optional)

Returns¶

str: The serialized object

function jetblack_serialization.xml.serialize_typed ¶

jetblack_serialization.xml.serialize_typed(

obj: Any,

annotation: Annotation,

config: jetblack_serialization.config.SerializerConfig | None,

encode: XMLEncoder | None

) -> str

Parameters¶

obj: Any

annotation: Annotation

config: jetblack_serialization.config.SerializerConfig | None (optional)

encode: XMLEncoder | None (optional)

Returns¶

str:

function jetblack_serialization.xml.serialize_untyped ¶

jetblack_serialization.xml.serialize_untyped(

obj: Any,

config: jetblack_serialization.config.SerializerConfig | None,

encode: XMLEncoder | None

) -> str

Parameters¶

obj: Any

config: jetblack_serialization.config.SerializerConfig | None (optional)

encode: XMLEncoder | None (optional)

Returns¶

str:

class XMLAttribute(XMLAnnotation) ¶

Summary¶

An XML attribute

jetblack_serialization.xml.annotations.XMLAttribute(

tag: str

) -> None

Parameters¶

tag: str

class XMLEntity(XMLAnnotation) ¶

Summary¶

An XML entity

jetblack_serialization.xml.annotations.XMLEntity(

tag: str

) -> None

Parameters¶

tag: str