doc/html/api/xml.etree.ElementTree.XMLParser-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>xml.etree.ElementTree.XMLParser</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         xml ::
  46         etree ::
  47         ElementTree ::
  48         XMLParser ::
  49         Class&nbsp;XMLParser
  50       </span>
  51     </td>
  52     <td>
  53       <table cellpadding="0" cellspacing="0">
  54         <!-- hide/show private -->
  55         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  56     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  57         <tr><td align="right"><span class="options"
  58             >[<a href="frames.html" target="_top">frames</a
  59             >]&nbsp;|&nbsp;<a href="xml.etree.ElementTree.XMLParser-class.html"
  60             target="_top">no&nbsp;frames</a>]</span></td></tr>
  61       </table>
  62     </td>
  63   </tr>
  64 </table>
  65 <!-- ==================== CLASS DESCRIPTION ==================== -->
  66 <h1 class="epydoc">Class XMLParser</h1><p class="nomargin-top"><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser">source&nbsp;code</a></span></p>
  67 <pre class="base-tree">
  68 object --+
  69          |
  70         <strong class="uidshort">XMLParser</strong>
  71 </pre>
  72
  73 <hr />
  74 <!-- ==================== INSTANCE METHODS ==================== -->
  75 <a name="section-InstanceMethods"></a>
  76 <table class="summary" border="1" cellpadding="3"
  77        cellspacing="0" width="100%" bgcolor="white">
  78 <tr bgcolor="#70b0f0" class="table-header">
  79   <td colspan="2" class="table-header">
  80     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  81       <tr valign="top">
  82         <td align="left"><span class="table-header">Instance Methods</span></td>
  83         <td align="right" valign="top"
  84          ><span class="options">[<a href="#section-InstanceMethods"
  85          class="privatelink" onclick="toggle_private();"
  86          >hide private</a>]</span></td>
  87       </tr>
  88     </table>
  89   </td>
  90 </tr>
  91 <tr class="private">
  92     <td width="15%" align="right" valign="top" class="summary">
  93       <span class="summary-type">&nbsp;</span>
  94     </td><td class="summary">
  95       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  96         <tr>
  97           <td><span class="summary-sig"><a name="__doctype"></a><span class="summary-sig-name">__doctype</span>(<span class="summary-sig-arg">self</span>,
  98         <span class="summary-sig-arg">name</span>,
  99         <span class="summary-sig-arg">pubid</span>,
 100         <span class="summary-sig-arg">system</span>)</span><br />
 101       This method of XMLParser is deprecated.</td>
 102           <td align="right" valign="top">
 103             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser.__doctype">source&nbsp;code</a></span>
 104
 105           </td>
 106         </tr>
 107       </table>
 108
 109     </td>
 110   </tr>
 111 <tr>
 112     <td width="15%" align="right" valign="top" class="summary">
 113       <span class="summary-type">&nbsp;</span>
 114     </td><td class="summary">
 115       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 116         <tr>
 117           <td><span class="summary-sig"><a href="xml.etree.ElementTree.XMLParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 118         <span class="summary-sig-arg">html</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">sentinel</code><code class="variable-quote">'</code><code class="variable-group">]</code></span>,
 119         <span class="summary-sig-arg">target</span>=<span class="summary-sig-default">None</span>,
 120         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>)</span><br />
 121       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 122           <td align="right" valign="top">
 123             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser.__init__">source&nbsp;code</a></span>
 124
 125           </td>
 126         </tr>
 127       </table>
 128
 129     </td>
 130   </tr>
 131 <tr class="private">
 132     <td width="15%" align="right" valign="top" class="summary">
 133       <span class="summary-type">&nbsp;</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 name="_comment"></a><span class="summary-sig-name">_comment</span>(<span class="summary-sig-arg">self</span>,
 138         <span class="summary-sig-arg">data</span>)</span></td>
 139           <td align="right" valign="top">
 140             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._comment">source&nbsp;code</a></span>
 141
 142           </td>
 143         </tr>
 144       </table>
 145
 146     </td>
 147   </tr>
 148 <tr class="private">
 149     <td width="15%" align="right" valign="top" class="summary">
 150       <span class="summary-type">&nbsp;</span>
 151     </td><td class="summary">
 152       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 153         <tr>
 154           <td><span class="summary-sig"><a name="_data"></a><span class="summary-sig-name">_data</span>(<span class="summary-sig-arg">self</span>,
 155         <span class="summary-sig-arg">text</span>)</span></td>
 156           <td align="right" valign="top">
 157             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._data">source&nbsp;code</a></span>
 158
 159           </td>
 160         </tr>
 161       </table>
 162
 163     </td>
 164   </tr>
 165 <tr class="private">
 166     <td width="15%" align="right" valign="top" class="summary">
 167       <span class="summary-type">&nbsp;</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="_default"></a><span class="summary-sig-name">_default</span>(<span class="summary-sig-arg">self</span>,
 172         <span class="summary-sig-arg">text</span>)</span></td>
 173           <td align="right" valign="top">
 174             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._default">source&nbsp;code</a></span>
 175
 176           </td>
 177         </tr>
 178       </table>
 179
 180     </td>
 181   </tr>
 182 <tr class="private">
 183     <td width="15%" align="right" valign="top" class="summary">
 184       <span class="summary-type">&nbsp;</span>
 185     </td><td class="summary">
 186       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 187         <tr>
 188           <td><span class="summary-sig"><a name="_end"></a><span class="summary-sig-name">_end</span>(<span class="summary-sig-arg">self</span>,
 189         <span class="summary-sig-arg">tag</span>)</span></td>
 190           <td align="right" valign="top">
 191             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._end">source&nbsp;code</a></span>
 192
 193           </td>
 194         </tr>
 195       </table>
 196
 197     </td>
 198   </tr>
 199 <tr class="private">
 200     <td width="15%" align="right" valign="top" class="summary">
 201       <span class="summary-type">&nbsp;</span>
 202     </td><td class="summary">
 203       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 204         <tr>
 205           <td><span class="summary-sig"><a name="_fixname"></a><span class="summary-sig-name">_fixname</span>(<span class="summary-sig-arg">self</span>,
 206         <span class="summary-sig-arg">key</span>)</span></td>
 207           <td align="right" valign="top">
 208             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._fixname">source&nbsp;code</a></span>
 209
 210           </td>
 211         </tr>
 212       </table>
 213
 214     </td>
 215   </tr>
 216 <tr class="private">
 217     <td width="15%" align="right" valign="top" class="summary">
 218       <span class="summary-type">&nbsp;</span>
 219     </td><td class="summary">
 220       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 221         <tr>
 222           <td><span class="summary-sig"><a name="_fixtext"></a><span class="summary-sig-name">_fixtext</span>(<span class="summary-sig-arg">self</span>,
 223         <span class="summary-sig-arg">text</span>)</span></td>
 224           <td align="right" valign="top">
 225             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._fixtext">source&nbsp;code</a></span>
 226
 227           </td>
 228         </tr>
 229       </table>
 230
 231     </td>
 232   </tr>
 233 <tr class="private">
 234     <td width="15%" align="right" valign="top" class="summary">
 235       <span class="summary-type">&nbsp;</span>
 236     </td><td class="summary">
 237       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 238         <tr>
 239           <td><span class="summary-sig"><a name="_pi"></a><span class="summary-sig-name">_pi</span>(<span class="summary-sig-arg">self</span>,
 240         <span class="summary-sig-arg">target</span>,
 241         <span class="summary-sig-arg">data</span>)</span></td>
 242           <td align="right" valign="top">
 243             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._pi">source&nbsp;code</a></span>
 244
 245           </td>
 246         </tr>
 247       </table>
 248
 249     </td>
 250   </tr>
 251 <tr class="private">
 252     <td width="15%" align="right" valign="top" class="summary">
 253       <span class="summary-type">&nbsp;</span>
 254     </td><td class="summary">
 255       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 256         <tr>
 257           <td><span class="summary-sig"><a name="_raiseerror"></a><span class="summary-sig-name">_raiseerror</span>(<span class="summary-sig-arg">self</span>,
 258         <span class="summary-sig-arg">value</span>)</span></td>
 259           <td align="right" valign="top">
 260             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._raiseerror">source&nbsp;code</a></span>
 261
 262           </td>
 263         </tr>
 264       </table>
 265
 266     </td>
 267   </tr>
 268 <tr class="private">
 269     <td width="15%" align="right" valign="top" class="summary">
 270       <span class="summary-type">&nbsp;</span>
 271     </td><td class="summary">
 272       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 273         <tr>
 274           <td><span class="summary-sig"><a name="_start"></a><span class="summary-sig-name">_start</span>(<span class="summary-sig-arg">self</span>,
 275         <span class="summary-sig-arg">tag</span>,
 276         <span class="summary-sig-arg">attrib_in</span>)</span></td>
 277           <td align="right" valign="top">
 278             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._start">source&nbsp;code</a></span>
 279
 280           </td>
 281         </tr>
 282       </table>
 283
 284     </td>
 285   </tr>
 286 <tr class="private">
 287     <td width="15%" align="right" valign="top" class="summary">
 288       <span class="summary-type">&nbsp;</span>
 289     </td><td class="summary">
 290       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 291         <tr>
 292           <td><span class="summary-sig"><a name="_start_list"></a><span class="summary-sig-name">_start_list</span>(<span class="summary-sig-arg">self</span>,
 293         <span class="summary-sig-arg">tag</span>,
 294         <span class="summary-sig-arg">attrib_in</span>)</span></td>
 295           <td align="right" valign="top">
 296             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser._start_list">source&nbsp;code</a></span>
 297
 298           </td>
 299         </tr>
 300       </table>
 301
 302     </td>
 303   </tr>
 304 <tr>
 305     <td width="15%" align="right" valign="top" class="summary">
 306       <span class="summary-type">&nbsp;</span>
 307     </td><td class="summary">
 308       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 309         <tr>
 310           <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span></td>
 311           <td align="right" valign="top">
 312             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser.close">source&nbsp;code</a></span>
 313
 314           </td>
 315         </tr>
 316       </table>
 317
 318     </td>
 319   </tr>
 320 <tr>
 321     <td width="15%" align="right" valign="top" class="summary">
 322       <span class="summary-type">&nbsp;</span>
 323     </td><td class="summary">
 324       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 325         <tr>
 326           <td><span class="summary-sig"><a name="doctype"></a><span class="summary-sig-name">doctype</span>(<span class="summary-sig-arg">self</span>,
 327         <span class="summary-sig-arg">name</span>,
 328         <span class="summary-sig-arg">pubid</span>,
 329         <span class="summary-sig-arg">system</span>)</span><br />
 330       This method of XMLParser is deprecated.</td>
 331           <td align="right" valign="top">
 332             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser.__doctype">source&nbsp;code</a></span>
 333
 334           </td>
 335         </tr>
 336       </table>
 337
 338     </td>
 339   </tr>
 340 <tr>
 341     <td width="15%" align="right" valign="top" class="summary">
 342       <span class="summary-type">&nbsp;</span>
 343     </td><td class="summary">
 344       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 345         <tr>
 346           <td><span class="summary-sig"><a name="feed"></a><span class="summary-sig-name">feed</span>(<span class="summary-sig-arg">self</span>,
 347         <span class="summary-sig-arg">data</span>)</span></td>
 348           <td align="right" valign="top">
 349             <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser.feed">source&nbsp;code</a></span>
 350
 351           </td>
 352         </tr>
 353       </table>
 354
 355     </td>
 356   </tr>
 357   <tr>
 358     <td colspan="2" class="summary">
 359     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 360       <code>__delattr__</code>,
 361       <code>__format__</code>,
 362       <code>__getattribute__</code>,
 363       <code>__hash__</code>,
 364       <code>__new__</code>,
 365       <code>__reduce__</code>,
 366       <code>__reduce_ex__</code>,
 367       <code>__repr__</code>,
 368       <code>__setattr__</code>,
 369       <code>__sizeof__</code>,
 370       <code>__str__</code>,
 371       <code>__subclasshook__</code>
 372       </p>
 373     </td>
 374   </tr>
 375 </table>
 376 <!-- ==================== PROPERTIES ==================== -->
 377 <a name="section-Properties"></a>
 378 <table class="summary" border="1" cellpadding="3"
 379        cellspacing="0" width="100%" bgcolor="white">
 380 <tr bgcolor="#70b0f0" class="table-header">
 381   <td colspan="2" class="table-header">
 382     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 383       <tr valign="top">
 384         <td align="left"><span class="table-header">Properties</span></td>
 385         <td align="right" valign="top"
 386          ><span class="options">[<a href="#section-Properties"
 387          class="privatelink" onclick="toggle_private();"
 388          >hide private</a>]</span></td>
 389       </tr>
 390     </table>
 391   </td>
 392 </tr>
 393   <tr>
 394     <td colspan="2" class="summary">
 395     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 396       <code>__class__</code>
 397       </p>
 398     </td>
 399   </tr>
 400 </table>
 401 <!-- ==================== METHOD DETAILS ==================== -->
 402 <a name="section-MethodDetails"></a>
 403 <table class="details" border="1" cellpadding="3"
 404        cellspacing="0" width="100%" bgcolor="white">
 405 <tr bgcolor="#70b0f0" class="table-header">
 406   <td colspan="2" class="table-header">
 407     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 408       <tr valign="top">
 409         <td align="left"><span class="table-header">Method Details</span></td>
 410         <td align="right" valign="top"
 411          ><span class="options">[<a href="#section-MethodDetails"
 412          class="privatelink" onclick="toggle_private();"
 413          >hide private</a>]</span></td>
 414       </tr>
 415     </table>
 416   </td>
 417 </tr>
 418 </table>
 419 <a name="__init__"></a>
 420 <div>
 421 <table class="details" border="1" cellpadding="3"
 422        cellspacing="0" width="100%" bgcolor="white">
 423 <tr><td>
 424   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 425   <tr valign="top"><td>
 426   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 427         <span class="sig-arg">html</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">sentinel</code><code class="variable-quote">'</code><code class="variable-group">]</code></span>,
 428         <span class="sig-arg">target</span>=<span class="sig-default">None</span>,
 429         <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>)</span>
 430     <br /><em class="fname">(Constructor)</em>
 431   </h3>
 432   </td><td align="right" valign="top"
 433     ><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#XMLParser.__init__">source&nbsp;code</a></span>&nbsp;
 434     </td>
 435   </tr></table>
 436
 437   x.__init__(...) initializes x; see help(type(x)) for signature
 438   <dl class="fields">
 439     <dt>Overrides:
 440         object.__init__
 441         <dd><em class="note">(inherited documentation)</em></dd>
 442     </dt>
 443   </dl>
 444 </td></tr></table>
 445 </div>
 446 <br />
 447 <!-- ==================== NAVIGATION BAR ==================== -->
 448 <table class="navbar" border="0" width="100%" cellpadding="0"
 449        bgcolor="#a0c0ff" cellspacing="0">
 450   <tr valign="middle">
 451   <!-- Home link -->
 452       <th>&nbsp;&nbsp;&nbsp;<a
 453         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 454
 455   <!-- Tree link -->
 456       <th>&nbsp;&nbsp;&nbsp;<a
 457         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 458
 459   <!-- Index link -->
 460       <th>&nbsp;&nbsp;&nbsp;<a
 461         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 462
 463   <!-- Help link -->
 464       <th>&nbsp;&nbsp;&nbsp;<a
 465         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 466
 467   <!-- Project homepage -->
 468       <th class="navbar" align="right" width="100%">
 469         <table border="0" cellpadding="0" cellspacing="0">
 470           <tr><th class="navbar" align="center"
 471             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 472           </tr></table></th>
 473   </tr>
 474 </table>
 475 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 476   <tr>
 477     <td align="left" class="footer">
 478     Generated by Epydoc 3.0.1
 479     on Wed Jan 29 12:26:21 2020
 480     </td>
 481     <td align="right" class="footer">
 482       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 483         >http://epydoc.sourceforge.net</a>
 484     </td>
 485   </tr>
 486 </table>
 487
 488 <script type="text/javascript">
 489   <!--
 490   // Private objects are initially displayed (because if
 491   // javascript is turned off then we want them to be
 492   // visible); but by default, we want to hide them.  So hide
 493   // them unless we have a cookie that says to show them.
 494   checkCookie();
 495   // -->
 496 </script>
 497 </body>
 498 </html>