doc/html/api/lxml.etree._Element-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._Element</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;_Element
  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._Element-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 _Element</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">_Element</strong>
  69 </pre>
  70
  71 <dl><dt>Known Subclasses:</dt>
  72 <dd>
  73       <ul class="subclass-list">
  74 <li><a href="lxml.etree.ElementBase-class.html">ElementBase</a></li><li class="private">, <a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></li>  </ul>
  75 </dd></dl>
  76
  77 <hr />
  78 <p>Element class.</p>
  79 <p>References a document object and a libxml node.</p>
  80 <p>By pointing to a Document instance, a reference is kept to
  81 _Document as long as there is some pointer to a node in it.</p>
  82
  83 <!-- ==================== INSTANCE METHODS ==================== -->
  84 <a name="section-InstanceMethods"></a>
  85 <table class="summary" border="1" cellpadding="3"
  86        cellspacing="0" width="100%" bgcolor="white">
  87 <tr bgcolor="#70b0f0" class="table-header">
  88   <td colspan="2" class="table-header">
  89     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  90       <tr valign="top">
  91         <td align="left"><span class="table-header">Instance Methods</span></td>
  92         <td align="right" valign="top"
  93          ><span class="options">[<a href="#section-InstanceMethods"
  94          class="privatelink" onclick="toggle_private();"
  95          >hide private</a>]</span></td>
  96       </tr>
  97     </table>
  98   </td>
  99 </tr>
 100 <tr>
 101     <td width="15%" align="right" valign="top" class="summary">
 102       <span class="summary-type">&nbsp;</span>
 103     </td><td class="summary">
 104       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 105         <tr>
 106           <td><span class="summary-sig"><a name="__contains__"></a><span class="summary-sig-name">__contains__</span>(<span class="summary-sig-arg">self</span>,
 107         <span class="summary-sig-arg">element</span>)</span></td>
 108           <td align="right" valign="top">
 109
 110
 111           </td>
 112         </tr>
 113       </table>
 114
 115     </td>
 116   </tr>
 117 <tr>
 118     <td width="15%" align="right" valign="top" class="summary">
 119       <span class="summary-type">&nbsp;</span>
 120     </td><td class="summary">
 121       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 122         <tr>
 123           <td><span class="summary-sig"><a name="__copy__"></a><span class="summary-sig-name">__copy__</span>(<span class="summary-sig-arg">self</span>)</span></td>
 124           <td align="right" valign="top">
 125
 126
 127           </td>
 128         </tr>
 129       </table>
 130
 131     </td>
 132   </tr>
 133 <tr>
 134     <td width="15%" align="right" valign="top" class="summary">
 135       <span class="summary-type">&nbsp;</span>
 136     </td><td class="summary">
 137       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 138         <tr>
 139           <td><span class="summary-sig"><a name="__deepcopy__"></a><span class="summary-sig-name">__deepcopy__</span>(<span class="summary-sig-arg">self</span>,
 140         <span class="summary-sig-arg">memo</span>)</span></td>
 141           <td align="right" valign="top">
 142
 143
 144           </td>
 145         </tr>
 146       </table>
 147
 148     </td>
 149   </tr>
 150 <tr>
 151     <td width="15%" align="right" valign="top" class="summary">
 152       <span class="summary-type">&nbsp;</span>
 153     </td><td class="summary">
 154       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 155         <tr>
 156           <td><span class="summary-sig"><a name="__delitem__"></a><span class="summary-sig-name">__delitem__</span>(<span class="summary-sig-arg">self</span>,
 157         <span class="summary-sig-arg">x</span>)</span><br />
 158       Deletes the given subelement or a slice.</td>
 159           <td align="right" valign="top">
 160
 161
 162           </td>
 163         </tr>
 164       </table>
 165
 166     </td>
 167   </tr>
 168 <tr>
 169     <td width="15%" align="right" valign="top" class="summary">
 170       <span class="summary-type">&nbsp;</span>
 171     </td><td class="summary">
 172       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 173         <tr>
 174           <td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">...</span>)</span><br />
 175       Returns the subelement at the given position or the requested
 176 slice.</td>
 177           <td align="right" valign="top">
 178
 179
 180           </td>
 181         </tr>
 182       </table>
 183
 184     </td>
 185   </tr>
 186 <tr>
 187     <td width="15%" align="right" valign="top" class="summary">
 188       <span class="summary-type">&nbsp;</span>
 189     </td><td class="summary">
 190       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 191         <tr>
 192           <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">self</span>)</span></td>
 193           <td align="right" valign="top">
 194
 195
 196           </td>
 197         </tr>
 198       </table>
 199
 200     </td>
 201   </tr>
 202 <tr>
 203     <td width="15%" align="right" valign="top" class="summary">
 204       <span class="summary-type">&nbsp;</span>
 205     </td><td class="summary">
 206       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 207         <tr>
 208           <td><span class="summary-sig"><a name="__len__"></a><span class="summary-sig-name">__len__</span>(<span class="summary-sig-arg">self</span>)</span><br />
 209       Returns the number of subelements.</td>
 210           <td align="right" valign="top">
 211
 212
 213           </td>
 214         </tr>
 215       </table>
 216
 217     </td>
 218   </tr>
 219 <tr>
 220     <td width="15%" align="right" valign="top" class="summary">
 221       <span class="summary-type">a new object with type S, a subtype of T</span>
 222     </td><td class="summary">
 223       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 224         <tr>
 225           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 226         <span class="summary-sig-arg">S</span>,
 227         <span class="summary-sig-arg">...</span>)</span></td>
 228           <td align="right" valign="top">
 229
 230
 231           </td>
 232         </tr>
 233       </table>
 234
 235     </td>
 236   </tr>
 237 <tr>
 238     <td width="15%" align="right" valign="top" class="summary">
 239       <span class="summary-type">&nbsp;</span>
 240     </td><td class="summary">
 241       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 242         <tr>
 243           <td><span class="summary-sig"><a name="__nonzero__"></a><span class="summary-sig-name">__nonzero__</span>(<span class="summary-sig-arg">x</span>)</span><br />
 244       x != 0</td>
 245           <td align="right" valign="top">
 246
 247
 248           </td>
 249         </tr>
 250       </table>
 251
 252     </td>
 253   </tr>
 254 <tr>
 255     <td width="15%" align="right" valign="top" class="summary">
 256       <span class="summary-type">&nbsp;</span>
 257     </td><td class="summary">
 258       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 259         <tr>
 260           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 261       repr(x)</td>
 262           <td align="right" valign="top">
 263
 264
 265           </td>
 266         </tr>
 267       </table>
 268
 269     </td>
 270   </tr>
 271 <tr>
 272     <td width="15%" align="right" valign="top" class="summary">
 273       <span class="summary-type">&nbsp;</span>
 274     </td><td class="summary">
 275       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 276         <tr>
 277           <td><span class="summary-sig"><a name="__reversed__"></a><span class="summary-sig-name">__reversed__</span>(<span class="summary-sig-arg">self</span>)</span></td>
 278           <td align="right" valign="top">
 279
 280
 281           </td>
 282         </tr>
 283       </table>
 284
 285     </td>
 286   </tr>
 287 <tr>
 288     <td width="15%" align="right" valign="top" class="summary">
 289       <span class="summary-type">&nbsp;</span>
 290     </td><td class="summary">
 291       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 292         <tr>
 293           <td><span class="summary-sig"><a name="__setitem__"></a><span class="summary-sig-name">__setitem__</span>(<span class="summary-sig-arg">self</span>,
 294         <span class="summary-sig-arg">x</span>,
 295         <span class="summary-sig-arg">value</span>)</span><br />
 296       Replaces the given subelement index or slice.</td>
 297           <td align="right" valign="top">
 298
 299
 300           </td>
 301         </tr>
 302       </table>
 303
 304     </td>
 305   </tr>
 306 <tr class="private">
 307     <td width="15%" align="right" valign="top" class="summary">
 308       <span class="summary-type">&nbsp;</span>
 309     </td><td class="summary">
 310       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 311         <tr>
 312           <td><span class="summary-sig"><a name="_init"></a><span class="summary-sig-name">_init</span>(<span class="summary-sig-arg">self</span>)</span><br />
 313       Called after object initialisation.  Custom subclasses may override
 314 this if they recursively call _init() in the superclasses.</td>
 315           <td align="right" valign="top">
 316
 317
 318           </td>
 319         </tr>
 320       </table>
 321
 322     </td>
 323   </tr>
 324 <tr>
 325     <td width="15%" align="right" valign="top" class="summary">
 326       <span class="summary-type">&nbsp;</span>
 327     </td><td class="summary">
 328       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 329         <tr>
 330           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#addnext" class="summary-sig-name">addnext</a>(<span class="summary-sig-arg">self</span>,
 331         <span class="summary-sig-arg">element</span>)</span><br />
 332       Adds the element as a following sibling directly after this
 333 element.</td>
 334           <td align="right" valign="top">
 335
 336
 337           </td>
 338         </tr>
 339       </table>
 340
 341     </td>
 342   </tr>
 343 <tr>
 344     <td width="15%" align="right" valign="top" class="summary">
 345       <span class="summary-type">&nbsp;</span>
 346     </td><td class="summary">
 347       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 348         <tr>
 349           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#addprevious" class="summary-sig-name">addprevious</a>(<span class="summary-sig-arg">self</span>,
 350         <span class="summary-sig-arg">element</span>)</span><br />
 351       Adds the element as a preceding sibling directly before this
 352 element.</td>
 353           <td align="right" valign="top">
 354
 355
 356           </td>
 357         </tr>
 358       </table>
 359
 360     </td>
 361   </tr>
 362 <tr>
 363     <td width="15%" align="right" valign="top" class="summary">
 364       <span class="summary-type">&nbsp;</span>
 365     </td><td class="summary">
 366       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 367         <tr>
 368           <td><span class="summary-sig"><a name="append"></a><span class="summary-sig-name">append</span>(<span class="summary-sig-arg">self</span>,
 369         <span class="summary-sig-arg">element</span>)</span><br />
 370       Adds a subelement to the end of this element.</td>
 371           <td align="right" valign="top">
 372
 373
 374           </td>
 375         </tr>
 376       </table>
 377
 378     </td>
 379   </tr>
 380 <tr>
 381     <td width="15%" align="right" valign="top" class="summary">
 382       <span class="summary-type">&nbsp;</span>
 383     </td><td class="summary">
 384       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 385         <tr>
 386           <td><span class="summary-sig"><a name="clear"></a><span class="summary-sig-name">clear</span>(<span class="summary-sig-arg">self</span>)</span><br />
 387       Resets an element.  This function removes all subelements, clears
 388 all attributes and sets the text and tail properties to None.</td>
 389           <td align="right" valign="top">
 390
 391
 392           </td>
 393         </tr>
 394       </table>
 395
 396     </td>
 397   </tr>
 398 <tr>
 399     <td width="15%" align="right" valign="top" class="summary">
 400       <span class="summary-type">&nbsp;</span>
 401     </td><td class="summary">
 402       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 403         <tr>
 404           <td><span class="summary-sig"><a name="extend"></a><span class="summary-sig-name">extend</span>(<span class="summary-sig-arg">self</span>,
 405         <span class="summary-sig-arg">elements</span>)</span><br />
 406       Extends the current children by the elements in the iterable.</td>
 407           <td align="right" valign="top">
 408
 409
 410           </td>
 411         </tr>
 412       </table>
 413
 414     </td>
 415   </tr>
 416 <tr>
 417     <td width="15%" align="right" valign="top" class="summary">
 418       <span class="summary-type">&nbsp;</span>
 419     </td><td class="summary">
 420       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 421         <tr>
 422           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#find" class="summary-sig-name">find</a>(<span class="summary-sig-arg">self</span>,
 423         <span class="summary-sig-arg">path</span>,
 424         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 425       Finds the first matching subelement, by tag name or path.</td>
 426           <td align="right" valign="top">
 427
 428
 429           </td>
 430         </tr>
 431       </table>
 432
 433     </td>
 434   </tr>
 435 <tr>
 436     <td width="15%" align="right" valign="top" class="summary">
 437       <span class="summary-type">&nbsp;</span>
 438     </td><td class="summary">
 439       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 440         <tr>
 441           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#findall" class="summary-sig-name">findall</a>(<span class="summary-sig-arg">self</span>,
 442         <span class="summary-sig-arg">path</span>,
 443         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 444       Finds all matching subelements, by tag name or path.</td>
 445           <td align="right" valign="top">
 446
 447
 448           </td>
 449         </tr>
 450       </table>
 451
 452     </td>
 453   </tr>
 454 <tr>
 455     <td width="15%" align="right" valign="top" class="summary">
 456       <span class="summary-type">&nbsp;</span>
 457     </td><td class="summary">
 458       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 459         <tr>
 460           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#findtext" class="summary-sig-name">findtext</a>(<span class="summary-sig-arg">self</span>,
 461         <span class="summary-sig-arg">path</span>,
 462         <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>,
 463         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 464       Finds text for the first matching subelement, by tag name or path.</td>
 465           <td align="right" valign="top">
 466
 467
 468           </td>
 469         </tr>
 470       </table>
 471
 472     </td>
 473   </tr>
 474 <tr>
 475     <td width="15%" align="right" valign="top" class="summary">
 476       <span class="summary-type">&nbsp;</span>
 477     </td><td class="summary">
 478       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 479         <tr>
 480           <td><span class="summary-sig"><a name="get"></a><span class="summary-sig-name">get</span>(<span class="summary-sig-arg">self</span>,
 481         <span class="summary-sig-arg">key</span>,
 482         <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br />
 483       Gets an element attribute.</td>
 484           <td align="right" valign="top">
 485
 486
 487           </td>
 488         </tr>
 489       </table>
 490
 491     </td>
 492   </tr>
 493 <tr>
 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 href="lxml.etree._Element-class.html#getchildren" class="summary-sig-name">getchildren</a>(<span class="summary-sig-arg">self</span>)</span><br />
 500       Returns all direct children.  The elements are returned in document
 501 order.</td>
 502           <td align="right" valign="top">
 503
 504
 505           </td>
 506         </tr>
 507       </table>
 508
 509     </td>
 510   </tr>
 511 <tr>
 512     <td width="15%" align="right" valign="top" class="summary">
 513       <span class="summary-type">&nbsp;</span>
 514     </td><td class="summary">
 515       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 516         <tr>
 517           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#getiterator" class="summary-sig-name">getiterator</a>(<span class="summary-sig-arg">self</span>,
 518         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 519       Returns a sequence or iterator of all elements in the subtree in
 520 document order (depth first pre-order), starting with this
 521 element.</td>
 522           <td align="right" valign="top">
 523
 524
 525           </td>
 526         </tr>
 527       </table>
 528
 529     </td>
 530   </tr>
 531 <tr>
 532     <td width="15%" align="right" valign="top" class="summary">
 533       <span class="summary-type">&nbsp;</span>
 534     </td><td class="summary">
 535       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 536         <tr>
 537           <td><span class="summary-sig"><a name="getnext"></a><span class="summary-sig-name">getnext</span>(<span class="summary-sig-arg">self</span>)</span><br />
 538       Returns the following sibling of this element or None.</td>
 539           <td align="right" valign="top">
 540
 541
 542           </td>
 543         </tr>
 544       </table>
 545
 546     </td>
 547   </tr>
 548 <tr>
 549     <td width="15%" align="right" valign="top" class="summary">
 550       <span class="summary-type">&nbsp;</span>
 551     </td><td class="summary">
 552       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 553         <tr>
 554           <td><span class="summary-sig"><a name="getparent"></a><span class="summary-sig-name">getparent</span>(<span class="summary-sig-arg">self</span>)</span><br />
 555       Returns the parent of this element or None for the root element.</td>
 556           <td align="right" valign="top">
 557
 558
 559           </td>
 560         </tr>
 561       </table>
 562
 563     </td>
 564   </tr>
 565 <tr>
 566     <td width="15%" align="right" valign="top" class="summary">
 567       <span class="summary-type">&nbsp;</span>
 568     </td><td class="summary">
 569       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 570         <tr>
 571           <td><span class="summary-sig"><a name="getprevious"></a><span class="summary-sig-name">getprevious</span>(<span class="summary-sig-arg">self</span>)</span><br />
 572       Returns the preceding sibling of this element or None.</td>
 573           <td align="right" valign="top">
 574
 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.etree._Element-class.html#getroottree" class="summary-sig-name">getroottree</a>(<span class="summary-sig-arg">self</span>)</span><br />
 589       Return an ElementTree for the root node of the document that
 590 contains this element.</td>
 591           <td align="right" valign="top">
 592
 593
 594           </td>
 595         </tr>
 596       </table>
 597
 598     </td>
 599   </tr>
 600 <tr>
 601     <td width="15%" align="right" valign="top" class="summary">
 602       <span class="summary-type">&nbsp;</span>
 603     </td><td class="summary">
 604       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 605         <tr>
 606           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#index" class="summary-sig-name">index</a>(<span class="summary-sig-arg">self</span>,
 607         <span class="summary-sig-arg">child</span>,
 608         <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">None</span>,
 609         <span class="summary-sig-arg">stop</span>=<span class="summary-sig-default">None</span>)</span><br />
 610       Find the position of the child within the parent.</td>
 611           <td align="right" valign="top">
 612
 613
 614           </td>
 615         </tr>
 616       </table>
 617
 618     </td>
 619   </tr>
 620 <tr>
 621     <td width="15%" align="right" valign="top" class="summary">
 622       <span class="summary-type">&nbsp;</span>
 623     </td><td class="summary">
 624       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 625         <tr>
 626           <td><span class="summary-sig"><a name="insert"></a><span class="summary-sig-name">insert</span>(<span class="summary-sig-arg">self</span>,
 627         <span class="summary-sig-arg">index</span>,
 628         <span class="summary-sig-arg">element</span>)</span><br />
 629       Inserts a subelement at the given position in this element</td>
 630           <td align="right" valign="top">
 631
 632
 633           </td>
 634         </tr>
 635       </table>
 636
 637     </td>
 638   </tr>
 639 <tr>
 640     <td width="15%" align="right" valign="top" class="summary">
 641       <span class="summary-type">&nbsp;</span>
 642     </td><td class="summary">
 643       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 644         <tr>
 645           <td><span class="summary-sig"><a name="items"></a><span class="summary-sig-name">items</span>(<span class="summary-sig-arg">self</span>)</span><br />
 646       Gets element attributes, as a sequence. The attributes are returned in
 647 an arbitrary order.</td>
 648           <td align="right" valign="top">
 649
 650
 651           </td>
 652         </tr>
 653       </table>
 654
 655     </td>
 656   </tr>
 657 <tr>
 658     <td width="15%" align="right" valign="top" class="summary">
 659       <span class="summary-type">&nbsp;</span>
 660     </td><td class="summary">
 661       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 662         <tr>
 663           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#iter" class="summary-sig-name">iter</a>(<span class="summary-sig-arg">self</span>,
 664         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 665       Iterate over all elements in the subtree in document order (depth
 666 first pre-order), starting with this element.</td>
 667           <td align="right" valign="top">
 668
 669
 670           </td>
 671         </tr>
 672       </table>
 673
 674     </td>
 675   </tr>
 676 <tr>
 677     <td width="15%" align="right" valign="top" class="summary">
 678       <span class="summary-type">&nbsp;</span>
 679     </td><td class="summary">
 680       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 681         <tr>
 682           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#iterancestors" class="summary-sig-name">iterancestors</a>(<span class="summary-sig-arg">self</span>,
 683         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 684       Iterate over the ancestors of this element (from parent to parent).</td>
 685           <td align="right" valign="top">
 686
 687
 688           </td>
 689         </tr>
 690       </table>
 691
 692     </td>
 693   </tr>
 694 <tr>
 695     <td width="15%" align="right" valign="top" class="summary">
 696       <span class="summary-type">&nbsp;</span>
 697     </td><td class="summary">
 698       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 699         <tr>
 700           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#iterchildren" class="summary-sig-name">iterchildren</a>(<span class="summary-sig-arg">self</span>,
 701         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
 702         <span class="summary-sig-arg">reversed</span>=<span class="summary-sig-default">False</span>)</span><br />
 703       Iterate over the children of this element.</td>
 704           <td align="right" valign="top">
 705
 706
 707           </td>
 708         </tr>
 709       </table>
 710
 711     </td>
 712   </tr>
 713 <tr>
 714     <td width="15%" align="right" valign="top" class="summary">
 715       <span class="summary-type">&nbsp;</span>
 716     </td><td class="summary">
 717       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 718         <tr>
 719           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#iterdescendants" class="summary-sig-name">iterdescendants</a>(<span class="summary-sig-arg">self</span>,
 720         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 721       Iterate over the descendants of this element in document order.</td>
 722           <td align="right" valign="top">
 723
 724
 725           </td>
 726         </tr>
 727       </table>
 728
 729     </td>
 730   </tr>
 731 <tr>
 732     <td width="15%" align="right" valign="top" class="summary">
 733       <span class="summary-type">&nbsp;</span>
 734     </td><td class="summary">
 735       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 736         <tr>
 737           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#iterfind" class="summary-sig-name">iterfind</a>(<span class="summary-sig-arg">self</span>,
 738         <span class="summary-sig-arg">path</span>,
 739         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
 740       Iterates over all matching subelements, by tag name or path.</td>
 741           <td align="right" valign="top">
 742
 743
 744           </td>
 745         </tr>
 746       </table>
 747
 748     </td>
 749   </tr>
 750 <tr>
 751     <td width="15%" align="right" valign="top" class="summary">
 752       <span class="summary-type">&nbsp;</span>
 753     </td><td class="summary">
 754       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 755         <tr>
 756           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#itersiblings" class="summary-sig-name">itersiblings</a>(<span class="summary-sig-arg">self</span>,
 757         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
 758         <span class="summary-sig-arg">preceding</span>=<span class="summary-sig-default">False</span>)</span><br />
 759       Iterate over the following or preceding siblings of this element.</td>
 760           <td align="right" valign="top">
 761
 762
 763           </td>
 764         </tr>
 765       </table>
 766
 767     </td>
 768   </tr>
 769 <tr>
 770     <td width="15%" align="right" valign="top" class="summary">
 771       <span class="summary-type">&nbsp;</span>
 772     </td><td class="summary">
 773       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 774         <tr>
 775           <td><span class="summary-sig"><a href="lxml.etree._Element-class.html#itertext" class="summary-sig-name">itertext</a>(<span class="summary-sig-arg">self</span>,
 776         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
 777         <span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>)</span><br />
 778       Iterates over the text content of a subtree.</td>
 779           <td align="right" valign="top">
 780
 781
 782           </td>
 783         </tr>
 784       </table>
 785
 786     </td>
 787   </tr>
 788 <tr>
 789     <td width="15%" align="right" valign="top" class="summary">
 790       <span class="summary-type">&nbsp;</span>
 791     </td><td class="summary">
 792       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 793         <tr>
 794           <td><span class="summary-sig"><a name="keys"></a><span class="summary-sig-name">keys</span>(<span class="summary-sig-arg">self</span>)</span><br />
 795       Gets a list of attribute names.  The names are returned in an
 796 arbitrary order (just like for an ordinary Python dictionary).</td>
 797           <td align="right" valign="top">
 798
 799
 800           </td>
 801         </tr>
 802       </table>
 803
 804     </td>
 805   </tr>
 806 <tr>
 807     <td width="15%" align="right" valign="top" class="summary">
 808       <span class="summary-type">&nbsp;</span>
 809     </td><td class="summary">
 810       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 811         <tr>
 812           <td><span class="summary-sig"><a name="makeelement"></a><span class="summary-sig-name">makeelement</span>(<span class="summary-sig-arg">self</span>,
 813         <span class="summary-sig-arg">_tag</span>,
 814         <span class="summary-sig-arg">attrib</span>=<span class="summary-sig-default">None</span>,
 815         <span class="summary-sig-arg">nsmap</span>=<span class="summary-sig-default">None</span>,
 816         <span class="summary-sig-arg">**_extra</span>)</span><br />
 817       Creates a new element associated with the same document.</td>
 818           <td align="right" valign="top">
 819
 820
 821           </td>
 822         </tr>
 823       </table>
 824
 825     </td>
 826   </tr>
 827 <tr>
 828     <td width="15%" align="right" valign="top" class="summary">
 829       <span class="summary-type">&nbsp;</span>
 830     </td><td class="summary">
 831       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 832         <tr>
 833           <td><span class="summary-sig"><a name="remove"></a><span class="summary-sig-name">remove</span>(<span class="summary-sig-arg">self</span>,
 834         <span class="summary-sig-arg">element</span>)</span><br />
 835       Removes a matching subelement. Unlike the find methods, this
 836 method compares elements based on identity, not on tag value
 837 or contents.</td>
 838           <td align="right" valign="top">
 839
 840
 841           </td>
 842         </tr>
 843       </table>
 844
 845     </td>
 846   </tr>
 847 <tr>
 848     <td width="15%" align="right" valign="top" class="summary">
 849       <span class="summary-type">&nbsp;</span>
 850     </td><td class="summary">
 851       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 852         <tr>
 853           <td><span class="summary-sig"><a name="replace"></a><span class="summary-sig-name">replace</span>(<span class="summary-sig-arg">self</span>,
 854         <span class="summary-sig-arg">old_element</span>,
 855         <span class="summary-sig-arg">new_element</span>)</span><br />
 856       Replaces a subelement with the element passed as second argument.</td>
 857           <td align="right" valign="top">
 858
 859
 860           </td>
 861         </tr>
 862       </table>
 863
 864     </td>
 865   </tr>
 866 <tr>
 867     <td width="15%" align="right" valign="top" class="summary">
 868       <span class="summary-type">&nbsp;</span>
 869     </td><td class="summary">
 870       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 871         <tr>
 872           <td><span class="summary-sig"><a name="set"></a><span class="summary-sig-name">set</span>(<span class="summary-sig-arg">self</span>,
 873         <span class="summary-sig-arg">key</span>,
 874         <span class="summary-sig-arg">value</span>)</span><br />
 875       Sets an element attribute.</td>
 876           <td align="right" valign="top">
 877
 878
 879           </td>
 880         </tr>
 881       </table>
 882
 883     </td>
 884   </tr>
 885 <tr>
 886     <td width="15%" align="right" valign="top" class="summary">
 887       <span class="summary-type">&nbsp;</span>
 888     </td><td class="summary">
 889       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 890         <tr>
 891           <td><span class="summary-sig"><a name="values"></a><span class="summary-sig-name">values</span>(<span class="summary-sig-arg">self</span>)</span><br />
 892       Gets element attribute values as a sequence of strings.  The
 893 attributes are returned in an arbitrary order.</td>
 894           <td align="right" valign="top">
 895
 896
 897           </td>
 898         </tr>
 899       </table>
 900
 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       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 908         <tr>
 909           <td><span class="summary-sig"><a name="xpath"></a><span class="summary-sig-name">xpath</span>(<span class="summary-sig-arg">self</span>,
 910         <span class="summary-sig-arg">_path</span>,
 911         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>,
 912         <span class="summary-sig-arg">extensions</span>=<span class="summary-sig-default">None</span>,
 913         <span class="summary-sig-arg">smart_strings</span>=<span class="summary-sig-default">True</span>,
 914         <span class="summary-sig-arg">**_variables</span>)</span><br />
 915       Evaluate an xpath expression using the element as context node.</td>
 916           <td align="right" valign="top">
 917
 918
 919           </td>
 920         </tr>
 921       </table>
 922
 923     </td>
 924   </tr>
 925   <tr>
 926     <td colspan="2" class="summary">
 927     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 928       <code>__delattr__</code>,
 929       <code>__format__</code>,
 930       <code>__getattribute__</code>,
 931       <code>__hash__</code>,
 932       <code>__init__</code>,
 933       <code>__reduce__</code>,
 934       <code>__reduce_ex__</code>,
 935       <code>__setattr__</code>,
 936       <code>__sizeof__</code>,
 937       <code>__str__</code>,
 938       <code>__subclasshook__</code>
 939       </p>
 940     </td>
 941   </tr>
 942 </table>
 943 <!-- ==================== PROPERTIES ==================== -->
 944 <a name="section-Properties"></a>
 945 <table class="summary" border="1" cellpadding="3"
 946        cellspacing="0" width="100%" bgcolor="white">
 947 <tr bgcolor="#70b0f0" class="table-header">
 948   <td colspan="2" class="table-header">
 949     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 950       <tr valign="top">
 951         <td align="left"><span class="table-header">Properties</span></td>
 952         <td align="right" valign="top"
 953          ><span class="options">[<a href="#section-Properties"
 954          class="privatelink" onclick="toggle_private();"
 955          >hide private</a>]</span></td>
 956       </tr>
 957     </table>
 958   </td>
 959 </tr>
 960 <tr>
 961     <td width="15%" align="right" valign="top" class="summary">
 962       <span class="summary-type">&nbsp;</span>
 963     </td><td class="summary">
 964         <a name="attrib"></a><span class="summary-name">attrib</span><br />
 965       Element attribute dictionary. Where possible, use get(), set(),
 966 keys(), values() and items() to access element attributes.
 967     </td>
 968   </tr>
 969 <tr>
 970     <td width="15%" align="right" valign="top" class="summary">
 971       <span class="summary-type">&nbsp;</span>
 972     </td><td class="summary">
 973         <a href="lxml.etree._Element-class.html#base" class="summary-name">base</a><br />
 974       The base URI of the Element (xml:base or HTML base URL).
 975 None if the base URI is unknown.
 976     </td>
 977   </tr>
 978 <tr>
 979     <td width="15%" align="right" valign="top" class="summary">
 980       <span class="summary-type">&nbsp;</span>
 981     </td><td class="summary">
 982         <a href="lxml.etree._Element-class.html#nsmap" class="summary-name">nsmap</a><br />
 983       Namespace prefix-&gt;URI mapping known in the context of this
 984 Element.  This includes all namespace declarations of the
 985 parents.
 986     </td>
 987   </tr>
 988 <tr>
 989     <td width="15%" align="right" valign="top" class="summary">
 990       <span class="summary-type">&nbsp;</span>
 991     </td><td class="summary">
 992         <a name="prefix"></a><span class="summary-name">prefix</span><br />
 993       Namespace prefix or None.
 994     </td>
 995   </tr>
 996 <tr>
 997     <td width="15%" align="right" valign="top" class="summary">
 998       <span class="summary-type">&nbsp;</span>
 999     </td><td class="summary">
1000         <a name="sourceline"></a><span class="summary-name">sourceline</span><br />
1001       Original line number as found by the parser or None if unknown.
1002     </td>
1003   </tr>
1004 <tr>
1005     <td width="15%" align="right" valign="top" class="summary">
1006       <span class="summary-type">&nbsp;</span>
1007     </td><td class="summary">
1008         <a name="tag"></a><span class="summary-name">tag</span><br />
1009       Element tag
1010     </td>
1011   </tr>
1012 <tr>
1013     <td width="15%" align="right" valign="top" class="summary">
1014       <span class="summary-type">&nbsp;</span>
1015     </td><td class="summary">
1016         <a name="tail"></a><span class="summary-name">tail</span><br />
1017       Text after this element's end tag, but before the next sibling
1018 element's start tag. This is either a string or the value None, if
1019 there was no text.
1020     </td>
1021   </tr>
1022 <tr>
1023     <td width="15%" align="right" valign="top" class="summary">
1024       <span class="summary-type">&nbsp;</span>
1025     </td><td class="summary">
1026         <a name="text"></a><span class="summary-name">text</span><br />
1027       Text before the first subelement. This is either a string or
1028 the value None, if there was no text.
1029     </td>
1030   </tr>
1031   <tr>
1032     <td colspan="2" class="summary">
1033     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
1034       <code>__class__</code>
1035       </p>
1036     </td>
1037   </tr>
1038 </table>
1039 <!-- ==================== METHOD DETAILS ==================== -->
1040 <a name="section-MethodDetails"></a>
1041 <table class="details" border="1" cellpadding="3"
1042        cellspacing="0" width="100%" bgcolor="white">
1043 <tr bgcolor="#70b0f0" class="table-header">
1044   <td colspan="2" class="table-header">
1045     <table border="0" cellpadding="0" cellspacing="0" width="100%">
1046       <tr valign="top">
1047         <td align="left"><span class="table-header">Method Details</span></td>
1048         <td align="right" valign="top"
1049          ><span class="options">[<a href="#section-MethodDetails"
1050          class="privatelink" onclick="toggle_private();"
1051          >hide private</a>]</span></td>
1052       </tr>
1053     </table>
1054   </td>
1055 </tr>
1056 </table>
1057 <a name="__new__"></a>
1058 <div>
1059 <table class="details" border="1" cellpadding="3"
1060        cellspacing="0" width="100%" bgcolor="white">
1061 <tr><td>
1062   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1063   <tr valign="top"><td>
1064   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
1065         <span class="sig-arg">S</span>,
1066         <span class="sig-arg">...</span>)</span>
1067   </h3>
1068   </td><td align="right" valign="top"
1069     >&nbsp;
1070     </td>
1071   </tr></table>
1072
1073
1074   <dl class="fields">
1075     <dt>Returns: a new object with type S, a subtype of T</dt>
1076     <dt>Overrides:
1077         object.__new__
1078     </dt>
1079   </dl>
1080 </td></tr></table>
1081 </div>
1082 <a name="__repr__"></a>
1083 <div>
1084 <table class="details" border="1" cellpadding="3"
1085        cellspacing="0" width="100%" bgcolor="white">
1086 <tr><td>
1087   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1088   <tr valign="top"><td>
1089   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
1090     <br /><em class="fname">(Representation operator)</em>
1091   </h3>
1092   </td><td align="right" valign="top"
1093     >&nbsp;
1094     </td>
1095   </tr></table>
1096
1097   repr(x)
1098   <dl class="fields">
1099     <dt>Overrides:
1100         object.__repr__
1101     </dt>
1102   </dl>
1103 </td></tr></table>
1104 </div>
1105 <a name="addnext"></a>
1106 <div>
1107 <table class="details" border="1" cellpadding="3"
1108        cellspacing="0" width="100%" bgcolor="white">
1109 <tr><td>
1110   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1111   <tr valign="top"><td>
1112   <h3 class="epydoc"><span class="sig"><span class="sig-name">addnext</span>(<span class="sig-arg">self</span>,
1113         <span class="sig-arg">element</span>)</span>
1114   </h3>
1115   </td><td align="right" valign="top"
1116     >&nbsp;
1117     </td>
1118   </tr></table>
1119
1120   <p>Adds the element as a following sibling directly after this
1121 element.</p>
1122 <p>This is normally used to set a processing instruction or comment after
1123 the root node of a document.  Note that tail text is automatically
1124 discarded when adding at the root level.</p>
1125   <dl class="fields">
1126   </dl>
1127 </td></tr></table>
1128 </div>
1129 <a name="addprevious"></a>
1130 <div>
1131 <table class="details" border="1" cellpadding="3"
1132        cellspacing="0" width="100%" bgcolor="white">
1133 <tr><td>
1134   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1135   <tr valign="top"><td>
1136   <h3 class="epydoc"><span class="sig"><span class="sig-name">addprevious</span>(<span class="sig-arg">self</span>,
1137         <span class="sig-arg">element</span>)</span>
1138   </h3>
1139   </td><td align="right" valign="top"
1140     >&nbsp;
1141     </td>
1142   </tr></table>
1143
1144   <p>Adds the element as a preceding sibling directly before this
1145 element.</p>
1146 <p>This is normally used to set a processing instruction or comment
1147 before the root node of a document.  Note that tail text is
1148 automatically discarded when adding at the root level.</p>
1149   <dl class="fields">
1150   </dl>
1151 </td></tr></table>
1152 </div>
1153 <a name="find"></a>
1154 <div>
1155 <table class="details" border="1" cellpadding="3"
1156        cellspacing="0" width="100%" bgcolor="white">
1157 <tr><td>
1158   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1159   <tr valign="top"><td>
1160   <h3 class="epydoc"><span class="sig"><span class="sig-name">find</span>(<span class="sig-arg">self</span>,
1161         <span class="sig-arg">path</span>,
1162         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
1163   </h3>
1164   </td><td align="right" valign="top"
1165     >&nbsp;
1166     </td>
1167   </tr></table>
1168
1169   <p>Finds the first matching subelement, by tag name or path.</p>
1170 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
1171 prefix-to-namespace mapping that allows the usage of XPath
1172 prefixes in the path expression.</p>
1173   <dl class="fields">
1174   </dl>
1175 </td></tr></table>
1176 </div>
1177 <a name="findall"></a>
1178 <div>
1179 <table class="details" border="1" cellpadding="3"
1180        cellspacing="0" width="100%" bgcolor="white">
1181 <tr><td>
1182   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1183   <tr valign="top"><td>
1184   <h3 class="epydoc"><span class="sig"><span class="sig-name">findall</span>(<span class="sig-arg">self</span>,
1185         <span class="sig-arg">path</span>,
1186         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
1187   </h3>
1188   </td><td align="right" valign="top"
1189     >&nbsp;
1190     </td>
1191   </tr></table>
1192
1193   <p>Finds all matching subelements, by tag name or path.</p>
1194 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
1195 prefix-to-namespace mapping that allows the usage of XPath
1196 prefixes in the path expression.</p>
1197   <dl class="fields">
1198   </dl>
1199 </td></tr></table>
1200 </div>
1201 <a name="findtext"></a>
1202 <div>
1203 <table class="details" border="1" cellpadding="3"
1204        cellspacing="0" width="100%" bgcolor="white">
1205 <tr><td>
1206   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1207   <tr valign="top"><td>
1208   <h3 class="epydoc"><span class="sig"><span class="sig-name">findtext</span>(<span class="sig-arg">self</span>,
1209         <span class="sig-arg">path</span>,
1210         <span class="sig-arg">default</span>=<span class="sig-default">None</span>,
1211         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
1212   </h3>
1213   </td><td align="right" valign="top"
1214     >&nbsp;
1215     </td>
1216   </tr></table>
1217
1218   <p>Finds text for the first matching subelement, by tag name or path.</p>
1219 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
1220 prefix-to-namespace mapping that allows the usage of XPath
1221 prefixes in the path expression.</p>
1222   <dl class="fields">
1223   </dl>
1224 </td></tr></table>
1225 </div>
1226 <a name="getchildren"></a>
1227 <div>
1228 <table class="details" border="1" cellpadding="3"
1229        cellspacing="0" width="100%" bgcolor="white">
1230 <tr><td>
1231   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1232   <tr valign="top"><td>
1233   <h3 class="epydoc"><span class="sig"><span class="sig-name">getchildren</span>(<span class="sig-arg">self</span>)</span>
1234   </h3>
1235   </td><td align="right" valign="top"
1236     >&nbsp;
1237     </td>
1238   </tr></table>
1239
1240   Returns all direct children.  The elements are returned in document
1241 order.
1242   <dl class="fields">
1243   </dl>
1244 <div class="fields">      <p><strong>Deprecated:</strong>
1245         Note that this method has been deprecated as of
1246 ElementTree 1.3 and lxml 2.0.  New code should use
1247 <tt class="rst-rst-docutils literal rst-docutils literal">list(element)</tt> or simply iterate over elements.
1248       </p>
1249 </div></td></tr></table>
1250 </div>
1251 <a name="getiterator"></a>
1252 <div>
1253 <table class="details" border="1" cellpadding="3"
1254        cellspacing="0" width="100%" bgcolor="white">
1255 <tr><td>
1256   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1257   <tr valign="top"><td>
1258   <h3 class="epydoc"><span class="sig"><span class="sig-name">getiterator</span>(<span class="sig-arg">self</span>,
1259         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
1260   </h3>
1261   </td><td align="right" valign="top"
1262     >&nbsp;
1263     </td>
1264   </tr></table>
1265
1266   <p>Returns a sequence or iterator of all elements in the subtree in
1267 document order (depth first pre-order), starting with this
1268 element.</p>
1269 <p>Can be restricted to find only elements with a specific tag
1270 (pass <tt class="rst-docutils literal"><span class="pre">tag=&quot;xyz&quot;</span></tt>) or from a namespace (pass <tt class="rst-docutils literal"><span class="pre">tag=&quot;{ns}*&quot;</span></tt>).</p>
1271 <p>You can also pass the Element, Comment, ProcessingInstruction and
1272 Entity factory functions to look only for the specific element type.</p>
1273   <dl class="fields">
1274   </dl>
1275 <div class="fields">      <p><strong>Deprecated:</strong>
1276         Note that this method is deprecated as of
1277 ElementTree 1.3 and lxml 2.0.  It returns an iterator in
1278 lxml, which diverges from the original ElementTree
1279 behaviour.  If you want an efficient iterator, use the
1280 <tt class="rst-rst-docutils literal rst-docutils literal">element.iter()</tt> method instead.  You should only use this
1281 method in new code if you require backwards compatibility
1282 with older versions of lxml or ElementTree.
1283       </p>
1284 </div></td></tr></table>
1285 </div>
1286 <a name="getroottree"></a>
1287 <div>
1288 <table class="details" border="1" cellpadding="3"
1289        cellspacing="0" width="100%" bgcolor="white">
1290 <tr><td>
1291   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1292   <tr valign="top"><td>
1293   <h3 class="epydoc"><span class="sig"><span class="sig-name">getroottree</span>(<span class="sig-arg">self</span>)</span>
1294   </h3>
1295   </td><td align="right" valign="top"
1296     >&nbsp;
1297     </td>
1298   </tr></table>
1299
1300   <p>Return an ElementTree for the root node of the document that
1301 contains this element.</p>
1302 <p>This is the same as following element.getparent() up the tree until it
1303 returns None (for the root element) and then build an ElementTree for
1304 the last parent that was returned.</p>
1305   <dl class="fields">
1306   </dl>
1307 </td></tr></table>
1308 </div>
1309 <a name="index"></a>
1310 <div>
1311 <table class="details" border="1" cellpadding="3"
1312        cellspacing="0" width="100%" bgcolor="white">
1313 <tr><td>
1314   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1315   <tr valign="top"><td>
1316   <h3 class="epydoc"><span class="sig"><span class="sig-name">index</span>(<span class="sig-arg">self</span>,
1317         <span class="sig-arg">child</span>,
1318         <span class="sig-arg">start</span>=<span class="sig-default">None</span>,
1319         <span class="sig-arg">stop</span>=<span class="sig-default">None</span>)</span>
1320   </h3>
1321   </td><td align="right" valign="top"
1322     >&nbsp;
1323     </td>
1324   </tr></table>
1325
1326   <p>Find the position of the child within the parent.</p>
1327 <p>This method is not part of the original ElementTree API.</p>
1328   <dl class="fields">
1329   </dl>
1330 </td></tr></table>
1331 </div>
1332 <a name="iter"></a>
1333 <div>
1334 <table class="details" border="1" cellpadding="3"
1335        cellspacing="0" width="100%" bgcolor="white">
1336 <tr><td>
1337   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1338   <tr valign="top"><td>
1339   <h3 class="epydoc"><span class="sig"><span class="sig-name">iter</span>(<span class="sig-arg">self</span>,
1340         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
1341   </h3>
1342   </td><td align="right" valign="top"
1343     >&nbsp;
1344     </td>
1345   </tr></table>
1346
1347   <p>Iterate over all elements in the subtree in document order (depth
1348 first pre-order), starting with this element.</p>
1349 <p>Can be restricted to find only elements with a specific tag
1350 (pass <tt class="rst-docutils literal"><span class="pre">tag=&quot;xyz&quot;</span></tt>) or from a namespace (pass <tt class="rst-docutils literal"><span class="pre">tag=&quot;{ns}*&quot;</span></tt>).</p>
1351 <p>You can also pass the Element, Comment, ProcessingInstruction and
1352 Entity factory functions to look only for the specific element type.</p>
1353   <dl class="fields">
1354   </dl>
1355 </td></tr></table>
1356 </div>
1357 <a name="iterancestors"></a>
1358 <div>
1359 <table class="details" border="1" cellpadding="3"
1360        cellspacing="0" width="100%" bgcolor="white">
1361 <tr><td>
1362   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1363   <tr valign="top"><td>
1364   <h3 class="epydoc"><span class="sig"><span class="sig-name">iterancestors</span>(<span class="sig-arg">self</span>,
1365         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
1366   </h3>
1367   </td><td align="right" valign="top"
1368     >&nbsp;
1369     </td>
1370   </tr></table>
1371
1372   <p>Iterate over the ancestors of this element (from parent to parent).</p>
1373 <p>The generated elements can be restricted to a specific tag name with
1374 the 'tag' keyword.</p>
1375   <dl class="fields">
1376   </dl>
1377 </td></tr></table>
1378 </div>
1379 <a name="iterchildren"></a>
1380 <div>
1381 <table class="details" border="1" cellpadding="3"
1382        cellspacing="0" width="100%" bgcolor="white">
1383 <tr><td>
1384   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1385   <tr valign="top"><td>
1386   <h3 class="epydoc"><span class="sig"><span class="sig-name">iterchildren</span>(<span class="sig-arg">self</span>,
1387         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
1388         <span class="sig-arg">reversed</span>=<span class="sig-default">False</span>)</span>
1389   </h3>
1390   </td><td align="right" valign="top"
1391     >&nbsp;
1392     </td>
1393   </tr></table>
1394
1395   <p>Iterate over the children of this element.</p>
1396 <p>As opposed to using normal iteration on this element, the generated
1397 elements can be restricted to a specific tag name with the 'tag'
1398 keyword and reversed with the 'reversed' keyword.</p>
1399   <dl class="fields">
1400   </dl>
1401 </td></tr></table>
1402 </div>
1403 <a name="iterdescendants"></a>
1404 <div>
1405 <table class="details" border="1" cellpadding="3"
1406        cellspacing="0" width="100%" bgcolor="white">
1407 <tr><td>
1408   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1409   <tr valign="top"><td>
1410   <h3 class="epydoc"><span class="sig"><span class="sig-name">iterdescendants</span>(<span class="sig-arg">self</span>,
1411         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
1412   </h3>
1413   </td><td align="right" valign="top"
1414     >&nbsp;
1415     </td>
1416   </tr></table>
1417
1418   <p>Iterate over the descendants of this element in document order.</p>
1419 <p>As opposed to <tt class="rst-docutils literal">el.iter()</tt>, this iterator does not yield the element
1420 itself.  The generated elements can be restricted to a specific tag
1421 name with the 'tag' keyword.</p>
1422   <dl class="fields">
1423   </dl>
1424 </td></tr></table>
1425 </div>
1426 <a name="iterfind"></a>
1427 <div>
1428 <table class="details" border="1" cellpadding="3"
1429        cellspacing="0" width="100%" bgcolor="white">
1430 <tr><td>
1431   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1432   <tr valign="top"><td>
1433   <h3 class="epydoc"><span class="sig"><span class="sig-name">iterfind</span>(<span class="sig-arg">self</span>,
1434         <span class="sig-arg">path</span>,
1435         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
1436   </h3>
1437   </td><td align="right" valign="top"
1438     >&nbsp;
1439     </td>
1440   </tr></table>
1441
1442   <p>Iterates over all matching subelements, by tag name or path.</p>
1443 <p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
1444 prefix-to-namespace mapping that allows the usage of XPath
1445 prefixes in the path expression.</p>
1446   <dl class="fields">
1447   </dl>
1448 </td></tr></table>
1449 </div>
1450 <a name="itersiblings"></a>
1451 <div>
1452 <table class="details" border="1" cellpadding="3"
1453        cellspacing="0" width="100%" bgcolor="white">
1454 <tr><td>
1455   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1456   <tr valign="top"><td>
1457   <h3 class="epydoc"><span class="sig"><span class="sig-name">itersiblings</span>(<span class="sig-arg">self</span>,
1458         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
1459         <span class="sig-arg">preceding</span>=<span class="sig-default">False</span>)</span>
1460   </h3>
1461   </td><td align="right" valign="top"
1462     >&nbsp;
1463     </td>
1464   </tr></table>
1465
1466   <p>Iterate over the following or preceding siblings of this element.</p>
1467 <p>The direction is determined by the 'preceding' keyword which
1468 defaults to False, i.e. forward iteration over the following
1469 siblings.  When True, the iterator yields the preceding
1470 siblings in reverse document order, i.e. starting right before
1471 the current element and going left.  The generated elements
1472 can be restricted to a specific tag name with the 'tag'
1473 keyword.</p>
1474   <dl class="fields">
1475   </dl>
1476 </td></tr></table>
1477 </div>
1478 <a name="itertext"></a>
1479 <div>
1480 <table class="details" border="1" cellpadding="3"
1481        cellspacing="0" width="100%" bgcolor="white">
1482 <tr><td>
1483   <table width="100%" cellpadding="0" cellspacing="0" border="0">
1484   <tr valign="top"><td>
1485   <h3 class="epydoc"><span class="sig"><span class="sig-name">itertext</span>(<span class="sig-arg">self</span>,
1486         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
1487         <span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>)</span>
1488   </h3>
1489   </td><td align="right" valign="top"
1490     >&nbsp;
1491     </td>
1492   </tr></table>
1493
1494   <p>Iterates over the text content of a subtree.</p>
1495 <p>You can pass the <tt class="rst-docutils literal">tag</tt> keyword argument to restrict text content to
1496 a specific tag name.</p>
1497 <p>You can set the <tt class="rst-docutils literal">with_tail</tt> keyword argument to <tt class="rst-docutils literal">False</tt> to skip
1498 over tail text.</p>
1499   <dl class="fields">
1500   </dl>
1501 </td></tr></table>
1502 </div>
1503 <br />
1504 <!-- ==================== PROPERTY DETAILS ==================== -->
1505 <a name="section-PropertyDetails"></a>
1506 <table class="details" border="1" cellpadding="3"
1507        cellspacing="0" width="100%" bgcolor="white">
1508 <tr bgcolor="#70b0f0" class="table-header">
1509   <td colspan="2" class="table-header">
1510     <table border="0" cellpadding="0" cellspacing="0" width="100%">
1511       <tr valign="top">
1512         <td align="left"><span class="table-header">Property Details</span></td>
1513         <td align="right" valign="top"
1514          ><span class="options">[<a href="#section-PropertyDetails"
1515          class="privatelink" onclick="toggle_private();"
1516          >hide private</a>]</span></td>
1517       </tr>
1518     </table>
1519   </td>
1520 </tr>
1521 </table>
1522 <a name="base"></a>
1523 <div>
1524 <table class="details" border="1" cellpadding="3"
1525        cellspacing="0" width="100%" bgcolor="white">
1526 <tr><td>
1527   <h3 class="epydoc">base</h3>
1528   <p>The base URI of the Element (xml:base or HTML base URL).
1529 None if the base URI is unknown.</p>
1530 <p>Note that the value depends on the URL of the document that
1531 holds the Element if there is no xml:base attribute on the
1532 Element or its ancestors.</p>
1533 <p>Setting this property will set an xml:base attribute on the
1534 Element, regardless of the document type (XML or HTML).</p>
1535   <dl class="fields">
1536   </dl>
1537 </td></tr></table>
1538 </div>
1539 <a name="nsmap"></a>
1540 <div>
1541 <table class="details" border="1" cellpadding="3"
1542        cellspacing="0" width="100%" bgcolor="white">
1543 <tr><td>
1544   <h3 class="epydoc">nsmap</h3>
1545   <p>Namespace prefix-&gt;URI mapping known in the context of this
1546 Element.  This includes all namespace declarations of the
1547 parents.</p>
1548 <p>Note that changing the returned dict has no effect on the Element.</p>
1549   <dl class="fields">
1550   </dl>
1551 </td></tr></table>
1552 </div>
1553 <br />
1554 <!-- ==================== NAVIGATION BAR ==================== -->
1555 <table class="navbar" border="0" width="100%" cellpadding="0"
1556        bgcolor="#a0c0ff" cellspacing="0">
1557   <tr valign="middle">
1558   <!-- Home link -->
1559       <th>&nbsp;&nbsp;&nbsp;<a
1560         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1561
1562   <!-- Tree link -->
1563       <th>&nbsp;&nbsp;&nbsp;<a
1564         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1565
1566   <!-- Index link -->
1567       <th>&nbsp;&nbsp;&nbsp;<a
1568         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1569
1570   <!-- Help link -->
1571       <th>&nbsp;&nbsp;&nbsp;<a
1572         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1573
1574   <!-- Project homepage -->
1575       <th class="navbar" align="right" width="100%">
1576         <table border="0" cellpadding="0" cellspacing="0">
1577           <tr><th class="navbar" align="center"
1578             ><a class="navbar" target="_top" href="/">lxml API</a></th>
1579           </tr></table></th>
1580   </tr>
1581 </table>
1582 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
1583   <tr>
1584     <td align="left" class="footer">
1585     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
1586     </td>
1587     <td align="right" class="footer">
1588       <a target="mainFrame" href="http://epydoc.sourceforge.net"
1589         >http://epydoc.sourceforge.net</a>
1590     </td>
1591   </tr>
1592 </table>
1593
1594 <script type="text/javascript">
1595   <!--
1596   // Private objects are initially displayed (because if
1597   // javascript is turned off then we want them to be
1598   // visible); but by default, we want to hide them.  So hide
1599   // them unless we have a cookie that says to show them.
1600   checkCookie();
1601   // -->
1602 </script>
1603 </body>
1604 </html>