xsdata.formats.dataclass.serializers.xml module¶
-
class
xsdata.formats.dataclass.serializers.xml.
XmlSerializer
(xml_declaration=True, encoding='UTF-8', pretty_print=False, context=<factory>)[source]¶ Bases:
xsdata.formats.bindings.AbstractSerializer
- Variables
xml_declaration – Add xml declaration
encoding – Result text encoding
pretty_print – Enable pretty output
context – XmlContext instance
- Parameters
xml_declaration (
bool
) –encoding (
str
) –pretty_print (
bool
) –context (
XmlContext
) –
-
xml_declaration
: bool = True¶
-
encoding
: str = 'UTF-8'¶
-
pretty_print
: bool = False¶
-
context
: XmlContext = None¶
-
render
(obj, namespaces=None)[source]¶ Convert the given object tree to xml string.
Optionally provide a namespaces instance with a predefined list of namespace uris and prefixes.
- Parameters
obj (
Any
) –namespaces (
Optional
[Namespaces
]) –
- Return type
-
render_tree
(obj, namespaces=None)[source]¶ Convert a dataclass instance to a nested Element structure.
Optionally provide a namespaces instance with a predefined list of namespace uris and prefixes.
- Parameters
obj (
Any
) –namespaces (
Optional
[Namespaces
]) –
- Return type
Element
-
render_node
(parent, obj, namespaces)[source]¶ Recursively traverse the given object and build the xml tree.
- Parameters
parent (
Element
) –obj (
Any
) –namespaces (
Namespaces
) –
-
render_complex_node
(parent, obj, namespaces)[source]¶ - Parameters
parent (
Element
) –obj (
Any
) –namespaces (
Namespaces
) –
-
render_sub_nodes
(parent, values, var, namespaces)[source]¶ - Parameters
parent (
Element
) –values (
List
) –var (
XmlVar
) –namespaces (
Namespaces
) –
-
render_sub_node
(parent, value, var, namespaces)[source]¶ - Parameters
parent (
Element
) –value (
Any
) –var (
XmlVar
) –namespaces (
Namespaces
) –
-
render_element_node
(parent, value, var, namespaces)[source]¶ - Parameters
parent (
Element
) –value (
Any
) –var (
XmlVar
) –namespaces (
Namespaces
) –
-
render_wildcard_node
(parent, value, var, namespaces)[source]¶ - Parameters
parent (
Element
) –value (
Any
) –var (
XmlVar
) –namespaces (
Namespaces
) –
-
set_xsi_type
(parent, value, var, namespaces)[source]¶ - Parameters
parent (
Element
) –value (
Any
) –var (
XmlVar
) –namespaces (
Namespaces
) –