xml.dom.pulldom — Support for building partial DOM trees¶

Source code:Lib/xml/dom/pulldom.py

Thexml.dom.pulldom module provides a “pull parser” which can also beasked to produce DOM-accessible fragments of the document where necessary. Thebasic concept involves pulling “events” from a stream of incoming XML andprocessing them. In contrast to SAX which also employs an event-drivenprocessing model together with callbacks, the user of a pull parser isresponsible for explicitly pulling events from the stream, looping over thoseevents until either processing is finished or an error condition occurs.

fromxml.dom.pulldomimportparsefromxml.saximportmake_parserfromxml.sax.handlerimportfeature_external_gesparser=make_parser()parser.setFeature(feature_external_ges,True)parse(filename,parser=parser)

Example:

fromxml.domimportpulldomdoc=pulldom.parse('sales_items.xml')forevent,nodeindoc:ifevent==pulldom.START_ELEMENTandnode.tagName=='item':ifint(node.getAttribute('price'))>50:doc.expandNode(node)print(node.toxml())

event is a constant and can be one of:

• START_ELEMENT

• END_ELEMENT

• COMMENT

• START_DOCUMENT

• END_DOCUMENT

• CHARACTERS

• PROCESSING_INSTRUCTION

• IGNORABLE_WHITESPACE

node is an object of typexml.dom.minidom.Document,xml.dom.minidom.Element orxml.dom.minidom.Text.

Since the document is treated as a “flat” stream of events, the document “tree”is implicitly traversed and the desired elements are found regardless of theirdepth in the tree. In other words, one does not need to consider hierarchicalissues such as recursive searching of the document nodes, although if thecontext of elements were important, one would either need to maintain somecontext-related state (i.e. remembering where one is in the document at anygiven point) or to make use of theDOMEventStream.expandNode() methodand switch to DOM-related processing.

classxml.dom.pulldom.PullDom(documentFactory=None)¶

Subclass ofxml.sax.handler.ContentHandler.

classxml.dom.pulldom.SAX2DOM(documentFactory=None)¶

Subclass ofxml.sax.handler.ContentHandler.

xml.dom.pulldom.parse(stream_or_string,parser=None,bufsize=None)¶

Return aDOMEventStream from the given input.stream_or_string may beeither a file name, or a file-like object.parser, if given, must be anXMLReader object. This function will change thedocument handler of theparser and activate namespace support; other parser configuration (likesetting an entity resolver) must have been done in advance.

If you have XML in a string, you can use theparseString() function instead:

xml.dom.pulldom.parseString(string,parser=None)¶

Return aDOMEventStream that represents the (Unicode)string.

xml.dom.pulldom.default_bufsize¶

Default value for thebufsize parameter toparse().

The value of this variable can be changed before callingparse() andthe new value will take effect.