twisted.web.microdom module documentation

Part of twisted.web

Micro Document Object Model: a partial DOM implementation with SUX.

This is an implementation of what we consider to be the useful subset of the DOM. The chief advantage of this library is that, not being burdened with standards compliance, it can remain very stable between versions. We can also implement utility 'pythonic' ways to access and mutate the XML tree.

Since this has not subjected to a serious trial by fire, it is not recommended to use this outside of Twisted applications. However, it seems to work just fine for the documentation generator, which parses a fairly representative sample of XML.

Microdom mainly focuses on working with HTML and XHTML.

Function getElementsByTagName Return a list of all child elements of iNode with a name matching name.
Function getElementsByTagNameNoCase Undocumented
Function unescape Perform the exact opposite of 'escape'.
Function escape Escape a few XML special chars with XML entities.
Class MismatchedTags Undocumented
Class Node No class docstring; 5/14 methods documented
Class Document No class docstring; 1/11 methods documented
Class EntityReference Undocumented
Class CharacterData Undocumented
Class Comment A comment node.
Class Text No class docstring; 1/5 methods documented
Class CDATASection Undocumented
Class Element No class docstring; 2/17 methods documented
Class MicroDOMParser Undocumented
Function parse Parse HTML or XML readable.
Function parseString Undocumented
Function parseXML Parse an XML readable object.
Function parseXMLString Parse an XML readable object.
Class lmx Easy creation of XML.
Function _streamWriteWrapper Undocumented
Function _genprefix Undocumented
Class _Attr Support class for getAttributeNode.
Function _unescapeDict Undocumented
Function _reverseDict Undocumented
def getElementsByTagName(iNode, name):

Return a list of all child elements of iNode with a name matching name.

Note that this implementation does not conform to the DOM Level 1 Core specification because it may return iNode.

ParametersiNodeAn element at which to begin searching. If iNode has a name matching name, it will be included in the result.
nameA str giving the name of the elements to return.
ReturnsA list of direct or indirect child elements of iNode with the name name. This may include iNode.
def getElementsByTagNameNoCase(iNode, name):
Undocumented
def _streamWriteWrapper(stream):
Undocumented
def unescape(text, chars=REV_HTML_ESCAPE_CHARS):

Perform the exact opposite of 'escape'.

def escape(text, chars=HTML_ESCAPE_CHARS):

Escape a few XML special chars with XML entities.

def _genprefix():
Undocumented
def _unescapeDict(d):
Undocumented
def _reverseDict(d):
Undocumented
def parse(readable, *args, **kwargs):

Parse HTML or XML readable.

def parseString(st, *args, **kw):
Undocumented
def parseXML(readable):

Parse an XML readable object.

def parseXMLString(st):

Parse an XML readable object.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.