doc/html/api/lxml.etree.iterwalk-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.iterwalk</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;iterwalk
  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.iterwalk-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 iterwalk</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">iterwalk</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>iterwalk(self, element_or_tree, events=(&quot;end&quot;,), tag=None)</p>
  73 <p>A tree walker that generates events from an existing tree as if it
  74 was parsing XML data with <tt class="rst-docutils literal">iterparse()</tt>.</p>
  75 <p>Just as for <tt class="rst-docutils literal">iterparse()</tt>, the <tt class="rst-docutils literal">tag</tt> argument can be a single tag or a
  76 sequence of tags.</p>
  77 <p>After receiving a 'start' or 'start-ns' event, the children and
  78 descendants of the current element can be excluded from iteration
  79 by calling the <tt class="rst-docutils literal">skip_subtree()</tt> method.</p>
  80
  81 <!-- ==================== INSTANCE METHODS ==================== -->
  82 <a name="section-InstanceMethods"></a>
  83 <table class="summary" border="1" cellpadding="3"
  84        cellspacing="0" width="100%" bgcolor="white">
  85 <tr bgcolor="#70b0f0" class="table-header">
  86   <td colspan="2" class="table-header">
  87     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  88       <tr valign="top">
  89         <td align="left"><span class="table-header">Instance Methods</span></td>
  90         <td align="right" valign="top"
  91          ><span class="options">[<a href="#section-InstanceMethods"
  92          class="privatelink" onclick="toggle_private();"
  93          >hide private</a>]</span></td>
  94       </tr>
  95     </table>
  96   </td>
  97 </tr>
  98 <tr>
  99     <td width="15%" align="right" valign="top" class="summary">
 100       <span class="summary-type">&nbsp;</span>
 101     </td><td class="summary">
 102       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 103         <tr>
 104           <td><span class="summary-sig"><a href="lxml.etree.iterwalk-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 105         <span class="summary-sig-arg">element_or_tree</span>,
 106         <span class="summary-sig-arg">events</span>=<span class="summary-sig-default">(&quot;end&quot;</span>,
 107         <span class="summary-sig-arg">)</span>,
 108         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 109       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 110           <td align="right" valign="top">
 111
 112
 113           </td>
 114         </tr>
 115       </table>
 116
 117     </td>
 118   </tr>
 119 <tr>
 120     <td width="15%" align="right" valign="top" class="summary">
 121       <span class="summary-type">&nbsp;</span>
 122     </td><td class="summary">
 123       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 124         <tr>
 125           <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 />
 126       iter(x)</td>
 127           <td align="right" valign="top">
 128
 129
 130           </td>
 131         </tr>
 132       </table>
 133
 134     </td>
 135   </tr>
 136 <tr>
 137     <td width="15%" align="right" valign="top" class="summary">
 138       <span class="summary-type">a new object with type S, a subtype of T</span>
 139     </td><td class="summary">
 140       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 141         <tr>
 142           <td><span class="summary-sig"><a href="lxml.etree.iterwalk-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 143         <span class="summary-sig-arg">S</span>,
 144         <span class="summary-sig-arg">...</span>)</span></td>
 145           <td align="right" valign="top">
 146
 147
 148           </td>
 149         </tr>
 150       </table>
 151
 152     </td>
 153   </tr>
 154 <tr>
 155     <td width="15%" align="right" valign="top" class="summary">
 156       <span class="summary-type">&nbsp;</span>
 157     </td><td class="summary">
 158       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 159         <tr>
 160           <td><span class="summary-sig"><a name="__next__"></a><span class="summary-sig-name">__next__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 161           <td align="right" valign="top">
 162
 163
 164           </td>
 165         </tr>
 166       </table>
 167
 168     </td>
 169   </tr>
 170 <tr>
 171     <td width="15%" align="right" valign="top" class="summary">
 172       <span class="summary-type">the next value, or raise StopIteration</span>
 173     </td><td class="summary">
 174       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 175         <tr>
 176           <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>
 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 href="lxml.etree.iterwalk-class.html#skip_subtree" class="summary-sig-name">skip_subtree</a>(<span class="summary-sig-arg">...</span>)</span><br />
 193       Prevent descending into the current subtree.
 194 Instead, the next returned event will be the 'end' event of the current element
 195 (if included), ignoring any children or descendants.</td>
 196           <td align="right" valign="top">
 197
 198
 199           </td>
 200         </tr>
 201       </table>
 202
 203     </td>
 204   </tr>
 205   <tr>
 206     <td colspan="2" class="summary">
 207     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 208       <code>__delattr__</code>,
 209       <code>__format__</code>,
 210       <code>__getattribute__</code>,
 211       <code>__hash__</code>,
 212       <code>__reduce__</code>,
 213       <code>__reduce_ex__</code>,
 214       <code>__repr__</code>,
 215       <code>__setattr__</code>,
 216       <code>__sizeof__</code>,
 217       <code>__str__</code>,
 218       <code>__subclasshook__</code>
 219       </p>
 220     </td>
 221   </tr>
 222 </table>
 223 <!-- ==================== PROPERTIES ==================== -->
 224 <a name="section-Properties"></a>
 225 <table class="summary" border="1" cellpadding="3"
 226        cellspacing="0" width="100%" bgcolor="white">
 227 <tr bgcolor="#70b0f0" class="table-header">
 228   <td colspan="2" class="table-header">
 229     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 230       <tr valign="top">
 231         <td align="left"><span class="table-header">Properties</span></td>
 232         <td align="right" valign="top"
 233          ><span class="options">[<a href="#section-Properties"
 234          class="privatelink" onclick="toggle_private();"
 235          >hide private</a>]</span></td>
 236       </tr>
 237     </table>
 238   </td>
 239 </tr>
 240   <tr>
 241     <td colspan="2" class="summary">
 242     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 243       <code>__class__</code>
 244       </p>
 245     </td>
 246   </tr>
 247 </table>
 248 <!-- ==================== METHOD DETAILS ==================== -->
 249 <a name="section-MethodDetails"></a>
 250 <table class="details" border="1" cellpadding="3"
 251        cellspacing="0" width="100%" bgcolor="white">
 252 <tr bgcolor="#70b0f0" class="table-header">
 253   <td colspan="2" class="table-header">
 254     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 255       <tr valign="top">
 256         <td align="left"><span class="table-header">Method Details</span></td>
 257         <td align="right" valign="top"
 258          ><span class="options">[<a href="#section-MethodDetails"
 259          class="privatelink" onclick="toggle_private();"
 260          >hide private</a>]</span></td>
 261       </tr>
 262     </table>
 263   </td>
 264 </tr>
 265 </table>
 266 <a name="__init__"></a>
 267 <div>
 268 <table class="details" border="1" cellpadding="3"
 269        cellspacing="0" width="100%" bgcolor="white">
 270 <tr><td>
 271   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 272   <tr valign="top"><td>
 273   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 274         <span class="sig-arg">element_or_tree</span>,
 275         <span class="sig-arg">events</span>=<span class="sig-default">(&quot;end&quot;</span>,
 276         <span class="sig-arg">)</span>,
 277         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
 278     <br /><em class="fname">(Constructor)</em>
 279   </h3>
 280   </td><td align="right" valign="top"
 281     >&nbsp;
 282     </td>
 283   </tr></table>
 284
 285   x.__init__(...) initializes x; see help(type(x)) for signature
 286   <dl class="fields">
 287     <dt>Overrides:
 288         object.__init__
 289     </dt>
 290   </dl>
 291 </td></tr></table>
 292 </div>
 293 <a name="__new__"></a>
 294 <div>
 295 <table class="details" border="1" cellpadding="3"
 296        cellspacing="0" width="100%" bgcolor="white">
 297 <tr><td>
 298   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 299   <tr valign="top"><td>
 300   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 301         <span class="sig-arg">S</span>,
 302         <span class="sig-arg">...</span>)</span>
 303   </h3>
 304   </td><td align="right" valign="top"
 305     >&nbsp;
 306     </td>
 307   </tr></table>
 308
 309
 310   <dl class="fields">
 311     <dt>Returns: a new object with type S, a subtype of T</dt>
 312     <dt>Overrides:
 313         object.__new__
 314     </dt>
 315   </dl>
 316 </td></tr></table>
 317 </div>
 318 <a name="skip_subtree"></a>
 319 <div>
 320 <table class="details" border="1" cellpadding="3"
 321        cellspacing="0" width="100%" bgcolor="white">
 322 <tr><td>
 323   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 324   <tr valign="top"><td>
 325   <h3 class="epydoc"><span class="sig"><span class="sig-name">skip_subtree</span>(<span class="sig-arg">...</span>)</span>
 326   </h3>
 327   </td><td align="right" valign="top"
 328     >&nbsp;
 329     </td>
 330   </tr></table>
 331
 332   <p>Prevent descending into the current subtree.
 333 Instead, the next returned event will be the 'end' event of the current element
 334 (if included), ignoring any children or descendants.</p>
 335 <p>This has no effect right after an 'end' or 'end-ns' event.</p>
 336   <dl class="fields">
 337   </dl>
 338 </td></tr></table>
 339 </div>
 340 <br />
 341 <!-- ==================== NAVIGATION BAR ==================== -->
 342 <table class="navbar" border="0" width="100%" cellpadding="0"
 343        bgcolor="#a0c0ff" cellspacing="0">
 344   <tr valign="middle">
 345   <!-- Home link -->
 346       <th>&nbsp;&nbsp;&nbsp;<a
 347         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 348
 349   <!-- Tree link -->
 350       <th>&nbsp;&nbsp;&nbsp;<a
 351         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 352
 353   <!-- Index link -->
 354       <th>&nbsp;&nbsp;&nbsp;<a
 355         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 356
 357   <!-- Help link -->
 358       <th>&nbsp;&nbsp;&nbsp;<a
 359         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 360
 361   <!-- Project homepage -->
 362       <th class="navbar" align="right" width="100%">
 363         <table border="0" cellpadding="0" cellspacing="0">
 364           <tr><th class="navbar" align="center"
 365             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 366           </tr></table></th>
 367   </tr>
 368 </table>
 369 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 370   <tr>
 371     <td align="left" class="footer">
 372     Generated by Epydoc 3.0.1
 373     on Thu Jul  9 18:29:53 2020
 374     </td>
 375     <td align="right" class="footer">
 376       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 377         >http://epydoc.sourceforge.net</a>
 378     </td>
 379   </tr>
 380 </table>
 381
 382 <script type="text/javascript">
 383   <!--
 384   // Private objects are initially displayed (because if
 385   // javascript is turned off then we want them to be
 386   // visible); but by default, we want to hide them.  So hide
 387   // them unless we have a cookie that says to show them.
 388   checkCookie();
 389   // -->
 390 </script>
 391 </body>
 392 </html>