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)

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

Parameters

• path (Path) –

• clazz (Type[~T]) –

Return type

~T

parse(source, clazz)

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

Parameters

• source (BytesIO) –

• clazz (Type[~T]) –

Return type

~T

parse_context(data, clazz)

Recursively build the given model from the input dict data.

Raises

ParserError – When parsing fails for any reason

Parameters

• data (Dict) –

• clazz (Type[~T]) –

Return type

~T

bind_value(var, value)

Bind value according to the class var.

The return value can be: - a dataclass instance - a dictionary with unknown attributes - a list of unknown elements - an enumeration - a primitive value

Parameters

• var (XmlVar) –

• value (Any) –

Return type

Any

static get_value(data, var)

Find the var value in the given dictionary or return the default var value.

Parameters

• data (Dict) –

• 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.

• event_names – Cache for qnames to event names.

• config (ParserConfig) –

• context (XmlContext) –

handler

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

event_names: Dict

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

Queue the next xml node for parsing.

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

Parameters

• queue (List[XmlNode]) –

• qname (str) –

• attrs (Dict) –

• ns_map (Dict) –

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

• clazz (Type[~T]) –

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

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]) –

• qname (str) –

• text (Optional[str]) –

• tail (Optional[str]) –

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

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) –