docx.oxml.parser
paper-docx 0.2.0 API reference
XML parser for python-docx.
element_class_lookup
attributeelement_class_lookup= etree.ElementNamespaceClassLookup()oxml_parser
attributeoxml_parser= etree.XMLParser(remove_blank_text=True, resolve_entities=False)OxmlElement
funcOxmlElement(nsptag_str: str, attrs: Dict[str, str] | None = None, nsdecls: Dict[str, str] | None = None) -> BaseOxmlElement | etree._ElementReturn a 'loose' lxml element having the tag specified by nsptag_str.
The tag in nsptag_str must contain the standard namespace prefix, e.g. a:tbl.
The resulting element is an instance of the custom element class for this tag name
if one is defined. A dictionary of attribute values may be provided as attrs; they
are set if present. All namespaces defined in the dict nsdecls are declared in the
element using the key as the prefix and the value as the namespace name. If
nsdecls is not provided, a single namespace declaration is added based on the
prefix on nsptag_str.
paramnsptag_strstrparamattrsDict[str, str] | None= NoneparamnsdeclsDict[str, str] | None= NoneReturns
docx.oxml.xmlchemy.BaseOxmlElement | lxml.etree.lxml.etree._Elementparse_xml
funcparse_xml(xml: str | bytes) -> 'BaseOxmlElement'Root lxml element obtained by parsing XML character string xml.
The custom parser is used, so custom element classes are produced for elements in
xml that have them.
paramxmlstr | bytesReturns
'BaseOxmlElement'register_element_cls
funcregister_element_cls(tag: str, cls: Type['BaseOxmlElement'])Register an lxml custom element-class to use for tag.
A instance of cls to be constructed when the oxml parser encounters an element
with matching tag. tag is a string of the form nspfx:tagroot, e.g.
'w:document'.
paramtagstr