Developer Interface

pydantic xml serialization/deserialization extension

class pydantic_xml.BaseXmlModel

Bases: BaseModel

Base pydantic-xml model.

classmethod from_xml_tree(root)

Deserializes an xml element tree to an object of cls type.

Parameters:

root (Element) – xml element to deserialize the object from

Returns:

deserialized object

Return type:

Optional[BaseXmlModel]

classmethod from_xml(source)

Deserializes an xml string to an object of cls type.

Parameters:

source (Union[str, bytes]) – xml string

Returns:

deserialized object

Return type:

Optional[BaseXmlModel]

to_xml_tree(*, encoder=None, skip_empty=False)

Serializes the object to an xml tree.

Parameters:

• encoder (Optional[XmlEncoder]) – xml type encoder

• skip_empty (bool) – skip empty elements (elements without sub-elements, attributes and text, Nones)

Returns:

object xml representation

Return type:

Element

to_xml(*, encoder=None, skip_empty=False, **kwargs)

Serializes the object to an xml string.

Parameters:

• encoder (Optional[XmlEncoder]) – xml type encoder

• skip_empty (bool) – skip empty elements (elements without sub-elements, attributes and text, Nones)

• kwargs (Any) – additional xml serialization arguments

Returns:

object xml representation

Return type:

Union[str, bytes]

class pydantic_xml.BaseGenericXmlModel

Bases: BaseXmlModel, GenericModel

Base pydantic-xml generic model.

classmethod from_xml_tree(root)

Deserializes an xml element tree to an object of cls type.

Parameters:

root (Element) – xml element to deserialize the object from

Returns:

deserialized object

Return type:

Optional[BaseXmlModel]

class pydantic_xml.XmlEncoder(default=None)

Bases: object

Xml data encoder.

Parameters:

default (Optional[Callable[[Any], Any]]) –

encode(obj)

Encodes provided object into a string

Parameters:

obj (Any) – object to be encoded

Returns:

encoded object

Return type:

str

exception pydantic_xml.ModelError

Bases: BaseError

Model definition error.

class pydantic_xml.XmlAttributeInfo(name=None, ns=None, **kwargs)

Bases: XmlEntityInfo

Field xml attribute meta-information.

Parameters:

• name (Optional[str]) – attribute name

• ns (Optional[str]) – attribute xml namespace

• kwargs (Any) – pydantic field arguments. See pydantic.Field

class pydantic_xml.XmlElementInfo(tag=None, ns=None, nsmap=None, **kwargs)

Bases: XmlEntityInfo

Field xml element meta-information.

Parameters:

• tag (Optional[str]) – element tag

• ns (Optional[str]) – element xml namespace

• nsmap (Optional[Dict[str, str]]) – element xml namespace map

• kwargs (Any) – pydantic field arguments

class pydantic_xml.XmlWrapperInfo(path, entity=None, ns=None, nsmap=None, **kwargs)

Bases: XmlEntityInfo

Field xml wrapper meta-information.

Parameters:

• entity (Optional[XmlEntityInfo]) – wrapped entity

• path (str) – entity path

• ns (Optional[str]) – element xml namespace

• nsmap (Optional[Dict[str, str]]) – element xml namespace map

• kwargs (Any) – pydantic field arguments

exception pydantic_xml.ParsingError

Bases: BaseError

Xml parsing error.

pydantic_xml.attr(**kwargs)

Marks a pydantic field as an xml attribute. Method parameters are identical to pydantic_xml.XmlAttributeInfo.

Parameters:

kwargs (Any) –

Return type:

Any

pydantic_xml.element(**kwargs)

Marks a pydantic field as an xml element. Method parameters are identical to pydantic_xml.XmlElementInfo.

Parameters:

kwargs (Any) –

Return type:

Any

pydantic_xml.wrapped(*args, **kwargs)

Marks a pydantic field as a wrapped xml entity. Method parameters are identical to pydantic_xml.XmlWrapperInfo.

Parameters:

• args (Any) –

• kwargs (Any) –

Return type:

Any