doc/html/api/lxml.etree.ETCompatXMLParser-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.etree.ETCompatXMLParser</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.etree-module.html">Module&nbsp;etree</a> ::
  47         Class&nbsp;ETCompatXMLParser
  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.etree.ETCompatXMLParser-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 ETCompatXMLParser</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66  object --+
  67           |
  68 <a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a> --+
  69               |
  70     <a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a> --+
  71                   |
  72           <a href="lxml.etree.XMLParser-class.html">XMLParser</a> --+
  73                       |
  74                      <strong class="uidshort">ETCompatXMLParser</strong>
  75 </pre>
  76
  77 <hr />
  78 <p>ETCompatXMLParser(self, encoding=None, attribute_defaults=False,                  dtd_validation=False, load_dtd=False, no_network=True,                  ns_clean=False, recover=False, schema=None,                  huge_tree=False, remove_blank_text=False, resolve_entities=True,                  remove_comments=True, remove_pis=True, strip_cdata=True,                  target=None, compact=True)</p>
  79 <p>An XML parser with an ElementTree compatible default setup.</p>
  80 <p>See the XMLParser class for details.</p>
  81 <p>This parser has <tt class="rst-docutils literal">remove_comments</tt> and <tt class="rst-docutils literal">remove_pis</tt> enabled by default
  82 and thus ignores comments and processing instructions.</p>
  83
  84 <!-- ==================== INSTANCE METHODS ==================== -->
  85 <a name="section-InstanceMethods"></a>
  86 <table class="summary" border="1" cellpadding="3"
  87        cellspacing="0" width="100%" bgcolor="white">
  88 <tr bgcolor="#70b0f0" class="table-header">
  89   <td colspan="2" class="table-header">
  90     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  91       <tr valign="top">
  92         <td align="left"><span class="table-header">Instance Methods</span></td>
  93         <td align="right" valign="top"
  94          ><span class="options">[<a href="#section-InstanceMethods"
  95          class="privatelink" onclick="toggle_private();"
  96          >hide private</a>]</span></td>
  97       </tr>
  98     </table>
  99   </td>
 100 </tr>
 101 <tr>
 102     <td width="15%" align="right" valign="top" class="summary">
 103       <span class="summary-type">&nbsp;</span>
 104     </td><td class="summary">
 105       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 106         <tr>
 107           <td><span class="summary-sig"><a href="lxml.etree.ETCompatXMLParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 108         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
 109         <span class="summary-sig-arg">attribute_defaults</span>=<span class="summary-sig-default">False</span>,
 110         <span class="summary-sig-arg">dtd_validation</span>=<span class="summary-sig-default">False</span>,
 111         <span class="summary-sig-arg">load_dtd</span>=<span class="summary-sig-default">False</span>,
 112         <span class="summary-sig-arg">no_network</span>=<span class="summary-sig-default">True</span>,
 113         <span class="summary-sig-arg">ns_clean</span>=<span class="summary-sig-default">False</span>,
 114         <span class="summary-sig-arg">recover</span>=<span class="summary-sig-default">False</span>,
 115         <span class="summary-sig-arg">schema</span>=<span class="summary-sig-default">None</span>,
 116         <span class="summary-sig-arg">huge_tree</span>=<span class="summary-sig-default">False</span>,
 117         <span class="summary-sig-arg">remove_blank_text</span>=<span class="summary-sig-default">False</span>,
 118         <span class="summary-sig-arg">resolve_entities</span>=<span class="summary-sig-default">True</span>,
 119         <span class="summary-sig-arg">remove_comments</span>=<span class="summary-sig-default">True</span>,
 120         <span class="summary-sig-arg">remove_pis</span>=<span class="summary-sig-default">True</span>,
 121         <span class="summary-sig-arg">strip_cdata</span>=<span class="summary-sig-default">True</span>,
 122         <span class="summary-sig-arg">target</span>=<span class="summary-sig-default">None</span>,
 123         <span class="summary-sig-arg">compact</span>=<span class="summary-sig-default">True</span>)</span><br />
 124       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 125           <td align="right" valign="top">
 126
 127
 128           </td>
 129         </tr>
 130       </table>
 131
 132     </td>
 133   </tr>
 134 <tr>
 135     <td width="15%" align="right" valign="top" class="summary">
 136       <span class="summary-type">a new object with type S, a subtype of T</span>
 137     </td><td class="summary">
 138       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 139         <tr>
 140           <td><span class="summary-sig"><a href="lxml.etree.ETCompatXMLParser-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 141         <span class="summary-sig-arg">S</span>,
 142         <span class="summary-sig-arg">...</span>)</span></td>
 143           <td align="right" valign="top">
 144
 145
 146           </td>
 147         </tr>
 148       </table>
 149
 150     </td>
 151   </tr>
 152   <tr>
 153     <td colspan="2" class="summary">
 154     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a></code></b>:
 155       <code><a href="lxml.etree._FeedParser-class.html#close">close</a></code>,
 156       <code><a href="lxml.etree._FeedParser-class.html#feed">feed</a></code>
 157       </p>
 158     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a></code></b>:
 159       <code><a href="lxml.etree._BaseParser-class.html#copy">copy</a></code>,
 160       <code><a href="lxml.etree._BaseParser-class.html#makeelement">makeelement</a></code>,
 161       <code><a href="lxml.etree._BaseParser-class.html#setElementClassLookup">setElementClassLookup</a></code>,
 162       <code><a href="lxml.etree._BaseParser-class.html#set_element_class_lookup">set_element_class_lookup</a></code>
 163       </p>
 164     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 165       <code>__delattr__</code>,
 166       <code>__format__</code>,
 167       <code>__getattribute__</code>,
 168       <code>__hash__</code>,
 169       <code>__reduce__</code>,
 170       <code>__reduce_ex__</code>,
 171       <code>__repr__</code>,
 172       <code>__setattr__</code>,
 173       <code>__sizeof__</code>,
 174       <code>__str__</code>,
 175       <code>__subclasshook__</code>
 176       </p>
 177     </td>
 178   </tr>
 179 </table>
 180 <!-- ==================== PROPERTIES ==================== -->
 181 <a name="section-Properties"></a>
 182 <table class="summary" border="1" cellpadding="3"
 183        cellspacing="0" width="100%" bgcolor="white">
 184 <tr bgcolor="#70b0f0" class="table-header">
 185   <td colspan="2" class="table-header">
 186     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 187       <tr valign="top">
 188         <td align="left"><span class="table-header">Properties</span></td>
 189         <td align="right" valign="top"
 190          ><span class="options">[<a href="#section-Properties"
 191          class="privatelink" onclick="toggle_private();"
 192          >hide private</a>]</span></td>
 193       </tr>
 194     </table>
 195   </td>
 196 </tr>
 197   <tr>
 198     <td colspan="2" class="summary">
 199     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a></code></b>:
 200       <code><a href="lxml.etree._FeedParser-class.html#feed_error_log">feed_error_log</a></code>
 201       </p>
 202     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a></code></b>:
 203       <code><a href="lxml.etree._BaseParser-class.html#error_log">error_log</a></code>,
 204       <code><a href="lxml.etree._BaseParser-class.html#resolvers">resolvers</a></code>,
 205       <code><a href="lxml.etree._BaseParser-class.html#target">target</a></code>,
 206       <code><a href="lxml.etree._BaseParser-class.html#version">version</a></code>
 207       </p>
 208     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 209       <code>__class__</code>
 210       </p>
 211     </td>
 212   </tr>
 213 </table>
 214 <!-- ==================== METHOD DETAILS ==================== -->
 215 <a name="section-MethodDetails"></a>
 216 <table class="details" 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">Method Details</span></td>
 223         <td align="right" valign="top"
 224          ><span class="options">[<a href="#section-MethodDetails"
 225          class="privatelink" onclick="toggle_private();"
 226          >hide private</a>]</span></td>
 227       </tr>
 228     </table>
 229   </td>
 230 </tr>
 231 </table>
 232 <a name="__init__"></a>
 233 <div>
 234 <table class="details" border="1" cellpadding="3"
 235        cellspacing="0" width="100%" bgcolor="white">
 236 <tr><td>
 237   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 238   <tr valign="top"><td>
 239   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 240         <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
 241         <span class="sig-arg">attribute_defaults</span>=<span class="sig-default">False</span>,
 242         <span class="sig-arg">dtd_validation</span>=<span class="sig-default">False</span>,
 243         <span class="sig-arg">load_dtd</span>=<span class="sig-default">False</span>,
 244         <span class="sig-arg">no_network</span>=<span class="sig-default">True</span>,
 245         <span class="sig-arg">ns_clean</span>=<span class="sig-default">False</span>,
 246         <span class="sig-arg">recover</span>=<span class="sig-default">False</span>,
 247         <span class="sig-arg">schema</span>=<span class="sig-default">None</span>,
 248         <span class="sig-arg">huge_tree</span>=<span class="sig-default">False</span>,
 249         <span class="sig-arg">remove_blank_text</span>=<span class="sig-default">False</span>,
 250         <span class="sig-arg">resolve_entities</span>=<span class="sig-default">True</span>,
 251         <span class="sig-arg">remove_comments</span>=<span class="sig-default">True</span>,
 252         <span class="sig-arg">remove_pis</span>=<span class="sig-default">True</span>,
 253         <span class="sig-arg">strip_cdata</span>=<span class="sig-default">True</span>,
 254         <span class="sig-arg">target</span>=<span class="sig-default">None</span>,
 255         <span class="sig-arg">compact</span>=<span class="sig-default">True</span>)</span>
 256     <br /><em class="fname">(Constructor)</em>
 257   </h3>
 258   </td><td align="right" valign="top"
 259     >&nbsp;
 260     </td>
 261   </tr></table>
 262
 263   x.__init__(...) initializes x; see help(type(x)) for signature
 264   <dl class="fields">
 265     <dt>Overrides:
 266         object.__init__
 267     </dt>
 268   </dl>
 269 </td></tr></table>
 270 </div>
 271 <a name="__new__"></a>
 272 <div>
 273 <table class="details" border="1" cellpadding="3"
 274        cellspacing="0" width="100%" bgcolor="white">
 275 <tr><td>
 276   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 277   <tr valign="top"><td>
 278   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 279         <span class="sig-arg">S</span>,
 280         <span class="sig-arg">...</span>)</span>
 281   </h3>
 282   </td><td align="right" valign="top"
 283     >&nbsp;
 284     </td>
 285   </tr></table>
 286
 287
 288   <dl class="fields">
 289     <dt>Returns: a new object with type S, a subtype of T</dt>
 290     <dt>Overrides:
 291         object.__new__
 292     </dt>
 293   </dl>
 294 </td></tr></table>
 295 </div>
 296 <br />
 297 <!-- ==================== NAVIGATION BAR ==================== -->
 298 <table class="navbar" border="0" width="100%" cellpadding="0"
 299        bgcolor="#a0c0ff" cellspacing="0">
 300   <tr valign="middle">
 301   <!-- Home link -->
 302       <th>&nbsp;&nbsp;&nbsp;<a
 303         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 304
 305   <!-- Tree link -->
 306       <th>&nbsp;&nbsp;&nbsp;<a
 307         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 308
 309   <!-- Index link -->
 310       <th>&nbsp;&nbsp;&nbsp;<a
 311         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 312
 313   <!-- Help link -->
 314       <th>&nbsp;&nbsp;&nbsp;<a
 315         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 316
 317   <!-- Project homepage -->
 318       <th class="navbar" align="right" width="100%">
 319         <table border="0" cellpadding="0" cellspacing="0">
 320           <tr><th class="navbar" align="center"
 321             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 322           </tr></table></th>
 323   </tr>
 324 </table>
 325 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 326   <tr>
 327     <td align="left" class="footer">
 328     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 329     </td>
 330     <td align="right" class="footer">
 331       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 332         >http://epydoc.sourceforge.net</a>
 333     </td>
 334   </tr>
 335 </table>
 336
 337 <script type="text/javascript">
 338   <!--
 339   // Private objects are initially displayed (because if
 340   // javascript is turned off then we want them to be
 341   // visible); but by default, we want to hide them.  So hide
 342   // them unless we have a cookie that says to show them.
 343   checkCookie();
 344   // -->
 345 </script>
 346 </body>
 347 </html>