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
  76 <!-- ==================== INSTANCE METHODS ==================== -->
  77 <a name="section-InstanceMethods"></a>
  78 <table class="summary" border="1" cellpadding="3"
  79        cellspacing="0" width="100%" bgcolor="white">
  80 <tr bgcolor="#70b0f0" class="table-header">
  81   <td colspan="2" class="table-header">
  82     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  83       <tr valign="top">
  84         <td align="left"><span class="table-header">Instance Methods</span></td>
  85         <td align="right" valign="top"
  86          ><span class="options">[<a href="#section-InstanceMethods"
  87          class="privatelink" onclick="toggle_private();"
  88          >hide private</a>]</span></td>
  89       </tr>
  90     </table>
  91   </td>
  92 </tr>
  93 <tr>
  94     <td width="15%" align="right" valign="top" class="summary">
  95       <span class="summary-type">&nbsp;</span>
  96     </td><td class="summary">
  97       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  98         <tr>
  99           <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>,
 100         <span class="summary-sig-arg">element_or_tree</span>,
 101         <span class="summary-sig-arg">events</span>=<span class="summary-sig-default">(&quot;end&quot;</span>,
 102         <span class="summary-sig-arg">)</span>,
 103         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span><br />
 104       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 105           <td align="right" valign="top">
 106
 107
 108           </td>
 109         </tr>
 110       </table>
 111
 112     </td>
 113   </tr>
 114 <tr>
 115     <td width="15%" align="right" valign="top" class="summary">
 116       <span class="summary-type">&nbsp;</span>
 117     </td><td class="summary">
 118       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 119         <tr>
 120           <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 />
 121       iter(x)</td>
 122           <td align="right" valign="top">
 123
 124
 125           </td>
 126         </tr>
 127       </table>
 128
 129     </td>
 130   </tr>
 131 <tr>
 132     <td width="15%" align="right" valign="top" class="summary">
 133       <span class="summary-type">a new object with type S, a subtype of T</span>
 134     </td><td class="summary">
 135       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 136         <tr>
 137           <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>,
 138         <span class="summary-sig-arg">S</span>,
 139         <span class="summary-sig-arg">...</span>)</span></td>
 140           <td align="right" valign="top">
 141
 142
 143           </td>
 144         </tr>
 145       </table>
 146
 147     </td>
 148   </tr>
 149 <tr>
 150     <td width="15%" align="right" valign="top" class="summary">
 151       <span class="summary-type">&nbsp;</span>
 152     </td><td class="summary">
 153       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 154         <tr>
 155           <td><span class="summary-sig"><a name="__next__"></a><span class="summary-sig-name">__next__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 156           <td align="right" valign="top">
 157
 158
 159           </td>
 160         </tr>
 161       </table>
 162
 163     </td>
 164   </tr>
 165 <tr>
 166     <td width="15%" align="right" valign="top" class="summary">
 167       <span class="summary-type">the next value, or raise StopIteration</span>
 168     </td><td class="summary">
 169       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 170         <tr>
 171           <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>
 172           <td align="right" valign="top">
 173
 174
 175           </td>
 176         </tr>
 177       </table>
 178
 179     </td>
 180   </tr>
 181   <tr>
 182     <td colspan="2" class="summary">
 183     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 184       <code>__delattr__</code>,
 185       <code>__format__</code>,
 186       <code>__getattribute__</code>,
 187       <code>__hash__</code>,
 188       <code>__reduce__</code>,
 189       <code>__reduce_ex__</code>,
 190       <code>__repr__</code>,
 191       <code>__setattr__</code>,
 192       <code>__sizeof__</code>,
 193       <code>__str__</code>,
 194       <code>__subclasshook__</code>
 195       </p>
 196     </td>
 197   </tr>
 198 </table>
 199 <!-- ==================== PROPERTIES ==================== -->
 200 <a name="section-Properties"></a>
 201 <table class="summary" border="1" cellpadding="3"
 202        cellspacing="0" width="100%" bgcolor="white">
 203 <tr bgcolor="#70b0f0" class="table-header">
 204   <td colspan="2" class="table-header">
 205     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 206       <tr valign="top">
 207         <td align="left"><span class="table-header">Properties</span></td>
 208         <td align="right" valign="top"
 209          ><span class="options">[<a href="#section-Properties"
 210          class="privatelink" onclick="toggle_private();"
 211          >hide private</a>]</span></td>
 212       </tr>
 213     </table>
 214   </td>
 215 </tr>
 216   <tr>
 217     <td colspan="2" class="summary">
 218     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 219       <code>__class__</code>
 220       </p>
 221     </td>
 222   </tr>
 223 </table>
 224 <!-- ==================== METHOD DETAILS ==================== -->
 225 <a name="section-MethodDetails"></a>
 226 <table class="details" border="1" cellpadding="3"
 227        cellspacing="0" width="100%" bgcolor="white">
 228 <tr bgcolor="#70b0f0" class="table-header">
 229   <td colspan="2" class="table-header">
 230     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 231       <tr valign="top">
 232         <td align="left"><span class="table-header">Method Details</span></td>
 233         <td align="right" valign="top"
 234          ><span class="options">[<a href="#section-MethodDetails"
 235          class="privatelink" onclick="toggle_private();"
 236          >hide private</a>]</span></td>
 237       </tr>
 238     </table>
 239   </td>
 240 </tr>
 241 </table>
 242 <a name="__init__"></a>
 243 <div>
 244 <table class="details" border="1" cellpadding="3"
 245        cellspacing="0" width="100%" bgcolor="white">
 246 <tr><td>
 247   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 248   <tr valign="top"><td>
 249   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 250         <span class="sig-arg">element_or_tree</span>,
 251         <span class="sig-arg">events</span>=<span class="sig-default">(&quot;end&quot;</span>,
 252         <span class="sig-arg">)</span>,
 253         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>)</span>
 254     <br /><em class="fname">(Constructor)</em>
 255   </h3>
 256   </td><td align="right" valign="top"
 257     >&nbsp;
 258     </td>
 259   </tr></table>
 260
 261   x.__init__(...) initializes x; see help(type(x)) for signature
 262   <dl class="fields">
 263     <dt>Overrides:
 264         object.__init__
 265     </dt>
 266   </dl>
 267 </td></tr></table>
 268 </div>
 269 <a name="__new__"></a>
 270 <div>
 271 <table class="details" border="1" cellpadding="3"
 272        cellspacing="0" width="100%" bgcolor="white">
 273 <tr><td>
 274   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 275   <tr valign="top"><td>
 276   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 277         <span class="sig-arg">S</span>,
 278         <span class="sig-arg">...</span>)</span>
 279   </h3>
 280   </td><td align="right" valign="top"
 281     >&nbsp;
 282     </td>
 283   </tr></table>
 284
 285
 286   <dl class="fields">
 287     <dt>Returns: a new object with type S, a subtype of T</dt>
 288     <dt>Overrides:
 289         object.__new__
 290     </dt>
 291   </dl>
 292 </td></tr></table>
 293 </div>
 294 <br />
 295 <!-- ==================== NAVIGATION BAR ==================== -->
 296 <table class="navbar" border="0" width="100%" cellpadding="0"
 297        bgcolor="#a0c0ff" cellspacing="0">
 298   <tr valign="middle">
 299   <!-- Home link -->
 300       <th>&nbsp;&nbsp;&nbsp;<a
 301         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 302
 303   <!-- Tree link -->
 304       <th>&nbsp;&nbsp;&nbsp;<a
 305         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 306
 307   <!-- Index link -->
 308       <th>&nbsp;&nbsp;&nbsp;<a
 309         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 310
 311   <!-- Help link -->
 312       <th>&nbsp;&nbsp;&nbsp;<a
 313         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 314
 315   <!-- Project homepage -->
 316       <th class="navbar" align="right" width="100%">
 317         <table border="0" cellpadding="0" cellspacing="0">
 318           <tr><th class="navbar" align="center"
 319             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 320           </tr></table></th>
 321   </tr>
 322 </table>
 323 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 324   <tr>
 325     <td align="left" class="footer">
 326     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
 327     </td>
 328     <td align="right" class="footer">
 329       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 330         >http://epydoc.sourceforge.net</a>
 331     </td>
 332   </tr>
 333 </table>
 334
 335 <script type="text/javascript">
 336   <!--
 337   // Private objects are initially displayed (because if
 338   // javascript is turned off then we want them to be
 339   // visible); but by default, we want to hide them.  So hide
 340   // them unless we have a cookie that says to show them.
 341   checkCookie();
 342   // -->
 343 </script>
 344 </body>
 345 </html>