twisted.web.microdom : API documentation

module documentation

(source)

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
Variable	HTML_ESCAPE_CHARS	Undocumented
Variable	REV_HTML_ESCAPE_CHARS	Undocumented
Variable	XML_ESCAPE_CHARS	Undocumented
Variable	REV_XML_ESCAPE_CHARS	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; 0/1 class variables, 0/2 instance variables, 5/14 methods documented
Class	Document	No class docstring; 0/1 class variables, 1/10 methods, 0/1 propertys documented
Class	EntityReference	Undocumented
Class	CharacterData	Undocumented
Class	Comment	A comment node.
Class	Text	No class docstring; 0/1 instance variables, 1/5 methods documented
Class	CDATASection	Undocumented
Variable	genprefix	Undocumented
Class	Element	No class docstring; 0/10 instance variables, 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): (source)

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.

Parameters	iNode	An element at which to begin searching. If `iNode` has a name matching `name`, it will be included in the result.
	name	A `str` giving the name of the elements to return.
Returns	A `list` of direct or indirect child elements of `iNode` with the name `name`. This may include `iNode`.

def getElementsByTagNameNoCase(iNode, name): (source)

Undocumented

def _streamWriteWrapper(stream): (source)

Undocumented

HTML_ESCAPE_CHARS = (source)

Undocumented

(type: tuple)

REV_HTML_ESCAPE_CHARS = (source)

Undocumented

XML_ESCAPE_CHARS = (source)

Undocumented

REV_XML_ESCAPE_CHARS = (source)

Undocumented

def unescape(text, chars=REV_HTML_ESCAPE_CHARS): (source)

Perform the exact opposite of 'escape'.

def escape(text, chars=HTML_ESCAPE_CHARS): (source)

Escape a few XML special chars with XML entities.

def _genprefix(): (source)

Undocumented

genprefix = (source)

Undocumented

def _unescapeDict(d): (source)

Undocumented

def _reverseDict(d): (source)

Undocumented

def parse(readable, *args, **kwargs): (source)

Parse HTML or XML readable.

def parseString(st, *args, **kw): (source)

Undocumented

def parseXML(readable): (source)

Parse an XML readable object.

def parseXMLString(st): (source)

Parse an XML readable object.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.