doc/html/api/lxml.sax.ElementTreeContentHandler-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.sax.ElementTreeContentHandler</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.sax-module.html">Module&nbsp;sax</a> ::
  47         Class&nbsp;ElementTreeContentHandler
  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.sax.ElementTreeContentHandler-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 ElementTreeContentHandler</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66 xml.sax.handler.ContentHandler --+
  67                                  |
  68                                 <strong class="uidshort">ElementTreeContentHandler</strong>
  69 </pre>
  70
  71 <hr />
  72 Build an lxml ElementTree from SAX events.
  73
  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>
  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 href="lxml.sax.ElementTreeContentHandler-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  98         <span class="summary-sig-arg">makeelement</span>=<span class="summary-sig-default">None</span>)</span></td>
  99           <td align="right" valign="top">
 100             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.__init__">source&nbsp;code</a></span>
 101
 102           </td>
 103         </tr>
 104       </table>
 105
 106     </td>
 107   </tr>
 108 <tr class="private">
 109     <td width="15%" align="right" valign="top" class="summary">
 110       <span class="summary-type">&nbsp;</span>
 111     </td><td class="summary">
 112       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 113         <tr>
 114           <td><span class="summary-sig"><a name="_get_etree"></a><span class="summary-sig-name">_get_etree</span>(<span class="summary-sig-arg">self</span>)</span><br />
 115       Contains the generated ElementTree after parsing is finished.</td>
 116           <td align="right" valign="top">
 117             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler._get_etree">source&nbsp;code</a></span>
 118
 119           </td>
 120         </tr>
 121       </table>
 122
 123     </td>
 124   </tr>
 125 <tr>
 126     <td width="15%" align="right" valign="top" class="summary">
 127       <span class="summary-type">&nbsp;</span>
 128     </td><td class="summary">
 129       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 130         <tr>
 131           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#setDocumentLocator" class="summary-sig-name">setDocumentLocator</a>(<span class="summary-sig-arg">self</span>,
 132         <span class="summary-sig-arg">locator</span>)</span><br />
 133       Called by the parser to give the application a locator for
 134 locating the origin of document events.</td>
 135           <td align="right" valign="top">
 136             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.setDocumentLocator">source&nbsp;code</a></span>
 137
 138           </td>
 139         </tr>
 140       </table>
 141
 142     </td>
 143   </tr>
 144 <tr>
 145     <td width="15%" align="right" valign="top" class="summary">
 146       <span class="summary-type">&nbsp;</span>
 147     </td><td class="summary">
 148       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 149         <tr>
 150           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#startDocument" class="summary-sig-name">startDocument</a>(<span class="summary-sig-arg">self</span>)</span><br />
 151       Receive notification of the beginning of a document.</td>
 152           <td align="right" valign="top">
 153             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startDocument">source&nbsp;code</a></span>
 154
 155           </td>
 156         </tr>
 157       </table>
 158
 159     </td>
 160   </tr>
 161 <tr>
 162     <td width="15%" align="right" valign="top" class="summary">
 163       <span class="summary-type">&nbsp;</span>
 164     </td><td class="summary">
 165       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 166         <tr>
 167           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#endDocument" class="summary-sig-name">endDocument</a>(<span class="summary-sig-arg">self</span>)</span><br />
 168       Receive notification of the end of a document.</td>
 169           <td align="right" valign="top">
 170             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endDocument">source&nbsp;code</a></span>
 171
 172           </td>
 173         </tr>
 174       </table>
 175
 176     </td>
 177   </tr>
 178 <tr>
 179     <td width="15%" align="right" valign="top" class="summary">
 180       <span class="summary-type">&nbsp;</span>
 181     </td><td class="summary">
 182       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 183         <tr>
 184           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#startPrefixMapping" class="summary-sig-name">startPrefixMapping</a>(<span class="summary-sig-arg">self</span>,
 185         <span class="summary-sig-arg">prefix</span>,
 186         <span class="summary-sig-arg">uri</span>)</span><br />
 187       Begin the scope of a prefix-URI Namespace mapping.</td>
 188           <td align="right" valign="top">
 189             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startPrefixMapping">source&nbsp;code</a></span>
 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">&nbsp;</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.sax.ElementTreeContentHandler-class.html#endPrefixMapping" class="summary-sig-name">endPrefixMapping</a>(<span class="summary-sig-arg">self</span>,
 204         <span class="summary-sig-arg">prefix</span>)</span><br />
 205       End the scope of a prefix-URI mapping.</td>
 206           <td align="right" valign="top">
 207             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endPrefixMapping">source&nbsp;code</a></span>
 208
 209           </td>
 210         </tr>
 211       </table>
 212
 213     </td>
 214   </tr>
 215 <tr class="private">
 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="_buildTag"></a><span class="summary-sig-name">_buildTag</span>(<span class="summary-sig-arg">self</span>,
 222         <span class="summary-sig-arg">ns_name_tuple</span>)</span></td>
 223           <td align="right" valign="top">
 224             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler._buildTag">source&nbsp;code</a></span>
 225
 226           </td>
 227         </tr>
 228       </table>
 229
 230     </td>
 231   </tr>
 232 <tr>
 233     <td width="15%" align="right" valign="top" class="summary">
 234       <span class="summary-type">&nbsp;</span>
 235     </td><td class="summary">
 236       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 237         <tr>
 238           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#startElementNS" class="summary-sig-name">startElementNS</a>(<span class="summary-sig-arg">self</span>,
 239         <span class="summary-sig-arg">ns_name</span>,
 240         <span class="summary-sig-arg">qname</span>,
 241         <span class="summary-sig-arg">attributes</span>=<span class="summary-sig-default">None</span>)</span><br />
 242       Signals the start of an element in namespace mode.</td>
 243           <td align="right" valign="top">
 244             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startElementNS">source&nbsp;code</a></span>
 245
 246           </td>
 247         </tr>
 248       </table>
 249
 250     </td>
 251   </tr>
 252 <tr>
 253     <td width="15%" align="right" valign="top" class="summary">
 254       <span class="summary-type">&nbsp;</span>
 255     </td><td class="summary">
 256       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 257         <tr>
 258           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#processingInstruction" class="summary-sig-name">processingInstruction</a>(<span class="summary-sig-arg">self</span>,
 259         <span class="summary-sig-arg">target</span>,
 260         <span class="summary-sig-arg">data</span>)</span><br />
 261       Receive notification of a processing instruction.</td>
 262           <td align="right" valign="top">
 263             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.processingInstruction">source&nbsp;code</a></span>
 264
 265           </td>
 266         </tr>
 267       </table>
 268
 269     </td>
 270   </tr>
 271 <tr>
 272     <td width="15%" align="right" valign="top" class="summary">
 273       <span class="summary-type">&nbsp;</span>
 274     </td><td class="summary">
 275       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 276         <tr>
 277           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#endElementNS" class="summary-sig-name">endElementNS</a>(<span class="summary-sig-arg">self</span>,
 278         <span class="summary-sig-arg">ns_name</span>,
 279         <span class="summary-sig-arg">qname</span>)</span><br />
 280       Signals the end of an element in namespace mode.</td>
 281           <td align="right" valign="top">
 282             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endElementNS">source&nbsp;code</a></span>
 283
 284           </td>
 285         </tr>
 286       </table>
 287
 288     </td>
 289   </tr>
 290 <tr>
 291     <td width="15%" align="right" valign="top" class="summary">
 292       <span class="summary-type">&nbsp;</span>
 293     </td><td class="summary">
 294       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 295         <tr>
 296           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#startElement" class="summary-sig-name">startElement</a>(<span class="summary-sig-arg">self</span>,
 297         <span class="summary-sig-arg">name</span>,
 298         <span class="summary-sig-arg">attributes</span>=<span class="summary-sig-default">None</span>)</span><br />
 299       Signals the start of an element in non-namespace mode.</td>
 300           <td align="right" valign="top">
 301             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startElement">source&nbsp;code</a></span>
 302
 303           </td>
 304         </tr>
 305       </table>
 306
 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       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 314         <tr>
 315           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#endElement" class="summary-sig-name">endElement</a>(<span class="summary-sig-arg">self</span>,
 316         <span class="summary-sig-arg">name</span>)</span><br />
 317       Signals the end of an element in non-namespace mode.</td>
 318           <td align="right" valign="top">
 319             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endElement">source&nbsp;code</a></span>
 320
 321           </td>
 322         </tr>
 323       </table>
 324
 325     </td>
 326   </tr>
 327 <tr>
 328     <td width="15%" align="right" valign="top" class="summary">
 329       <span class="summary-type">&nbsp;</span>
 330     </td><td class="summary">
 331       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 332         <tr>
 333           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#characters" class="summary-sig-name">characters</a>(<span class="summary-sig-arg">self</span>,
 334         <span class="summary-sig-arg">data</span>)</span><br />
 335       Receive notification of character data.</td>
 336           <td align="right" valign="top">
 337             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.characters">source&nbsp;code</a></span>
 338
 339           </td>
 340         </tr>
 341       </table>
 342
 343     </td>
 344   </tr>
 345 <tr>
 346     <td width="15%" align="right" valign="top" class="summary">
 347       <span class="summary-type">&nbsp;</span>
 348     </td><td class="summary">
 349       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 350         <tr>
 351           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#ignorableWhitespace" class="summary-sig-name">ignorableWhitespace</a>(<span class="summary-sig-arg">self</span>,
 352         <span class="summary-sig-arg">data</span>)</span><br />
 353       Receive notification of character data.</td>
 354           <td align="right" valign="top">
 355             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.characters">source&nbsp;code</a></span>
 356
 357           </td>
 358         </tr>
 359       </table>
 360
 361     </td>
 362   </tr>
 363   <tr>
 364     <td colspan="2" class="summary">
 365     <p class="indent-wrapped-lines"><b>Inherited from <code>xml.sax.handler.ContentHandler</code></b>:
 366       <code>skippedEntity</code>
 367       </p>
 368     </td>
 369   </tr>
 370 </table>
 371 <!-- ==================== CLASS VARIABLES ==================== -->
 372 <a name="section-ClassVariables"></a>
 373 <table class="summary" border="1" cellpadding="3"
 374        cellspacing="0" width="100%" bgcolor="white">
 375 <tr bgcolor="#70b0f0" class="table-header">
 376   <td colspan="2" class="table-header">
 377     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 378       <tr valign="top">
 379         <td align="left"><span class="table-header">Class Variables</span></td>
 380         <td align="right" valign="top"
 381          ><span class="options">[<a href="#section-ClassVariables"
 382          class="privatelink" onclick="toggle_private();"
 383          >hide private</a>]</span></td>
 384       </tr>
 385     </table>
 386   </td>
 387 </tr>
 388 <tr>
 389     <td width="15%" align="right" valign="top" class="summary">
 390       <span class="summary-type">&nbsp;</span>
 391     </td><td class="summary">
 392         <a name="__qualname__"></a><span class="summary-name">__qualname__</span> = <code title="'ElementTreeContentHandler'"><code class="variable-quote">'</code><code class="variable-string">ElementTreeContentHandler</code><code class="variable-quote">'</code></code>
 393     </td>
 394   </tr>
 395 </table>
 396 <!-- ==================== PROPERTIES ==================== -->
 397 <a name="section-Properties"></a>
 398 <table class="summary" border="1" cellpadding="3"
 399        cellspacing="0" width="100%" bgcolor="white">
 400 <tr bgcolor="#70b0f0" class="table-header">
 401   <td colspan="2" class="table-header">
 402     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 403       <tr valign="top">
 404         <td align="left"><span class="table-header">Properties</span></td>
 405         <td align="right" valign="top"
 406          ><span class="options">[<a href="#section-Properties"
 407          class="privatelink" onclick="toggle_private();"
 408          >hide private</a>]</span></td>
 409       </tr>
 410     </table>
 411   </td>
 412 </tr>
 413 <tr>
 414     <td width="15%" align="right" valign="top" class="summary">
 415       <span class="summary-type">&nbsp;</span>
 416     </td><td class="summary">
 417         <a href="lxml.sax.ElementTreeContentHandler-class.html#etree" class="summary-name">etree</a><br />
 418       Contains the generated ElementTree after parsing is finished.
 419     </td>
 420   </tr>
 421 </table>
 422 <!-- ==================== METHOD DETAILS ==================== -->
 423 <a name="section-MethodDetails"></a>
 424 <table class="details" border="1" cellpadding="3"
 425        cellspacing="0" width="100%" bgcolor="white">
 426 <tr bgcolor="#70b0f0" class="table-header">
 427   <td colspan="2" class="table-header">
 428     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 429       <tr valign="top">
 430         <td align="left"><span class="table-header">Method Details</span></td>
 431         <td align="right" valign="top"
 432          ><span class="options">[<a href="#section-MethodDetails"
 433          class="privatelink" onclick="toggle_private();"
 434          >hide private</a>]</span></td>
 435       </tr>
 436     </table>
 437   </td>
 438 </tr>
 439 </table>
 440 <a name="__init__"></a>
 441 <div>
 442 <table class="details" border="1" cellpadding="3"
 443        cellspacing="0" width="100%" bgcolor="white">
 444 <tr><td>
 445   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 446   <tr valign="top"><td>
 447   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 448         <span class="sig-arg">makeelement</span>=<span class="sig-default">None</span>)</span>
 449     <br /><em class="fname">(Constructor)</em>
 450   </h3>
 451   </td><td align="right" valign="top"
 452     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.__init__">source&nbsp;code</a></span>&nbsp;
 453     </td>
 454   </tr></table>
 455
 456
 457   <dl class="fields">
 458     <dt>Overrides:
 459         xml.sax.handler.ContentHandler.__init__
 460     </dt>
 461   </dl>
 462 </td></tr></table>
 463 </div>
 464 <a name="setDocumentLocator"></a>
 465 <div>
 466 <table class="details" border="1" cellpadding="3"
 467        cellspacing="0" width="100%" bgcolor="white">
 468 <tr><td>
 469   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 470   <tr valign="top"><td>
 471   <h3 class="epydoc"><span class="sig"><span class="sig-name">setDocumentLocator</span>(<span class="sig-arg">self</span>,
 472         <span class="sig-arg">locator</span>)</span>
 473   </h3>
 474   </td><td align="right" valign="top"
 475     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.setDocumentLocator">source&nbsp;code</a></span>&nbsp;
 476     </td>
 477   </tr></table>
 478
 479   <p>Called by the parser to give the application a locator for
 480 locating the origin of document events.</p>
 481 <p>SAX parsers are strongly encouraged (though not absolutely
 482 required) to supply a locator: if it does so, it must supply
 483 the locator to the application by invoking this method before
 484 invoking any of the other methods in the DocumentHandler
 485 interface.</p>
 486 <p>The locator allows the application to determine the end
 487 position of any document-related event, even if the parser is
 488 not reporting an error. Typically, the application will use
 489 this information for reporting its own errors (such as
 490 character content that does not match an application's
 491 business rules). The information returned by the locator is
 492 probably not sufficient for use with a search engine.</p>
 493 <p>Note that the locator will return correct information only
 494 during the invocation of the events in this interface. The
 495 application should not attempt to use it at any other time.</p>
 496   <dl class="fields">
 497     <dt>Overrides:
 498         xml.sax.handler.ContentHandler.setDocumentLocator
 499         <dd><em class="note">(inherited documentation)</em></dd>
 500     </dt>
 501   </dl>
 502 </td></tr></table>
 503 </div>
 504 <a name="startDocument"></a>
 505 <div>
 506 <table class="details" border="1" cellpadding="3"
 507        cellspacing="0" width="100%" bgcolor="white">
 508 <tr><td>
 509   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 510   <tr valign="top"><td>
 511   <h3 class="epydoc"><span class="sig"><span class="sig-name">startDocument</span>(<span class="sig-arg">self</span>)</span>
 512   </h3>
 513   </td><td align="right" valign="top"
 514     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startDocument">source&nbsp;code</a></span>&nbsp;
 515     </td>
 516   </tr></table>
 517
 518   <p>Receive notification of the beginning of a document.</p>
 519 <p>The SAX parser will invoke this method only once, before any
 520 other methods in this interface or in DTDHandler (except for
 521 setDocumentLocator).</p>
 522   <dl class="fields">
 523     <dt>Overrides:
 524         xml.sax.handler.ContentHandler.startDocument
 525         <dd><em class="note">(inherited documentation)</em></dd>
 526     </dt>
 527   </dl>
 528 </td></tr></table>
 529 </div>
 530 <a name="endDocument"></a>
 531 <div>
 532 <table class="details" border="1" cellpadding="3"
 533        cellspacing="0" width="100%" bgcolor="white">
 534 <tr><td>
 535   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 536   <tr valign="top"><td>
 537   <h3 class="epydoc"><span class="sig"><span class="sig-name">endDocument</span>(<span class="sig-arg">self</span>)</span>
 538   </h3>
 539   </td><td align="right" valign="top"
 540     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endDocument">source&nbsp;code</a></span>&nbsp;
 541     </td>
 542   </tr></table>
 543
 544   <p>Receive notification of the end of a document.</p>
 545 <p>The SAX parser will invoke this method only once, and it will
 546 be the last method invoked during the parse. The parser shall
 547 not invoke this method until it has either abandoned parsing
 548 (because of an unrecoverable error) or reached the end of
 549 input.</p>
 550   <dl class="fields">
 551     <dt>Overrides:
 552         xml.sax.handler.ContentHandler.endDocument
 553         <dd><em class="note">(inherited documentation)</em></dd>
 554     </dt>
 555   </dl>
 556 </td></tr></table>
 557 </div>
 558 <a name="startPrefixMapping"></a>
 559 <div>
 560 <table class="details" border="1" cellpadding="3"
 561        cellspacing="0" width="100%" bgcolor="white">
 562 <tr><td>
 563   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 564   <tr valign="top"><td>
 565   <h3 class="epydoc"><span class="sig"><span class="sig-name">startPrefixMapping</span>(<span class="sig-arg">self</span>,
 566         <span class="sig-arg">prefix</span>,
 567         <span class="sig-arg">uri</span>)</span>
 568   </h3>
 569   </td><td align="right" valign="top"
 570     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startPrefixMapping">source&nbsp;code</a></span>&nbsp;
 571     </td>
 572   </tr></table>
 573
 574   <p>Begin the scope of a prefix-URI Namespace mapping.</p>
 575 <p>The information from this event is not necessary for normal
 576 Namespace processing: the SAX XML reader will automatically
 577 replace prefixes for element and attribute names when the
 578 <a class="rst-reference external" href="http://xml.org/sax/features/namespaces" target="_top">http://xml.org/sax/features/namespaces</a> feature is true (the
 579 default).</p>
 580 <p>There are cases, however, when applications need to use
 581 prefixes in character data or in attribute values, where they
 582 cannot safely be expanded automatically; the
 583 start/endPrefixMapping event supplies the information to the
 584 application to expand prefixes in those contexts itself, if
 585 necessary.</p>
 586 <p>Note that start/endPrefixMapping events are not guaranteed to
 587 be properly nested relative to each-other: all
 588 startPrefixMapping events will occur before the corresponding
 589 startElement event, and all endPrefixMapping events will occur
 590 after the corresponding endElement event, but their order is
 591 not guaranteed.</p>
 592   <dl class="fields">
 593     <dt>Overrides:
 594         xml.sax.handler.ContentHandler.startPrefixMapping
 595         <dd><em class="note">(inherited documentation)</em></dd>
 596     </dt>
 597   </dl>
 598 </td></tr></table>
 599 </div>
 600 <a name="endPrefixMapping"></a>
 601 <div>
 602 <table class="details" border="1" cellpadding="3"
 603        cellspacing="0" width="100%" bgcolor="white">
 604 <tr><td>
 605   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 606   <tr valign="top"><td>
 607   <h3 class="epydoc"><span class="sig"><span class="sig-name">endPrefixMapping</span>(<span class="sig-arg">self</span>,
 608         <span class="sig-arg">prefix</span>)</span>
 609   </h3>
 610   </td><td align="right" valign="top"
 611     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endPrefixMapping">source&nbsp;code</a></span>&nbsp;
 612     </td>
 613   </tr></table>
 614
 615   <p>End the scope of a prefix-URI mapping.</p>
 616 <p>See startPrefixMapping for details. This event will always
 617 occur after the corresponding endElement event, but the order
 618 of endPrefixMapping events is not otherwise guaranteed.</p>
 619   <dl class="fields">
 620     <dt>Overrides:
 621         xml.sax.handler.ContentHandler.endPrefixMapping
 622         <dd><em class="note">(inherited documentation)</em></dd>
 623     </dt>
 624   </dl>
 625 </td></tr></table>
 626 </div>
 627 <a name="startElementNS"></a>
 628 <div>
 629 <table class="details" border="1" cellpadding="3"
 630        cellspacing="0" width="100%" bgcolor="white">
 631 <tr><td>
 632   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 633   <tr valign="top"><td>
 634   <h3 class="epydoc"><span class="sig"><span class="sig-name">startElementNS</span>(<span class="sig-arg">self</span>,
 635         <span class="sig-arg">ns_name</span>,
 636         <span class="sig-arg">qname</span>,
 637         <span class="sig-arg">attributes</span>=<span class="sig-default">None</span>)</span>
 638   </h3>
 639   </td><td align="right" valign="top"
 640     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startElementNS">source&nbsp;code</a></span>&nbsp;
 641     </td>
 642   </tr></table>
 643
 644   <p>Signals the start of an element in namespace mode.</p>
 645 <p>The name parameter contains the name of the element type as a
 646 (uri, localname) tuple, the qname parameter the raw XML 1.0
 647 name used in the source document, and the attrs parameter
 648 holds an instance of the Attributes class containing the
 649 attributes of the element.</p>
 650 <p>The uri part of the name tuple is None for elements which have
 651 no namespace.</p>
 652   <dl class="fields">
 653     <dt>Overrides:
 654         xml.sax.handler.ContentHandler.startElementNS
 655         <dd><em class="note">(inherited documentation)</em></dd>
 656     </dt>
 657   </dl>
 658 </td></tr></table>
 659 </div>
 660 <a name="processingInstruction"></a>
 661 <div>
 662 <table class="details" border="1" cellpadding="3"
 663        cellspacing="0" width="100%" bgcolor="white">
 664 <tr><td>
 665   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 666   <tr valign="top"><td>
 667   <h3 class="epydoc"><span class="sig"><span class="sig-name">processingInstruction</span>(<span class="sig-arg">self</span>,
 668         <span class="sig-arg">target</span>,
 669         <span class="sig-arg">data</span>)</span>
 670   </h3>
 671   </td><td align="right" valign="top"
 672     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.processingInstruction">source&nbsp;code</a></span>&nbsp;
 673     </td>
 674   </tr></table>
 675
 676   <p>Receive notification of a processing instruction.</p>
 677 <p>The Parser will invoke this method once for each processing
 678 instruction found: note that processing instructions may occur
 679 before or after the main document element.</p>
 680 <p>A SAX parser should never report an XML declaration (XML 1.0,
 681 section 2.8) or a text declaration (XML 1.0, section 4.3.1)
 682 using this method.</p>
 683   <dl class="fields">
 684     <dt>Overrides:
 685         xml.sax.handler.ContentHandler.processingInstruction
 686         <dd><em class="note">(inherited documentation)</em></dd>
 687     </dt>
 688   </dl>
 689 </td></tr></table>
 690 </div>
 691 <a name="endElementNS"></a>
 692 <div>
 693 <table class="details" border="1" cellpadding="3"
 694        cellspacing="0" width="100%" bgcolor="white">
 695 <tr><td>
 696   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 697   <tr valign="top"><td>
 698   <h3 class="epydoc"><span class="sig"><span class="sig-name">endElementNS</span>(<span class="sig-arg">self</span>,
 699         <span class="sig-arg">ns_name</span>,
 700         <span class="sig-arg">qname</span>)</span>
 701   </h3>
 702   </td><td align="right" valign="top"
 703     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endElementNS">source&nbsp;code</a></span>&nbsp;
 704     </td>
 705   </tr></table>
 706
 707   <p>Signals the end of an element in namespace mode.</p>
 708 <p>The name parameter contains the name of the element type, just
 709 as with the startElementNS event.</p>
 710   <dl class="fields">
 711     <dt>Overrides:
 712         xml.sax.handler.ContentHandler.endElementNS
 713         <dd><em class="note">(inherited documentation)</em></dd>
 714     </dt>
 715   </dl>
 716 </td></tr></table>
 717 </div>
 718 <a name="startElement"></a>
 719 <div>
 720 <table class="details" border="1" cellpadding="3"
 721        cellspacing="0" width="100%" bgcolor="white">
 722 <tr><td>
 723   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 724   <tr valign="top"><td>
 725   <h3 class="epydoc"><span class="sig"><span class="sig-name">startElement</span>(<span class="sig-arg">self</span>,
 726         <span class="sig-arg">name</span>,
 727         <span class="sig-arg">attributes</span>=<span class="sig-default">None</span>)</span>
 728   </h3>
 729   </td><td align="right" valign="top"
 730     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startElement">source&nbsp;code</a></span>&nbsp;
 731     </td>
 732   </tr></table>
 733
 734   <p>Signals the start of an element in non-namespace mode.</p>
 735 <p>The name parameter contains the raw XML 1.0 name of the
 736 element type as a string and the attrs parameter holds an
 737 instance of the Attributes class containing the attributes of
 738 the element.</p>
 739   <dl class="fields">
 740     <dt>Overrides:
 741         xml.sax.handler.ContentHandler.startElement
 742         <dd><em class="note">(inherited documentation)</em></dd>
 743     </dt>
 744   </dl>
 745 </td></tr></table>
 746 </div>
 747 <a name="endElement"></a>
 748 <div>
 749 <table class="details" border="1" cellpadding="3"
 750        cellspacing="0" width="100%" bgcolor="white">
 751 <tr><td>
 752   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 753   <tr valign="top"><td>
 754   <h3 class="epydoc"><span class="sig"><span class="sig-name">endElement</span>(<span class="sig-arg">self</span>,
 755         <span class="sig-arg">name</span>)</span>
 756   </h3>
 757   </td><td align="right" valign="top"
 758     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endElement">source&nbsp;code</a></span>&nbsp;
 759     </td>
 760   </tr></table>
 761
 762   <p>Signals the end of an element in non-namespace mode.</p>
 763 <p>The name parameter contains the name of the element type, just
 764 as with the startElement event.</p>
 765   <dl class="fields">
 766     <dt>Overrides:
 767         xml.sax.handler.ContentHandler.endElement
 768         <dd><em class="note">(inherited documentation)</em></dd>
 769     </dt>
 770   </dl>
 771 </td></tr></table>
 772 </div>
 773 <a name="characters"></a>
 774 <div>
 775 <table class="details" border="1" cellpadding="3"
 776        cellspacing="0" width="100%" bgcolor="white">
 777 <tr><td>
 778   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 779   <tr valign="top"><td>
 780   <h3 class="epydoc"><span class="sig"><span class="sig-name">characters</span>(<span class="sig-arg">self</span>,
 781         <span class="sig-arg">data</span>)</span>
 782   </h3>
 783   </td><td align="right" valign="top"
 784     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.characters">source&nbsp;code</a></span>&nbsp;
 785     </td>
 786   </tr></table>
 787
 788   <p>Receive notification of character data.</p>
 789 <p>The Parser will call this method to report each chunk of
 790 character data. SAX parsers may return all contiguous
 791 character data in a single chunk, or they may split it into
 792 several chunks; however, all of the characters in any single
 793 event must come from the same external entity so that the
 794 Locator provides useful information.</p>
 795   <dl class="fields">
 796     <dt>Overrides:
 797         xml.sax.handler.ContentHandler.characters
 798         <dd><em class="note">(inherited documentation)</em></dd>
 799     </dt>
 800   </dl>
 801 </td></tr></table>
 802 </div>
 803 <a name="ignorableWhitespace"></a>
 804 <div>
 805 <table class="details" border="1" cellpadding="3"
 806        cellspacing="0" width="100%" bgcolor="white">
 807 <tr><td>
 808   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 809   <tr valign="top"><td>
 810   <h3 class="epydoc"><span class="sig"><span class="sig-name">ignorableWhitespace</span>(<span class="sig-arg">self</span>,
 811         <span class="sig-arg">data</span>)</span>
 812   </h3>
 813   </td><td align="right" valign="top"
 814     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.characters">source&nbsp;code</a></span>&nbsp;
 815     </td>
 816   </tr></table>
 817
 818   <p>Receive notification of character data.</p>
 819 <p>The Parser will call this method to report each chunk of
 820 character data. SAX parsers may return all contiguous
 821 character data in a single chunk, or they may split it into
 822 several chunks; however, all of the characters in any single
 823 event must come from the same external entity so that the
 824 Locator provides useful information.</p>
 825   <dl class="fields">
 826     <dt>Overrides:
 827         xml.sax.handler.ContentHandler.ignorableWhitespace
 828         <dd><em class="note">(inherited documentation)</em></dd>
 829     </dt>
 830   </dl>
 831 </td></tr></table>
 832 </div>
 833 <br />
 834 <!-- ==================== PROPERTY DETAILS ==================== -->
 835 <a name="section-PropertyDetails"></a>
 836 <table class="details" border="1" cellpadding="3"
 837        cellspacing="0" width="100%" bgcolor="white">
 838 <tr bgcolor="#70b0f0" class="table-header">
 839   <td colspan="2" class="table-header">
 840     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 841       <tr valign="top">
 842         <td align="left"><span class="table-header">Property Details</span></td>
 843         <td align="right" valign="top"
 844          ><span class="options">[<a href="#section-PropertyDetails"
 845          class="privatelink" onclick="toggle_private();"
 846          >hide private</a>]</span></td>
 847       </tr>
 848     </table>
 849   </td>
 850 </tr>
 851 </table>
 852 <a name="etree"></a>
 853 <div>
 854 <table class="details" border="1" cellpadding="3"
 855        cellspacing="0" width="100%" bgcolor="white">
 856 <tr><td>
 857   <h3 class="epydoc">etree</h3>
 858   Contains the generated ElementTree after parsing is finished.
 859   <dl class="fields">
 860     <dt>Get Method:</dt>
 861     <dd class="value"><span class="summary-sig"><a href="lxml.sax.ElementTreeContentHandler-class.html#_get_etree" class="summary-sig-name" onclick="show_private();">_get_etree</a>(<span class="summary-sig-arg">self</span>)</span>
 862         - Contains the generated ElementTree after parsing is finished.
 863     </dd>
 864   </dl>
 865 </td></tr></table>
 866 </div>
 867 <br />
 868 <!-- ==================== NAVIGATION BAR ==================== -->
 869 <table class="navbar" border="0" width="100%" cellpadding="0"
 870        bgcolor="#a0c0ff" cellspacing="0">
 871   <tr valign="middle">
 872   <!-- Home link -->
 873       <th>&nbsp;&nbsp;&nbsp;<a
 874         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 875
 876   <!-- Tree link -->
 877       <th>&nbsp;&nbsp;&nbsp;<a
 878         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 879
 880   <!-- Index link -->
 881       <th>&nbsp;&nbsp;&nbsp;<a
 882         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 883
 884   <!-- Help link -->
 885       <th>&nbsp;&nbsp;&nbsp;<a
 886         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 887
 888   <!-- Project homepage -->
 889       <th class="navbar" align="right" width="100%">
 890         <table border="0" cellpadding="0" cellspacing="0">
 891           <tr><th class="navbar" align="center"
 892             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 893           </tr></table></th>
 894   </tr>
 895 </table>
 896 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 897   <tr>
 898     <td align="left" class="footer">
 899     Generated by Epydoc 3.0.1
 900     on Wed Jan 29 12:26:21 2020
 901     </td>
 902     <td align="right" class="footer">
 903       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 904         >http://epydoc.sourceforge.net</a>
 905     </td>
 906   </tr>
 907 </table>
 908
 909 <script type="text/javascript">
 910   <!--
 911   // Private objects are initially displayed (because if
 912   // javascript is turned off then we want them to be
 913   // visible); but by default, we want to hide them.  So hide
 914   // them unless we have a cookie that says to show them.
 915   checkCookie();
 916   // -->
 917 </script>
 918 </body>
 919 </html>