doc/html/api/lxml.sax-module.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</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         Module&nbsp;sax
  47       </span>
  48     </td>
  49     <td>
  50       <table cellpadding="0" cellspacing="0">
  51         <!-- hide/show private -->
  52         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  53     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  54         <tr><td align="right"><span class="options"
  55             >[<a href="frames.html" target="_top">frames</a
  56             >]&nbsp;|&nbsp;<a href="lxml.sax-module.html"
  57             target="_top">no&nbsp;frames</a>]</span></td></tr>
  58       </table>
  59     </td>
  60   </tr>
  61 </table>
  62 <!-- ==================== MODULE DESCRIPTION ==================== -->
  63 <h1 class="epydoc">Module sax</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.sax-pysrc.html">source&nbsp;code</a></span></p>
  64 <p>SAX-based adapter to copy trees from/to the Python standard library.</p>
  65 <p>Use the <a href="lxml.sax.ElementTreeContentHandler-class.html" class="link">ElementTreeContentHandler</a> class to build an ElementTree from
  66 SAX events.</p>
  67 <p>Use the <a href="lxml.sax.ElementTreeProducer-class.html" class="link">ElementTreeProducer</a> class or the <a href="lxml.sax-module.html#saxify" class="link">saxify()</a> function to fire
  68 the SAX events of an ElementTree against a SAX ContentHandler.</p>
  69 <p>See <a class="rst-reference external" href="http://codespeak.net/lxml/sax.html" target="_top">http://codespeak.net/lxml/sax.html</a></p>
  70
  71 <!-- ==================== CLASSES ==================== -->
  72 <a name="section-Classes"></a>
  73 <table class="summary" border="1" cellpadding="3"
  74        cellspacing="0" width="100%" bgcolor="white">
  75 <tr bgcolor="#70b0f0" class="table-header">
  76   <td colspan="2" class="table-header">
  77     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  78       <tr valign="top">
  79         <td align="left"><span class="table-header">Classes</span></td>
  80         <td align="right" valign="top"
  81          ><span class="options">[<a href="#section-Classes"
  82          class="privatelink" onclick="toggle_private();"
  83          >hide private</a>]</span></td>
  84       </tr>
  85     </table>
  86   </td>
  87 </tr>
  88 <tr>
  89     <td width="15%" align="right" valign="top" class="summary">
  90       <span class="summary-type">&nbsp;</span>
  91     </td><td class="summary">
  92         <a href="lxml.sax.SaxError-class.html" class="summary-name">SaxError</a><br />
  93       General SAX error.
  94     </td>
  95   </tr>
  96 <tr>
  97     <td width="15%" align="right" valign="top" class="summary">
  98       <span class="summary-type">&nbsp;</span>
  99     </td><td class="summary">
 100         <a href="lxml.sax.ElementTreeContentHandler-class.html" class="summary-name">ElementTreeContentHandler</a><br />
 101       Build an lxml ElementTree from SAX events.
 102     </td>
 103   </tr>
 104 <tr>
 105     <td width="15%" align="right" valign="top" class="summary">
 106       <span class="summary-type">&nbsp;</span>
 107     </td><td class="summary">
 108         <a href="lxml.sax.ElementTreeProducer-class.html" class="summary-name">ElementTreeProducer</a><br />
 109       Produces SAX events for an element and children.
 110     </td>
 111   </tr>
 112 </table>
 113 <!-- ==================== FUNCTIONS ==================== -->
 114 <a name="section-Functions"></a>
 115 <table class="summary" border="1" cellpadding="3"
 116        cellspacing="0" width="100%" bgcolor="white">
 117 <tr bgcolor="#70b0f0" class="table-header">
 118   <td colspan="2" class="table-header">
 119     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 120       <tr valign="top">
 121         <td align="left"><span class="table-header">Functions</span></td>
 122         <td align="right" valign="top"
 123          ><span class="options">[<a href="#section-Functions"
 124          class="privatelink" onclick="toggle_private();"
 125          >hide private</a>]</span></td>
 126       </tr>
 127     </table>
 128   </td>
 129 </tr>
 130 <tr class="private">
 131     <td width="15%" align="right" valign="top" class="summary">
 132       <span class="summary-type">&nbsp;</span>
 133     </td><td class="summary">
 134       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 135         <tr>
 136           <td><span class="summary-sig"><a name="_getNsTag"></a><span class="summary-sig-name">_getNsTag</span>(<span class="summary-sig-arg">tag</span>)</span></td>
 137           <td align="right" valign="top">
 138             <span class="codelink"><a href="lxml.sax-pysrc.html#_getNsTag">source&nbsp;code</a></span>
 139
 140           </td>
 141         </tr>
 142       </table>
 143
 144     </td>
 145   </tr>
 146 <tr>
 147     <td width="15%" align="right" valign="top" class="summary">
 148       <span class="summary-type">&nbsp;</span>
 149     </td><td class="summary">
 150       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 151         <tr>
 152           <td><span class="summary-sig"><a name="saxify"></a><span class="summary-sig-name">saxify</span>(<span class="summary-sig-arg">element_or_tree</span>,
 153         <span class="summary-sig-arg">content_handler</span>)</span><br />
 154       One-shot helper to generate SAX events from an XML tree and fire
 155 them against a SAX ContentHandler.</td>
 156           <td align="right" valign="top">
 157             <span class="codelink"><a href="lxml.sax-pysrc.html#saxify">source&nbsp;code</a></span>
 158
 159           </td>
 160         </tr>
 161       </table>
 162
 163     </td>
 164   </tr>
 165 <tr class="private">
 166     <td width="15%" align="right" valign="top" class="summary">
 167       <span class="summary-type">&nbsp;</span>
 168     </td><td class="summary">
 169       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 170         <tr>
 171           <td><span class="summary-sig"><a name="__pyx_unpickle_ElementTreeProducer"></a><span class="summary-sig-name">__pyx_unpickle_ElementTreeProducer</span>(<span class="summary-sig-arg">...</span>)</span></td>
 172           <td align="right" valign="top">
 173             <span class="codelink"><a href="lxml.sax-pysrc.html#__pyx_unpickle_ElementTreeProducer">source&nbsp;code</a></span>
 174
 175           </td>
 176         </tr>
 177       </table>
 178
 179     </td>
 180   </tr>
 181 <tr>
 182     <td width="15%" align="right" valign="top" class="summary">
 183       <span class="summary-type">&nbsp;</span>
 184     </td><td class="summary">
 185       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 186         <tr>
 187           <td><span class="summary-sig"><a name="__reduce_cython__"></a><span class="summary-sig-name">__reduce_cython__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 188           <td align="right" valign="top">
 189             <span class="codelink"><a href="lxml.sax-pysrc.html#__reduce_cython__">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 name="__setstate_cython__"></a><span class="summary-sig-name">__setstate_cython__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 204           <td align="right" valign="top">
 205             <span class="codelink"><a href="lxml.sax-pysrc.html#__setstate_cython__">source&nbsp;code</a></span>
 206
 207           </td>
 208         </tr>
 209       </table>
 210
 211     </td>
 212   </tr>
 213 </table>
 214 <!-- ==================== VARIABLES ==================== -->
 215 <a name="section-Variables"></a>
 216 <table class="summary" border="1" cellpadding="3"
 217        cellspacing="0" width="100%" bgcolor="white">
 218 <tr bgcolor="#70b0f0" class="table-header">
 219   <td colspan="2" class="table-header">
 220     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 221       <tr valign="top">
 222         <td align="left"><span class="table-header">Variables</span></td>
 223         <td align="right" valign="top"
 224          ><span class="options">[<a href="#section-Variables"
 225          class="privatelink" onclick="toggle_private();"
 226          >hide private</a>]</span></td>
 227       </tr>
 228     </table>
 229   </td>
 230 </tr>
 231 <tr>
 232     <td width="15%" align="right" valign="top" class="summary">
 233       <span class="summary-type">&nbsp;</span>
 234     </td><td class="summary">
 235         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
 236       hash(x)
 237     </td>
 238   </tr>
 239 <tr>
 240     <td width="15%" align="right" valign="top" class="summary">
 241       <span class="summary-type">&nbsp;</span>
 242     </td><td class="summary">
 243         <a href="lxml.sax-module.html#__pyx_capi__" class="summary-name">__pyx_capi__</a> = <code title="{'_getNsTag': &lt;capsule object &quot;PyObject *(PyObject *)&quot; at 0x7f3a92914a\
 244 20&gt;}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">_getNsTag</code><code class="variable-quote">'</code><code class="variable-op">: </code>&lt;capsule object &quot;PyObject *(PyObj<code class="variable-ellipsis">...</code></code>
 245     </td>
 246   </tr>
 247 <tr>
 248     <td width="15%" align="right" valign="top" class="summary">
 249       <span class="summary-type">&nbsp;</span>
 250     </td><td class="summary">
 251         <a name="__test__"></a><span class="summary-name">__test__</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>
 252     </td>
 253   </tr>
 254 </table>
 255 <!-- ==================== VARIABLES DETAILS ==================== -->
 256 <a name="section-VariablesDetails"></a>
 257 <table class="details" border="1" cellpadding="3"
 258        cellspacing="0" width="100%" bgcolor="white">
 259 <tr bgcolor="#70b0f0" class="table-header">
 260   <td colspan="2" class="table-header">
 261     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 262       <tr valign="top">
 263         <td align="left"><span class="table-header">Variables Details</span></td>
 264         <td align="right" valign="top"
 265          ><span class="options">[<a href="#section-VariablesDetails"
 266          class="privatelink" onclick="toggle_private();"
 267          >hide private</a>]</span></td>
 268       </tr>
 269     </table>
 270   </td>
 271 </tr>
 272 </table>
 273 <a name="__pyx_capi__"></a>
 274 <div>
 275 <table class="details" border="1" cellpadding="3"
 276        cellspacing="0" width="100%" bgcolor="white">
 277 <tr><td>
 278   <h3 class="epydoc">__pyx_capi__</h3>
 279
 280   <dl class="fields">
 281   </dl>
 282   <dl class="fields">
 283     <dt>Value:</dt>
 284       <dd><table><tr><td><pre class="variable">
 285 <code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">_getNsTag</code><code class="variable-quote">'</code><code class="variable-op">: </code>&lt;capsule object &quot;PyObject *(PyObject *)&quot; at 0x7f3a92914a<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 286 20&gt;<code class="variable-group">}</code>
 287 </pre></td></tr></table>
 288 </dd>
 289   </dl>
 290 </td></tr></table>
 291 </div>
 292 <br />
 293 <!-- ==================== NAVIGATION BAR ==================== -->
 294 <table class="navbar" border="0" width="100%" cellpadding="0"
 295        bgcolor="#a0c0ff" cellspacing="0">
 296   <tr valign="middle">
 297   <!-- Home link -->
 298       <th>&nbsp;&nbsp;&nbsp;<a
 299         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 300
 301   <!-- Tree link -->
 302       <th>&nbsp;&nbsp;&nbsp;<a
 303         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 304
 305   <!-- Index link -->
 306       <th>&nbsp;&nbsp;&nbsp;<a
 307         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 308
 309   <!-- Help link -->
 310       <th>&nbsp;&nbsp;&nbsp;<a
 311         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 312
 313   <!-- Project homepage -->
 314       <th class="navbar" align="right" width="100%">
 315         <table border="0" cellpadding="0" cellspacing="0">
 316           <tr><th class="navbar" align="center"
 317             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 318           </tr></table></th>
 319   </tr>
 320 </table>
 321 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 322   <tr>
 323     <td align="left" class="footer">
 324     Generated by Epydoc 3.0.1
 325     on Wed Jan 29 12:26:21 2020
 326     </td>
 327     <td align="right" class="footer">
 328       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 329         >http://epydoc.sourceforge.net</a>
 330     </td>
 331   </tr>
 332 </table>
 333
 334 <script type="text/javascript">
 335   <!--
 336   // Private objects are initially displayed (because if
 337   // javascript is turned off then we want them to be
 338   // visible); but by default, we want to hide them.  So hide
 339   // them unless we have a cookie that says to show them.
 340   checkCookie();
 341   // -->
 342 </script>
 343 </body>
 344 </html>