xsdata.formats.dataclass.serializers package¶

Subpackages¶

xsdata.formats.dataclass.serializers.writers package
- Submodules
  - xsdata.formats.dataclass.serializers.writers.lxml module
  - xsdata.formats.dataclass.serializers.writers.native module
- Module contents

Submodules¶

Module contents¶

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

Bases: xsdata.formats.bindings.AbstractSerializer

Simple json.dumps wrapper.

Parameters

indent (Optional[int]) – output indentation.
encoder (Type[JSONEncoder]) – Value encoder.
dict_factory (Callable) – Override default dict factory to add further logic.

indent: Optional[int] = None¶

encoder¶: alias of JsonEncoder

dict_factory¶: alias of builtins.dict

render(obj)[source]¶

Convert the given object tree to json string.

Parameters: obj (object) –
Return type: str

class xsdata.formats.dataclass.serializers.DictFactory[source]¶

Bases: object

Dictionary factory types.

FILTER_NONE()¶

Parameters: x (Tuple) –
Return type: Dict

class xsdata.formats.dataclass.serializers.XmlSerializer(encoding='UTF-8', pretty_print=False, context=<factory>, writer=<class 'xsdata.formats.dataclass.serializers.writers.lxml.LxmlEventWriter'>)[source]¶

Bases: xsdata.formats.bindings.AbstractSerializer

Xml serialize for dataclasses.

Parameters

encoding (str) – Text encoding
pretty_print (bool) – Enable pretty output
context (XmlContext) – XmlContext instance
writer (Type[XmlWriter]) – xml writer type

encoding: str = 'UTF-8'¶

pretty_print: bool = False¶

context: xsdata.formats.dataclass.context.XmlContext¶

writer¶: alias of xsdata.formats.dataclass.serializers.writers.lxml.LxmlEventWriter

render(obj, ns_map=None)[source]¶

Convert and return the given object tree as xml string.

Optionally provide a prefix-URI namespaces mapping.

Parameters

obj (Any) –
ns_map (Optional[Dict]) –

Return type

str

write(out, obj, ns_map=None)[source]¶

Write the given object tree to output text stream.

Optionally provide a prefix-URI namespaces mapping.

Parameters

out (TextIO) –
obj (Any) –
ns_map (Optional[Dict]) –

write_object(obj)[source]¶

Produce an events stream from a dataclass or a derived element.

Parameters: obj (Any) –

write_dataclass(obj, namespace=None, qname=None, nillable=False, xsi_type=None)[source]¶

Produce an events stream from a dataclass.

Optionally override the qualified name and the xsi properties type and nil.

Parameters

obj (Any) –
namespace (Optional[str]) –
qname (Optional[str]) –
nillable (bool) –
xsi_type (Optional[QName]) –

Return type

Generator

write_xsi_type(value, var, namespace)[source]¶

Produce an events stream from a dataclass for the given var with with xsi abstract type check for non wildcards.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

write_value(value, var, namespace)[source]¶

Delegates the given value to the correct writer according to the variable metadata.

The order of the checks is important as more than one condition can be true.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

write_list(values, var, namespace)[source]¶

Produce an events stream for the given list of values.

Parameters

values (List) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

write_tokens(value, var, namespace)[source]¶

Produce an events stream for the given tokens list or list of tokens lists.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

write_mixed_content(values, var, namespace)[source]¶

Produce an events stream for the given list of mixed type objects.

Parameters

values (List) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

write_any_type(value, var, namespace)[source]¶

Produce an events stream for the given object.

The object can be a dataclass or a generic object or any other simple type.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

write_wildcard(value, var, namespace)[source]¶

Produce an element events stream for the given generic object.

Parameters

value (AnyElement) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

xsi_type(var, value, namespace)[source]¶

Get xsi:type if the given value is a derived instance.

Parameters

var (XmlVar) –
value (Any) –
namespace (Optional[str]) –

Return type

Optional[QName]

write_elements(value, var, namespace)[source]¶

Produce an events stream from compound elements field.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

write_choice(value, var, namespace)[source]¶

Produce an events stream for the given value of a compound elements field.

The value can be anything as long as we can match the qualified name or its type to a choice.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

classmethod write_element(value, var, namespace)[source]¶

Produce an element events stream for the given simple type value.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

classmethod write_data(value, var, namespace)[source]¶

Produce a data event for the given value.

Parameters

value (Any) –
var (XmlVar) –
namespace (Optional[str]) –

Return type

Generator

classmethod next_value(obj, meta)[source]¶

Return the non attribute variables with their object values in the correct order according to their definition and the sequential metadata property.

Sequential fields need to be rendered together in parallel order eg: <a1/><a2/><a1/><a/2></a1>

Parameters

obj (Any) –
meta (XmlMeta) –

classmethod next_attribute(obj, meta, xsi_nil, xsi_type)[source]¶

Return the attribute variables with their object values.

Ignores None values and empty lists. Optionally include the xsi properties type and nil.

Parameters

obj (Any) –
meta (XmlMeta) –
xsi_nil (bool) –
xsi_type (Optional[QName]) –

Return type

Generator