xsdata.formats.dataclass.serializers package

Submodules

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

Module contents

class xsdata.formats.dataclass.serializers.DictFactory

Bases: object

FILTER_NONE()

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

Bases: xsdata.formats.bindings.AbstractSerializer

dict_factory

alias of builtins.dict

render(obj)

Convert the given object tree to dictionary with primitive values.

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

dict_factory

alias of builtins.dict

encoder

alias of JsonEncoder

indent: Optional[int] = None

render(obj)

Convert the given object tree to json string.

Return type

str

class xsdata.formats.dataclass.serializers.XmlSerializer(name_generator=<function ModelInspect.<lambda>>, cache=<factory>, xml_declaration=True, encoding='UTF-8', pretty_print=False)

Bases: xsdata.formats.bindings.AbstractSerializer, xsdata.formats.dataclass.mixins.ModelInspect

Variables

• xml_declaration – Add xml declaration

• encoding – Result text encoding

• pretty_print – Enable pretty output

xml_declaration: bool = True

encoding: str = 'UTF-8'

pretty_print: bool = False

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.

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.

Return type

Element

render_node(obj, parent, namespaces)

Recursively traverse the given dataclass instance fields and build the lxml Element structure.

Return type

Element

render_sub_nodes(parent, values, var, namespaces)

classmethod set_attribute(parent, key, value)

classmethod set_attributes(parent, values)

classmethod set_text(parent, value)

classmethod set_tail(parent, value)

classmethod set_nil_attribute(element, nillable, namespaces)

classmethod next_value(meta, obj)