xsdata.formats.dataclass.parsers.mixins module

class xsdata.formats.dataclass.parsers.mixins.PushParser

Bases: xsdata.formats.bindings.AbstractParser

A generic interface for event based content handlers like sax.

Parameters

config – Parser configuration.

config: xsdata.formats.dataclass.parsers.config.ParserConfig

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

Queue the next xml node for parsing.

Parameters

• clazz (Optional[Type]) –

• queue (List) –

• objects (List) –

• qname (str) –

• attrs (Dict) –

• ns_map (Dict) –

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

Parse the last xml node and bind any intermediate objects.

Return type

Any

Returns

The result of the binding process.

Parameters

• queue (List) –

• objects (List) –

• qname (str) –

• text (Optional[str]) –

• tail (Optional[str]) –

abstract start_prefix_mapping(prefix, uri)

Add the given namespace in the registry.

Parameters

• prefix (Optional[str]) –

• uri (str) –

class xsdata.formats.dataclass.parsers.mixins.XmlNode

Bases: abc.ABC

A generic interface for xml nodes that need to implement the two public methods to be used in an event based parser with start/end element events.

The parser needs to maintain a queue for these nodes and a list of objects that these nodes return.

abstract child(qname, attrs, ns_map, position)

Initialize the next child node to be queued, when a new xml element starts.

This entry point is responsible to create the next node type with all the necessary information on how to bind the incoming input data.

Parameters

• qname (str) –

• attrs (Dict) –

• ns_map (Dict) –

• position (int) –

Return type

XmlNode

abstract bind(qname, text, tail, objects)

Parse the current element bind child objects and return the result.

This entry point is called when an xml element ends and is responsible to parse the current element attributes/text, bind any children objects and initialize a new object.

Return type

bool

Returns

Whether or not anything was appended in the objects list.

Parameters

• qname (str) –

• text (Optional[str]) –

• tail (Optional[str]) –

• objects (List) –

class xsdata.formats.dataclass.parsers.mixins.XmlHandler(parser, clazz, queue=<factory>, objects=<factory>)

Bases: object

Xml content handler interface.

Parameters

• parser (PushParser) – The parser instance to feed events.

• clazz (Optional[Type]) – The model to bind the xml document data. If it’s not provided the parser is responsible to locate one from the xml context.

• queue (List) – The queue list of xml nodes.

• objects (List) – Temporary storage for intermediate objects, eg [(qname, object)]

parser: xsdata.formats.dataclass.parsers.mixins.PushParser

clazz: Optional[Type]

queue: List

objects: List

parse(source)

Parse an XML document from a system identifier or an InputSource.

Parameters

source (Any) –

Return type

Any

start_ns_bulk(ns_map)

Bulk start-ns event handler that returns a normalized copy of the prefix-URI mapping that also includes the parent mapping.

Parameters

ns_map (Dict) –

Return type

Dict

class xsdata.formats.dataclass.parsers.mixins.EventsHandler(parser, clazz, queue=<factory>, objects=<factory>)

Bases: xsdata.formats.dataclass.parsers.mixins.XmlHandler

Content handler based on pre-recorded events.

Parameters

• parser (PushParser) –

• clazz (Optional[Type]) –

• queue (List) –

• objects (List) –

parse(source)

Forward the pre-recorded events to the main parser.

Parameters

source (List[Tuple]) –

Return type

Any

parser: xsdata.formats.dataclass.parsers.mixins.PushParser

clazz: Optional[Type]

queue: List

objects: List