doc/html/api/lxml.etree._FeedParser-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._FeedParser</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;_FeedParser
  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._FeedParser-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 _FeedParser</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66     object --+
  67              |
  68 ??._BaseParser --+
  69                  |
  70                 <strong class="uidshort">_FeedParser</strong>
  71 </pre>
  72
  73 <dl><dt>Known Subclasses:</dt>
  74 <dd>
  75       <ul class="subclass-list">
  76 <li><a href="lxml.etree.HTMLParser-class.html">HTMLParser</a></li><li>, <a href="lxml.etree.XMLParser-class.html">XMLParser</a></li>  </ul>
  77 </dd></dl>
  78
  79 <hr />
  80 <!-- ==================== INSTANCE METHODS ==================== -->
  81 <a name="section-InstanceMethods"></a>
  82 <table class="summary" border="1" cellpadding="3"
  83        cellspacing="0" width="100%" bgcolor="white">
  84 <tr bgcolor="#70b0f0" class="table-header">
  85   <td colspan="2" class="table-header">
  86     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  87       <tr valign="top">
  88         <td align="left"><span class="table-header">Instance Methods</span></td>
  89         <td align="right" valign="top"
  90          ><span class="options">[<a href="#section-InstanceMethods"
  91          class="privatelink" onclick="toggle_private();"
  92          >hide private</a>]</span></td>
  93       </tr>
  94     </table>
  95   </td>
  96 </tr>
  97 <tr>
  98     <td width="15%" align="right" valign="top" class="summary">
  99       <span class="summary-type">a new object with type S, a subtype of T</span>
 100     </td><td class="summary">
 101       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 102         <tr>
 103           <td><span class="summary-sig"><a href="lxml.etree._FeedParser-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 104         <span class="summary-sig-arg">S</span>,
 105         <span class="summary-sig-arg">...</span>)</span></td>
 106           <td align="right" valign="top">
 107
 108
 109           </td>
 110         </tr>
 111       </table>
 112
 113     </td>
 114   </tr>
 115 <tr>
 116     <td width="15%" align="right" valign="top" class="summary">
 117       <span class="summary-type">&nbsp;</span>
 118     </td><td class="summary">
 119       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 120         <tr>
 121           <td><span class="summary-sig"><a href="lxml.etree._FeedParser-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br />
 122       Terminates feeding data to this parser.  This tells the parser to
 123 process any remaining data in the feed buffer, and then returns the
 124 root Element of the tree that was parsed.</td>
 125           <td align="right" valign="top">
 126
 127
 128           </td>
 129         </tr>
 130       </table>
 131
 132     </td>
 133   </tr>
 134 <tr>
 135     <td width="15%" align="right" valign="top" class="summary">
 136       <span class="summary-type">&nbsp;</span>
 137     </td><td class="summary">
 138       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 139         <tr>
 140           <td><span class="summary-sig"><a href="lxml.etree._FeedParser-class.html#feed" class="summary-sig-name">feed</a>(<span class="summary-sig-arg">self</span>,
 141         <span class="summary-sig-arg">data</span>)</span><br />
 142       Feeds data to the parser.  The argument should be an 8-bit string
 143 buffer containing encoded data, although Unicode is supported as long
 144 as both string types are not mixed.</td>
 145           <td align="right" valign="top">
 146
 147
 148           </td>
 149         </tr>
 150       </table>
 151
 152     </td>
 153   </tr>
 154   <tr>
 155     <td colspan="2" class="summary">
 156     <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>._BaseParser</code></b>:
 157       <code>__init__</code>,
 158       <code>copy</code>,
 159       <code>makeelement</code>,
 160       <code>setElementClassLookup</code>,
 161       <code>set_element_class_lookup</code>
 162       </p>
 163     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 164       <code>__delattr__</code>,
 165       <code>__format__</code>,
 166       <code>__getattribute__</code>,
 167       <code>__hash__</code>,
 168       <code>__reduce__</code>,
 169       <code>__reduce_ex__</code>,
 170       <code>__repr__</code>,
 171       <code>__setattr__</code>,
 172       <code>__sizeof__</code>,
 173       <code>__str__</code>,
 174       <code>__subclasshook__</code>
 175       </p>
 176     </td>
 177   </tr>
 178 </table>
 179 <!-- ==================== PROPERTIES ==================== -->
 180 <a name="section-Properties"></a>
 181 <table class="summary" border="1" cellpadding="3"
 182        cellspacing="0" width="100%" bgcolor="white">
 183 <tr bgcolor="#70b0f0" class="table-header">
 184   <td colspan="2" class="table-header">
 185     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 186       <tr valign="top">
 187         <td align="left"><span class="table-header">Properties</span></td>
 188         <td align="right" valign="top"
 189          ><span class="options">[<a href="#section-Properties"
 190          class="privatelink" onclick="toggle_private();"
 191          >hide private</a>]</span></td>
 192       </tr>
 193     </table>
 194   </td>
 195 </tr>
 196 <tr>
 197     <td width="15%" align="right" valign="top" class="summary">
 198       <span class="summary-type">&nbsp;</span>
 199     </td><td class="summary">
 200         <a href="lxml.etree._FeedParser-class.html#feed_error_log" class="summary-name">feed_error_log</a><br />
 201       The error log of the last (or current) run of the feed parser.
 202     </td>
 203   </tr>
 204   <tr>
 205     <td colspan="2" class="summary">
 206     <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>._BaseParser</code></b>:
 207       <code>error_log</code>,
 208       <code>resolvers</code>,
 209       <code>target</code>,
 210       <code>version</code>
 211       </p>
 212     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 213       <code>__class__</code>
 214       </p>
 215     </td>
 216   </tr>
 217 </table>
 218 <!-- ==================== METHOD DETAILS ==================== -->
 219 <a name="section-MethodDetails"></a>
 220 <table class="details" border="1" cellpadding="3"
 221        cellspacing="0" width="100%" bgcolor="white">
 222 <tr bgcolor="#70b0f0" class="table-header">
 223   <td colspan="2" class="table-header">
 224     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 225       <tr valign="top">
 226         <td align="left"><span class="table-header">Method Details</span></td>
 227         <td align="right" valign="top"
 228          ><span class="options">[<a href="#section-MethodDetails"
 229          class="privatelink" onclick="toggle_private();"
 230          >hide private</a>]</span></td>
 231       </tr>
 232     </table>
 233   </td>
 234 </tr>
 235 </table>
 236 <a name="__new__"></a>
 237 <div>
 238 <table class="details" border="1" cellpadding="3"
 239        cellspacing="0" width="100%" bgcolor="white">
 240 <tr><td>
 241   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 242   <tr valign="top"><td>
 243   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 244         <span class="sig-arg">S</span>,
 245         <span class="sig-arg">...</span>)</span>
 246   </h3>
 247   </td><td align="right" valign="top"
 248     >&nbsp;
 249     </td>
 250   </tr></table>
 251
 252
 253   <dl class="fields">
 254     <dt>Returns: a new object with type S, a subtype of T</dt>
 255     <dt>Overrides:
 256         object.__new__
 257     </dt>
 258   </dl>
 259 </td></tr></table>
 260 </div>
 261 <a name="close"></a>
 262 <div>
 263 <table class="details" border="1" cellpadding="3"
 264        cellspacing="0" width="100%" bgcolor="white">
 265 <tr><td>
 266   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 267   <tr valign="top"><td>
 268   <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>)</span>
 269   </h3>
 270   </td><td align="right" valign="top"
 271     >&nbsp;
 272     </td>
 273   </tr></table>
 274
 275   <p>Terminates feeding data to this parser.  This tells the parser to
 276 process any remaining data in the feed buffer, and then returns the
 277 root Element of the tree that was parsed.</p>
 278 <p>This method must be called after passing the last chunk of data into
 279 the <tt class="rst-docutils literal">feed()</tt> method.  It should only be called when using the feed
 280 parser interface, all other usage is undefined.</p>
 281   <dl class="fields">
 282   </dl>
 283 </td></tr></table>
 284 </div>
 285 <a name="feed"></a>
 286 <div>
 287 <table class="details" border="1" cellpadding="3"
 288        cellspacing="0" width="100%" bgcolor="white">
 289 <tr><td>
 290   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 291   <tr valign="top"><td>
 292   <h3 class="epydoc"><span class="sig"><span class="sig-name">feed</span>(<span class="sig-arg">self</span>,
 293         <span class="sig-arg">data</span>)</span>
 294   </h3>
 295   </td><td align="right" valign="top"
 296     >&nbsp;
 297     </td>
 298   </tr></table>
 299
 300   <p>Feeds data to the parser.  The argument should be an 8-bit string
 301 buffer containing encoded data, although Unicode is supported as long
 302 as both string types are not mixed.</p>
 303 <p>This is the main entry point to the consumer interface of a
 304 parser.  The parser will parse as much of the XML stream as it
 305 can on each call.  To finish parsing or to reset the parser,
 306 call the <tt class="rst-docutils literal">close()</tt> method.  Both methods may raise
 307 ParseError if errors occur in the input data.  If an error is
 308 raised, there is no longer a need to call <tt class="rst-docutils literal">close()</tt>.</p>
 309 <p>The feed parser interface is independent of the normal parser
 310 usage.  You can use the same parser as a feed parser and in
 311 the <tt class="rst-docutils literal">parse()</tt> function concurrently.</p>
 312   <dl class="fields">
 313   </dl>
 314 </td></tr></table>
 315 </div>
 316 <br />
 317 <!-- ==================== PROPERTY DETAILS ==================== -->
 318 <a name="section-PropertyDetails"></a>
 319 <table class="details" border="1" cellpadding="3"
 320        cellspacing="0" width="100%" bgcolor="white">
 321 <tr bgcolor="#70b0f0" class="table-header">
 322   <td colspan="2" class="table-header">
 323     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 324       <tr valign="top">
 325         <td align="left"><span class="table-header">Property Details</span></td>
 326         <td align="right" valign="top"
 327          ><span class="options">[<a href="#section-PropertyDetails"
 328          class="privatelink" onclick="toggle_private();"
 329          >hide private</a>]</span></td>
 330       </tr>
 331     </table>
 332   </td>
 333 </tr>
 334 </table>
 335 <a name="feed_error_log"></a>
 336 <div>
 337 <table class="details" border="1" cellpadding="3"
 338        cellspacing="0" width="100%" bgcolor="white">
 339 <tr><td>
 340   <h3 class="epydoc">feed_error_log</h3>
 341   <p>The error log of the last (or current) run of the feed parser.</p>
 342 <p>Note that this is local to the feed parser and thus is
 343 different from what the <tt class="rst-docutils literal">error_log</tt> property returns.</p>
 344   <dl class="fields">
 345   </dl>
 346 </td></tr></table>
 347 </div>
 348 <br />
 349 <!-- ==================== NAVIGATION BAR ==================== -->
 350 <table class="navbar" border="0" width="100%" cellpadding="0"
 351        bgcolor="#a0c0ff" cellspacing="0">
 352   <tr valign="middle">
 353   <!-- Home link -->
 354       <th>&nbsp;&nbsp;&nbsp;<a
 355         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 356
 357   <!-- Tree link -->
 358       <th>&nbsp;&nbsp;&nbsp;<a
 359         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 360
 361   <!-- Index link -->
 362       <th>&nbsp;&nbsp;&nbsp;<a
 363         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 364
 365   <!-- Help link -->
 366       <th>&nbsp;&nbsp;&nbsp;<a
 367         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 368
 369   <!-- Project homepage -->
 370       <th class="navbar" align="right" width="100%">
 371         <table border="0" cellpadding="0" cellspacing="0">
 372           <tr><th class="navbar" align="center"
 373             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 374           </tr></table></th>
 375   </tr>
 376 </table>
 377 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 378   <tr>
 379     <td align="left" class="footer">
 380     Generated by Epydoc 3.0.1
 381     on Thu Jul  9 18:29:53 2020
 382     </td>
 383     <td align="right" class="footer">
 384       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 385         >http://epydoc.sourceforge.net</a>
 386     </td>
 387   </tr>
 388 </table>
 389
 390 <script type="text/javascript">
 391   <!--
 392   // Private objects are initially displayed (because if
 393   // javascript is turned off then we want them to be
 394   // visible); but by default, we want to hide them.  So hide
 395   // them unless we have a cookie that says to show them.
 396   checkCookie();
 397   // -->
 398 </script>
 399 </body>
 400 </html>