doc/html/api/lxml.etree.ElementDepthFirstIterator-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.ElementDepthFirstIterator</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;ElementDepthFirstIterator
  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.ElementDepthFirstIterator-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 ElementDepthFirstIterator</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66         object --+
  67                  |
  68 <a href="lxml.etree._ElementTagMatcher-class.html" onclick="show_private();">_ElementTagMatcher</a> --+
  69                      |
  70                     <strong class="uidshort">ElementDepthFirstIterator</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>ElementDepthFirstIterator(self, node, tag=None, inclusive=True)
  75 Iterates over an element and its sub-elements in document order (depth
  76 first pre-order).</p>
  77 <p>Note that this also includes comments, entities and processing
  78 instructions.  To filter them out, check if the <tt class="rst-docutils literal">tag</tt> property
  79 of the returned element is a string (i.e. not None and not a
  80 factory function), or pass the <tt class="rst-docutils literal">Element</tt> factory for the <tt class="rst-docutils literal">tag</tt>
  81 keyword.</p>
  82 <p>If the optional <tt class="rst-docutils literal">tag</tt> argument is not None, the iterator returns only
  83 the elements that match the respective name and namespace.</p>
  84 <p>The optional boolean argument 'inclusive' defaults to True and can be set
  85 to False to exclude the start element itself.</p>
  86 <p>Note that the behaviour of this iterator is completely undefined if the
  87 tree it traverses is modified during iteration.</p>
  88
  89 <!-- ==================== INSTANCE METHODS ==================== -->
  90 <a name="section-InstanceMethods"></a>
  91 <table class="summary" border="1" cellpadding="3"
  92        cellspacing="0" width="100%" bgcolor="white">
  93 <tr bgcolor="#70b0f0" class="table-header">
  94   <td colspan="2" class="table-header">
  95     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  96       <tr valign="top">
  97         <td align="left"><span class="table-header">Instance Methods</span></td>
  98         <td align="right" valign="top"
  99          ><span class="options">[<a href="#section-InstanceMethods"
 100          class="privatelink" onclick="toggle_private();"
 101          >hide private</a>]</span></td>
 102       </tr>
 103     </table>
 104   </td>
 105 </tr>
 106 <tr>
 107     <td width="15%" align="right" valign="top" class="summary">
 108       <span class="summary-type">&nbsp;</span>
 109     </td><td class="summary">
 110       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 111         <tr>
 112           <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">x</span>)</span><br />
 113       iter(x)</td>
 114           <td align="right" valign="top">
 115
 116
 117           </td>
 118         </tr>
 119       </table>
 120
 121     </td>
 122   </tr>
 123 <tr>
 124     <td width="15%" align="right" valign="top" class="summary">
 125       <span class="summary-type">a new object with type S, a subtype of T</span>
 126     </td><td class="summary">
 127       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 128         <tr>
 129           <td><span class="summary-sig"><a href="lxml.etree.ElementDepthFirstIterator-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 130         <span class="summary-sig-arg">S</span>,
 131         <span class="summary-sig-arg">...</span>)</span></td>
 132           <td align="right" valign="top">
 133
 134
 135           </td>
 136         </tr>
 137       </table>
 138
 139     </td>
 140   </tr>
 141 <tr>
 142     <td width="15%" align="right" valign="top" class="summary">
 143       <span class="summary-type">&nbsp;</span>
 144     </td><td class="summary">
 145       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 146         <tr>
 147           <td><span class="summary-sig"><a name="__next__"></a><span class="summary-sig-name">__next__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 148           <td align="right" valign="top">
 149
 150
 151           </td>
 152         </tr>
 153       </table>
 154
 155     </td>
 156   </tr>
 157 <tr>
 158     <td width="15%" align="right" valign="top" class="summary">
 159       <span class="summary-type">the next value, or raise StopIteration</span>
 160     </td><td class="summary">
 161       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 162         <tr>
 163           <td><span class="summary-sig"><a name="next"></a><span class="summary-sig-name">next</span>(<span class="summary-sig-arg">x</span>)</span></td>
 164           <td align="right" valign="top">
 165
 166
 167           </td>
 168         </tr>
 169       </table>
 170
 171     </td>
 172   </tr>
 173   <tr>
 174     <td colspan="2" class="summary">
 175     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 176       <code>__delattr__</code>,
 177       <code>__format__</code>,
 178       <code>__getattribute__</code>,
 179       <code>__hash__</code>,
 180       <code>__init__</code>,
 181       <code>__reduce__</code>,
 182       <code>__reduce_ex__</code>,
 183       <code>__repr__</code>,
 184       <code>__setattr__</code>,
 185       <code>__sizeof__</code>,
 186       <code>__str__</code>,
 187       <code>__subclasshook__</code>
 188       </p>
 189     </td>
 190   </tr>
 191 </table>
 192 <!-- ==================== PROPERTIES ==================== -->
 193 <a name="section-Properties"></a>
 194 <table class="summary" border="1" cellpadding="3"
 195        cellspacing="0" width="100%" bgcolor="white">
 196 <tr bgcolor="#70b0f0" class="table-header">
 197   <td colspan="2" class="table-header">
 198     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 199       <tr valign="top">
 200         <td align="left"><span class="table-header">Properties</span></td>
 201         <td align="right" valign="top"
 202          ><span class="options">[<a href="#section-Properties"
 203          class="privatelink" onclick="toggle_private();"
 204          >hide private</a>]</span></td>
 205       </tr>
 206     </table>
 207   </td>
 208 </tr>
 209   <tr>
 210     <td colspan="2" class="summary">
 211     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 212       <code>__class__</code>
 213       </p>
 214     </td>
 215   </tr>
 216 </table>
 217 <!-- ==================== METHOD DETAILS ==================== -->
 218 <a name="section-MethodDetails"></a>
 219 <table class="details" border="1" cellpadding="3"
 220        cellspacing="0" width="100%" bgcolor="white">
 221 <tr bgcolor="#70b0f0" class="table-header">
 222   <td colspan="2" class="table-header">
 223     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 224       <tr valign="top">
 225         <td align="left"><span class="table-header">Method Details</span></td>
 226         <td align="right" valign="top"
 227          ><span class="options">[<a href="#section-MethodDetails"
 228          class="privatelink" onclick="toggle_private();"
 229          >hide private</a>]</span></td>
 230       </tr>
 231     </table>
 232   </td>
 233 </tr>
 234 </table>
 235 <a name="__new__"></a>
 236 <div>
 237 <table class="details" border="1" cellpadding="3"
 238        cellspacing="0" width="100%" bgcolor="white">
 239 <tr><td>
 240   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 241   <tr valign="top"><td>
 242   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 243         <span class="sig-arg">S</span>,
 244         <span class="sig-arg">...</span>)</span>
 245   </h3>
 246   </td><td align="right" valign="top"
 247     >&nbsp;
 248     </td>
 249   </tr></table>
 250
 251
 252   <dl class="fields">
 253     <dt>Returns: a new object with type S, a subtype of T</dt>
 254     <dt>Overrides:
 255         object.__new__
 256     </dt>
 257   </dl>
 258 </td></tr></table>
 259 </div>
 260 <br />
 261 <!-- ==================== NAVIGATION BAR ==================== -->
 262 <table class="navbar" border="0" width="100%" cellpadding="0"
 263        bgcolor="#a0c0ff" cellspacing="0">
 264   <tr valign="middle">
 265   <!-- Home link -->
 266       <th>&nbsp;&nbsp;&nbsp;<a
 267         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 268
 269   <!-- Tree link -->
 270       <th>&nbsp;&nbsp;&nbsp;<a
 271         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 272
 273   <!-- Index link -->
 274       <th>&nbsp;&nbsp;&nbsp;<a
 275         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 276
 277   <!-- Help link -->
 278       <th>&nbsp;&nbsp;&nbsp;<a
 279         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 280
 281   <!-- Project homepage -->
 282       <th class="navbar" align="right" width="100%">
 283         <table border="0" cellpadding="0" cellspacing="0">
 284           <tr><th class="navbar" align="center"
 285             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 286           </tr></table></th>
 287   </tr>
 288 </table>
 289 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 290   <tr>
 291     <td align="left" class="footer">
 292     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 293     </td>
 294     <td align="right" class="footer">
 295       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 296         >http://epydoc.sourceforge.net</a>
 297     </td>
 298   </tr>
 299 </table>
 300
 301 <script type="text/javascript">
 302   <!--
 303   // Private objects are initially displayed (because if
 304   // javascript is turned off then we want them to be
 305   // visible); but by default, we want to hide them.  So hide
 306   // them unless we have a cookie that says to show them.
 307   checkCookie();
 308   // -->
 309 </script>
 310 </body>
 311 </html>