doc/html/api/lxml.html-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.html</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>&nbsp;&nbsp;&nbsp;<a
  19         href="lxml-module.html">Home</a>&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         <a href="lxml-module.html">Package&nbsp;lxml</a> ::
  46         Package&nbsp;html
  47       </span>
  48     </td>
  49     <td>
  50       <table cellpadding="0" cellspacing="0">
  51         <!-- hide/show private -->
  52         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  53     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  54         <tr><td align="right"><span class="options"
  55             >[<a href="frames.html" target="_top">frames</a
  56             >]&nbsp;|&nbsp;<a href="lxml.html-module.html"
  57             target="_top">no&nbsp;frames</a>]</span></td></tr>
  58       </table>
  59     </td>
  60   </tr>
  61 </table>
  62 <!-- ==================== PACKAGE DESCRIPTION ==================== -->
  63 <h1 class="epydoc">Package html</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html">source&nbsp;code</a></span></p>
  64 The <tt class="rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">lxml.html</tt> tool set for HTML handling.
  65
  66 <!-- ==================== SUBMODULES ==================== -->
  67 <a name="section-Submodules"></a>
  68 <table class="summary" border="1" cellpadding="3"
  69        cellspacing="0" width="100%" bgcolor="white">
  70 <tr bgcolor="#70b0f0" class="table-header">
  71   <td colspan="2" class="table-header">
  72     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  73       <tr valign="top">
  74         <td align="left"><span class="table-header">Submodules</span></td>
  75         <td align="right" valign="top"
  76          ><span class="options">[<a href="#section-Submodules"
  77          class="privatelink" onclick="toggle_private();"
  78          >hide private</a>]</span></td>
  79       </tr>
  80     </table>
  81   </td>
  82 </tr>
  83   <tr><td class="summary">
  84   <ul class="nomargin">
  85     <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>
  86     <li class="private"> <strong class="uidlink">lxml.html._dictmixin</strong>    </li>
  87     <li class="private"> <strong class="uidlink">lxml.html._setmixin</strong>    </li>
  88     <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>
  89     <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>
  90     <li> <strong class="uidlink"><a href="lxml.html.defs-module.html">lxml.html.defs</a></strong>    </li>
  91     <li> <strong class="uidlink"><a href="lxml.html.diff-module.html">lxml.html.diff</a></strong>    </li>
  92     <li> <strong class="uidlink"><a href="lxml.html.formfill-module.html">lxml.html.formfill</a></strong>    </li>
  93     <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>
  94     <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>
  95     <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>
  96   </ul></td></tr>
  97 </table>
  98
  99 <br />
 100 <!-- ==================== CLASSES ==================== -->
 101 <a name="section-Classes"></a>
 102 <table class="summary" border="1" cellpadding="3"
 103        cellspacing="0" width="100%" bgcolor="white">
 104 <tr bgcolor="#70b0f0" class="table-header">
 105   <td colspan="2" class="table-header">
 106     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 107       <tr valign="top">
 108         <td align="left"><span class="table-header">Classes</span></td>
 109         <td align="right" valign="top"
 110          ><span class="options">[<a href="#section-Classes"
 111          class="privatelink" onclick="toggle_private();"
 112          >hide private</a>]</span></td>
 113       </tr>
 114     </table>
 115   </td>
 116 </tr>
 117 <tr class="private">
 118     <td width="15%" align="right" valign="top" class="summary">
 119       <span class="summary-type">&nbsp;</span>
 120     </td><td class="summary">
 121         <a href="lxml.html.HtmlMixin-class.html" class="summary-name" onclick="show_private();">HtmlMixin</a>
 122     </td>
 123   </tr>
 124 <tr class="private">
 125     <td width="15%" align="right" valign="top" class="summary">
 126       <span class="summary-type">&nbsp;</span>
 127     </td><td class="summary">
 128         <a href="lxml.html._MethodFunc-class.html" class="summary-name" onclick="show_private();">_MethodFunc</a><br />
 129       An object that represents a method on an element as a function;
 130 the function takes either an element or an HTML string.  It
 131 returns whatever the function normally returns, or if the function
 132 works in-place (and so returns None) it returns a serialized form
 133 of the resulting document.
 134     </td>
 135   </tr>
 136 <tr class="private">
 137     <td width="15%" align="right" valign="top" class="summary">
 138       <span class="summary-type">&nbsp;</span>
 139     </td><td class="summary">
 140         <a href="lxml.html.HtmlComment-class.html" class="summary-name" onclick="show_private();">HtmlComment</a>
 141     </td>
 142   </tr>
 143 <tr class="private">
 144     <td width="15%" align="right" valign="top" class="summary">
 145       <span class="summary-type">&nbsp;</span>
 146     </td><td class="summary">
 147         <a href="lxml.html.HtmlElement-class.html" class="summary-name" onclick="show_private();">HtmlElement</a>
 148     </td>
 149   </tr>
 150 <tr class="private">
 151     <td width="15%" align="right" valign="top" class="summary">
 152       <span class="summary-type">&nbsp;</span>
 153     </td><td class="summary">
 154         <a href="lxml.html.HtmlProcessingInstruction-class.html" class="summary-name" onclick="show_private();">HtmlProcessingInstruction</a>
 155     </td>
 156   </tr>
 157 <tr class="private">
 158     <td width="15%" align="right" valign="top" class="summary">
 159       <span class="summary-type">&nbsp;</span>
 160     </td><td class="summary">
 161         <a href="lxml.html.HtmlEntity-class.html" class="summary-name" onclick="show_private();">HtmlEntity</a>
 162     </td>
 163   </tr>
 164 <tr class="private">
 165     <td width="15%" align="right" valign="top" class="summary">
 166       <span class="summary-type">&nbsp;</span>
 167     </td><td class="summary">
 168         <a href="lxml.html.HtmlElementClassLookup-class.html" class="summary-name" onclick="show_private();">HtmlElementClassLookup</a><br />
 169       A lookup scheme for HTML Element classes.
 170     </td>
 171   </tr>
 172 <tr class="private">
 173     <td width="15%" align="right" valign="top" class="summary">
 174       <span class="summary-type">&nbsp;</span>
 175     </td><td class="summary">
 176         <a href="lxml.html.FormElement-class.html" class="summary-name" onclick="show_private();">FormElement</a><br />
 177       Represents a &lt;form&gt; element.
 178     </td>
 179   </tr>
 180 <tr class="private">
 181     <td width="15%" align="right" valign="top" class="summary">
 182       <span class="summary-type">&nbsp;</span>
 183     </td><td class="summary">
 184         <a href="lxml.html.FieldsDict-class.html" class="summary-name" onclick="show_private();">FieldsDict</a>
 185     </td>
 186   </tr>
 187 <tr class="private">
 188     <td width="15%" align="right" valign="top" class="summary">
 189       <span class="summary-type">&nbsp;</span>
 190     </td><td class="summary">
 191         <a href="lxml.html.InputGetter-class.html" class="summary-name" onclick="show_private();">InputGetter</a><br />
 192       An accessor that represents all the input fields in a form.
 193     </td>
 194   </tr>
 195 <tr class="private">
 196     <td width="15%" align="right" valign="top" class="summary">
 197       <span class="summary-type">&nbsp;</span>
 198     </td><td class="summary">
 199         <a href="lxml.html.InputMixin-class.html" class="summary-name" onclick="show_private();">InputMixin</a><br />
 200       Mix-in for all input elements (input, select, and textarea)
 201     </td>
 202   </tr>
 203 <tr class="private">
 204     <td width="15%" align="right" valign="top" class="summary">
 205       <span class="summary-type">&nbsp;</span>
 206     </td><td class="summary">
 207         <a href="lxml.html.TextareaElement-class.html" class="summary-name" onclick="show_private();">TextareaElement</a><br />
 208       <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">&lt;textarea&gt;</tt> element.  You can get the name with <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">.name</tt> and
 209 get/set the value with <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">.value</tt>
 210     </td>
 211   </tr>
 212 <tr class="private">
 213     <td width="15%" align="right" valign="top" class="summary">
 214       <span class="summary-type">&nbsp;</span>
 215     </td><td class="summary">
 216         <a href="lxml.html.SelectElement-class.html" class="summary-name" onclick="show_private();">SelectElement</a><br />
 217       <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">&lt;select&gt;</tt> element.  You can get the name with <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">.name</tt>.
 218     </td>
 219   </tr>
 220 <tr class="private">
 221     <td width="15%" align="right" valign="top" class="summary">
 222       <span class="summary-type">&nbsp;</span>
 223     </td><td class="summary">
 224         <a href="lxml.html.MultipleSelectOptions-class.html" class="summary-name" onclick="show_private();">MultipleSelectOptions</a><br />
 225       Represents all the selected options in a <tt class="rst-rst-docutils literal rst-docutils literal">&lt;select multiple&gt;</tt> element.
 226     </td>
 227   </tr>
 228 <tr class="private">
 229     <td width="15%" align="right" valign="top" class="summary">
 230       <span class="summary-type">&nbsp;</span>
 231     </td><td class="summary">
 232         <a href="lxml.html.RadioGroup-class.html" class="summary-name" onclick="show_private();">RadioGroup</a><br />
 233       This object represents several <tt class="rst-rst-docutils literal rst-docutils literal">&lt;input type=radio&gt;</tt> elements
 234 that have the same name.
 235     </td>
 236   </tr>
 237 <tr class="private">
 238     <td width="15%" align="right" valign="top" class="summary">
 239       <span class="summary-type">&nbsp;</span>
 240     </td><td class="summary">
 241         <a href="lxml.html.CheckboxGroup-class.html" class="summary-name" onclick="show_private();">CheckboxGroup</a><br />
 242       Represents a group of checkboxes (<tt class="rst-rst-docutils literal rst-docutils literal">&lt;input type=checkbox&gt;</tt>) that
 243 have the same name.
 244     </td>
 245   </tr>
 246 <tr class="private">
 247     <td width="15%" align="right" valign="top" class="summary">
 248       <span class="summary-type">&nbsp;</span>
 249     </td><td class="summary">
 250         <a href="lxml.html.CheckboxValues-class.html" class="summary-name" onclick="show_private();">CheckboxValues</a><br />
 251       Represents the values of the checked checkboxes in a group of
 252 checkboxes with the same name.
 253     </td>
 254   </tr>
 255 <tr class="private">
 256     <td width="15%" align="right" valign="top" class="summary">
 257       <span class="summary-type">&nbsp;</span>
 258     </td><td class="summary">
 259         <a href="lxml.html.InputElement-class.html" class="summary-name" onclick="show_private();">InputElement</a><br />
 260       Represents an <tt class="rst-rst-rst-rst-docutils literal rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">&lt;input&gt;</tt> element.
 261     </td>
 262   </tr>
 263 <tr class="private">
 264     <td width="15%" align="right" valign="top" class="summary">
 265       <span class="summary-type">&nbsp;</span>
 266     </td><td class="summary">
 267         <a href="lxml.html.LabelElement-class.html" class="summary-name" onclick="show_private();">LabelElement</a><br />
 268       Represents a <tt class="rst-rst-rst-docutils literal rst-rst-docutils literal rst-docutils literal">&lt;label&gt;</tt> element.
 269     </td>
 270   </tr>
 271 <tr class="private">
 272     <td width="15%" align="right" valign="top" class="summary">
 273       <span class="summary-type">&nbsp;</span>
 274     </td><td class="summary">
 275         <a href="lxml.html.HTMLParser-class.html" class="summary-name" onclick="show_private();">HTMLParser</a><br />
 276       An HTML parser that is configured to return lxml.html Element
 277 objects.
 278     </td>
 279   </tr>
 280 <tr class="private">
 281     <td width="15%" align="right" valign="top" class="summary">
 282       <span class="summary-type">&nbsp;</span>
 283     </td><td class="summary">
 284         <a href="lxml.html.XHTMLParser-class.html" class="summary-name" onclick="show_private();">XHTMLParser</a><br />
 285       An XML parser that is configured to return lxml.html Element
 286 objects.
 287     </td>
 288   </tr>
 289 </table>
 290 <!-- ==================== FUNCTIONS ==================== -->
 291 <a name="section-Functions"></a>
 292 <table class="summary" border="1" cellpadding="3"
 293        cellspacing="0" width="100%" bgcolor="white">
 294 <tr bgcolor="#70b0f0" class="table-header">
 295   <td colspan="2" class="table-header">
 296     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 297       <tr valign="top">
 298         <td align="left"><span class="table-header">Functions</span></td>
 299         <td align="right" valign="top"
 300          ><span class="options">[<a href="#section-Functions"
 301          class="privatelink" onclick="toggle_private();"
 302          >hide private</a>]</span></td>
 303       </tr>
 304     </table>
 305   </td>
 306 </tr>
 307 <tr class="private">
 308     <td width="15%" align="right" valign="top" class="summary">
 309       <span class="summary-type">&nbsp;</span>
 310     </td><td class="summary">
 311       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 312         <tr>
 313           <td><span class="summary-sig"><a name="__fix_docstring"></a><span class="summary-sig-name">__fix_docstring</span>(<span class="summary-sig-arg">s</span>)</span></td>
 314           <td align="right" valign="top">
 315             <span class="codelink"><a href="lxml.html-pysrc.html#__fix_docstring">source&nbsp;code</a></span>
 316
 317           </td>
 318         </tr>
 319       </table>
 320
 321     </td>
 322   </tr>
 323 <tr class="private">
 324     <td width="15%" align="right" valign="top" class="summary">
 325       <span class="summary-type">&nbsp;</span>
 326     </td><td class="summary">
 327       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 328         <tr>
 329           <td><span class="summary-sig"><a name="_unquote_match"></a><span class="summary-sig-name">_unquote_match</span>(<span class="summary-sig-arg">s</span>,
 330         <span class="summary-sig-arg">pos</span>)</span></td>
 331           <td align="right" valign="top">
 332             <span class="codelink"><a href="lxml.html-pysrc.html#_unquote_match">source&nbsp;code</a></span>
 333
 334           </td>
 335         </tr>
 336       </table>
 337
 338     </td>
 339   </tr>
 340 <tr class="private">
 341     <td width="15%" align="right" valign="top" class="summary">
 342       <span class="summary-type">&nbsp;</span>
 343     </td><td class="summary">
 344       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 345         <tr>
 346           <td><span class="summary-sig"><a name="_transform_result"></a><span class="summary-sig-name">_transform_result</span>(<span class="summary-sig-arg">typ</span>,
 347         <span class="summary-sig-arg">result</span>)</span><br />
 348       Convert the result back into the input type.</td>
 349           <td align="right" valign="top">
 350             <span class="codelink"><a href="lxml.html-pysrc.html#_transform_result">source&nbsp;code</a></span>
 351
 352           </td>
 353         </tr>
 354       </table>
 355
 356     </td>
 357   </tr>
 358 <tr class="private">
 359     <td width="15%" align="right" valign="top" class="summary">
 360       <span class="summary-type">&nbsp;</span>
 361     </td><td class="summary">
 362       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 363         <tr>
 364           <td><span class="summary-sig"><a name="_nons"></a><span class="summary-sig-name">_nons</span>(<span class="summary-sig-arg">tag</span>)</span></td>
 365           <td align="right" valign="top">
 366             <span class="codelink"><a href="lxml.html-pysrc.html#_nons">source&nbsp;code</a></span>
 367
 368           </td>
 369         </tr>
 370       </table>
 371
 372     </td>
 373   </tr>
 374 <tr>
 375     <td width="15%" align="right" valign="top" class="summary">
 376       <span class="summary-type">&nbsp;</span>
 377     </td><td class="summary">
 378       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 379         <tr>
 380           <td><span class="summary-sig"><a name="document_fromstring"></a><span class="summary-sig-name">document_fromstring</span>(<span class="summary-sig-arg">html</span>,
 381         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
 382         <span class="summary-sig-arg">**kw</span>)</span></td>
 383           <td align="right" valign="top">
 384             <span class="codelink"><a href="lxml.html-pysrc.html#document_fromstring">source&nbsp;code</a></span>
 385
 386           </td>
 387         </tr>
 388       </table>
 389
 390     </td>
 391   </tr>
 392 <tr>
 393     <td width="15%" align="right" valign="top" class="summary">
 394       <span class="summary-type">&nbsp;</span>
 395     </td><td class="summary">
 396       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 397         <tr>
 398           <td><span class="summary-sig"><a href="lxml.html-module.html#fragments_fromstring" class="summary-sig-name">fragments_fromstring</a>(<span class="summary-sig-arg">html</span>,
 399         <span class="summary-sig-arg">no_leading_text</span>=<span class="summary-sig-default">False</span>,
 400         <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
 401         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
 402         <span class="summary-sig-arg">**kw</span>)</span><br />
 403       Parses several HTML elements, returning a list of elements.</td>
 404           <td align="right" valign="top">
 405             <span class="codelink"><a href="lxml.html-pysrc.html#fragments_fromstring">source&nbsp;code</a></span>
 406
 407           </td>
 408         </tr>
 409       </table>
 410
 411     </td>
 412   </tr>
 413 <tr>
 414     <td width="15%" align="right" valign="top" class="summary">
 415       <span class="summary-type">&nbsp;</span>
 416     </td><td class="summary">
 417       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 418         <tr>
 419           <td><span class="summary-sig"><a href="lxml.html-module.html#fragment_fromstring" class="summary-sig-name">fragment_fromstring</a>(<span class="summary-sig-arg">html</span>,
 420         <span class="summary-sig-arg">create_parent</span>=<span class="summary-sig-default">False</span>,
 421         <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
 422         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
 423         <span class="summary-sig-arg">**kw</span>)</span><br />
 424       Parses a single HTML element; it is an error if there is more than
 425 one element, or if anything but whitespace precedes or follows the
 426 element.</td>
 427           <td align="right" valign="top">
 428             <span class="codelink"><a href="lxml.html-pysrc.html#fragment_fromstring">source&nbsp;code</a></span>
 429
 430           </td>
 431         </tr>
 432       </table>
 433
 434     </td>
 435   </tr>
 436 <tr>
 437     <td width="15%" align="right" valign="top" class="summary">
 438       <span class="summary-type">&nbsp;</span>
 439     </td><td class="summary">
 440       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 441         <tr>
 442           <td><span class="summary-sig"><a href="lxml.html-module.html#fromstring" class="summary-sig-name">fromstring</a>(<span class="summary-sig-arg">html</span>,
 443         <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
 444         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
 445         <span class="summary-sig-arg">**kw</span>)</span><br />
 446       Parse the html, returning a single element/document.</td>
 447           <td align="right" valign="top">
 448             <span class="codelink"><a href="lxml.html-pysrc.html#fromstring">source&nbsp;code</a></span>
 449
 450           </td>
 451         </tr>
 452       </table>
 453
 454     </td>
 455   </tr>
 456 <tr>
 457     <td width="15%" align="right" valign="top" class="summary">
 458       <span class="summary-type">&nbsp;</span>
 459     </td><td class="summary">
 460       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 461         <tr>
 462           <td><span class="summary-sig"><a href="lxml.html-module.html#parse" class="summary-sig-name">parse</a>(<span class="summary-sig-arg">filename_or_url</span>,
 463         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
 464         <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>,
 465         <span class="summary-sig-arg">**kw</span>)</span><br />
 466       Parse a filename, URL, or file-like object into an HTML document
 467 tree.  Note: this returns a tree, not an element.  Use
 468 <tt class="rst-docutils literal"><span class="pre">parse(...).getroot()</span></tt> to get the document root.</td>
 469           <td align="right" valign="top">
 470             <span class="codelink"><a href="lxml.html-pysrc.html#parse">source&nbsp;code</a></span>
 471
 472           </td>
 473         </tr>
 474       </table>
 475
 476     </td>
 477   </tr>
 478 <tr class="private">
 479     <td width="15%" align="right" valign="top" class="summary">
 480       <span class="summary-type">&nbsp;</span>
 481     </td><td class="summary">
 482       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 483         <tr>
 484           <td><span class="summary-sig"><a name="_contains_block_level_tag"></a><span class="summary-sig-name">_contains_block_level_tag</span>(<span class="summary-sig-arg">el</span>)</span></td>
 485           <td align="right" valign="top">
 486             <span class="codelink"><a href="lxml.html-pysrc.html#_contains_block_level_tag">source&nbsp;code</a></span>
 487
 488           </td>
 489         </tr>
 490       </table>
 491
 492     </td>
 493   </tr>
 494 <tr class="private">
 495     <td width="15%" align="right" valign="top" class="summary">
 496       <span class="summary-type">&nbsp;</span>
 497     </td><td class="summary">
 498       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 499         <tr>
 500           <td><span class="summary-sig"><a name="_element_name"></a><span class="summary-sig-name">_element_name</span>(<span class="summary-sig-arg">el</span>)</span></td>
 501           <td align="right" valign="top">
 502             <span class="codelink"><a href="lxml.html-pysrc.html#_element_name">source&nbsp;code</a></span>
 503
 504           </td>
 505         </tr>
 506       </table>
 507
 508     </td>
 509   </tr>
 510 <tr>
 511     <td width="15%" align="right" valign="top" class="summary">
 512       <span class="summary-type">&nbsp;</span>
 513     </td><td class="summary">
 514       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 515         <tr>
 516           <td><span class="summary-sig"><a href="lxml.html-module.html#submit_form" class="summary-sig-name">submit_form</a>(<span class="summary-sig-arg">form</span>,
 517         <span class="summary-sig-arg">extra_values</span>=<span class="summary-sig-default">None</span>,
 518         <span class="summary-sig-arg">open_http</span>=<span class="summary-sig-default">None</span>)</span><br />
 519       Helper function to submit a form.  Returns a file-like object, as from
 520 <tt class="rst-docutils literal">urllib.urlopen()</tt>.  This object also has a <tt class="rst-docutils literal">.geturl()</tt> function,
 521 which shows the URL if there were any redirects.</td>
 522           <td align="right" valign="top">
 523             <span class="codelink"><a href="lxml.html-pysrc.html#submit_form">source&nbsp;code</a></span>
 524
 525           </td>
 526         </tr>
 527       </table>
 528
 529     </td>
 530   </tr>
 531 <tr class="private">
 532     <td width="15%" align="right" valign="top" class="summary">
 533       <span class="summary-type">&nbsp;</span>
 534     </td><td class="summary">
 535       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 536         <tr>
 537           <td><span class="summary-sig"><a name="open_http_urllib"></a><span class="summary-sig-name">open_http_urllib</span>(<span class="summary-sig-arg">method</span>,
 538         <span class="summary-sig-arg">url</span>,
 539         <span class="summary-sig-arg">values</span>)</span></td>
 540           <td align="right" valign="top">
 541             <span class="codelink"><a href="lxml.html-pysrc.html#open_http_urllib">source&nbsp;code</a></span>
 542
 543           </td>
 544         </tr>
 545       </table>
 546
 547     </td>
 548   </tr>
 549 <tr class="private">
 550     <td width="15%" align="right" valign="top" class="summary">
 551       <span class="summary-type">&nbsp;</span>
 552     </td><td class="summary">
 553       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 554         <tr>
 555           <td><span class="summary-sig"><a name="html_to_xhtml"></a><span class="summary-sig-name">html_to_xhtml</span>(<span class="summary-sig-arg">html</span>)</span><br />
 556       Convert all tags in an HTML tree to XHTML by moving them to the
 557 XHTML namespace.</td>
 558           <td align="right" valign="top">
 559             <span class="codelink"><a href="lxml.html-pysrc.html#html_to_xhtml">source&nbsp;code</a></span>
 560
 561           </td>
 562         </tr>
 563       </table>
 564
 565     </td>
 566   </tr>
 567 <tr class="private">
 568     <td width="15%" align="right" valign="top" class="summary">
 569       <span class="summary-type">&nbsp;</span>
 570     </td><td class="summary">
 571       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 572         <tr>
 573           <td><span class="summary-sig"><a name="xhtml_to_html"></a><span class="summary-sig-name">xhtml_to_html</span>(<span class="summary-sig-arg">xhtml</span>)</span><br />
 574       Convert all tags in an XHTML tree to HTML by removing their
 575 XHTML namespace.</td>
 576           <td align="right" valign="top">
 577             <span class="codelink"><a href="lxml.html-pysrc.html#xhtml_to_html">source&nbsp;code</a></span>
 578
 579           </td>
 580         </tr>
 581       </table>
 582
 583     </td>
 584   </tr>
 585 <tr class="private">
 586     <td width="15%" align="right" valign="top" class="summary">
 587       <span class="summary-type">&nbsp;</span>
 588     </td><td class="summary">
 589       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 590         <tr>
 591           <td><span class="summary-sig"><a name="__str_replace_meta_content_type"></a><span class="summary-sig-name">__str_replace_meta_content_type</span>(<span class="summary-sig-arg">...</span>)</span><br />
 592       sub(repl, string[, count = 0]) --&gt; newstring
 593 Return the string obtained by replacing the leftmost non-overlapping
 594 occurrences of pattern in string by the replacement repl.</td>
 595           <td align="right" valign="top">
 596             <span class="codelink"><a href="lxml.html-pysrc.html#__str_replace_meta_content_type">source&nbsp;code</a></span>
 597
 598           </td>
 599         </tr>
 600       </table>
 601
 602     </td>
 603   </tr>
 604 <tr class="private">
 605     <td width="15%" align="right" valign="top" class="summary">
 606       <span class="summary-type">&nbsp;</span>
 607     </td><td class="summary">
 608       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 609         <tr>
 610           <td><span class="summary-sig"><a name="__bytes_replace_meta_content_type"></a><span class="summary-sig-name">__bytes_replace_meta_content_type</span>(<span class="summary-sig-arg">...</span>)</span><br />
 611       sub(repl, string[, count = 0]) --&gt; newstring
 612 Return the string obtained by replacing the leftmost non-overlapping
 613 occurrences of pattern in string by the replacement repl.</td>
 614           <td align="right" valign="top">
 615             <span class="codelink"><a href="lxml.html-pysrc.html#__bytes_replace_meta_content_type">source&nbsp;code</a></span>
 616
 617           </td>
 618         </tr>
 619       </table>
 620
 621     </td>
 622   </tr>
 623 <tr>
 624     <td width="15%" align="right" valign="top" class="summary">
 625       <span class="summary-type">&nbsp;</span>
 626     </td><td class="summary">
 627       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 628         <tr>
 629           <td><span class="summary-sig"><a href="lxml.html-module.html#tostring" class="summary-sig-name">tostring</a>(<span class="summary-sig-arg">doc</span>,
 630         <span class="summary-sig-arg">pretty_print</span>=<span class="summary-sig-default">False</span>,
 631         <span class="summary-sig-arg">include_meta_content_type</span>=<span class="summary-sig-default">False</span>,
 632         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
 633         <span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">html</code><code class="variable-quote">'</code></span>,
 634         <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>,
 635         <span class="summary-sig-arg">doctype</span>=<span class="summary-sig-default">None</span>)</span><br />
 636       Return an HTML string representation of the document.</td>
 637           <td align="right" valign="top">
 638             <span class="codelink"><a href="lxml.html-pysrc.html#tostring">source&nbsp;code</a></span>
 639
 640           </td>
 641         </tr>
 642       </table>
 643
 644     </td>
 645   </tr>
 646 <tr>
 647     <td width="15%" align="right" valign="top" class="summary">
 648       <span class="summary-type">&nbsp;</span>
 649     </td><td class="summary">
 650       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 651         <tr>
 652           <td><span class="summary-sig"><a name="open_in_browser"></a><span class="summary-sig-name">open_in_browser</span>(<span class="summary-sig-arg">doc</span>,
 653         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>)</span><br />
 654       Open the HTML document in a web browser, saving it to a temporary
 655 file to open it.  Note that this does not delete the file after
 656 use.  This is mainly meant for debugging.</td>
 657           <td align="right" valign="top">
 658             <span class="codelink"><a href="lxml.html-pysrc.html#open_in_browser">source&nbsp;code</a></span>
 659
 660           </td>
 661         </tr>
 662       </table>
 663
 664     </td>
 665   </tr>
 666 <tr>
 667     <td width="15%" align="right" valign="top" class="summary">
 668       <span class="summary-type">&nbsp;</span>
 669     </td><td class="summary">
 670       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 671         <tr>
 672           <td><span class="summary-sig"><a href="lxml.html-module.html#Element" class="summary-sig-name">Element</a>(<span class="summary-sig-arg">*args</span>,
 673         <span class="summary-sig-arg">**kw</span>)</span><br />
 674       Create a new HTML Element.</td>
 675           <td align="right" valign="top">
 676             <span class="codelink"><a href="lxml.html-pysrc.html#Element">source&nbsp;code</a></span>
 677
 678           </td>
 679         </tr>
 680       </table>
 681
 682     </td>
 683   </tr>
 684 </table>
 685 <!-- ==================== VARIABLES ==================== -->
 686 <a name="section-Variables"></a>
 687 <table class="summary" border="1" cellpadding="3"
 688        cellspacing="0" width="100%" bgcolor="white">
 689 <tr bgcolor="#70b0f0" class="table-header">
 690   <td colspan="2" class="table-header">
 691     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 692       <tr valign="top">
 693         <td align="left"><span class="table-header">Variables</span></td>
 694         <td align="right" valign="top"
 695          ><span class="options">[<a href="#section-Variables"
 696          class="privatelink" onclick="toggle_private();"
 697          >hide private</a>]</span></td>
 698       </tr>
 699     </table>
 700   </td>
 701 </tr>
 702 <tr class="private">
 703     <td width="15%" align="right" valign="top" class="summary">
 704       <span class="summary-type">&nbsp;</span>
 705     </td><td class="summary">
 706         <a name="XHTML_NAMESPACE"></a><span class="summary-name">XHTML_NAMESPACE</span> = <code title="'http://www.w3.org/1999/xhtml'"><code class="variable-quote">'</code><code class="variable-string">http://www.w3.org/1999/xhtml</code><code class="variable-quote">'</code></code>
 707     </td>
 708   </tr>
 709 <tr class="private">
 710     <td width="15%" align="right" valign="top" class="summary">
 711       <span class="summary-type">&nbsp;</span>
 712     </td><td class="summary">
 713         <a href="lxml.html-module.html#_rel_links_xpath" class="summary-name" onclick="show_private();">_rel_links_xpath</a> = <code title="descendant-or-self::a[@rel]|descendant-or-self::x:a[@rel]">descendant-or-self::a[@rel]|descendant-or-s<code class="variable-ellipsis">...</code></code>
 714     </td>
 715   </tr>
 716 <tr class="private">
 717     <td width="15%" align="right" valign="top" class="summary">
 718       <span class="summary-type">&nbsp;</span>
 719     </td><td class="summary">
 720         <a href="lxml.html-module.html#_options_xpath" class="summary-name" onclick="show_private();">_options_xpath</a> = <code title="descendant-or-self::option|descendant-or-self::x:option">descendant-or-self::option|descendant-or-self<code class="variable-ellipsis">...</code></code>
 721     </td>
 722   </tr>
 723 <tr class="private">
 724     <td width="15%" align="right" valign="top" class="summary">
 725       <span class="summary-type">&nbsp;</span>
 726     </td><td class="summary">
 727         <a href="lxml.html-module.html#_forms_xpath" class="summary-name" onclick="show_private();">_forms_xpath</a> = <code title="descendant-or-self::form|descendant-or-self::x:form">descendant-or-self::form|descendant-or-self::x:<code class="variable-ellipsis">...</code></code>
 728     </td>
 729   </tr>
 730 <tr class="private">
 731     <td width="15%" align="right" valign="top" class="summary">
 732       <span class="summary-type">&nbsp;</span>
 733     </td><td class="summary">
 734         <a href="lxml.html-module.html#_class_xpath" class="summary-name" onclick="show_private();">_class_xpath</a> = <code title="descendant-or-self::*[@class and contains(concat(' ', normalize-space(\
 735 @class), ' '), concat(' ', $class_name, ' '))]">descendant-or-self::*[@class and contains(conca<code class="variable-ellipsis">...</code></code>
 736     </td>
 737   </tr>
 738 <tr class="private">
 739     <td width="15%" align="right" valign="top" class="summary">
 740       <span class="summary-type">&nbsp;</span>
 741     </td><td class="summary">
 742         <a name="_id_xpath"></a><span class="summary-name">_id_xpath</span> = <code title="descendant-or-self::*[@id=$id]">descendant-or-self::*[@id=$id]</code>
 743     </td>
 744   </tr>
 745 <tr class="private">
 746     <td width="15%" align="right" valign="top" class="summary">
 747       <span class="summary-type">&nbsp;</span>
 748     </td><td class="summary">
 749         <a name="_collect_string_content"></a><span class="summary-name">_collect_string_content</span> = <code title="string()">string()</code>
 750     </td>
 751   </tr>
 752 <tr class="private">
 753     <td width="15%" align="right" valign="top" class="summary">
 754       <span class="summary-type">&nbsp;</span>
 755     </td><td class="summary">
 756         <a href="lxml.html-module.html#_css_url_re" class="summary-name" onclick="show_private();">_css_url_re</a> = <code title="re.compile(r'(?i)url\((&quot;[^&quot;]*&quot;|\'[^\']*\'|[^\)]*)\)')">re.compile(r'<code class="re-flags">(?i)</code>url\(<code class="re-group">(</code>&quot;<code class="re-group">[^</code>&quot;<code class="re-group">]</code><code class="re-op">*</code>&quot;<code class="re-op">|</code>\'<code class="re-group">[^</code>\'<code class="re-group">]</code><code class="re-op">*</code>\'<code class="re-op">|</code><code class="re-group">[^</code>\)<code class="re-group">]</code><code class="re-op">*</code><code class="variable-ellipsis">...</code></code>
 757     </td>
 758   </tr>
 759 <tr class="private">
 760     <td width="15%" align="right" valign="top" class="summary">
 761       <span class="summary-type">&nbsp;</span>
 762     </td><td class="summary">
 763         <a name="_css_import_re"></a><span class="summary-name">_css_import_re</span> = <code title="re.compile(r'@import &quot;(.*?)&quot;')">re.compile(r'@import &quot;<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>&quot;')</code>
 764     </td>
 765   </tr>
 766 <tr class="private">
 767     <td width="15%" align="right" valign="top" class="summary">
 768       <span class="summary-type">&nbsp;</span>
 769     </td><td class="summary">
 770         <a name="_label_xpath"></a><span class="summary-name">_label_xpath</span> = <code title="//label[@for=$id]|//x:label[@for=$id]">//label[@for=$id]|//x:label[@for=$id]</code>
 771     </td>
 772   </tr>
 773 <tr class="private">
 774     <td width="15%" align="right" valign="top" class="summary">
 775       <span class="summary-type">&nbsp;</span>
 776     </td><td class="summary">
 777         <a name="_archive_re"></a><span class="summary-name">_archive_re</span> = <code title="re.compile(r'[^ ]+')">re.compile(r'<code class="re-group">[^</code> <code class="re-group">]</code><code class="re-op">+</code>')</code>
 778     </td>
 779   </tr>
 780 <tr>
 781     <td width="15%" align="right" valign="top" class="summary">
 782       <span class="summary-type">&nbsp;</span>
 783     </td><td class="summary">
 784         <a name="find_rel_links"></a><span class="summary-name">find_rel_links</span> = <code title="_MethodFunc('find_rel_links', copy= False)">_MethodFunc('find_rel_links', copy= False)</code>
 785     </td>
 786   </tr>
 787 <tr>
 788     <td width="15%" align="right" valign="top" class="summary">
 789       <span class="summary-type">&nbsp;</span>
 790     </td><td class="summary">
 791         <a name="find_class"></a><span class="summary-name">find_class</span> = <code title="_MethodFunc('find_class', copy= False)">_MethodFunc('find_class', copy= False)</code>
 792     </td>
 793   </tr>
 794 <tr>
 795     <td width="15%" align="right" valign="top" class="summary">
 796       <span class="summary-type">&nbsp;</span>
 797     </td><td class="summary">
 798         <a href="lxml.html-module.html#make_links_absolute" class="summary-name">make_links_absolute</a> = <code title="_MethodFunc('make_links_absolute', copy= True)">_MethodFunc('make_links_absolute', copy=<code class="variable-ellipsis">...</code></code>
 799     </td>
 800   </tr>
 801 <tr>
 802     <td width="15%" align="right" valign="top" class="summary">
 803       <span class="summary-type">&nbsp;</span>
 804     </td><td class="summary">
 805         <a name="resolve_base_href"></a><span class="summary-name">resolve_base_href</span> = <code title="_MethodFunc('resolve_base_href', copy= True)">_MethodFunc('resolve_base_href', copy= True)</code>
 806     </td>
 807   </tr>
 808 <tr>
 809     <td width="15%" align="right" valign="top" class="summary">
 810       <span class="summary-type">&nbsp;</span>
 811     </td><td class="summary">
 812         <a name="iterlinks"></a><span class="summary-name">iterlinks</span> = <code title="_MethodFunc('iterlinks', copy= False)">_MethodFunc('iterlinks', copy= False)</code>
 813     </td>
 814   </tr>
 815 <tr>
 816     <td width="15%" align="right" valign="top" class="summary">
 817       <span class="summary-type">&nbsp;</span>
 818     </td><td class="summary">
 819         <a name="rewrite_links"></a><span class="summary-name">rewrite_links</span> = <code title="_MethodFunc('rewrite_links', copy= True)">_MethodFunc('rewrite_links', copy= True)</code>
 820     </td>
 821   </tr>
 822 <tr class="private">
 823     <td width="15%" align="right" valign="top" class="summary">
 824       <span class="summary-type">&nbsp;</span>
 825     </td><td class="summary">
 826         <a name="html_parser"></a><span class="summary-name">html_parser</span> = <code title="HTMLParser()">HTMLParser()</code>
 827     </td>
 828   </tr>
 829 <tr class="private">
 830     <td width="15%" align="right" valign="top" class="summary">
 831       <span class="summary-type">&nbsp;</span>
 832     </td><td class="summary">
 833         <a name="xhtml_parser"></a><span class="summary-name">xhtml_parser</span> = <code title="XHTMLParser()">XHTMLParser()</code>
 834     </td>
 835   </tr>
 836 <tr class="private">
 837     <td width="15%" align="right" valign="top" class="summary">
 838       <span class="summary-type">&nbsp;</span>
 839     </td><td class="summary">
 840         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml.html'"><code class="variable-quote">'</code><code class="variable-string">lxml.html</code><code class="variable-quote">'</code></code>
 841     </td>
 842   </tr>
 843 </table>
 844 <!-- ==================== FUNCTION DETAILS ==================== -->
 845 <a name="section-FunctionDetails"></a>
 846 <table class="details" border="1" cellpadding="3"
 847        cellspacing="0" width="100%" bgcolor="white">
 848 <tr bgcolor="#70b0f0" class="table-header">
 849   <td colspan="2" class="table-header">
 850     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 851       <tr valign="top">
 852         <td align="left"><span class="table-header">Function Details</span></td>
 853         <td align="right" valign="top"
 854          ><span class="options">[<a href="#section-FunctionDetails"
 855          class="privatelink" onclick="toggle_private();"
 856          >hide private</a>]</span></td>
 857       </tr>
 858     </table>
 859   </td>
 860 </tr>
 861 </table>
 862 <a name="fragments_fromstring"></a>
 863 <div>
 864 <table class="details" border="1" cellpadding="3"
 865        cellspacing="0" width="100%" bgcolor="white">
 866 <tr><td>
 867   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 868   <tr valign="top"><td>
 869   <h3 class="epydoc"><span class="sig"><span class="sig-name">fragments_fromstring</span>(<span class="sig-arg">html</span>,
 870         <span class="sig-arg">no_leading_text</span>=<span class="sig-default">False</span>,
 871         <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
 872         <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
 873         <span class="sig-arg">**kw</span>)</span>
 874   </h3>
 875   </td><td align="right" valign="top"
 876     ><span class="codelink"><a href="lxml.html-pysrc.html#fragments_fromstring">source&nbsp;code</a></span>&nbsp;
 877     </td>
 878   </tr></table>
 879
 880   <p>Parses several HTML elements, returning a list of elements.</p>
 881 <p>The first item in the list may be a string (though leading
 882 whitespace is removed).  If no_leading_text is true, then it will
 883 be an error if there is leading text, and it will always be a list
 884 of only elements.</p>
 885 <p>base_url will set the document's base_url attribute (and the tree's docinfo.URL)</p>
 886   <dl class="fields">
 887   </dl>
 888 </td></tr></table>
 889 </div>
 890 <a name="fragment_fromstring"></a>
 891 <div>
 892 <table class="details" border="1" cellpadding="3"
 893        cellspacing="0" width="100%" bgcolor="white">
 894 <tr><td>
 895   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 896   <tr valign="top"><td>
 897   <h3 class="epydoc"><span class="sig"><span class="sig-name">fragment_fromstring</span>(<span class="sig-arg">html</span>,
 898         <span class="sig-arg">create_parent</span>=<span class="sig-default">False</span>,
 899         <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
 900         <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
 901         <span class="sig-arg">**kw</span>)</span>
 902   </h3>
 903   </td><td align="right" valign="top"
 904     ><span class="codelink"><a href="lxml.html-pysrc.html#fragment_fromstring">source&nbsp;code</a></span>&nbsp;
 905     </td>
 906   </tr></table>
 907
 908   <p>Parses a single HTML element; it is an error if there is more than
 909 one element, or if anything but whitespace precedes or follows the
 910 element.</p>
 911 <p>If create_parent is true (or is a tag name) then a parent node
 912 will be created to encapsulate the HTML in a single element.  In
 913 this case, leading or trailing text is allowed.</p>
 914 <p>base_url will set the document's base_url attribute (and the tree's docinfo.URL)</p>
 915   <dl class="fields">
 916   </dl>
 917 </td></tr></table>
 918 </div>
 919 <a name="fromstring"></a>
 920 <div>
 921 <table class="details" border="1" cellpadding="3"
 922        cellspacing="0" width="100%" bgcolor="white">
 923 <tr><td>
 924   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 925   <tr valign="top"><td>
 926   <h3 class="epydoc"><span class="sig"><span class="sig-name">fromstring</span>(<span class="sig-arg">html</span>,
 927         <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
 928         <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
 929         <span class="sig-arg">**kw</span>)</span>
 930   </h3>
 931   </td><td align="right" valign="top"
 932     ><span class="codelink"><a href="lxml.html-pysrc.html#fromstring">source&nbsp;code</a></span>&nbsp;
 933     </td>
 934   </tr></table>
 935
 936   <p>Parse the html, returning a single element/document.</p>
 937 <p>This tries to minimally parse the chunk of text, without knowing if it
 938 is a fragment or a document.</p>
 939 <p>base_url will set the document's base_url attribute (and the tree's docinfo.URL)</p>
 940   <dl class="fields">
 941   </dl>
 942 </td></tr></table>
 943 </div>
 944 <a name="parse"></a>
 945 <div>
 946 <table class="details" border="1" cellpadding="3"
 947        cellspacing="0" width="100%" bgcolor="white">
 948 <tr><td>
 949   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 950   <tr valign="top"><td>
 951   <h3 class="epydoc"><span class="sig"><span class="sig-name">parse</span>(<span class="sig-arg">filename_or_url</span>,
 952         <span class="sig-arg">parser</span>=<span class="sig-default">None</span>,
 953         <span class="sig-arg">base_url</span>=<span class="sig-default">None</span>,
 954         <span class="sig-arg">**kw</span>)</span>
 955   </h3>
 956   </td><td align="right" valign="top"
 957     ><span class="codelink"><a href="lxml.html-pysrc.html#parse">source&nbsp;code</a></span>&nbsp;
 958     </td>
 959   </tr></table>
 960
 961   <p>Parse a filename, URL, or file-like object into an HTML document
 962 tree.  Note: this returns a tree, not an element.  Use
 963 <tt class="rst-rst-docutils literal rst-docutils literal"><span class="pre">parse(...).getroot()</span></tt> to get the document root.</p>
 964 <p>You can override the base URL with the <tt class="rst-docutils literal">base_url</tt> keyword.  This
 965 is most useful when parsing from a file-like object.</p>
 966   <dl class="fields">
 967   </dl>
 968 </td></tr></table>
 969 </div>
 970 <a name="submit_form"></a>
 971 <div>
 972 <table class="details" border="1" cellpadding="3"
 973        cellspacing="0" width="100%" bgcolor="white">
 974 <tr><td>
 975   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 976   <tr valign="top"><td>
 977   <h3 class="epydoc"><span class="sig"><span class="sig-name">submit_form</span>(<span class="sig-arg">form</span>,
 978         <span class="sig-arg">extra_values</span>=<span class="sig-default">None</span>,
 979         <span class="sig-arg">open_http</span>=<span class="sig-default">None</span>)</span>
 980   </h3>
 981   </td><td align="right" valign="top"
 982     ><span class="codelink"><a href="lxml.html-pysrc.html#submit_form">source&nbsp;code</a></span>&nbsp;
 983     </td>
 984   </tr></table>
 985
 986   <p>Helper function to submit a form.  Returns a file-like object, as from
 987 <tt class="rst-rst-docutils literal rst-docutils literal">urllib.urlopen()</tt>.  This object also has a <tt class="rst-rst-docutils literal rst-docutils literal">.geturl()</tt> function,
 988 which shows the URL if there were any redirects.</p>
 989 <p>You can use this like:</p>
 990 <pre class="rst-literal-block">
 991 form = doc.forms[0]
 992 form.inputs['foo'].value = 'bar' # etc
 993 response = form.submit()
 994 doc = parse(response)
 995 doc.make_links_absolute(response.geturl())
 996 </pre>
 997 <p>To change the HTTP requester, pass a function as <tt class="rst-docutils literal">open_http</tt> keyword
 998 argument that opens the URL for you.  The function must have the following
 999 signature:</p>
1000 <pre class="rst-literal-block">
1001 open_http(method, URL, values)
1002 </pre>
1003 <p>The action is one of 'GET' or 'POST', the URL is the target URL as a
1004 string, and the values are a sequence of <tt class="rst-docutils literal">(name, value)</tt> tuples with the
1005 form data.</p>
1006   <dl class="fields">
1007   </dl>
1008 </td></tr></table>
1009 </div>
1010 <a name="tostring"></a>
1011 <div>
1012 <table class="details" border="1" cellpadding="3"
1013        cellspacing="0" width="100%" bgcolor="white">
1014 <tr><td>
1015   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1016   <tr valign="top"><td>
1017   <h3 class="epydoc"><span class="sig"><span class="sig-name">tostring</span>(<span class="sig-arg">doc</span>,
1018         <span class="sig-arg">pretty_print</span>=<span class="sig-default">False</span>,
1019         <span class="sig-arg">include_meta_content_type</span>=<span class="sig-default">False</span>,
1020         <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
1021         <span class="sig-arg">method</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">html</code><code class="variable-quote">'</code></span>,
1022         <span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>,
1023         <span class="sig-arg">doctype</span>=<span class="sig-default">None</span>)</span>
1024   </h3>
1025   </td><td align="right" valign="top"
1026     ><span class="codelink"><a href="lxml.html-pysrc.html#tostring">source&nbsp;code</a></span>&nbsp;
1027     </td>
1028   </tr></table>
1029
1030   <p>Return an HTML string representation of the document.</p>
1031 <p>Note: if include_meta_content_type is true this will create a
1032 <tt class="rst-docutils literal">&lt;meta <span class="pre">http-equiv=&quot;Content-Type&quot;</span> <span class="pre">...&gt;</span></tt> tag in the head;
1033 regardless of the value of include_meta_content_type any existing
1034 <tt class="rst-docutils literal">&lt;meta <span class="pre">http-equiv=&quot;Content-Type&quot;</span> <span class="pre">...&gt;</span></tt> tag will be removed</p>
1035 <p>The <tt class="rst-docutils literal">encoding</tt> argument controls the output encoding (defauts to
1036 ASCII, with &amp;#...; character references for any characters outside
1037 of ASCII).  Note that you can pass the name <tt class="rst-docutils literal">'unicode'</tt> as
1038 <tt class="rst-docutils literal">encoding</tt> argument to serialise to a unicode string.</p>
1039 <p>The <tt class="rst-docutils literal">method</tt> argument defines the output method.  It defaults to
1040 'html', but can also be 'xml' for xhtml output, or 'text' to
1041 serialise to plain text without markup.</p>
1042 <p>To leave out the tail text of the top-level element that is being
1043 serialised, pass <tt class="rst-docutils literal">with_tail=False</tt>.</p>
1044 <p>The <tt class="rst-docutils literal">doctype</tt> option allows passing in a plain string that will
1045 be serialised before the XML tree.  Note that passing in non
1046 well-formed content here will make the XML output non well-formed.
1047 Also, an existing doctype in the document tree will not be removed
1048 when serialising an ElementTree instance.</p>
1049 <p>Example:</p>
1050 <pre class="rst-literal-block">
1051 &gt;&gt;&gt; from lxml import html
1052 &gt;&gt;&gt; root = html.fragment_fromstring('&lt;p&gt;Hello&lt;br&gt;world!&lt;/p&gt;')
1053
1054 &gt;&gt;&gt; html.tostring(root)
1055 '&lt;p&gt;Hello&lt;br&gt;world!&lt;/p&gt;'
1056 &gt;&gt;&gt; html.tostring(root, method='html')
1057 '&lt;p&gt;Hello&lt;br&gt;world!&lt;/p&gt;'
1058
1059 &gt;&gt;&gt; html.tostring(root, method='xml')
1060 '&lt;p&gt;Hello&lt;br/&gt;world!&lt;/p&gt;'
1061
1062 &gt;&gt;&gt; html.tostring(root, method='text')
1063 'Helloworld!'
1064
1065 &gt;&gt;&gt; html.tostring(root, method='text', encoding=unicode)
1066 u'Helloworld!'
1067
1068 &gt;&gt;&gt; root = html.fragment_fromstring('&lt;div&gt;&lt;p&gt;Hello&lt;br&gt;world!&lt;/p&gt;TAIL&lt;/div&gt;')
1069 &gt;&gt;&gt; html.tostring(root[0], method='text', encoding=unicode)
1070 u'Helloworld!TAIL'
1071
1072 &gt;&gt;&gt; html.tostring(root[0], method='text', encoding=unicode, with_tail=False)
1073 u'Helloworld!'
1074
1075 &gt;&gt;&gt; doc = html.document_fromstring('&lt;p&gt;Hello&lt;br&gt;world!&lt;/p&gt;')
1076 &gt;&gt;&gt; html.tostring(doc, method='html', encoding=unicode)
1077 u'&lt;html&gt;&lt;body&gt;&lt;p&gt;Hello&lt;br&gt;world!&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;'
1078
1079 &gt;&gt;&gt; print(html.tostring(doc, method='html', encoding=unicode,
1080 ...          doctype='&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.01//EN&quot;'
1081 ...                  ' &quot;http://www.w3.org/TR/html4/strict.dtd&quot;&gt;'))
1082 &lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.01//EN&quot; &quot;http://www.w3.org/TR/html4/strict.dtd&quot;&gt;
1083 &lt;html&gt;&lt;body&gt;&lt;p&gt;Hello&lt;br&gt;world!&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;
1084 </pre>
1085   <dl class="fields">
1086   </dl>
1087 </td></tr></table>
1088 </div>
1089 <a name="Element"></a>
1090 <div>
1091 <table class="details" border="1" cellpadding="3"
1092        cellspacing="0" width="100%" bgcolor="white">
1093 <tr><td>
1094   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1095   <tr valign="top"><td>
1096   <h3 class="epydoc"><span class="sig"><span class="sig-name">Element</span>(<span class="sig-arg">*args</span>,
1097         <span class="sig-arg">**kw</span>)</span>
1098   </h3>
1099   </td><td align="right" valign="top"
1100     ><span class="codelink"><a href="lxml.html-pysrc.html#Element">source&nbsp;code</a></span>&nbsp;
1101     </td>
1102   </tr></table>
1103
1104   <p>Create a new HTML Element.</p>
1105 <p>This can also be used for XHTML documents.</p>
1106   <dl class="fields">
1107   </dl>
1108 </td></tr></table>
1109 </div>
1110 <br />
1111 <!-- ==================== VARIABLES DETAILS ==================== -->
1112 <a name="section-VariablesDetails"></a>
1113 <table class="details" border="1" cellpadding="3"
1114        cellspacing="0" width="100%" bgcolor="white">
1115 <tr bgcolor="#70b0f0" class="table-header">
1116   <td colspan="2" class="table-header">
1117     <table border="0" cellpadding="0" cellspacing="0" width="100%">
1118       <tr valign="top">
1119         <td align="left"><span class="table-header">Variables Details</span></td>
1120         <td align="right" valign="top"
1121          ><span class="options">[<a href="#section-VariablesDetails"
1122          class="privatelink" onclick="toggle_private();"
1123          >hide private</a>]</span></td>
1124       </tr>
1125     </table>
1126   </td>
1127 </tr>
1128 </table>
1129 <a name="_rel_links_xpath"></a>
1130 <div class="private">
1131 <table class="details" border="1" cellpadding="3"
1132        cellspacing="0" width="100%" bgcolor="white">
1133 <tr><td>
1134   <h3 class="epydoc">_rel_links_xpath</h3>
1135
1136   <dl class="fields">
1137   </dl>
1138   <dl class="fields">
1139     <dt>Value:</dt>
1140       <dd><table><tr><td><pre class="variable">
1141 descendant-or-self::a[@rel]|descendant-or-self::x:a[@rel]
1142 </pre></td></tr></table>
1143 </dd>
1144   </dl>
1145 </td></tr></table>
1146 </div>
1147 <a name="_options_xpath"></a>
1148 <div class="private">
1149 <table class="details" border="1" cellpadding="3"
1150        cellspacing="0" width="100%" bgcolor="white">
1151 <tr><td>
1152   <h3 class="epydoc">_options_xpath</h3>
1153
1154   <dl class="fields">
1155   </dl>
1156   <dl class="fields">
1157     <dt>Value:</dt>
1158       <dd><table><tr><td><pre class="variable">
1159 descendant-or-self::option|descendant-or-self::x:option
1160 </pre></td></tr></table>
1161 </dd>
1162   </dl>
1163 </td></tr></table>
1164 </div>
1165 <a name="_forms_xpath"></a>
1166 <div class="private">
1167 <table class="details" border="1" cellpadding="3"
1168        cellspacing="0" width="100%" bgcolor="white">
1169 <tr><td>
1170   <h3 class="epydoc">_forms_xpath</h3>
1171
1172   <dl class="fields">
1173   </dl>
1174   <dl class="fields">
1175     <dt>Value:</dt>
1176       <dd><table><tr><td><pre class="variable">
1177 descendant-or-self::form|descendant-or-self::x:form
1178 </pre></td></tr></table>
1179 </dd>
1180   </dl>
1181 </td></tr></table>
1182 </div>
1183 <a name="_class_xpath"></a>
1184 <div class="private">
1185 <table class="details" border="1" cellpadding="3"
1186        cellspacing="0" width="100%" bgcolor="white">
1187 <tr><td>
1188   <h3 class="epydoc">_class_xpath</h3>
1189
1190   <dl class="fields">
1191   </dl>
1192   <dl class="fields">
1193     <dt>Value:</dt>
1194       <dd><table><tr><td><pre class="variable">
1195 descendant-or-self::*[@class and contains(concat(' ', normalize-space(<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1196 @class), ' '), concat(' ', $class_name, ' '))]
1197 </pre></td></tr></table>
1198 </dd>
1199   </dl>
1200 </td></tr></table>
1201 </div>
1202 <a name="_css_url_re"></a>
1203 <div class="private">
1204 <table class="details" border="1" cellpadding="3"
1205        cellspacing="0" width="100%" bgcolor="white">
1206 <tr><td>
1207   <h3 class="epydoc">_css_url_re</h3>
1208
1209   <dl class="fields">
1210   </dl>
1211   <dl class="fields">
1212     <dt>Value:</dt>
1213       <dd><table><tr><td><pre class="variable">
1214 re.compile(r'<code class="re-flags">(?i)</code>url\(<code class="re-group">(</code>&quot;<code class="re-group">[^</code>&quot;<code class="re-group">]</code><code class="re-op">*</code>&quot;<code class="re-op">|</code>\'<code class="re-group">[^</code>\'<code class="re-group">]</code><code class="re-op">*</code>\'<code class="re-op">|</code><code class="re-group">[^</code>\)<code class="re-group">]</code><code class="re-op">*</code><code class="re-group">)</code>\)')
1215 </pre></td></tr></table>
1216 </dd>
1217   </dl>
1218 </td></tr></table>
1219 </div>
1220 <a name="make_links_absolute"></a>
1221 <div>
1222 <table class="details" border="1" cellpadding="3"
1223        cellspacing="0" width="100%" bgcolor="white">
1224 <tr><td>
1225   <h3 class="epydoc">make_links_absolute</h3>
1226
1227   <dl class="fields">
1228   </dl>
1229   <dl class="fields">
1230     <dt>Value:</dt>
1231       <dd><table><tr><td><pre class="variable">
1232 _MethodFunc('make_links_absolute', copy= True)
1233 </pre></td></tr></table>
1234 </dd>
1235   </dl>
1236 </td></tr></table>
1237 </div>
1238 <br />
1239 <!-- ==================== NAVIGATION BAR ==================== -->
1240 <table class="navbar" border="0" width="100%" cellpadding="0"
1241        bgcolor="#a0c0ff" cellspacing="0">
1242   <tr valign="middle">
1243   <!-- Home link -->
1244       <th>&nbsp;&nbsp;&nbsp;<a
1245         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1246
1247   <!-- Tree link -->
1248       <th>&nbsp;&nbsp;&nbsp;<a
1249         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1250
1251   <!-- Index link -->
1252       <th>&nbsp;&nbsp;&nbsp;<a
1253         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1254
1255   <!-- Help link -->
1256       <th>&nbsp;&nbsp;&nbsp;<a
1257         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1258
1259   <!-- Project homepage -->
1260       <th class="navbar" align="right" width="100%">
1261         <table border="0" cellpadding="0" cellspacing="0">
1262           <tr><th class="navbar" align="center"
1263             ><a class="navbar" target="_top" href="/">lxml API</a></th>
1264           </tr></table></th>
1265   </tr>
1266 </table>
1267 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
1268   <tr>
1269     <td align="left" class="footer">
1270     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:17 2012
1271     </td>
1272     <td align="right" class="footer">
1273       <a target="mainFrame" href="http://epydoc.sourceforge.net"
1274         >http://epydoc.sourceforge.net</a>
1275     </td>
1276   </tr>
1277 </table>
1278
1279 <script type="text/javascript">
1280   <!--
1281   // Private objects are initially displayed (because if
1282   // javascript is turned off then we want them to be
1283   // visible); but by default, we want to hide them.  So hide
1284   // them unless we have a cookie that says to show them.
1285   checkCookie();
1286   // -->
1287 </script>
1288 </body>
1289 </html>