doc/html/api/lxml.etree._ElementTree-class.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.etree._ElementTree</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         <a href="lxml.etree-module.html">Module&nbsp;etree</a> ::
  47         Class&nbsp;_ElementTree
  48       </span>
  49     </td>
  50     <td>
  51       <table cellpadding="0" cellspacing="0">
  52         <!-- hide/show private -->
  53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  55         <tr><td align="right"><span class="options"
  56             >[<a href="frames.html" target="_top">frames</a
  57             >]&nbsp;|&nbsp;<a href="lxml.etree._ElementTree-class.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== CLASS DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Class _ElementTree</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">_ElementTree</strong>
  69 </pre>
  70
  71 <dl><dt>Known Subclasses:</dt>
  72 <dd>
  73       <ul class="subclass-list">
  74 <li class="private"><a href="lxml.etree._XSLTResultTree-class.html" onclick="show_private();">_XSLTResultTree</a></li>  </ul>
  75 </dd></dl>
  76
  77 <hr />
  78 <!-- ==================== INSTANCE METHODS ==================== -->
  79 <a name="section-InstanceMethods"></a>
  80 <table class="summary" border="1" cellpadding="3"
  81        cellspacing="0" width="100%" bgcolor="white">
  82 <tr bgcolor="#70b0f0" class="table-header">
  83   <td colspan="2" class="table-header">
  84     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  85       <tr valign="top">
  86         <td align="left"><span class="table-header">Instance Methods</span></td>
  87         <td align="right" valign="top"
  88          ><span class="options">[<a href="#section-InstanceMethods"
  89          class="privatelink" onclick="toggle_private();"
  90          >hide private</a>]</span></td>
  91       </tr>
  92     </table>
  93   </td>
  94 </tr>
  95 <tr>
  96     <td width="15%" align="right" valign="top" class="summary">
  97       <span class="summary-type">&nbsp;</span>
  98     </td><td class="summary">
  99       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 100         <tr>
 101           <td><span class="summary-sig"><a name="__copy__"></a><span class="summary-sig-name">__copy__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 102           <td align="right" valign="top">
 103
 104
 105           </td>
 106         </tr>
 107       </table>
 108
 109     </td>
 110   </tr>
 111 <tr>
 112     <td width="15%" align="right" valign="top" class="summary">
 113       <span class="summary-type">&nbsp;</span>
 114     </td><td class="summary">
 115       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 116         <tr>
 117           <td><span class="summary-sig"><a name="__deepcopy__"></a><span class="summary-sig-name">__deepcopy__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 118           <td align="right" valign="top">
 119
 120
 121           </td>
 122         </tr>
 123       </table>
 124
 125     </td>
 126   </tr>
 127 <tr>
 128     <td width="15%" align="right" valign="top" class="summary">
 129       <span class="summary-type">a new object with type S, a subtype of T</span>
 130     </td><td class="summary">
 131       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 132         <tr>
 133           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 134         <span class="summary-sig-arg">S</span>,
 135         <span class="summary-sig-arg">...</span>)</span></td>
 136           <td align="right" valign="top">
 137
 138
 139           </td>
 140         </tr>
 141       </table>
 142
 143     </td>
 144   </tr>
 145 <tr class="private">
 146     <td width="15%" align="right" valign="top" class="summary">
 147       <span class="summary-type">&nbsp;</span>
 148     </td><td class="summary">
 149       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 150         <tr>
 151           <td><span class="summary-sig"><a name="_setroot"></a><span class="summary-sig-name">_setroot</span>(<span class="summary-sig-arg">self</span>,
 152         <span class="summary-sig-arg">root</span>)</span><br />
 153       Relocate the ElementTree to a new root node.</td>
 154           <td align="right" valign="top">
 155
 156
 157           </td>
 158         </tr>
 159       </table>
 160
 161     </td>
 162   </tr>
 163 <tr>
 164     <td width="15%" align="right" valign="top" class="summary">
 165       <span class="summary-type">&nbsp;</span>
 166     </td><td class="summary">
 167       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 168         <tr>
 169           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#find" class="summary-sig-name">find</a>(<span class="summary-sig-arg">self</span>,
 170         <span class="summary-sig-arg">path</span>,
 171         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 172       Finds the first toplevel element with given tag.  Same as
 173 <tt class="rst-docutils literal"><span class="pre">tree.getroot().find(path)</span></tt>.</td>
 174           <td align="right" valign="top">
 175
 176
 177           </td>
 178         </tr>
 179       </table>
 180
 181     </td>
 182   </tr>
 183 <tr>
 184     <td width="15%" align="right" valign="top" class="summary">
 185       <span class="summary-type">&nbsp;</span>
 186     </td><td class="summary">
 187       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 188         <tr>
 189           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#findall" class="summary-sig-name">findall</a>(<span class="summary-sig-arg">self</span>,
 190         <span class="summary-sig-arg">path</span>,
 191         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 192       Finds all elements matching the ElementPath expression.  Same as
 193 getroot().findall(path).</td>
 194           <td align="right" valign="top">
 195
 196
 197           </td>
 198         </tr>
 199       </table>
 200
 201     </td>
 202   </tr>
 203 <tr>
 204     <td width="15%" align="right" valign="top" class="summary">
 205       <span class="summary-type">&nbsp;</span>
 206     </td><td class="summary">
 207       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 208         <tr>
 209           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#findtext" class="summary-sig-name">findtext</a>(<span class="summary-sig-arg">self</span>,
 210         <span class="summary-sig-arg">path</span>,
 211         <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>,
 212         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 213       Finds the text for the first element matching the ElementPath
 214 expression.  Same as getroot().findtext(path)</td>
 215           <td align="right" valign="top">
 216
 217
 218           </td>
 219         </tr>
 220       </table>
 221
 222     </td>
 223   </tr>
 224 <tr>
 225     <td width="15%" align="right" valign="top" class="summary">
 226       <span class="summary-type">&nbsp;</span>
 227     </td><td class="summary">
 228       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 229         <tr>
 230           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#getiterator" class="summary-sig-name">getiterator</a>(<span class="summary-sig-arg">self</span>,
 231         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 232       Returns a sequence or iterator of all elements in document order
 233 (depth first pre-order), starting with the root element.</td>
 234           <td align="right" valign="top">
 235
 236
 237           </td>
 238         </tr>
 239       </table>
 240
 241     </td>
 242   </tr>
 243 <tr>
 244     <td width="15%" align="right" valign="top" class="summary">
 245       <span class="summary-type">&nbsp;</span>
 246     </td><td class="summary">
 247       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 248         <tr>
 249           <td><span class="summary-sig"><a name="getpath"></a><span class="summary-sig-name">getpath</span>(<span class="summary-sig-arg">self</span>,
 250         <span class="summary-sig-arg">element</span>)</span><br />
 251       Returns a structural, absolute XPath expression to find that element.</td>
 252           <td align="right" valign="top">
 253
 254
 255           </td>
 256         </tr>
 257       </table>
 258
 259     </td>
 260   </tr>
 261 <tr>
 262     <td width="15%" align="right" valign="top" class="summary">
 263       <span class="summary-type">&nbsp;</span>
 264     </td><td class="summary">
 265       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 266         <tr>
 267           <td><span class="summary-sig"><a name="getroot"></a><span class="summary-sig-name">getroot</span>(<span class="summary-sig-arg">self</span>)</span><br />
 268       Gets the root element for this tree.</td>
 269           <td align="right" valign="top">
 270
 271
 272           </td>
 273         </tr>
 274       </table>
 275
 276     </td>
 277   </tr>
 278 <tr>
 279     <td width="15%" align="right" valign="top" class="summary">
 280       <span class="summary-type">&nbsp;</span>
 281     </td><td class="summary">
 282       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 283         <tr>
 284           <td><span class="summary-sig"><a name="iter"></a><span class="summary-sig-name">iter</span>(<span class="summary-sig-arg">self</span>,
 285         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 286       Creates an iterator for the root element.  The iterator loops over
 287 all elements in this tree, in document order.</td>
 288           <td align="right" valign="top">
 289
 290
 291           </td>
 292         </tr>
 293       </table>
 294
 295     </td>
 296   </tr>
 297 <tr>
 298     <td width="15%" align="right" valign="top" class="summary">
 299       <span class="summary-type">&nbsp;</span>
 300     </td><td class="summary">
 301       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 302         <tr>
 303           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#iterfind" class="summary-sig-name">iterfind</a>(<span class="summary-sig-arg">self</span>,
 304         <span class="summary-sig-arg">path</span>,
 305         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 306       Iterates over all elements matching the ElementPath expression.
 307 Same as getroot().iterfind(path).</td>
 308           <td align="right" valign="top">
 309
 310
 311           </td>
 312         </tr>
 313       </table>
 314
 315     </td>
 316   </tr>
 317 <tr>
 318     <td width="15%" align="right" valign="top" class="summary">
 319       <span class="summary-type">&nbsp;</span>
 320     </td><td class="summary">
 321       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 322         <tr>
 323           <td><span class="summary-sig"><a name="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">self</span>,
 324         <span class="summary-sig-arg">source</span>,
 325         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
 326         <span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
 327       Updates self with the content of source and returns its root</td>
 328           <td align="right" valign="top">
 329
 330
 331           </td>
 332         </tr>
 333       </table>
 334
 335     </td>
 336   </tr>
 337 <tr>
 338     <td width="15%" align="right" valign="top" class="summary">
 339       <span class="summary-type">&nbsp;</span>
 340     </td><td class="summary">
 341       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 342         <tr>
 343           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#relaxng" class="summary-sig-name">relaxng</a>(<span class="summary-sig-arg">self</span>,
 344         <span class="summary-sig-arg">relaxng</span>)</span><br />
 345       Validate this document using other document.</td>
 346           <td align="right" valign="top">
 347
 348
 349           </td>
 350         </tr>
 351       </table>
 352
 353     </td>
 354   </tr>
 355 <tr>
 356     <td width="15%" align="right" valign="top" class="summary">
 357       <span class="summary-type">&nbsp;</span>
 358     </td><td class="summary">
 359       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 360         <tr>
 361           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
 362         <span class="summary-sig-arg">file</span>,
 363         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
 364         <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">&quot;xml&quot;</span>,
 365         <span class="summary-sig-arg">pretty_print</span>=<span class="summary-sig-default">False</span>,
 366         <span class="summary-sig-arg">xml_declaration</span>=<span class="summary-sig-default">None</span>,
 367         <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>,
 368         <span class="summary-sig-arg">standalone</span>=<span class="summary-sig-default">None</span>,
 369         <span class="summary-sig-arg">compression</span>=<span class="summary-sig-default">0</span>,
 370         <span class="summary-sig-arg">exclusive</span>=<span class="summary-sig-default">False</span>,
 371         <span class="summary-sig-arg">with_comments</span>=<span class="summary-sig-default">True</span>)</span><br />
 372       Write the tree to a filename, file or file-like object.</td>
 373           <td align="right" valign="top">
 374
 375
 376           </td>
 377         </tr>
 378       </table>
 379
 380     </td>
 381   </tr>
 382 <tr>
 383     <td width="15%" align="right" valign="top" class="summary">
 384       <span class="summary-type">&nbsp;</span>
 385     </td><td class="summary">
 386       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 387         <tr>
 388           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#write_c14n" class="summary-sig-name">write_c14n</a>(<span class="summary-sig-arg">self</span>,
 389         <span class="summary-sig-arg">file</span>,
 390         <span class="summary-sig-arg">exclusive</span>=<span class="summary-sig-default">False</span>,
 391         <span class="summary-sig-arg">with_comments</span>=<span class="summary-sig-default">True</span>,
 392         <span class="summary-sig-arg">compression</span>=<span class="summary-sig-default">0</span>)</span><br />
 393       C14N write of document. Always writes UTF-8.</td>
 394           <td align="right" valign="top">
 395
 396
 397           </td>
 398         </tr>
 399       </table>
 400
 401     </td>
 402   </tr>
 403 <tr>
 404     <td width="15%" align="right" valign="top" class="summary">
 405       <span class="summary-type">&nbsp;</span>
 406     </td><td class="summary">
 407       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 408         <tr>
 409           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xinclude" class="summary-sig-name">xinclude</a>(<span class="summary-sig-arg">self</span>)</span><br />
 410       Process the XInclude nodes in this document and include the
 411 referenced XML fragments.</td>
 412           <td align="right" valign="top">
 413
 414
 415           </td>
 416         </tr>
 417       </table>
 418
 419     </td>
 420   </tr>
 421 <tr>
 422     <td width="15%" align="right" valign="top" class="summary">
 423       <span class="summary-type">&nbsp;</span>
 424     </td><td class="summary">
 425       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 426         <tr>
 427           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xmlschema" class="summary-sig-name">xmlschema</a>(<span class="summary-sig-arg">self</span>,
 428         <span class="summary-sig-arg">xmlschema</span>)</span><br />
 429       Validate this document using other document.</td>
 430           <td align="right" valign="top">
 431
 432
 433           </td>
 434         </tr>
 435       </table>
 436
 437     </td>
 438   </tr>
 439 <tr>
 440     <td width="15%" align="right" valign="top" class="summary">
 441       <span class="summary-type">&nbsp;</span>
 442     </td><td class="summary">
 443       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 444         <tr>
 445           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xpath" class="summary-sig-name">xpath</a>(<span class="summary-sig-arg">self</span>,
 446         <span class="summary-sig-arg">_path</span>,
 447         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>,
 448         <span class="summary-sig-arg">extensions</span>=<span class="summary-sig-default">None</span>,
 449         <span class="summary-sig-arg">smart_strings</span>=<span class="summary-sig-default">True</span>,
 450         <span class="summary-sig-arg">**_variables</span>)</span><br />
 451       XPath evaluate in context of document.</td>
 452           <td align="right" valign="top">
 453
 454
 455           </td>
 456         </tr>
 457       </table>
 458
 459     </td>
 460   </tr>
 461 <tr>
 462     <td width="15%" align="right" valign="top" class="summary">
 463       <span class="summary-type">&nbsp;</span>
 464     </td><td class="summary">
 465       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 466         <tr>
 467           <td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xslt" class="summary-sig-name">xslt</a>(<span class="summary-sig-arg">self</span>,
 468         <span class="summary-sig-arg">_xslt</span>,
 469         <span class="summary-sig-arg">extensions</span>=<span class="summary-sig-default">None</span>,
 470         <span class="summary-sig-arg">access_control</span>=<span class="summary-sig-default">None</span>,
 471         <span class="summary-sig-arg">**_kw</span>)</span><br />
 472       Transform this document using other document.</td>
 473           <td align="right" valign="top">
 474
 475
 476           </td>
 477         </tr>
 478       </table>
 479
 480     </td>
 481   </tr>
 482   <tr>
 483     <td colspan="2" class="summary">
 484     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 485       <code>__delattr__</code>,
 486       <code>__format__</code>,
 487       <code>__getattribute__</code>,
 488       <code>__hash__</code>,
 489       <code>__init__</code>,
 490       <code>__reduce__</code>,
 491       <code>__reduce_ex__</code>,
 492       <code>__repr__</code>,
 493       <code>__setattr__</code>,
 494       <code>__sizeof__</code>,
 495       <code>__str__</code>,
 496       <code>__subclasshook__</code>
 497       </p>
 498     </td>
 499   </tr>
 500 </table>
 501 <!-- ==================== PROPERTIES ==================== -->
 502 <a name="section-Properties"></a>
 503 <table class="summary" border="1" cellpadding="3"
 504        cellspacing="0" width="100%" bgcolor="white">
 505 <tr bgcolor="#70b0f0" class="table-header">
 506   <td colspan="2" class="table-header">
 507     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 508       <tr valign="top">
 509         <td align="left"><span class="table-header">Properties</span></td>
 510         <td align="right" valign="top"
 511          ><span class="options">[<a href="#section-Properties"
 512          class="privatelink" onclick="toggle_private();"
 513          >hide private</a>]</span></td>
 514       </tr>
 515     </table>
 516   </td>
 517 </tr>
 518 <tr>
 519     <td width="15%" align="right" valign="top" class="summary">
 520       <span class="summary-type">&nbsp;</span>
 521     </td><td class="summary">
 522         <a name="docinfo"></a><span class="summary-name">docinfo</span><br />
 523       Information about the document provided by parser and DTD.  This
 524 value is only defined for ElementTree objects based on the root node
 525 of a parsed document (e.g.  those returned by the parse functions),
 526 not for trees that were built manually.
 527     </td>
 528   </tr>
 529 <tr>
 530     <td width="15%" align="right" valign="top" class="summary">
 531       <span class="summary-type">&nbsp;</span>
 532     </td><td class="summary">
 533         <a name="parser"></a><span class="summary-name">parser</span><br />
 534       The parser that was used to parse the document in this ElementTree.
 535     </td>
 536   </tr>
 537   <tr>
 538     <td colspan="2" class="summary">
 539     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 540       <code>__class__</code>
 541       </p>
 542     </td>
 543   </tr>
 544 </table>
 545 <!-- ==================== METHOD DETAILS ==================== -->
 546 <a name="section-MethodDetails"></a>
 547 <table class="details" border="1" cellpadding="3"
 548        cellspacing="0" width="100%" bgcolor="white">
 549 <tr bgcolor="#70b0f0" class="table-header">
 550   <td colspan="2" class="table-header">
 551     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 552       <tr valign="top">
 553         <td align="left"><span class="table-header">Method Details</span></td>
 554         <td align="right" valign="top"
 555          ><span class="options">[<a href="#section-MethodDetails"
 556          class="privatelink" onclick="toggle_private();"
 557          >hide private</a>]</span></td>
 558       </tr>
 559     </table>
 560   </td>
 561 </tr>
 562 </table>
 563 <a name="__new__"></a>
 564 <div>
 565 <table class="details" border="1" cellpadding="3"
 566        cellspacing="0" width="100%" bgcolor="white">
 567 <tr><td>
 568   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 569   <tr valign="top"><td>
 570   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 571         <span class="sig-arg">S</span>,
 572         <span class="sig-arg">...</span>)</span>
 573   </h3>
 574   </td><td align="right" valign="top"
 575     >&nbsp;
 576     </td>
 577   </tr></table>
 578
 579
 580   <dl class="fields">
 581     <dt>Returns: a new object with type S, a subtype of T</dt>
 582     <dt>Overrides:
 583         object.__new__
 584     </dt>
 585   </dl>
 586 </td></tr></table>
 587 </div>
 588 <a name="find"></a>
 589 <div>
 590 <table class="details" border="1" cellpadding="3"
 591        cellspacing="0" width="100%" bgcolor="white">
 592 <tr><td>
 593   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 594   <tr valign="top"><td>
 595   <h3 class="epydoc"><span class="sig"><span class="sig-name">find</span>(<span class="sig-arg">self</span>,
 596         <span class="sig-arg">path</span>,
 597         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
 598   </h3>
 599   </td><td align="right" valign="top"
 600     >&nbsp;
 601     </td>
 602   </tr></table>
 603
 604   <p>Finds the first toplevel element with given tag.  Same as
 605 <tt class="rst-rst-docutils literal rst-docutils literal"><span class="pre">tree.getroot().find(path)</span></tt>.</p>
 606 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
 607 prefix-to-namespace mapping that allows the usage of XPath
 608 prefixes in the path expression.</p>
 609   <dl class="fields">
 610   </dl>
 611 </td></tr></table>
 612 </div>
 613 <a name="findall"></a>
 614 <div>
 615 <table class="details" border="1" cellpadding="3"
 616        cellspacing="0" width="100%" bgcolor="white">
 617 <tr><td>
 618   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 619   <tr valign="top"><td>
 620   <h3 class="epydoc"><span class="sig"><span class="sig-name">findall</span>(<span class="sig-arg">self</span>,
 621         <span class="sig-arg">path</span>,
 622         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
 623   </h3>
 624   </td><td align="right" valign="top"
 625     >&nbsp;
 626     </td>
 627   </tr></table>
 628
 629   <p>Finds all elements matching the ElementPath expression.  Same as
 630 getroot().findall(path).</p>
 631 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
 632 prefix-to-namespace mapping that allows the usage of XPath
 633 prefixes in the path expression.</p>
 634   <dl class="fields">
 635   </dl>
 636 </td></tr></table>
 637 </div>
 638 <a name="findtext"></a>
 639 <div>
 640 <table class="details" border="1" cellpadding="3"
 641        cellspacing="0" width="100%" bgcolor="white">
 642 <tr><td>
 643   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 644   <tr valign="top"><td>
 645   <h3 class="epydoc"><span class="sig"><span class="sig-name">findtext</span>(<span class="sig-arg">self</span>,
 646         <span class="sig-arg">path</span>,
 647         <span class="sig-arg">default</span>=<span class="sig-default">None</span>,
 648         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
 649   </h3>
 650   </td><td align="right" valign="top"
 651     >&nbsp;
 652     </td>
 653   </tr></table>
 654
 655   <p>Finds the text for the first element matching the ElementPath
 656 expression.  Same as getroot().findtext(path)</p>
 657 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
 658 prefix-to-namespace mapping that allows the usage of XPath
 659 prefixes in the path expression.</p>
 660   <dl class="fields">
 661   </dl>
 662 </td></tr></table>
 663 </div>
 664 <a name="getiterator"></a>
 665 <div>
 666 <table class="details" border="1" cellpadding="3"
 667        cellspacing="0" width="100%" bgcolor="white">
 668 <tr><td>
 669   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 670   <tr valign="top"><td>
 671   <h3 class="epydoc"><span class="sig"><span class="sig-name">getiterator</span>(<span class="sig-arg">self</span>,
 672         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
 673   </h3>
 674   </td><td align="right" valign="top"
 675     >&nbsp;
 676     </td>
 677   </tr></table>
 678
 679   <p>Returns a sequence or iterator of all elements in document order
 680 (depth first pre-order), starting with the root element.</p>
 681 <p>Can be restricted to find only elements with a specific tag
 682 (pass <tt class="rst-docutils literal"><span class="pre">tag=&quot;xyz&quot;</span></tt> or <tt class="rst-docutils literal"><span class="pre">tag=&quot;{ns}xyz&quot;</span></tt>) or from a namespace
 683 (pass <tt class="rst-docutils literal"><span class="pre">tag=&quot;{ns}*&quot;</span></tt>).</p>
 684 <p>You can also pass the Element, Comment, ProcessingInstruction and
 685 Entity factory functions to look only for the specific element type.</p>
 686   <dl class="fields">
 687   </dl>
 688 <div class="fields">      <p><strong>Deprecated:</strong>
 689         Note that this method is deprecated as of
 690 ElementTree 1.3 and lxml 2.0.  It returns an iterator in
 691 lxml, which diverges from the original ElementTree
 692 behaviour.  If you want an efficient iterator, use the
 693 <tt class="rst-rst-docutils literal rst-docutils literal">tree.iter()</tt> method instead.  You should only use this
 694 method in new code if you require backwards compatibility
 695 with older versions of lxml or ElementTree.
 696       </p>
 697 </div></td></tr></table>
 698 </div>
 699 <a name="iterfind"></a>
 700 <div>
 701 <table class="details" border="1" cellpadding="3"
 702        cellspacing="0" width="100%" bgcolor="white">
 703 <tr><td>
 704   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 705   <tr valign="top"><td>
 706   <h3 class="epydoc"><span class="sig"><span class="sig-name">iterfind</span>(<span class="sig-arg">self</span>,
 707         <span class="sig-arg">path</span>,
 708         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
 709   </h3>
 710   </td><td align="right" valign="top"
 711     >&nbsp;
 712     </td>
 713   </tr></table>
 714
 715   <p>Iterates over all elements matching the ElementPath expression.
 716 Same as getroot().iterfind(path).</p>
 717 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
 718 prefix-to-namespace mapping that allows the usage of XPath
 719 prefixes in the path expression.</p>
 720   <dl class="fields">
 721   </dl>
 722 </td></tr></table>
 723 </div>
 724 <a name="relaxng"></a>
 725 <div>
 726 <table class="details" border="1" cellpadding="3"
 727        cellspacing="0" width="100%" bgcolor="white">
 728 <tr><td>
 729   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 730   <tr valign="top"><td>
 731   <h3 class="epydoc"><span class="sig"><span class="sig-name">relaxng</span>(<span class="sig-arg">self</span>,
 732         <span class="sig-arg">relaxng</span>)</span>
 733   </h3>
 734   </td><td align="right" valign="top"
 735     >&nbsp;
 736     </td>
 737   </tr></table>
 738
 739   <p>Validate this document using other document.</p>
 740 <p>The relaxng argument is a tree that should contain a Relax NG schema.</p>
 741 <p>Returns True or False, depending on whether validation
 742 succeeded.</p>
 743 <p>Note: if you are going to apply the same Relax NG schema against
 744 multiple documents, it is more efficient to use the RelaxNG
 745 class directly.</p>
 746   <dl class="fields">
 747   </dl>
 748 </td></tr></table>
 749 </div>
 750 <a name="write"></a>
 751 <div>
 752 <table class="details" border="1" cellpadding="3"
 753        cellspacing="0" width="100%" bgcolor="white">
 754 <tr><td>
 755   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 756   <tr valign="top"><td>
 757   <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,
 758         <span class="sig-arg">file</span>,
 759         <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
 760         <span class="sig-arg">method</span>=<span class="sig-default">&quot;xml&quot;</span>,
 761         <span class="sig-arg">pretty_print</span>=<span class="sig-default">False</span>,
 762         <span class="sig-arg">xml_declaration</span>=<span class="sig-default">None</span>,
 763         <span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>,
 764         <span class="sig-arg">standalone</span>=<span class="sig-default">None</span>,
 765         <span class="sig-arg">compression</span>=<span class="sig-default">0</span>,
 766         <span class="sig-arg">exclusive</span>=<span class="sig-default">False</span>,
 767         <span class="sig-arg">with_comments</span>=<span class="sig-default">True</span>)</span>
 768   </h3>
 769   </td><td align="right" valign="top"
 770     >&nbsp;
 771     </td>
 772   </tr></table>
 773
 774   <p>Write the tree to a filename, file or file-like object.</p>
 775 <p>Defaults to ASCII encoding and writing a declaration as needed.</p>
 776 <p>The keyword argument 'method' selects the output method:
 777 'xml', 'html', 'text' or 'c14n'.  Default is 'xml'.</p>
 778 <p>The <tt class="rst-docutils literal">exclusive</tt> and <tt class="rst-docutils literal">with_comments</tt> arguments are only
 779 used with C14N output, where they request exclusive and
 780 uncommented C14N serialisation respectively.</p>
 781 <p>Passing a boolean value to the <tt class="rst-docutils literal">standalone</tt> option will
 782 output an XML declaration with the corresponding
 783 <tt class="rst-docutils literal">standalone</tt> flag.</p>
 784 <p>The <tt class="rst-docutils literal">compression</tt> option enables GZip compression level 1-9.</p>
 785   <dl class="fields">
 786   </dl>
 787 </td></tr></table>
 788 </div>
 789 <a name="write_c14n"></a>
 790 <div>
 791 <table class="details" border="1" cellpadding="3"
 792        cellspacing="0" width="100%" bgcolor="white">
 793 <tr><td>
 794   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 795   <tr valign="top"><td>
 796   <h3 class="epydoc"><span class="sig"><span class="sig-name">write_c14n</span>(<span class="sig-arg">self</span>,
 797         <span class="sig-arg">file</span>,
 798         <span class="sig-arg">exclusive</span>=<span class="sig-default">False</span>,
 799         <span class="sig-arg">with_comments</span>=<span class="sig-default">True</span>,
 800         <span class="sig-arg">compression</span>=<span class="sig-default">0</span>)</span>
 801   </h3>
 802   </td><td align="right" valign="top"
 803     >&nbsp;
 804     </td>
 805   </tr></table>
 806
 807   <p>C14N write of document. Always writes UTF-8.</p>
 808 <p>The <tt class="rst-docutils literal">compression</tt> option enables GZip compression level 1-9.</p>
 809   <dl class="fields">
 810   </dl>
 811 </td></tr></table>
 812 </div>
 813 <a name="xinclude"></a>
 814 <div>
 815 <table class="details" border="1" cellpadding="3"
 816        cellspacing="0" width="100%" bgcolor="white">
 817 <tr><td>
 818   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 819   <tr valign="top"><td>
 820   <h3 class="epydoc"><span class="sig"><span class="sig-name">xinclude</span>(<span class="sig-arg">self</span>)</span>
 821   </h3>
 822   </td><td align="right" valign="top"
 823     >&nbsp;
 824     </td>
 825   </tr></table>
 826
 827   <p>Process the XInclude nodes in this document and include the
 828 referenced XML fragments.</p>
 829 <p>There is support for loading files through the file system, HTTP and
 830 FTP.</p>
 831 <p>Note that XInclude does not support custom resolvers in Python space
 832 due to restrictions of libxml2 &lt;= 2.6.29.</p>
 833   <dl class="fields">
 834   </dl>
 835 </td></tr></table>
 836 </div>
 837 <a name="xmlschema"></a>
 838 <div>
 839 <table class="details" border="1" cellpadding="3"
 840        cellspacing="0" width="100%" bgcolor="white">
 841 <tr><td>
 842   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 843   <tr valign="top"><td>
 844   <h3 class="epydoc"><span class="sig"><span class="sig-name">xmlschema</span>(<span class="sig-arg">self</span>,
 845         <span class="sig-arg">xmlschema</span>)</span>
 846   </h3>
 847   </td><td align="right" valign="top"
 848     >&nbsp;
 849     </td>
 850   </tr></table>
 851
 852   <p>Validate this document using other document.</p>
 853 <p>The xmlschema argument is a tree that should contain an XML Schema.</p>
 854 <p>Returns True or False, depending on whether validation
 855 succeeded.</p>
 856 <p>Note: If you are going to apply the same XML Schema against
 857 multiple documents, it is more efficient to use the XMLSchema
 858 class directly.</p>
 859   <dl class="fields">
 860   </dl>
 861 </td></tr></table>
 862 </div>
 863 <a name="xpath"></a>
 864 <div>
 865 <table class="details" border="1" cellpadding="3"
 866        cellspacing="0" width="100%" bgcolor="white">
 867 <tr><td>
 868   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 869   <tr valign="top"><td>
 870   <h3 class="epydoc"><span class="sig"><span class="sig-name">xpath</span>(<span class="sig-arg">self</span>,
 871         <span class="sig-arg">_path</span>,
 872         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>,
 873         <span class="sig-arg">extensions</span>=<span class="sig-default">None</span>,
 874         <span class="sig-arg">smart_strings</span>=<span class="sig-default">True</span>,
 875         <span class="sig-arg">**_variables</span>)</span>
 876   </h3>
 877   </td><td align="right" valign="top"
 878     >&nbsp;
 879     </td>
 880   </tr></table>
 881
 882   <p>XPath evaluate in context of document.</p>
 883 <p><tt class="rst-docutils literal">namespaces</tt> is an optional dictionary with prefix to namespace URI
 884 mappings, used by XPath.  <tt class="rst-docutils literal">extensions</tt> defines additional extension
 885 functions.</p>
 886 <p>Returns a list (nodeset), or bool, float or string.</p>
 887 <p>In case of a list result, return Element for element nodes,
 888 string for text and attribute values.</p>
 889 <p>Note: if you are going to apply multiple XPath expressions
 890 against the same document, it is more efficient to use
 891 XPathEvaluator directly.</p>
 892   <dl class="fields">
 893   </dl>
 894 </td></tr></table>
 895 </div>
 896 <a name="xslt"></a>
 897 <div>
 898 <table class="details" border="1" cellpadding="3"
 899        cellspacing="0" width="100%" bgcolor="white">
 900 <tr><td>
 901   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 902   <tr valign="top"><td>
 903   <h3 class="epydoc"><span class="sig"><span class="sig-name">xslt</span>(<span class="sig-arg">self</span>,
 904         <span class="sig-arg">_xslt</span>,
 905         <span class="sig-arg">extensions</span>=<span class="sig-default">None</span>,
 906         <span class="sig-arg">access_control</span>=<span class="sig-default">None</span>,
 907         <span class="sig-arg">**_kw</span>)</span>
 908   </h3>
 909   </td><td align="right" valign="top"
 910     >&nbsp;
 911     </td>
 912   </tr></table>
 913
 914   <p>Transform this document using other document.</p>
 915 <p>xslt is a tree that should be XSLT
 916 keyword parameters are XSLT transformation parameters.</p>
 917 <p>Returns the transformed tree.</p>
 918 <p>Note: if you are going to apply the same XSLT stylesheet against
 919 multiple documents, it is more efficient to use the XSLT
 920 class directly.</p>
 921   <dl class="fields">
 922   </dl>
 923 </td></tr></table>
 924 </div>
 925 <br />
 926 <!-- ==================== NAVIGATION BAR ==================== -->
 927 <table class="navbar" border="0" width="100%" cellpadding="0"
 928        bgcolor="#a0c0ff" cellspacing="0">
 929   <tr valign="middle">
 930   <!-- Home link -->
 931       <th>&nbsp;&nbsp;&nbsp;<a
 932         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 933
 934   <!-- Tree link -->
 935       <th>&nbsp;&nbsp;&nbsp;<a
 936         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 937
 938   <!-- Index link -->
 939       <th>&nbsp;&nbsp;&nbsp;<a
 940         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 941
 942   <!-- Help link -->
 943       <th>&nbsp;&nbsp;&nbsp;<a
 944         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 945
 946   <!-- Project homepage -->
 947       <th class="navbar" align="right" width="100%">
 948         <table border="0" cellpadding="0" cellspacing="0">
 949           <tr><th class="navbar" align="center"
 950             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 951           </tr></table></th>
 952   </tr>
 953 </table>
 954 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 955   <tr>
 956     <td align="left" class="footer">
 957     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 958     </td>
 959     <td align="right" class="footer">
 960       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 961         >http://epydoc.sourceforge.net</a>
 962     </td>
 963   </tr>
 964 </table>
 965
 966 <script type="text/javascript">
 967   <!--
 968   // Private objects are initially displayed (because if
 969   // javascript is turned off then we want them to be
 970   // visible); but by default, we want to hide them.  So hide
 971   // them unless we have a cookie that says to show them.
 972   checkCookie();
 973   // -->
 974 </script>
 975 </body>
 976 </html>