doc/html/api/lxml.sax.ElementTreeProducer-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.ElementTreeProducer</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;ElementTreeProducer
  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.ElementTreeProducer-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 ElementTreeProducer</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">ElementTreeProducer</strong>
  69 </pre>
  70
  71 <hr />
  72 Produces SAX events for an element and children.
  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.ElementTreeProducer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  98         <span class="summary-sig-arg">element_or_tree</span>,
  99         <span class="summary-sig-arg">content_handler</span>)</span><br />
 100       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 101           <td align="right" valign="top">
 102             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.__init__">source&nbsp;code</a></span>
 103
 104           </td>
 105         </tr>
 106       </table>
 107
 108     </td>
 109   </tr>
 110 <tr>
 111     <td width="15%" align="right" valign="top" class="summary">
 112       <span class="summary-type">&nbsp;</span>
 113     </td><td class="summary">
 114       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 115         <tr>
 116           <td><span class="summary-sig"><a name="saxify"></a><span class="summary-sig-name">saxify</span>(<span class="summary-sig-arg">self</span>)</span></td>
 117           <td align="right" valign="top">
 118             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.saxify">source&nbsp;code</a></span>
 119
 120           </td>
 121         </tr>
 122       </table>
 123
 124     </td>
 125   </tr>
 126 <tr class="private">
 127     <td width="15%" align="right" valign="top" class="summary">
 128       <span class="summary-type">&nbsp;</span>
 129     </td><td class="summary">
 130       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 131         <tr>
 132           <td><span class="summary-sig"><a name="_recursive_saxify"></a><span class="summary-sig-name">_recursive_saxify</span>(<span class="summary-sig-arg">self</span>,
 133         <span class="summary-sig-arg">element</span>,
 134         <span class="summary-sig-arg">parent_nsmap</span>)</span></td>
 135           <td align="right" valign="top">
 136             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer._recursive_saxify">source&nbsp;code</a></span>
 137
 138           </td>
 139         </tr>
 140       </table>
 141
 142     </td>
 143   </tr>
 144 <tr class="private">
 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 name="_build_qname"></a><span class="summary-sig-name">_build_qname</span>(<span class="summary-sig-arg">self</span>,
 151         <span class="summary-sig-arg">ns_uri</span>,
 152         <span class="summary-sig-arg">local_name</span>,
 153         <span class="summary-sig-arg">nsmap</span>,
 154         <span class="summary-sig-arg">preferred_prefix</span>,
 155         <span class="summary-sig-arg">is_attribute</span>)</span></td>
 156           <td align="right" valign="top">
 157             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer._build_qname">source&nbsp;code</a></span>
 158
 159           </td>
 160         </tr>
 161       </table>
 162
 163     </td>
 164   </tr>
 165 <tr>
 166     <td width="15%" align="right" valign="top" class="summary">
 167       <span class="summary-type">a new object with type S, a subtype of T</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 href="lxml.sax.ElementTreeProducer-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 172         <span class="summary-sig-arg">S</span>,
 173         <span class="summary-sig-arg">...</span>)</span></td>
 174           <td align="right" valign="top">
 175             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.__new__">source&nbsp;code</a></span>
 176
 177           </td>
 178         </tr>
 179       </table>
 180
 181     </td>
 182   </tr>
 183 <tr>
 184     <td width="15%" align="right" valign="top" class="summary">
 185       <span class="summary-type">&nbsp;</span>
 186     </td><td class="summary">
 187       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 188         <tr>
 189           <td><span class="summary-sig"><a href="lxml.sax.ElementTreeProducer-class.html#__reduce__" class="summary-sig-name">__reduce__</a>(<span class="summary-sig-arg">...</span>)</span><br />
 190       helper for pickle</td>
 191           <td align="right" valign="top">
 192             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.__reduce__">source&nbsp;code</a></span>
 193
 194           </td>
 195         </tr>
 196       </table>
 197
 198     </td>
 199   </tr>
 200 <tr>
 201     <td width="15%" align="right" valign="top" class="summary">
 202       <span class="summary-type">&nbsp;</span>
 203     </td><td class="summary">
 204       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 205         <tr>
 206           <td><span class="summary-sig"><a name="__setstate__"></a><span class="summary-sig-name">__setstate__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 207           <td align="right" valign="top">
 208             <span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.__setstate__">source&nbsp;code</a></span>
 209
 210           </td>
 211         </tr>
 212       </table>
 213
 214     </td>
 215   </tr>
 216   <tr>
 217     <td colspan="2" class="summary">
 218     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 219       <code>__delattr__</code>,
 220       <code>__format__</code>,
 221       <code>__getattribute__</code>,
 222       <code>__hash__</code>,
 223       <code>__reduce_ex__</code>,
 224       <code>__repr__</code>,
 225       <code>__setattr__</code>,
 226       <code>__sizeof__</code>,
 227       <code>__str__</code>,
 228       <code>__subclasshook__</code>
 229       </p>
 230     </td>
 231   </tr>
 232 </table>
 233 <!-- ==================== PROPERTIES ==================== -->
 234 <a name="section-Properties"></a>
 235 <table class="summary" border="1" cellpadding="3"
 236        cellspacing="0" width="100%" bgcolor="white">
 237 <tr bgcolor="#70b0f0" class="table-header">
 238   <td colspan="2" class="table-header">
 239     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 240       <tr valign="top">
 241         <td align="left"><span class="table-header">Properties</span></td>
 242         <td align="right" valign="top"
 243          ><span class="options">[<a href="#section-Properties"
 244          class="privatelink" onclick="toggle_private();"
 245          >hide private</a>]</span></td>
 246       </tr>
 247     </table>
 248   </td>
 249 </tr>
 250   <tr>
 251     <td colspan="2" class="summary">
 252     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 253       <code>__class__</code>
 254       </p>
 255     </td>
 256   </tr>
 257 </table>
 258 <!-- ==================== METHOD DETAILS ==================== -->
 259 <a name="section-MethodDetails"></a>
 260 <table class="details" border="1" cellpadding="3"
 261        cellspacing="0" width="100%" bgcolor="white">
 262 <tr bgcolor="#70b0f0" class="table-header">
 263   <td colspan="2" class="table-header">
 264     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 265       <tr valign="top">
 266         <td align="left"><span class="table-header">Method Details</span></td>
 267         <td align="right" valign="top"
 268          ><span class="options">[<a href="#section-MethodDetails"
 269          class="privatelink" onclick="toggle_private();"
 270          >hide private</a>]</span></td>
 271       </tr>
 272     </table>
 273   </td>
 274 </tr>
 275 </table>
 276 <a name="__init__"></a>
 277 <div>
 278 <table class="details" border="1" cellpadding="3"
 279        cellspacing="0" width="100%" bgcolor="white">
 280 <tr><td>
 281   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 282   <tr valign="top"><td>
 283   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 284         <span class="sig-arg">element_or_tree</span>,
 285         <span class="sig-arg">content_handler</span>)</span>
 286     <br /><em class="fname">(Constructor)</em>
 287   </h3>
 288   </td><td align="right" valign="top"
 289     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.__init__">source&nbsp;code</a></span>&nbsp;
 290     </td>
 291   </tr></table>
 292
 293   x.__init__(...) initializes x; see help(type(x)) for signature
 294   <dl class="fields">
 295     <dt>Overrides:
 296         object.__init__
 297     </dt>
 298   </dl>
 299 </td></tr></table>
 300 </div>
 301 <a name="__new__"></a>
 302 <div>
 303 <table class="details" border="1" cellpadding="3"
 304        cellspacing="0" width="100%" bgcolor="white">
 305 <tr><td>
 306   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 307   <tr valign="top"><td>
 308   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 309         <span class="sig-arg">S</span>,
 310         <span class="sig-arg">...</span>)</span>
 311   </h3>
 312   </td><td align="right" valign="top"
 313     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.__new__">source&nbsp;code</a></span>&nbsp;
 314     </td>
 315   </tr></table>
 316
 317
 318   <dl class="fields">
 319     <dt>Returns: a new object with type S, a subtype of T</dt>
 320     <dt>Overrides:
 321         object.__new__
 322     </dt>
 323   </dl>
 324 </td></tr></table>
 325 </div>
 326 <a name="__reduce__"></a>
 327 <div>
 328 <table class="details" border="1" cellpadding="3"
 329        cellspacing="0" width="100%" bgcolor="white">
 330 <tr><td>
 331   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 332   <tr valign="top"><td>
 333   <h3 class="epydoc"><span class="sig"><span class="sig-name">__reduce__</span>(<span class="sig-arg">...</span>)</span>
 334   </h3>
 335   </td><td align="right" valign="top"
 336     ><span class="codelink"><a href="lxml.sax-pysrc.html#ElementTreeProducer.__reduce__">source&nbsp;code</a></span>&nbsp;
 337     </td>
 338   </tr></table>
 339
 340   helper for pickle
 341   <dl class="fields">
 342     <dt>Overrides:
 343         object.__reduce__
 344         <dd><em class="note">(inherited documentation)</em></dd>
 345     </dt>
 346   </dl>
 347 </td></tr></table>
 348 </div>
 349 <br />
 350 <!-- ==================== NAVIGATION BAR ==================== -->
 351 <table class="navbar" border="0" width="100%" cellpadding="0"
 352        bgcolor="#a0c0ff" cellspacing="0">
 353   <tr valign="middle">
 354   <!-- Home link -->
 355       <th>&nbsp;&nbsp;&nbsp;<a
 356         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 357
 358   <!-- Tree link -->
 359       <th>&nbsp;&nbsp;&nbsp;<a
 360         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 361
 362   <!-- Index link -->
 363       <th>&nbsp;&nbsp;&nbsp;<a
 364         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 365
 366   <!-- Help link -->
 367       <th>&nbsp;&nbsp;&nbsp;<a
 368         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 369
 370   <!-- Project homepage -->
 371       <th class="navbar" align="right" width="100%">
 372         <table border="0" cellpadding="0" cellspacing="0">
 373           <tr><th class="navbar" align="center"
 374             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 375           </tr></table></th>
 376   </tr>
 377 </table>
 378 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 379   <tr>
 380     <td align="left" class="footer">
 381     Generated by Epydoc 3.0.1
 382     on Wed Jan 29 12:26:21 2020
 383     </td>
 384     <td align="right" class="footer">
 385       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 386         >http://epydoc.sourceforge.net</a>
 387     </td>
 388   </tr>
 389 </table>
 390
 391 <script type="text/javascript">
 392   <!--
 393   // Private objects are initially displayed (because if
 394   // javascript is turned off then we want them to be
 395   // visible); but by default, we want to hide them.  So hide
 396   // them unless we have a cookie that says to show them.
 397   checkCookie();
 398   // -->
 399 </script>
 400 </body>
 401 </html>