doc/html/api/lxml.etree.iterparse-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.iterparse</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="http://codespeak.net/lxml/">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;iterparse
  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.iterparse-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 iterparse</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66  object --+
  67           |
  68 <a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a> --+
  69               |
  70              <strong class="uidshort">iterparse</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>iterparse(self, source, events=(&quot;end&quot;,), tag=None, attribute_defaults=False, dtd_validation=False, load_dtd=False, no_network=True, remove_blank_text=False, remove_comments=False, remove_pis=False, encoding=None, html=False, huge_tree=False, schema=None)</p>
  75 <p>Incremental parser.</p>
  76 <p>Parses XML into a tree and generates tuples (event, element) in a
  77 SAX-like fashion. <tt class="rst-docutils literal"><span class="pre">event</span></tt> is any of 'start', 'end', 'start-ns',
  78 'end-ns'.</p>
  79 <p>For 'start' and 'end', <tt class="rst-docutils literal"><span class="pre">element</span></tt> is the Element that the parser just
  80 found opening or closing.  For 'start-ns', it is a tuple (prefix, URI) of
  81 a new namespace declaration.  For 'end-ns', it is simply None.  Note that
  82 all start and end events are guaranteed to be properly nested.</p>
  83 <p>The keyword argument <tt class="rst-docutils literal"><span class="pre">events</span></tt> specifies a sequence of event type names
  84 that should be generated.  By default, only 'end' events will be
  85 generated.</p>
  86 <p>The additional <tt class="rst-docutils literal"><span class="pre">tag</span></tt> argument restricts the 'start' and 'end' events to
  87 those elements that match the given tag.  By default, events are generated
  88 for all elements.  Note that the 'start-ns' and 'end-ns' events are not
  89 impacted by this restriction.</p>
  90 <p>The other keyword arguments in the constructor are mainly based on the
  91 libxml2 parser configuration.  A DTD will also be loaded if validation or
  92 attribute default values are requested.</p>
  93 <dl class="rst-docutils">
  94 <dt>Available boolean keyword arguments:</dt>
  95 <dd><ul class="rst-first rst-last">
  96 <li><p class="rst-first">attribute_defaults: read default attributes from DTD</p>
  97 </li>
  98 <li><p class="rst-first">dtd_validation: validate (if DTD is available)</p>
  99 </li>
 100 <li><p class="rst-first">load_dtd: use DTD for parsing</p>
 101 </li>
 102 <li><p class="rst-first">no_network: prevent network access for related files</p>
 103 </li>
 104 <li><p class="rst-first">remove_blank_text: discard blank text nodes</p>
 105 </li>
 106 <li><p class="rst-first">remove_comments: discard comments</p>
 107 </li>
 108 <li><p class="rst-first">remove_pis: discard processing instructions</p>
 109 </li>
 110 <li><p class="rst-first">strip_cdata: replace CDATA sections by normal text content (default: True)</p>
 111 </li>
 112 <li><p class="rst-first">compact: safe memory for short text content (default: True)</p>
 113 </li>
 114 <li><p class="rst-first">resolve_entities: replace entities by their text value (default: True)</p>
 115 </li>
 116 <li><dl class="rst-first rst-docutils">
 117 <dt>huge_tree: disable security restrictions and support very deep trees</dt>
 118 <dd><p class="rst-first rst-last">and very long text content (only affects libxml2 2.7+)</p>
 119 </dd>
 120 </dl>
 121 </li>
 122 </ul>
 123 </dd>
 124 <dt>Other keyword arguments:</dt>
 125 <dd><ul class="rst-first rst-last rst-simple">
 126 <li>encoding: override the document encoding</li>
 127 <li>schema: an XMLSchema to validate against</li>
 128 </ul>
 129 </dd>
 130 </dl>
 131
 132 <!-- ==================== INSTANCE METHODS ==================== -->
 133 <a name="section-InstanceMethods"></a>
 134 <table class="summary" border="1" cellpadding="3"
 135        cellspacing="0" width="100%" bgcolor="white">
 136 <tr bgcolor="#70b0f0" class="table-header">
 137   <td colspan="2" class="table-header">
 138     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 139       <tr valign="top">
 140         <td align="left"><span class="table-header">Instance Methods</span></td>
 141         <td align="right" valign="top"
 142          ><span class="options">[<a href="#section-InstanceMethods"
 143          class="privatelink" onclick="toggle_private();"
 144          >hide private</a>]</span></td>
 145       </tr>
 146     </table>
 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 href="lxml.etree.iterparse-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 156         <span class="summary-sig-arg">source</span>,
 157         <span class="summary-sig-arg">events</span>=<span class="summary-sig-default">(&quot;end&quot;</span>,
 158         <span class="summary-sig-arg">)</span>,
 159         <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
 160         <span class="summary-sig-arg">attribute_defaults</span>=<span class="summary-sig-default">False</span>,
 161         <span class="summary-sig-arg">dtd_validation</span>=<span class="summary-sig-default">False</span>,
 162         <span class="summary-sig-arg">load_dtd</span>=<span class="summary-sig-default">False</span>,
 163         <span class="summary-sig-arg">no_network</span>=<span class="summary-sig-default">True</span>,
 164         <span class="summary-sig-arg">remove_blank_text</span>=<span class="summary-sig-default">False</span>,
 165         <span class="summary-sig-arg">remove_comments</span>=<span class="summary-sig-default">False</span>,
 166         <span class="summary-sig-arg">remove_pis</span>=<span class="summary-sig-default">False</span>,
 167         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
 168         <span class="summary-sig-arg">html</span>=<span class="summary-sig-default">False</span>,
 169         <span class="summary-sig-arg">huge_tree</span>=<span class="summary-sig-default">False</span>,
 170         <span class="summary-sig-arg">schema</span>=<span class="summary-sig-default">None</span>)</span><br />
 171       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
 172           <td align="right" valign="top">
 173
 174
 175           </td>
 176         </tr>
 177       </table>
 178
 179     </td>
 180   </tr>
 181 <tr>
 182     <td width="15%" align="right" valign="top" class="summary">
 183       <span class="summary-type">&nbsp;</span>
 184     </td><td class="summary">
 185       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 186         <tr>
 187           <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 188           <td align="right" valign="top">
 189
 190
 191           </td>
 192         </tr>
 193       </table>
 194
 195     </td>
 196   </tr>
 197 <tr>
 198     <td width="15%" align="right" valign="top" class="summary">
 199       <span class="summary-type">a new object with type S, a subtype of T</span>
 200     </td><td class="summary">
 201       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 202         <tr>
 203           <td><span class="summary-sig"><a href="lxml.etree.iterparse-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 204         <span class="summary-sig-arg">S</span>,
 205         <span class="summary-sig-arg">...</span>)</span></td>
 206           <td align="right" valign="top">
 207
 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="__next__"></a><span class="summary-sig-name">__next__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 222           <td align="right" valign="top">
 223
 224
 225           </td>
 226         </tr>
 227       </table>
 228
 229     </td>
 230   </tr>
 231 <tr>
 232     <td width="15%" align="right" valign="top" class="summary">
 233       <span class="summary-type">&nbsp;</span>
 234     </td><td class="summary">
 235       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 236         <tr>
 237           <td><span class="summary-sig"><a href="lxml.etree.iterparse-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">self</span>)</span><br />
 238       Create a new parser with the same configuration.</td>
 239           <td align="right" valign="top">
 240
 241
 242           </td>
 243         </tr>
 244       </table>
 245
 246     </td>
 247   </tr>
 248 <tr>
 249     <td width="15%" align="right" valign="top" class="summary">
 250       <span class="summary-type">the next value, or raise StopIteration</span>
 251     </td><td class="summary">
 252       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 253         <tr>
 254           <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>
 255           <td align="right" valign="top">
 256
 257
 258           </td>
 259         </tr>
 260       </table>
 261
 262     </td>
 263   </tr>
 264   <tr>
 265     <td colspan="2" class="summary">
 266     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a></code></b>:
 267       <code><a href="lxml.etree._BaseParser-class.html#makeelement">makeelement</a></code>,
 268       <code><a href="lxml.etree._BaseParser-class.html#setElementClassLookup">setElementClassLookup</a></code>,
 269       <code><a href="lxml.etree._BaseParser-class.html#set_element_class_lookup">set_element_class_lookup</a></code>
 270       </p>
 271     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 272       <code>__delattr__</code>,
 273       <code>__getattribute__</code>,
 274       <code>__hash__</code>,
 275       <code>__reduce__</code>,
 276       <code>__reduce_ex__</code>,
 277       <code>__repr__</code>,
 278       <code>__setattr__</code>,
 279       <code>__str__</code>
 280       </p>
 281     </td>
 282   </tr>
 283 </table>
 284 <!-- ==================== PROPERTIES ==================== -->
 285 <a name="section-Properties"></a>
 286 <table class="summary" border="1" cellpadding="3"
 287        cellspacing="0" width="100%" bgcolor="white">
 288 <tr bgcolor="#70b0f0" class="table-header">
 289   <td colspan="2" class="table-header">
 290     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 291       <tr valign="top">
 292         <td align="left"><span class="table-header">Properties</span></td>
 293         <td align="right" valign="top"
 294          ><span class="options">[<a href="#section-Properties"
 295          class="privatelink" onclick="toggle_private();"
 296          >hide private</a>]</span></td>
 297       </tr>
 298     </table>
 299   </td>
 300 </tr>
 301 <tr>
 302     <td width="15%" align="right" valign="top" class="summary">
 303       <span class="summary-type">&nbsp;</span>
 304     </td><td class="summary">
 305         <a name="error_log"></a><span class="summary-name">error_log</span><br />
 306       The error log of the last (or current) parser run.
 307     </td>
 308   </tr>
 309 <tr>
 310     <td width="15%" align="right" valign="top" class="summary">
 311       <span class="summary-type">&nbsp;</span>
 312     </td><td class="summary">
 313         <a name="root"></a><span class="summary-name">root</span>
 314     </td>
 315   </tr>
 316   <tr>
 317     <td colspan="2" class="summary">
 318     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a></code></b>:
 319       <code><a href="lxml.etree._BaseParser-class.html#resolvers">resolvers</a></code>,
 320       <code><a href="lxml.etree._BaseParser-class.html#version">version</a></code>
 321       </p>
 322     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 323       <code>__class__</code>
 324       </p>
 325     </td>
 326   </tr>
 327 </table>
 328 <!-- ==================== METHOD DETAILS ==================== -->
 329 <a name="section-MethodDetails"></a>
 330 <table class="details" border="1" cellpadding="3"
 331        cellspacing="0" width="100%" bgcolor="white">
 332 <tr bgcolor="#70b0f0" class="table-header">
 333   <td colspan="2" class="table-header">
 334     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 335       <tr valign="top">
 336         <td align="left"><span class="table-header">Method Details</span></td>
 337         <td align="right" valign="top"
 338          ><span class="options">[<a href="#section-MethodDetails"
 339          class="privatelink" onclick="toggle_private();"
 340          >hide private</a>]</span></td>
 341       </tr>
 342     </table>
 343   </td>
 344 </tr>
 345 </table>
 346 <a name="__init__"></a>
 347 <div>
 348 <table class="details" border="1" cellpadding="3"
 349        cellspacing="0" width="100%" bgcolor="white">
 350 <tr><td>
 351   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 352   <tr valign="top"><td>
 353   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 354         <span class="sig-arg">source</span>,
 355         <span class="sig-arg">events</span>=<span class="sig-default">(&quot;end&quot;</span>,
 356         <span class="sig-arg">)</span>,
 357         <span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
 358         <span class="sig-arg">attribute_defaults</span>=<span class="sig-default">False</span>,
 359         <span class="sig-arg">dtd_validation</span>=<span class="sig-default">False</span>,
 360         <span class="sig-arg">load_dtd</span>=<span class="sig-default">False</span>,
 361         <span class="sig-arg">no_network</span>=<span class="sig-default">True</span>,
 362         <span class="sig-arg">remove_blank_text</span>=<span class="sig-default">False</span>,
 363         <span class="sig-arg">remove_comments</span>=<span class="sig-default">False</span>,
 364         <span class="sig-arg">remove_pis</span>=<span class="sig-default">False</span>,
 365         <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
 366         <span class="sig-arg">html</span>=<span class="sig-default">False</span>,
 367         <span class="sig-arg">huge_tree</span>=<span class="sig-default">False</span>,
 368         <span class="sig-arg">schema</span>=<span class="sig-default">None</span>)</span>
 369     <br /><em class="fname">(Constructor)</em>
 370   </h3>
 371   </td><td align="right" valign="top"
 372     >&nbsp;
 373     </td>
 374   </tr></table>
 375
 376   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 377   <dl class="fields">
 378     <dt>Overrides:
 379         object.__init__
 380     </dt>
 381   </dl>
 382 </td></tr></table>
 383 </div>
 384 <a name="__new__"></a>
 385 <div>
 386 <table class="details" border="1" cellpadding="3"
 387        cellspacing="0" width="100%" bgcolor="white">
 388 <tr><td>
 389   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 390   <tr valign="top"><td>
 391   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 392         <span class="sig-arg">S</span>,
 393         <span class="sig-arg">...</span>)</span>
 394   </h3>
 395   </td><td align="right" valign="top"
 396     >&nbsp;
 397     </td>
 398   </tr></table>
 399
 400
 401   <dl class="fields">
 402     <dt>Returns: a new object with type S, a subtype of T</dt>
 403     <dt>Overrides:
 404         object.__new__
 405     </dt>
 406   </dl>
 407 </td></tr></table>
 408 </div>
 409 <a name="copy"></a>
 410 <div>
 411 <table class="details" border="1" cellpadding="3"
 412        cellspacing="0" width="100%" bgcolor="white">
 413 <tr><td>
 414   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 415   <tr valign="top"><td>
 416   <h3 class="epydoc"><span class="sig"><span class="sig-name">copy</span>(<span class="sig-arg">self</span>)</span>
 417   </h3>
 418   </td><td align="right" valign="top"
 419     >&nbsp;
 420     </td>
 421   </tr></table>
 422
 423   Create a new parser with the same configuration.
 424   <dl class="fields">
 425     <dt>Overrides:
 426         <a href="lxml.etree._BaseParser-class.html#copy">_BaseParser.copy</a>
 427         <dd><em class="note">(inherited documentation)</em></dd>
 428     </dt>
 429   </dl>
 430 </td></tr></table>
 431 </div>
 432 <br />
 433 <!-- ==================== NAVIGATION BAR ==================== -->
 434 <table class="navbar" border="0" width="100%" cellpadding="0"
 435        bgcolor="#a0c0ff" cellspacing="0">
 436   <tr valign="middle">
 437   <!-- Home link -->
 438       <th>&nbsp;&nbsp;&nbsp;<a
 439         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 440
 441   <!-- Tree link -->
 442       <th>&nbsp;&nbsp;&nbsp;<a
 443         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 444
 445   <!-- Index link -->
 446       <th>&nbsp;&nbsp;&nbsp;<a
 447         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 448
 449   <!-- Help link -->
 450       <th>&nbsp;&nbsp;&nbsp;<a
 451         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 452
 453   <!-- Project homepage -->
 454       <th class="navbar" align="right" width="100%">
 455         <table border="0" cellpadding="0" cellspacing="0">
 456           <tr><th class="navbar" align="center"
 457             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
 458           </tr></table></th>
 459   </tr>
 460 </table>
 461 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 462   <tr>
 463     <td align="left" class="footer">
 464     Generated by Epydoc 3.0 on Fri Oct 30 14:51:46 2009
 465     </td>
 466     <td align="right" class="footer">
 467       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 468         >http://epydoc.sourceforge.net</a>
 469     </td>
 470   </tr>
 471 </table>
 472
 473 <script type="text/javascript">
 474   <!--
 475   // Private objects are initially displayed (because if
 476   // javascript is turned off then we want them to be
 477   // visible); but by default, we want to hide them.  So hide
 478   // them unless we have a cookie that says to show them.
 479   checkCookie();
 480   // -->
 481 </script>
 482 </body>
 483 </html>