xsdata.formats.dataclass.parsers package

Subpackages

• xsdata.formats.dataclass.parsers.handlers package
  • Submodules
    • xsdata.formats.dataclass.parsers.handlers.lxml module
    • xsdata.formats.dataclass.parsers.handlers.native module
  • Module contents

Submodules

• xsdata.formats.dataclass.parsers.config module
• xsdata.formats.dataclass.parsers.json module
• xsdata.formats.dataclass.parsers.mixins module
• xsdata.formats.dataclass.parsers.nodes module
• xsdata.formats.dataclass.parsers.utils module
• xsdata.formats.dataclass.parsers.xml module

Module contents

class xsdata.formats.dataclass.parsers.JsonParser(context=<factory>)

Bases: xsdata.formats.bindings.AbstractParser

Json parsing and binding for dataclasses.

Parameters

context (XmlContext) – Model metadata builder

context: xsdata.formats.dataclass.context.XmlContext

from_path(path, clazz=None)

Parse the input file path and return the resulting object tree.

Parameters

• path (Path) –

• clazz (Optional[Type[~T]]) –

Return type

~T

parse(source, clazz=None)

Parse the JSON input stream and return the resulting object tree.

Parameters

• source (BytesIO) –

• clazz (Optional[Type[~T]]) –

Return type

~T

bind_value(var, value)

Bind value according to the class var.

Parameters

• var (XmlVar) –

• value (Any) –

Return type

Any

bind_dataclass(data, clazz)

Recursively build the given model from the input dict data.

Parameters

• data (Dict) –

• clazz (Type[~T]) –

Return type

~T

bind_dataclass_union(value, var)

Bind data to all possible models and return the best candidate.

Parameters

• value (Dict) –

• var (XmlVar) –

Return type

Any

bind_wildcard(value)

Bind data to a wildcard model.

Parameters

value (Any) –

Return type

Any

bind_choice(value, var)

Bind data to one of the choice models.

Parameters

• value (Any) –

• var (XmlVar) –

Return type

Any

bind_choice_simple(value, var)

Bind data to one of the simple choice types and return the first that succeeds.

Parameters

• value (Any) –

• var (XmlVar) –

Return type

Any

bind_choice_generic(value, var)

Bind data to a either a derived or a user derived model.

Parameters

• value (Dict) –

• var (XmlVar) –

Return type

Any

bind_choice_dataclass(value, var)

Bind data to the best matching choice model.

Parameters

• value (Dict) –

• var (XmlVar) –

Return type

Any

classmethod parse_value(value, var)

Convert any value to one of the given var types.

Parameters

• value (Any) –

• var (XmlVar) –

Return type

Any

class xsdata.formats.dataclass.parsers.XmlParser(config=<factory>, context=<factory>, handler=<class 'xsdata.formats.dataclass.parsers.handlers.lxml.LxmlEventHandler'>)

Bases: xsdata.formats.dataclass.parsers.nodes.NodeParser

Bind xml nodes to dataclasses with event hooks.

Parameters

• handler (Type[XmlHandler]) – Xml handler type

• emit_cache – Cache for qnames to event names

• config (ParserConfig) –

• context (XmlContext) –

handler

alias of xsdata.formats.dataclass.parsers.handlers.lxml.LxmlEventHandler

emit_cache: Dict

start(clazz, queue, objects, qname, attrs, ns_map)

Queue the next xml node for parsing.

Emit a start event with the current element qualified name and attributes.

Parameters

• clazz (Optional[Type]) –

• queue (List[XmlNode]) –

• objects (List[Tuple[Optional[str], Any]]) –

• qname (str) –

• attrs (Dict) –

• ns_map (Dict) –

end(queue, objects, qname, text, tail)

Parse the last xml node and bind any intermediate objects.

Emit an end event with the result object if any.

Return type

Any

Returns

The result of the binding process.

Parameters

• queue (List[XmlNode]) –

• objects (List[Tuple[Optional[str], Any]]) –

• qname (str) –

• text (Optional[str]) –

• tail (Optional[str]) –

emit_event(event, name, **kwargs)

Call if exist the parser’s hook for the given element and event.

Parameters

• event (str) –

• name (str) –

• kwargs (Any) –