twisted.web.microdom.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.web.microdom</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.web.html">Package web</a> ::
Module microdom
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.microdom.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.web.microdom</h2>
<p>Micro Document Object Model: a partial DOM implementation with
SUX.</p>
<p>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.</p>
<p>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.</p>
Microdom mainly focuses on working with HTML and XHTML.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom._Attr.html"><code>_Attr</code></a></b></td>
<td>Support class for getAttributeNode.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.CDATASection.html"><code>CDATASection</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.CharacterData.html"><code>CharacterData</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.Comment.html"><code>Comment</code></a></b></td>
<td>A comment node.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.Document.html"><code>Document</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.Element.html"><code>Element</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.EntityReference.html"><code>EntityReference</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.lmx.html"><code>lmx</code></a></b></td>
<td>Easy creation of XML.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.MicroDOMParser.html"><code>MicroDOMParser</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.Node.html"><code>Node</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.Text.html"><code>Text</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
<b><a href="twisted.web.microdom.MismatchedTags.html"><code>MismatchedTags</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_reverseDict"></a><span class="summary-sig"><span class="summary-sig-name">_reverseDict</span>(<span class=summary-sig-arg>d</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.microdom.html#_selectDict" class="summary-sig-name"><code>_selectDict</code></a>(<span class=summary-sig-arg>dct</span>,
<span class=summary-sig-arg>caseInsensitive</span>,
<span class=summary-sig-arg>preserveCase</span>)</span></code>
<br />
Return a copy of the dct with case sensitivity/preserving turned on as
appropriate.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_unescapeDict"></a><span class="summary-sig"><span class="summary-sig-name">_unescapeDict</span>(<span class=summary-sig-arg>d</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.microdom.html#escape" class="summary-sig-name"><code>escape</code></a>(<span class=summary-sig-arg>text</span>,
<span class=summary-sig-arg>chars</span>)</span></code>
<br />
Escape a few XML special chars with XML entities.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="genprefix"></a><span class="summary-sig"><span class="summary-sig-name">genprefix</span>()</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getElementsByTagName"></a><span class="summary-sig"><span class="summary-sig-name">getElementsByTagName</span>(<span class=summary-sig-arg>iNode</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getElementsByTagNameNoCase"></a><span class="summary-sig"><span class="summary-sig-name">getElementsByTagNameNoCase</span>(<span class=summary-sig-arg>iNode</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.microdom.html#parse" class="summary-sig-name"><code>parse</code></a>(<span class=summary-sig-arg>readable</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Parse HTML or XML readable.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="parseString"></a><span class="summary-sig"><span class="summary-sig-name">parseString</span>(<span class=summary-sig-arg>st</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.microdom.html#parseXML" class="summary-sig-name"><code>parseXML</code></a>(<span class=summary-sig-arg>readable</span>)</span></code>
<br />
Parse an XML readable object.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.microdom.html#parseXMLString" class="summary-sig-name"><code>parseXMLString</code></a>(<span class=summary-sig-arg>st</span>)</span></code>
<br />
Parse an XML readable object.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.microdom.html#unescape" class="summary-sig-name"><code>unescape</code></a>(<span class=summary-sig-arg>text</span>,
<span class=summary-sig-arg>chars</span>)</span></code>
<br />
Perform the exact opposite of 'escape'.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>method-wrapper</code></font></td>
<td><b><a href="twisted.web.microdom.html#_nextid"><code>_nextid</code></a></b> = <span title="<method-wrapper object at 0x851f0ac>"><code><method-wrapper object at 0x851f0ac> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.web.microdom.html#dictsAreNotSequences"><code>dictsAreNotSequences</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.web.microdom.html#HTML_ESCAPE_CHARS"><code>HTML_ESCAPE_CHARS</code></a></b> = <span title="(('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'), ('"', '&quot;'))"><code>(('&', '&amp;'), ('<', '&lt;'), ('>'<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.web.microdom.html#XML_ESCAPE_CHARS"><code>XML_ESCAPE_CHARS</code></a></b> = <span title="(('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'), ('"', '&quot;'), ("'", '&apos;'))"><code>(('&', '&amp;'), ('<', '&lt;'), ('>',<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="_selectDict"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_selectDict</span>(<span class=sig-arg>dct</span>,
<span class=sig-arg>caseInsensitive</span>,
<span class=sig-arg>preserveCase</span>)</span>
</h3>
Return a copy of the dct with case sensitivity/preserving turned on
as appropriate.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="escape"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">escape</span>(<span class=sig-arg>text</span>,
<span class=sig-arg>chars</span>=<span class=sig-default>(('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'), ('"', '&qu...</span>)</span>
</h3>
Escape a few XML special chars with XML entities.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse</span>(<span class=sig-arg>readable</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
Parse HTML or XML readable.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseXML"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseXML</span>(<span class=sig-arg>readable</span>)</span>
</h3>
Parse an XML readable object.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseXMLString"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseXMLString</span>(<span class=sig-arg>st</span>)</span>
</h3>
Parse an XML readable object.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unescape"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unescape</span>(<span class=sig-arg>text</span>,
<span class=sig-arg>chars</span>=<span class=sig-default>(('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'), ('"', '&qu...</span>)</span>
</h3>
Perform the exact opposite of 'escape'.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_nextid"></a>
<h3>_nextid</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>method-wrapper</code>
</dd>
<span title="<method-wrapper object at 0x851f0ac>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<method-wrapper object at 0x851f0ac> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="dictsAreNotSequences"></a>
<h3>dictsAreNotSequences</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="HTML_ESCAPE_CHARS"></a>
<h3>HTML_ESCAPE_CHARS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'), ('"', '&quot;'))"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'), ('"', '&quot;')) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="XML_ESCAPE_CHARS"></a>
<h3>XML_ESCAPE_CHARS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'), ('"', '&quot;'), ("'", '&apos;'))"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(('&', '&amp;'),
('<', '&lt;'),
('>', '&gt;'),
('"', '&quot;'),
("'", '&apos;')) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:45 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>