xsdata.formats.dataclass.serializers package

Submodules

• xsdata.formats.dataclass.serializers.json module
• xsdata.formats.dataclass.serializers.utils module
• xsdata.formats.dataclass.serializers.xml module

Module contents

class xsdata.formats.dataclass.serializers.DictFactory

Bases: object

FILTER_NONE()

Parameters

x (Tuple) –

Return type

Dict

class xsdata.formats.dataclass.serializers.DictSerializer(dict_factory=<class 'dict'>)

Bases: xsdata.formats.bindings.AbstractSerializer

Parameters

dict_factory (Callable) –

dict_factory

alias of builtins.dict

render(obj)

Convert the given object tree to dictionary with primitive values.

Parameters

obj (object) –

Return type

Dict

class xsdata.formats.dataclass.serializers.JsonSerializer(dict_factory=<class 'dict'>, encoder=<class 'xsdata.formats.dataclass.serializers.json.JsonEncoder'>, indent=None)

Bases: xsdata.formats.bindings.AbstractSerializer

Variables

• dict_factory – Callable to generate dictionary

• encoder – Value encoder

• indent – Pretty print indent

Parameters

• dict_factory (Callable) –

• encoder (Type[JSONEncoder]) –

• indent (Optional[int]) –

dict_factory

alias of builtins.dict

encoder

alias of JsonEncoder

indent: Optional[int] = None

render(obj)

Convert the given object tree to json string.

Parameters

obj (object) –

Return type

str

class xsdata.formats.dataclass.serializers.XmlSerializer(xml_declaration=True, encoding='UTF-8', pretty_print=False, context=<factory>)

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)

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

str

render_tree(obj, namespaces=None)

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)

Recursively traverse the given object and build the xml tree.

Parameters

• parent (Element) –

• obj (Any) –

• namespaces (Namespaces) –

render_complex_node(parent, obj, namespaces)

Parameters

• parent (Element) –

• obj (Any) –

• namespaces (Namespaces) –

render_sub_nodes(parent, values, var, namespaces)

Parameters

• parent (Element) –

• values (List) –

• var (XmlVar) –

• namespaces (Namespaces) –

render_sub_node(parent, value, var, namespaces)

Parameters

• parent (Element) –

• value (Any) –

• var (XmlVar) –

• namespaces (Namespaces) –

render_element_node(parent, value, var, namespaces)

Parameters

• parent (Element) –

• value (Any) –

• var (XmlVar) –

• namespaces (Namespaces) –

render_wildcard_node(parent, value, var, namespaces)

Parameters

• parent (Element) –

• value (Any) –

• var (XmlVar) –

• namespaces (Namespaces) –

set_xsi_type(parent, value, var, namespaces)

Parameters

• parent (Element) –

• value (Any) –

• var (XmlVar) –

• namespaces (Namespaces) –

classmethod next_value(meta, obj)

Parameters

• meta (XmlMeta) –

• obj (Any) –