doc/html/api/lxml-module.html

   1 <?xml version="1.0" encoding="ascii"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3           "DTD/xhtml1-transitional.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>lxml</title>
   7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
   8   <script type="text/javascript" src="epydoc.js"></script>
   9 </head>
  10
  11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
  12       alink="#204080">
  13 <!-- ==================== NAVIGATION BAR ==================== -->
  14 <table class="navbar" border="0" width="100%" cellpadding="0"
  15        bgcolor="#a0c0ff" cellspacing="0">
  16   <tr valign="middle">
  17   <!-- Home link -->
  18       <th bgcolor="#70b0f0" class="navbar-select"
  19           >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
  20
  21   <!-- Tree link -->
  22       <th>&nbsp;&nbsp;&nbsp;<a
  23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  24
  25   <!-- Index link -->
  26       <th>&nbsp;&nbsp;&nbsp;<a
  27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  28
  29   <!-- Help link -->
  30       <th>&nbsp;&nbsp;&nbsp;<a
  31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  32
  33   <!-- Project homepage -->
  34       <th class="navbar" align="right" width="100%">
  35         <table border="0" cellpadding="0" cellspacing="0">
  36           <tr><th class="navbar" align="center"
  37             ><a class="navbar" target="_top" href="/">lxml API</a></th>
  38           </tr></table></th>
  39   </tr>
  40 </table>
  41 <table width="100%" cellpadding="0" cellspacing="0">
  42   <tr valign="top">
  43     <td width="100%">
  44       <span class="breadcrumbs">
  45         Package&nbsp;lxml
  46       </span>
  47     </td>
  48     <td>
  49       <table cellpadding="0" cellspacing="0">
  50         <!-- hide/show private -->
  51         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  52     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  53         <tr><td align="right"><span class="options"
  54             >[<a href="frames.html" target="_top">frames</a
  55             >]&nbsp;|&nbsp;<a href="lxml-module.html"
  56             target="_top">no&nbsp;frames</a>]</span></td></tr>
  57       </table>
  58     </td>
  59   </tr>
  60 </table>
  61 <!-- ==================== PACKAGE DESCRIPTION ==================== -->
  62 <h1 class="epydoc">Package lxml</h1><p class="nomargin-top"><span class="codelink"><a href="lxml-pysrc.html">source&nbsp;code</a></span></p>
  63 <!-- ==================== SUBMODULES ==================== -->
  64 <a name="section-Submodules"></a>
  65 <table class="summary" border="1" cellpadding="3"
  66        cellspacing="0" width="100%" bgcolor="white">
  67 <tr bgcolor="#70b0f0" class="table-header">
  68   <td colspan="2" class="table-header">
  69     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  70       <tr valign="top">
  71         <td align="left"><span class="table-header">Submodules</span></td>
  72         <td align="right" valign="top"
  73          ><span class="options">[<a href="#section-Submodules"
  74          class="privatelink" onclick="toggle_private();"
  75          >hide private</a>]</span></td>
  76       </tr>
  77     </table>
  78   </td>
  79 </tr>
  80   <tr><td class="summary">
  81   <ul class="nomargin">
  82     <li> <strong class="uidlink"><a href="lxml.ElementInclude-module.html">lxml.ElementInclude</a></strong>: <em class="summary">Limited XInclude support for the ElementTree package.</em>    </li>
  83     <li> <strong class="uidlink"><a href="lxml.builder-module.html">lxml.builder</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">E</tt> Element factory for generating XML documents.</em>    </li>
  84     <li> <strong class="uidlink"><a href="lxml.cssselect-module.html">lxml.cssselect</a></strong>: <em class="summary">CSS Selectors based on XPath.</em>    </li>
  85     <li> <strong class="uidlink"><a href="lxml.doctestcompare-module.html">lxml.doctestcompare</a></strong>: <em class="summary">lxml-based doctest output comparison.</em>    </li>
  86     <li> <strong class="uidlink"><a href="lxml.etree-module.html">lxml.etree</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.etree</tt> module implements the extended ElementTree API
  87 for XML.</em>    </li>
  88     <li> <strong class="uidlink"><a href="lxml.html-module.html">lxml.html</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.html</tt> tool set for HTML handling.</em>
  89     <ul>
  90     <li> <strong class="uidlink"><a href="lxml.html.ElementSoup-module.html">lxml.html.ElementSoup</a></strong>: <em class="summary">Legacy interface to the BeautifulSoup HTML parser.</em>    </li>
  91     <li class="private"> <strong class="uidlink">lxml.html._dictmixin</strong>    </li>
  92     <li class="private"> <strong class="uidlink">lxml.html._setmixin</strong>    </li>
  93     <li> <strong class="uidlink"><a href="lxml.html.builder-module.html">lxml.html.builder</a></strong>: <em class="summary">A set of HTML generator tags for building HTML documents.</em>    </li>
  94     <li> <strong class="uidlink"><a href="lxml.html.clean-module.html">lxml.html.clean</a></strong>: <em class="summary">A cleanup tool for HTML.</em>    </li>
  95     <li> <strong class="uidlink"><a href="lxml.html.defs-module.html">lxml.html.defs</a></strong>    </li>
  96     <li> <strong class="uidlink"><a href="lxml.html.diff-module.html">lxml.html.diff</a></strong>    </li>
  97     <li> <strong class="uidlink"><a href="lxml.html.formfill-module.html">lxml.html.formfill</a></strong>    </li>
  98     <li> <strong class="uidlink"><a href="lxml.html.html5parser-module.html">lxml.html.html5parser</a></strong>: <em class="summary">An interface to html5lib that mimics the lxml.html interface.</em>    </li>
  99     <li> <strong class="uidlink"><a href="lxml.html.soupparser-module.html">lxml.html.soupparser</a></strong>: <em class="summary">External interface to the BeautifulSoup HTML parser.</em>    </li>
 100     <li> <strong class="uidlink"><a href="lxml.html.usedoctest-module.html">lxml.html.usedoctest</a></strong>: <em class="summary">Doctest module for HTML comparison.</em>    </li>
 101     </ul>
 102     </li>
 103     <li> <strong class="uidlink"><a href="lxml.include-module.html">lxml.include</a></strong>    </li>
 104     <li> <strong class="uidlink"><a href="lxml.isoschematron-module.html">lxml.isoschematron</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.isoschematron</tt> package implements ISO Schematron support on top
 105 of the pure-xslt 'skeleton' implementation.</em>    </li>
 106     <li> <strong class="uidlink"><a href="lxml.objectify-module.html">lxml.objectify</a></strong>: <em class="summary">The <tt class="rst-rst-docutils literal rst-docutils literal">lxml.objectify</tt> module implements a Python object API for
 107 XML.  It is based on <a href="lxml.etree-module.html" class="link">lxml.etree</a>.</em>    </li>
 108     <li> <strong class="uidlink"><a href="lxml.pyclasslookup-module.html">lxml.pyclasslookup</a></strong>    </li>
 109     <li> <strong class="uidlink"><a href="lxml.sax-module.html">lxml.sax</a></strong>: <em class="summary">SAX-based adapter to copy trees from/to the Python standard library.</em>    </li>
 110     <li> <strong class="uidlink"><a href="lxml.tests-module.html">lxml.tests</a></strong>: <em class="summary">The lxml test suite for lxml, ElementTree and cElementTree.</em>
 111     <ul>
 112     <li> <strong class="uidlink"><a href="lxml.tests.common_imports-module.html">lxml.tests.common_imports</a></strong>    </li>
 113     <li> <strong class="uidlink"><a href="lxml.tests.test_classlookup-module.html">lxml.tests.test_classlookup</a></strong>: <em class="summary">Tests for different Element class lookup mechanisms.</em>    </li>
 114     <li> <strong class="uidlink"><a href="lxml.tests.test_css-module.html">lxml.tests.test_css</a></strong>    </li>
 115     <li> <strong class="uidlink"><a href="lxml.tests.test_dtd-module.html">lxml.tests.test_dtd</a></strong>: <em class="summary">Test cases related to DTD parsing and validation</em>    </li>
 116     <li> <strong class="uidlink"><a href="lxml.tests.test_elementtree-module.html">lxml.tests.test_elementtree</a></strong>: <em class="summary">Tests for the ElementTree API</em>    </li>
 117     <li> <strong class="uidlink"><a href="lxml.tests.test_errors-module.html">lxml.tests.test_errors</a></strong>    </li>
 118     <li> <strong class="uidlink"><a href="lxml.tests.test_etree-module.html">lxml.tests.test_etree</a></strong>: <em class="summary">Tests specific to the extended etree API</em>    </li>
 119     <li> <strong class="uidlink"><a href="lxml.tests.test_htmlparser-module.html">lxml.tests.test_htmlparser</a></strong>: <em class="summary">HTML parser test cases for etree</em>    </li>
 120     <li> <strong class="uidlink"><a href="lxml.tests.test_io-module.html">lxml.tests.test_io</a></strong>: <em class="summary">IO test cases that apply to both etree and ElementTree</em>    </li>
 121     <li> <strong class="uidlink"><a href="lxml.tests.test_isoschematron-module.html">lxml.tests.test_isoschematron</a></strong>: <em class="summary">Test cases related to ISO-Schematron parsing and validation</em>    </li>
 122     <li> <strong class="uidlink"><a href="lxml.tests.test_nsclasses-module.html">lxml.tests.test_nsclasses</a></strong>: <em class="summary">Test cases related to namespace implementation classes and the
 123 namespace registry mechanism</em>    </li>
 124     <li> <strong class="uidlink"><a href="lxml.tests.test_objectify-module.html">lxml.tests.test_objectify</a></strong>: <em class="summary">Tests specific to the lxml.objectify API</em>    </li>
 125     <li> <strong class="uidlink"><a href="lxml.tests.test_pyclasslookup-module.html">lxml.tests.test_pyclasslookup</a></strong>: <em class="summary">Tests specific to the Python based class lookup.</em>    </li>
 126     <li> <strong class="uidlink"><a href="lxml.tests.test_relaxng-module.html">lxml.tests.test_relaxng</a></strong>: <em class="summary">Test cases related to RelaxNG parsing and validation</em>    </li>
 127     <li> <strong class="uidlink"><a href="lxml.tests.test_sax-module.html">lxml.tests.test_sax</a></strong>: <em class="summary">Test cases related to SAX I/O</em>    </li>
 128     <li> <strong class="uidlink"><a href="lxml.tests.test_schematron-module.html">lxml.tests.test_schematron</a></strong>: <em class="summary">Test cases related to Schematron parsing and validation</em>    </li>
 129     <li> <strong class="uidlink"><a href="lxml.tests.test_threading-module.html">lxml.tests.test_threading</a></strong>: <em class="summary">Tests for thread usage in lxml.etree.</em>    </li>
 130     <li> <strong class="uidlink"><a href="lxml.tests.test_unicode-module.html">lxml.tests.test_unicode</a></strong>    </li>
 131     <li> <strong class="uidlink"><a href="lxml.tests.test_xmlschema-module.html">lxml.tests.test_xmlschema</a></strong>: <em class="summary">Test cases related to XML Schema parsing and validation</em>    </li>
 132     <li> <strong class="uidlink"><a href="lxml.tests.test_xpathevaluator-module.html">lxml.tests.test_xpathevaluator</a></strong>: <em class="summary">Test cases related to XPath evaluation and the XPath class</em>    </li>
 133     <li> <strong class="uidlink"><a href="lxml.tests.test_xslt-module.html">lxml.tests.test_xslt</a></strong>: <em class="summary">Test cases related to XSLT processing</em>    </li>
 134     </ul>
 135     </li>
 136     <li> <strong class="uidlink"><a href="lxml.usedoctest-module.html">lxml.usedoctest</a></strong>: <em class="summary">Doctest module for XML comparison.</em>    </li>
 137   </ul></td></tr>
 138 </table>
 139
 140 <br />
 141 <!-- ==================== FUNCTIONS ==================== -->
 142 <a name="section-Functions"></a>
 143 <table class="summary" border="1" cellpadding="3"
 144        cellspacing="0" width="100%" bgcolor="white">
 145 <tr bgcolor="#70b0f0" class="table-header">
 146   <td colspan="2" class="table-header">
 147     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 148       <tr valign="top">
 149         <td align="left"><span class="table-header">Functions</span></td>
 150         <td align="right" valign="top"
 151          ><span class="options">[<a href="#section-Functions"
 152          class="privatelink" onclick="toggle_private();"
 153          >hide private</a>]</span></td>
 154       </tr>
 155     </table>
 156   </td>
 157 </tr>
 158 <tr>
 159     <td width="15%" align="right" valign="top" class="summary">
 160       <span class="summary-type">&nbsp;</span>
 161     </td><td class="summary">
 162       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 163         <tr>
 164           <td><span class="summary-sig"><a name="get_include"></a><span class="summary-sig-name">get_include</span>()</span><br />
 165       Returns a list of header include paths (for lxml itself, libxml2
 166 and libxslt) needed to compile C code against lxml if it was built
 167 with statically linked libraries.</td>
 168           <td align="right" valign="top">
 169             <span class="codelink"><a href="lxml-pysrc.html#get_include">source&nbsp;code</a></span>
 170
 171           </td>
 172         </tr>
 173       </table>
 174
 175     </td>
 176   </tr>
 177 </table>
 178 <!-- ==================== VARIABLES ==================== -->
 179 <a name="section-Variables"></a>
 180 <table class="summary" border="1" cellpadding="3"
 181        cellspacing="0" width="100%" bgcolor="white">
 182 <tr bgcolor="#70b0f0" class="table-header">
 183   <td colspan="2" class="table-header">
 184     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 185       <tr valign="top">
 186         <td align="left"><span class="table-header">Variables</span></td>
 187         <td align="right" valign="top"
 188          ><span class="options">[<a href="#section-Variables"
 189          class="privatelink" onclick="toggle_private();"
 190          >hide private</a>]</span></td>
 191       </tr>
 192     </table>
 193   </td>
 194 </tr>
 195 <tr>
 196     <td width="15%" align="right" valign="top" class="summary">
 197       <span class="summary-type">&nbsp;</span>
 198     </td><td class="summary">
 199         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml'"><code class="variable-quote">'</code><code class="variable-string">lxml</code><code class="variable-quote">'</code></code>
 200     </td>
 201   </tr>
 202 </table>
 203 <!-- ==================== NAVIGATION BAR ==================== -->
 204 <table class="navbar" border="0" width="100%" cellpadding="0"
 205        bgcolor="#a0c0ff" cellspacing="0">
 206   <tr valign="middle">
 207   <!-- Home link -->
 208       <th bgcolor="#70b0f0" class="navbar-select"
 209           >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
 210
 211   <!-- Tree link -->
 212       <th>&nbsp;&nbsp;&nbsp;<a
 213         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 214
 215   <!-- Index link -->
 216       <th>&nbsp;&nbsp;&nbsp;<a
 217         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 218
 219   <!-- Help link -->
 220       <th>&nbsp;&nbsp;&nbsp;<a
 221         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 222
 223   <!-- Project homepage -->
 224       <th class="navbar" align="right" width="100%">
 225         <table border="0" cellpadding="0" cellspacing="0">
 226           <tr><th class="navbar" align="center"
 227             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 228           </tr></table></th>
 229   </tr>
 230 </table>
 231 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 232   <tr>
 233     <td align="left" class="footer">
 234     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:17 2012
 235     </td>
 236     <td align="right" class="footer">
 237       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 238         >http://epydoc.sourceforge.net</a>
 239     </td>
 240   </tr>
 241 </table>
 242
 243 <script type="text/javascript">
 244   <!--
 245   // Private objects are initially displayed (because if
 246   // javascript is turned off then we want them to be
 247   // visible); but by default, we want to hide them.  So hide
 248   // them unless we have a cookie that says to show them.
 249   checkCookie();
 250   // -->
 251 </script>
 252 </body>
 253 </html>