xsdata.formats.dataclass.parsers package

Submodules

• xsdata.formats.dataclass.parsers.config module
• xsdata.formats.dataclass.parsers.json 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(name_generator=<function XmlContext.<lambda>>, cache=<factory>)

Bases: xsdata.formats.bindings.AbstractParser, xsdata.formats.dataclass.context.XmlContext

Parameters

• name_generator (Callable) –

• cache (Dict[Type, XmlMeta]) –

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

TypeError – 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, field)

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

Parameters

• data (Dict) –

• field (XmlVar) –

Return type

Any

cache

class xsdata.formats.dataclass.parsers.XmlParser(context=<factory>, event_names=<factory>, config=<factory>)

Bases: xsdata.formats.bindings.AbstractParser

Xml parsing and binding for dataclasses.

Parameters

• namespaces – Store the prefix/namespace as they are parsed.

• context (XmlContext) – Model metadata builder

• event_names (Dict) – Cache for event names for each element

• config (ParserConfig) – Parser configuration

namespaces: Namespaces

context: XmlContext

event_names: Dict

config: ParserConfig

parse(source, clazz)

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

Parameters

• source (BytesIO) –

• clazz (Type[~T]) –

Return type

~T

parse_context(context, clazz)

Dispatch elements to handlers as they arrive and are fully parsed.

Raises

ParserError – When the requested type doesn’t match the result object

Parameters

• context (iterparse) –

• clazz (Type[~T]) –

Return type

~T

add_namespace(namespace)

Add the given namespace in the registry.

Parameters

namespace (Tuple) –

queue(element, queue, objects)

Queue the next xml node for parsing based on the given element qualified name.

Parameters

• element (Element) –

• queue (List[XmlNode]) –

• objects (List[Tuple[QName, Any]]) –

dequeue(element, queue, objects)

Use the last xml node to parse the given element and bind any child objects.

Return type

Any

Returns

Any: A dataclass instance or a python primitive value or None

Parameters

• element (Element) –

• queue (List[XmlNode]) –

• objects (List[Tuple[QName, 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) –