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 </table>
 166 <!-- ==================== VARIABLES ==================== -->
 167 <a name="section-Variables"></a>
 168 <table class="summary" border="1" cellpadding="3"
 169        cellspacing="0" width="100%" bgcolor="white">
 170 <tr bgcolor="#70b0f0" class="table-header">
 171   <td colspan="2" class="table-header">
 172     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 173       <tr valign="top">
 174         <td align="left"><span class="table-header">Variables</span></td>
 175         <td align="right" valign="top"
 176          ><span class="options">[<a href="#section-Variables"
 177          class="privatelink" onclick="toggle_private();"
 178          >hide private</a>]</span></td>
 179       </tr>
 180     </table>
 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         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml'"><code class="variable-quote">'</code><code class="variable-string">lxml</code><code class="variable-quote">'</code></code>
 188     </td>
 189   </tr>
 190 </table>
 191 <!-- ==================== NAVIGATION BAR ==================== -->
 192 <table class="navbar" border="0" width="100%" cellpadding="0"
 193        bgcolor="#a0c0ff" cellspacing="0">
 194   <tr valign="middle">
 195   <!-- Home link -->
 196       <th>&nbsp;&nbsp;&nbsp;<a
 197         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 198
 199   <!-- Tree link -->
 200       <th>&nbsp;&nbsp;&nbsp;<a
 201         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 202
 203   <!-- Index link -->
 204       <th>&nbsp;&nbsp;&nbsp;<a
 205         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 206
 207   <!-- Help link -->
 208       <th>&nbsp;&nbsp;&nbsp;<a
 209         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 210
 211   <!-- Project homepage -->
 212       <th class="navbar" align="right" width="100%">
 213         <table border="0" cellpadding="0" cellspacing="0">
 214           <tr><th class="navbar" align="center"
 215             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 216           </tr></table></th>
 217   </tr>
 218 </table>
 219 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 220   <tr>
 221     <td align="left" class="footer">
 222     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:17 2012
 223     </td>
 224     <td align="right" class="footer">
 225       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 226         >http://epydoc.sourceforge.net</a>
 227     </td>
 228   </tr>
 229 </table>
 230
 231 <script type="text/javascript">
 232   <!--
 233   // Private objects are initially displayed (because if
 234   // javascript is turned off then we want them to be
 235   // visible); but by default, we want to hide them.  So hide
 236   // them unless we have a cookie that says to show them.
 237   checkCookie();
 238   // -->
 239 </script>
 240 </body>
 241 </html>