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