doc/html/api/xml.etree.ElementTree.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>xml.etree.ElementTree.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         xml ::
  46         etree ::
  47         ElementTree ::
  48         ElementTree ::
  49         Class&nbsp;ElementTree
  50       </span>
  51     </td>
  52     <td>
  53       <table cellpadding="0" cellspacing="0">
  54         <!-- hide/show private -->
  55         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  56     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  57         <tr><td align="right"><span class="options"
  58             >[<a href="frames.html" target="_top">frames</a
  59             >]&nbsp;|&nbsp;<a href="xml.etree.ElementTree.ElementTree-class.html"
  60             target="_top">no&nbsp;frames</a>]</span></td></tr>
  61       </table>
  62     </td>
  63   </tr>
  64 </table>
  65 <!-- ==================== CLASS DESCRIPTION ==================== -->
  66 <h1 class="epydoc">Class ElementTree</h1><p class="nomargin-top"><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree">source&nbsp;code</a></span></p>
  67 <pre class="base-tree">
  68 object --+
  69          |
  70         <strong class="uidshort">ElementTree</strong>
  71 </pre>
  72
  73 <hr />
  74 <!-- ==================== INSTANCE METHODS ==================== -->
  75 <a name="section-InstanceMethods"></a>
  76 <table class="summary" border="1" cellpadding="3"
  77        cellspacing="0" width="100%" bgcolor="white">
  78 <tr bgcolor="#70b0f0" class="table-header">
  79   <td colspan="2" class="table-header">
  80     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  81       <tr valign="top">
  82         <td align="left"><span class="table-header">Instance Methods</span></td>
  83         <td align="right" valign="top"
  84          ><span class="options">[<a href="#section-InstanceMethods"
  85          class="privatelink" onclick="toggle_private();"
  86          >hide private</a>]</span></td>
  87       </tr>
  88     </table>
  89   </td>
  90 </tr>
  91 <tr>
  92     <td width="15%" align="right" valign="top" class="summary">
  93       <span class="summary-type">&nbsp;</span>
  94     </td><td class="summary">
  95       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  96         <tr>
  97           <td><span class="summary-sig"><a href="xml.etree.ElementTree.ElementTree-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  98         <span class="summary-sig-arg">element</span>=<span class="summary-sig-default">None</span>,
  99         <span class="summary-sig-arg">file</span>=<span class="summary-sig-default">None</span>)</span><br />
 100       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 101           <td align="right" valign="top">
 102             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.__init__">source&nbsp;code</a></span>
 103
 104           </td>
 105         </tr>
 106       </table>
 107
 108     </td>
 109   </tr>
 110 <tr class="private">
 111     <td width="15%" align="right" valign="top" class="summary">
 112       <span class="summary-type">&nbsp;</span>
 113     </td><td class="summary">
 114       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 115         <tr>
 116           <td><span class="summary-sig"><a name="_setroot"></a><span class="summary-sig-name">_setroot</span>(<span class="summary-sig-arg">self</span>,
 117         <span class="summary-sig-arg">element</span>)</span></td>
 118           <td align="right" valign="top">
 119             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree._setroot">source&nbsp;code</a></span>
 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">&nbsp;</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 name="find"></a><span class="summary-sig-name">find</span>(<span class="summary-sig-arg">self</span>,
 134         <span class="summary-sig-arg">path</span>,
 135         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
 136           <td align="right" valign="top">
 137             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.find">source&nbsp;code</a></span>
 138
 139           </td>
 140         </tr>
 141       </table>
 142
 143     </td>
 144   </tr>
 145 <tr>
 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="findall"></a><span class="summary-sig-name">findall</span>(<span class="summary-sig-arg">self</span>,
 152         <span class="summary-sig-arg">path</span>,
 153         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
 154           <td align="right" valign="top">
 155             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.findall">source&nbsp;code</a></span>
 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 name="findtext"></a><span class="summary-sig-name">findtext</span>(<span class="summary-sig-arg">self</span>,
 170         <span class="summary-sig-arg">path</span>,
 171         <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>,
 172         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
 173           <td align="right" valign="top">
 174             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.findtext">source&nbsp;code</a></span>
 175
 176           </td>
 177         </tr>
 178       </table>
 179
 180     </td>
 181   </tr>
 182 <tr>
 183     <td width="15%" align="right" valign="top" class="summary">
 184       <span class="summary-type">&nbsp;</span>
 185     </td><td class="summary">
 186       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 187         <tr>
 188           <td><span class="summary-sig"><a name="getiterator"></a><span class="summary-sig-name">getiterator</span>(<span class="summary-sig-arg">self</span>,
 189         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span></td>
 190           <td align="right" valign="top">
 191             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.getiterator">source&nbsp;code</a></span>
 192
 193           </td>
 194         </tr>
 195       </table>
 196
 197     </td>
 198   </tr>
 199 <tr>
 200     <td width="15%" align="right" valign="top" class="summary">
 201       <span class="summary-type">&nbsp;</span>
 202     </td><td class="summary">
 203       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 204         <tr>
 205           <td><span class="summary-sig"><a name="getroot"></a><span class="summary-sig-name">getroot</span>(<span class="summary-sig-arg">self</span>)</span></td>
 206           <td align="right" valign="top">
 207             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.getroot">source&nbsp;code</a></span>
 208
 209           </td>
 210         </tr>
 211       </table>
 212
 213     </td>
 214   </tr>
 215 <tr>
 216     <td width="15%" align="right" valign="top" class="summary">
 217       <span class="summary-type">&nbsp;</span>
 218     </td><td class="summary">
 219       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 220         <tr>
 221           <td><span class="summary-sig"><a name="iter"></a><span class="summary-sig-name">iter</span>(<span class="summary-sig-arg">self</span>,
 222         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span></td>
 223           <td align="right" valign="top">
 224             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.iter">source&nbsp;code</a></span>
 225
 226           </td>
 227         </tr>
 228       </table>
 229
 230     </td>
 231   </tr>
 232 <tr>
 233     <td width="15%" align="right" valign="top" class="summary">
 234       <span class="summary-type">&nbsp;</span>
 235     </td><td class="summary">
 236       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 237         <tr>
 238           <td><span class="summary-sig"><a name="iterfind"></a><span class="summary-sig-name">iterfind</span>(<span class="summary-sig-arg">self</span>,
 239         <span class="summary-sig-arg">path</span>,
 240         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
 241           <td align="right" valign="top">
 242             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.iterfind">source&nbsp;code</a></span>
 243
 244           </td>
 245         </tr>
 246       </table>
 247
 248     </td>
 249   </tr>
 250 <tr>
 251     <td width="15%" align="right" valign="top" class="summary">
 252       <span class="summary-type">&nbsp;</span>
 253     </td><td class="summary">
 254       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 255         <tr>
 256           <td><span class="summary-sig"><a name="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">self</span>,
 257         <span class="summary-sig-arg">source</span>,
 258         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span></td>
 259           <td align="right" valign="top">
 260             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.parse">source&nbsp;code</a></span>
 261
 262           </td>
 263         </tr>
 264       </table>
 265
 266     </td>
 267   </tr>
 268 <tr>
 269     <td width="15%" align="right" valign="top" class="summary">
 270       <span class="summary-type">&nbsp;</span>
 271     </td><td class="summary">
 272       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 273         <tr>
 274           <td><span class="summary-sig"><a name="write"></a><span class="summary-sig-name">write</span>(<span class="summary-sig-arg">self</span>,
 275         <span class="summary-sig-arg">file_or_filename</span>,
 276         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
 277         <span class="summary-sig-arg">xml_declaration</span>=<span class="summary-sig-default">None</span>,
 278         <span class="summary-sig-arg">default_namespace</span>=<span class="summary-sig-default">None</span>,
 279         <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">None</span>)</span></td>
 280           <td align="right" valign="top">
 281             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.write">source&nbsp;code</a></span>
 282
 283           </td>
 284         </tr>
 285       </table>
 286
 287     </td>
 288   </tr>
 289 <tr>
 290     <td width="15%" align="right" valign="top" class="summary">
 291       <span class="summary-type">&nbsp;</span>
 292     </td><td class="summary">
 293       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 294         <tr>
 295           <td><span class="summary-sig"><a name="write_c14n"></a><span class="summary-sig-name">write_c14n</span>(<span class="summary-sig-arg">self</span>,
 296         <span class="summary-sig-arg">file</span>)</span></td>
 297           <td align="right" valign="top">
 298             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.write_c14n">source&nbsp;code</a></span>
 299
 300           </td>
 301         </tr>
 302       </table>
 303
 304     </td>
 305   </tr>
 306   <tr>
 307     <td colspan="2" class="summary">
 308     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 309       <code>__delattr__</code>,
 310       <code>__format__</code>,
 311       <code>__getattribute__</code>,
 312       <code>__hash__</code>,
 313       <code>__new__</code>,
 314       <code>__reduce__</code>,
 315       <code>__reduce_ex__</code>,
 316       <code>__repr__</code>,
 317       <code>__setattr__</code>,
 318       <code>__sizeof__</code>,
 319       <code>__str__</code>,
 320       <code>__subclasshook__</code>
 321       </p>
 322     </td>
 323   </tr>
 324 </table>
 325 <!-- ==================== PROPERTIES ==================== -->
 326 <a name="section-Properties"></a>
 327 <table class="summary" border="1" cellpadding="3"
 328        cellspacing="0" width="100%" bgcolor="white">
 329 <tr bgcolor="#70b0f0" class="table-header">
 330   <td colspan="2" class="table-header">
 331     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 332       <tr valign="top">
 333         <td align="left"><span class="table-header">Properties</span></td>
 334         <td align="right" valign="top"
 335          ><span class="options">[<a href="#section-Properties"
 336          class="privatelink" onclick="toggle_private();"
 337          >hide private</a>]</span></td>
 338       </tr>
 339     </table>
 340   </td>
 341 </tr>
 342   <tr>
 343     <td colspan="2" class="summary">
 344     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 345       <code>__class__</code>
 346       </p>
 347     </td>
 348   </tr>
 349 </table>
 350 <!-- ==================== METHOD DETAILS ==================== -->
 351 <a name="section-MethodDetails"></a>
 352 <table class="details" border="1" cellpadding="3"
 353        cellspacing="0" width="100%" bgcolor="white">
 354 <tr bgcolor="#70b0f0" class="table-header">
 355   <td colspan="2" class="table-header">
 356     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 357       <tr valign="top">
 358         <td align="left"><span class="table-header">Method Details</span></td>
 359         <td align="right" valign="top"
 360          ><span class="options">[<a href="#section-MethodDetails"
 361          class="privatelink" onclick="toggle_private();"
 362          >hide private</a>]</span></td>
 363       </tr>
 364     </table>
 365   </td>
 366 </tr>
 367 </table>
 368 <a name="__init__"></a>
 369 <div>
 370 <table class="details" border="1" cellpadding="3"
 371        cellspacing="0" width="100%" bgcolor="white">
 372 <tr><td>
 373   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 374   <tr valign="top"><td>
 375   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 376         <span class="sig-arg">element</span>=<span class="sig-default">None</span>,
 377         <span class="sig-arg">file</span>=<span class="sig-default">None</span>)</span>
 378     <br /><em class="fname">(Constructor)</em>
 379   </h3>
 380   </td><td align="right" valign="top"
 381     ><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.__init__">source&nbsp;code</a></span>&nbsp;
 382     </td>
 383   </tr></table>
 384
 385   x.__init__(...) initializes x; see help(type(x)) for signature
 386   <dl class="fields">
 387     <dt>Overrides:
 388         object.__init__
 389         <dd><em class="note">(inherited documentation)</em></dd>
 390     </dt>
 391   </dl>
 392 </td></tr></table>
 393 </div>
 394 <br />
 395 <!-- ==================== NAVIGATION BAR ==================== -->
 396 <table class="navbar" border="0" width="100%" cellpadding="0"
 397        bgcolor="#a0c0ff" cellspacing="0">
 398   <tr valign="middle">
 399   <!-- Home link -->
 400       <th>&nbsp;&nbsp;&nbsp;<a
 401         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 402
 403   <!-- Tree link -->
 404       <th>&nbsp;&nbsp;&nbsp;<a
 405         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 406
 407   <!-- Index link -->
 408       <th>&nbsp;&nbsp;&nbsp;<a
 409         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 410
 411   <!-- Help link -->
 412       <th>&nbsp;&nbsp;&nbsp;<a
 413         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 414
 415   <!-- Project homepage -->
 416       <th class="navbar" align="right" width="100%">
 417         <table border="0" cellpadding="0" cellspacing="0">
 418           <tr><th class="navbar" align="center"
 419             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 420           </tr></table></th>
 421   </tr>
 422 </table>
 423 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 424   <tr>
 425     <td align="left" class="footer">
 426     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:20 2012
 427     </td>
 428     <td align="right" class="footer">
 429       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 430         >http://epydoc.sourceforge.net</a>
 431     </td>
 432   </tr>
 433 </table>
 434
 435 <script type="text/javascript">
 436   <!--
 437   // Private objects are initially displayed (because if
 438   // javascript is turned off then we want them to be
 439   // visible); but by default, we want to hide them.  So hide
 440   // them unless we have a cookie that says to show them.
 441   checkCookie();
 442   // -->
 443 </script>
 444 </body>
 445 </html>