XmlParser

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

Xml parser for dataclasses.

Parameters

• config (ParserConfig) – Parser configuration

• context (XmlContext) – Model context provider

• handler (Type[XmlHandler]) – Override default XmlHandler

Variables

• ms_map – The prefix-URI map generated during parsing

• emit_cache – Qname to event name cache

handler

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

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

Start element notification receiver.

Build and queue the XmlNode for the starting element and emits and propagate the event to subclasses.

Parameters

• clazz (Optional[Type]) – Root class type, if it’s missing look for any suitable models from the current context.

• queue (List[XmlNode]) – The active XmlNode queue

• objects (List[Tuple[Optional[str], Any]]) – The list of all intermediate parsed objects

• qname (str) – Qualified name

• attrs (Dict) – Attribute key-value map

• ns_map (Dict) – Namespace prefix-URI map

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

End element notification receiver.

Pop the last XmlNode from the queue and use it to build and return the resulting object tree with its text and tail content. Propagate the event to subclasses.

Parameters

• queue (List[XmlNode]) – Xml nodes queue

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

• qname (str) – Qualified name

• text (Optional[str]) – Text content

• tail (Optional[str]) – Tail content

Return type

Any

emit_event(event, name, **kwargs)

Propagate event to subclasses.

Match event and name to a subclass method and trigger it with any input keyword arguments.

Example:

event=start, name={urn}bookTitle -> start_booking_title(**kwargs)

Parameters

• event (str) – Event type start|end

• name (str) – Element qualified name

• kwargs (Any) – Event keyword arguments