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 <!-- ==================== PROPERTIES ==================== -->
 372 <a name="section-Properties"></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">Properties</span></td>
 380         <td align="right" valign="top"
 381          ><span class="options">[<a href="#section-Properties"
 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 href="lxml.sax.ElementTreeContentHandler-class.html#etree" class="summary-name">etree</a><br />
 393       Contains the generated ElementTree after parsing is finished.
 394     </td>
 395   </tr>
 396 </table>
 397 <!-- ==================== METHOD DETAILS ==================== -->
 398 <a name="section-MethodDetails"></a>
 399 <table class="details" border="1" cellpadding="3"
 400        cellspacing="0" width="100%" bgcolor="white">
 401 <tr bgcolor="#70b0f0" class="table-header">
 402   <td colspan="2" class="table-header">
 403     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 404       <tr valign="top">
 405         <td align="left"><span class="table-header">Method Details</span></td>
 406         <td align="right" valign="top"
 407          ><span class="options">[<a href="#section-MethodDetails"
 408          class="privatelink" onclick="toggle_private();"
 409          >hide private</a>]</span></td>
 410       </tr>
 411     </table>
 412   </td>
 413 </tr>
 414 </table>
 415 <a name="__init__"></a>
 416 <div>
 417 <table class="details" border="1" cellpadding="3"
 418        cellspacing="0" width="100%" bgcolor="white">
 419 <tr><td>
 420   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 421   <tr valign="top"><td>
 422   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 423         <span class="sig-arg">makeelement</span>=<span class="sig-default">None</span>)</span>
 424     <br /><em class="fname">(Constructor)</em>
 425   </h3>
 426   </td><td align="right" valign="top"
 427     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.__init__">source&nbsp;code</a></span>&nbsp;
 428     </td>
 429   </tr></table>
 430
 431
 432   <dl class="fields">
 433     <dt>Overrides:
 434         xml.sax.handler.ContentHandler.__init__
 435     </dt>
 436   </dl>
 437 </td></tr></table>
 438 </div>
 439 <a name="setDocumentLocator"></a>
 440 <div>
 441 <table class="details" border="1" cellpadding="3"
 442        cellspacing="0" width="100%" bgcolor="white">
 443 <tr><td>
 444   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 445   <tr valign="top"><td>
 446   <h3 class="epydoc"><span class="sig"><span class="sig-name">setDocumentLocator</span>(<span class="sig-arg">self</span>,
 447         <span class="sig-arg">locator</span>)</span>
 448   </h3>
 449   </td><td align="right" valign="top"
 450     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.setDocumentLocator">source&nbsp;code</a></span>&nbsp;
 451     </td>
 452   </tr></table>
 453
 454   <p>Called by the parser to give the application a locator for
 455 locating the origin of document events.</p>
 456 <p>SAX parsers are strongly encouraged (though not absolutely
 457 required) to supply a locator: if it does so, it must supply
 458 the locator to the application by invoking this method before
 459 invoking any of the other methods in the DocumentHandler
 460 interface.</p>
 461 <p>The locator allows the application to determine the end
 462 position of any document-related event, even if the parser is
 463 not reporting an error. Typically, the application will use
 464 this information for reporting its own errors (such as
 465 character content that does not match an application's
 466 business rules). The information returned by the locator is
 467 probably not sufficient for use with a search engine.</p>
 468 <p>Note that the locator will return correct information only
 469 during the invocation of the events in this interface. The
 470 application should not attempt to use it at any other time.</p>
 471   <dl class="fields">
 472     <dt>Overrides:
 473         xml.sax.handler.ContentHandler.setDocumentLocator
 474         <dd><em class="note">(inherited documentation)</em></dd>
 475     </dt>
 476   </dl>
 477 </td></tr></table>
 478 </div>
 479 <a name="startDocument"></a>
 480 <div>
 481 <table class="details" border="1" cellpadding="3"
 482        cellspacing="0" width="100%" bgcolor="white">
 483 <tr><td>
 484   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 485   <tr valign="top"><td>
 486   <h3 class="epydoc"><span class="sig"><span class="sig-name">startDocument</span>(<span class="sig-arg">self</span>)</span>
 487   </h3>
 488   </td><td align="right" valign="top"
 489     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startDocument">source&nbsp;code</a></span>&nbsp;
 490     </td>
 491   </tr></table>
 492
 493   <p>Receive notification of the beginning of a document.</p>
 494 <p>The SAX parser will invoke this method only once, before any
 495 other methods in this interface or in DTDHandler (except for
 496 setDocumentLocator).</p>
 497   <dl class="fields">
 498     <dt>Overrides:
 499         xml.sax.handler.ContentHandler.startDocument
 500         <dd><em class="note">(inherited documentation)</em></dd>
 501     </dt>
 502   </dl>
 503 </td></tr></table>
 504 </div>
 505 <a name="endDocument"></a>
 506 <div>
 507 <table class="details" border="1" cellpadding="3"
 508        cellspacing="0" width="100%" bgcolor="white">
 509 <tr><td>
 510   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 511   <tr valign="top"><td>
 512   <h3 class="epydoc"><span class="sig"><span class="sig-name">endDocument</span>(<span class="sig-arg">self</span>)</span>
 513   </h3>
 514   </td><td align="right" valign="top"
 515     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endDocument">source&nbsp;code</a></span>&nbsp;
 516     </td>
 517   </tr></table>
 518
 519   <p>Receive notification of the end of a document.</p>
 520 <p>The SAX parser will invoke this method only once, and it will
 521 be the last method invoked during the parse. The parser shall
 522 not invoke this method until it has either abandoned parsing
 523 (because of an unrecoverable error) or reached the end of
 524 input.</p>
 525   <dl class="fields">
 526     <dt>Overrides:
 527         xml.sax.handler.ContentHandler.endDocument
 528         <dd><em class="note">(inherited documentation)</em></dd>
 529     </dt>
 530   </dl>
 531 </td></tr></table>
 532 </div>
 533 <a name="startPrefixMapping"></a>
 534 <div>
 535 <table class="details" border="1" cellpadding="3"
 536        cellspacing="0" width="100%" bgcolor="white">
 537 <tr><td>
 538   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 539   <tr valign="top"><td>
 540   <h3 class="epydoc"><span class="sig"><span class="sig-name">startPrefixMapping</span>(<span class="sig-arg">self</span>,
 541         <span class="sig-arg">prefix</span>,
 542         <span class="sig-arg">uri</span>)</span>
 543   </h3>
 544   </td><td align="right" valign="top"
 545     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startPrefixMapping">source&nbsp;code</a></span>&nbsp;
 546     </td>
 547   </tr></table>
 548
 549   <p>Begin the scope of a prefix-URI Namespace mapping.</p>
 550 <p>The information from this event is not necessary for normal
 551 Namespace processing: the SAX XML reader will automatically
 552 replace prefixes for element and attribute names when the
 553 <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
 554 default).</p>
 555 <p>There are cases, however, when applications need to use
 556 prefixes in character data or in attribute values, where they
 557 cannot safely be expanded automatically; the
 558 start/endPrefixMapping event supplies the information to the
 559 application to expand prefixes in those contexts itself, if
 560 necessary.</p>
 561 <p>Note that start/endPrefixMapping events are not guaranteed to
 562 be properly nested relative to each-other: all
 563 startPrefixMapping events will occur before the corresponding
 564 startElement event, and all endPrefixMapping events will occur
 565 after the corresponding endElement event, but their order is
 566 not guaranteed.</p>
 567   <dl class="fields">
 568     <dt>Overrides:
 569         xml.sax.handler.ContentHandler.startPrefixMapping
 570         <dd><em class="note">(inherited documentation)</em></dd>
 571     </dt>
 572   </dl>
 573 </td></tr></table>
 574 </div>
 575 <a name="endPrefixMapping"></a>
 576 <div>
 577 <table class="details" border="1" cellpadding="3"
 578        cellspacing="0" width="100%" bgcolor="white">
 579 <tr><td>
 580   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 581   <tr valign="top"><td>
 582   <h3 class="epydoc"><span class="sig"><span class="sig-name">endPrefixMapping</span>(<span class="sig-arg">self</span>,
 583         <span class="sig-arg">prefix</span>)</span>
 584   </h3>
 585   </td><td align="right" valign="top"
 586     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endPrefixMapping">source&nbsp;code</a></span>&nbsp;
 587     </td>
 588   </tr></table>
 589
 590   <p>End the scope of a prefix-URI mapping.</p>
 591 <p>See startPrefixMapping for details. This event will always
 592 occur after the corresponding endElement event, but the order
 593 of endPrefixMapping events is not otherwise guaranteed.</p>
 594   <dl class="fields">
 595     <dt>Overrides:
 596         xml.sax.handler.ContentHandler.endPrefixMapping
 597         <dd><em class="note">(inherited documentation)</em></dd>
 598     </dt>
 599   </dl>
 600 </td></tr></table>
 601 </div>
 602 <a name="startElementNS"></a>
 603 <div>
 604 <table class="details" border="1" cellpadding="3"
 605        cellspacing="0" width="100%" bgcolor="white">
 606 <tr><td>
 607   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 608   <tr valign="top"><td>
 609   <h3 class="epydoc"><span class="sig"><span class="sig-name">startElementNS</span>(<span class="sig-arg">self</span>,
 610         <span class="sig-arg">ns_name</span>,
 611         <span class="sig-arg">qname</span>,
 612         <span class="sig-arg">attributes</span>=<span class="sig-default">None</span>)</span>
 613   </h3>
 614   </td><td align="right" valign="top"
 615     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startElementNS">source&nbsp;code</a></span>&nbsp;
 616     </td>
 617   </tr></table>
 618
 619   <p>Signals the start of an element in namespace mode.</p>
 620 <p>The name parameter contains the name of the element type as a
 621 (uri, localname) tuple, the qname parameter the raw XML 1.0
 622 name used in the source document, and the attrs parameter
 623 holds an instance of the Attributes class containing the
 624 attributes of the element.</p>
 625 <p>The uri part of the name tuple is None for elements which have
 626 no namespace.</p>
 627   <dl class="fields">
 628     <dt>Overrides:
 629         xml.sax.handler.ContentHandler.startElementNS
 630         <dd><em class="note">(inherited documentation)</em></dd>
 631     </dt>
 632   </dl>
 633 </td></tr></table>
 634 </div>
 635 <a name="processingInstruction"></a>
 636 <div>
 637 <table class="details" border="1" cellpadding="3"
 638        cellspacing="0" width="100%" bgcolor="white">
 639 <tr><td>
 640   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 641   <tr valign="top"><td>
 642   <h3 class="epydoc"><span class="sig"><span class="sig-name">processingInstruction</span>(<span class="sig-arg">self</span>,
 643         <span class="sig-arg">target</span>,
 644         <span class="sig-arg">data</span>)</span>
 645   </h3>
 646   </td><td align="right" valign="top"
 647     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.processingInstruction">source&nbsp;code</a></span>&nbsp;
 648     </td>
 649   </tr></table>
 650
 651   <p>Receive notification of a processing instruction.</p>
 652 <p>The Parser will invoke this method once for each processing
 653 instruction found: note that processing instructions may occur
 654 before or after the main document element.</p>
 655 <p>A SAX parser should never report an XML declaration (XML 1.0,
 656 section 2.8) or a text declaration (XML 1.0, section 4.3.1)
 657 using this method.</p>
 658   <dl class="fields">
 659     <dt>Overrides:
 660         xml.sax.handler.ContentHandler.processingInstruction
 661         <dd><em class="note">(inherited documentation)</em></dd>
 662     </dt>
 663   </dl>
 664 </td></tr></table>
 665 </div>
 666 <a name="endElementNS"></a>
 667 <div>
 668 <table class="details" border="1" cellpadding="3"
 669        cellspacing="0" width="100%" bgcolor="white">
 670 <tr><td>
 671   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 672   <tr valign="top"><td>
 673   <h3 class="epydoc"><span class="sig"><span class="sig-name">endElementNS</span>(<span class="sig-arg">self</span>,
 674         <span class="sig-arg">ns_name</span>,
 675         <span class="sig-arg">qname</span>)</span>
 676   </h3>
 677   </td><td align="right" valign="top"
 678     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endElementNS">source&nbsp;code</a></span>&nbsp;
 679     </td>
 680   </tr></table>
 681
 682   <p>Signals the end of an element in namespace mode.</p>
 683 <p>The name parameter contains the name of the element type, just
 684 as with the startElementNS event.</p>
 685   <dl class="fields">
 686     <dt>Overrides:
 687         xml.sax.handler.ContentHandler.endElementNS
 688         <dd><em class="note">(inherited documentation)</em></dd>
 689     </dt>
 690   </dl>
 691 </td></tr></table>
 692 </div>
 693 <a name="startElement"></a>
 694 <div>
 695 <table class="details" border="1" cellpadding="3"
 696        cellspacing="0" width="100%" bgcolor="white">
 697 <tr><td>
 698   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 699   <tr valign="top"><td>
 700   <h3 class="epydoc"><span class="sig"><span class="sig-name">startElement</span>(<span class="sig-arg">self</span>,
 701         <span class="sig-arg">name</span>,
 702         <span class="sig-arg">attributes</span>=<span class="sig-default">None</span>)</span>
 703   </h3>
 704   </td><td align="right" valign="top"
 705     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.startElement">source&nbsp;code</a></span>&nbsp;
 706     </td>
 707   </tr></table>
 708
 709   <p>Signals the start of an element in non-namespace mode.</p>
 710 <p>The name parameter contains the raw XML 1.0 name of the
 711 element type as a string and the attrs parameter holds an
 712 instance of the Attributes class containing the attributes of
 713 the element.</p>
 714   <dl class="fields">
 715     <dt>Overrides:
 716         xml.sax.handler.ContentHandler.startElement
 717         <dd><em class="note">(inherited documentation)</em></dd>
 718     </dt>
 719   </dl>
 720 </td></tr></table>
 721 </div>
 722 <a name="endElement"></a>
 723 <div>
 724 <table class="details" border="1" cellpadding="3"
 725        cellspacing="0" width="100%" bgcolor="white">
 726 <tr><td>
 727   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 728   <tr valign="top"><td>
 729   <h3 class="epydoc"><span class="sig"><span class="sig-name">endElement</span>(<span class="sig-arg">self</span>,
 730         <span class="sig-arg">name</span>)</span>
 731   </h3>
 732   </td><td align="right" valign="top"
 733     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.endElement">source&nbsp;code</a></span>&nbsp;
 734     </td>
 735   </tr></table>
 736
 737   <p>Signals the end of an element in non-namespace mode.</p>
 738 <p>The name parameter contains the name of the element type, just
 739 as with the startElement event.</p>
 740   <dl class="fields">
 741     <dt>Overrides:
 742         xml.sax.handler.ContentHandler.endElement
 743         <dd><em class="note">(inherited documentation)</em></dd>
 744     </dt>
 745   </dl>
 746 </td></tr></table>
 747 </div>
 748 <a name="characters"></a>
 749 <div>
 750 <table class="details" border="1" cellpadding="3"
 751        cellspacing="0" width="100%" bgcolor="white">
 752 <tr><td>
 753   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 754   <tr valign="top"><td>
 755   <h3 class="epydoc"><span class="sig"><span class="sig-name">characters</span>(<span class="sig-arg">self</span>,
 756         <span class="sig-arg">data</span>)</span>
 757   </h3>
 758   </td><td align="right" valign="top"
 759     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.characters">source&nbsp;code</a></span>&nbsp;
 760     </td>
 761   </tr></table>
 762
 763   <p>Receive notification of character data.</p>
 764 <p>The Parser will call this method to report each chunk of
 765 character data. SAX parsers may return all contiguous
 766 character data in a single chunk, or they may split it into
 767 several chunks; however, all of the characters in any single
 768 event must come from the same external entity so that the
 769 Locator provides useful information.</p>
 770   <dl class="fields">
 771     <dt>Overrides:
 772         xml.sax.handler.ContentHandler.characters
 773         <dd><em class="note">(inherited documentation)</em></dd>
 774     </dt>
 775   </dl>
 776 </td></tr></table>
 777 </div>
 778 <a name="ignorableWhitespace"></a>
 779 <div>
 780 <table class="details" border="1" cellpadding="3"
 781        cellspacing="0" width="100%" bgcolor="white">
 782 <tr><td>
 783   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 784   <tr valign="top"><td>
 785   <h3 class="epydoc"><span class="sig"><span class="sig-name">ignorableWhitespace</span>(<span class="sig-arg">self</span>,
 786         <span class="sig-arg">data</span>)</span>
 787   </h3>
 788   </td><td align="right" valign="top"
 789     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeContentHandler.characters">source&nbsp;code</a></span>&nbsp;
 790     </td>
 791   </tr></table>
 792
 793   <p>Receive notification of character data.</p>
 794 <p>The Parser will call this method to report each chunk of
 795 character data. SAX parsers may return all contiguous
 796 character data in a single chunk, or they may split it into
 797 several chunks; however, all of the characters in any single
 798 event must come from the same external entity so that the
 799 Locator provides useful information.</p>
 800   <dl class="fields">
 801     <dt>Overrides:
 802         xml.sax.handler.ContentHandler.ignorableWhitespace
 803         <dd><em class="note">(inherited documentation)</em></dd>
 804     </dt>
 805   </dl>
 806 </td></tr></table>
 807 </div>
 808 <br />
 809 <!-- ==================== PROPERTY DETAILS ==================== -->
 810 <a name="section-PropertyDetails"></a>
 811 <table class="details" border="1" cellpadding="3"
 812        cellspacing="0" width="100%" bgcolor="white">
 813 <tr bgcolor="#70b0f0" class="table-header">
 814   <td colspan="2" class="table-header">
 815     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 816       <tr valign="top">
 817         <td align="left"><span class="table-header">Property Details</span></td>
 818         <td align="right" valign="top"
 819          ><span class="options">[<a href="#section-PropertyDetails"
 820          class="privatelink" onclick="toggle_private();"
 821          >hide private</a>]</span></td>
 822       </tr>
 823     </table>
 824   </td>
 825 </tr>
 826 </table>
 827 <a name="etree"></a>
 828 <div>
 829 <table class="details" border="1" cellpadding="3"
 830        cellspacing="0" width="100%" bgcolor="white">
 831 <tr><td>
 832   <h3 class="epydoc">etree</h3>
 833   Contains the generated ElementTree after parsing is finished.
 834   <dl class="fields">
 835     <dt>Get Method:</dt>
 836     <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>
 837         - Contains the generated ElementTree after parsing is finished.
 838     </dd>
 839   </dl>
 840 </td></tr></table>
 841 </div>
 842 <br />
 843 <!-- ==================== NAVIGATION BAR ==================== -->
 844 <table class="navbar" border="0" width="100%" cellpadding="0"
 845        bgcolor="#a0c0ff" cellspacing="0">
 846   <tr valign="middle">
 847   <!-- Home link -->
 848       <th>&nbsp;&nbsp;&nbsp;<a
 849         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 850
 851   <!-- Tree link -->
 852       <th>&nbsp;&nbsp;&nbsp;<a
 853         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 854
 855   <!-- Index link -->
 856       <th>&nbsp;&nbsp;&nbsp;<a
 857         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 858
 859   <!-- Help link -->
 860       <th>&nbsp;&nbsp;&nbsp;<a
 861         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 862
 863   <!-- Project homepage -->
 864       <th class="navbar" align="right" width="100%">
 865         <table border="0" cellpadding="0" cellspacing="0">
 866           <tr><th class="navbar" align="center"
 867             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 868           </tr></table></th>
 869   </tr>
 870 </table>
 871 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 872   <tr>
 873     <td align="left" class="footer">
 874     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
 875     </td>
 876     <td align="right" class="footer">
 877       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 878         >http://epydoc.sourceforge.net</a>
 879     </td>
 880   </tr>
 881 </table>
 882
 883 <script type="text/javascript">
 884   <!--
 885   // Private objects are initially displayed (because if
 886   // javascript is turned off then we want them to be
 887   // visible); but by default, we want to hide them.  So hide
 888   // them unless we have a cookie that says to show them.
 889   checkCookie();
 890   // -->
 891 </script>
 892 </body>
 893 </html>