doc/html/api/lxml.etree.XMLParser-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.XMLParser</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;XMLParser
  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.XMLParser-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 XMLParser</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                  <strong class="uidshort">XMLParser</strong>
  73 </pre>
  74
  75 <dl><dt>Known Subclasses:</dt>
  76 <dd>
  77       <ul class="subclass-list">
  78 <li><a href="lxml.etree.ETCompatXMLParser-class.html">ETCompatXMLParser</a></li><li class="private">, <a href="lxml.html.XHTMLParser-class.html" onclick="show_private();">html.XHTMLParser</a></li>  </ul>
  79 </dd></dl>
  80
  81 <hr />
  82 <p>XMLParser(self, encoding=None, attribute_defaults=False, dtd_validation=False, load_dtd=False, no_network=True, ns_clean=False, recover=False, XMLSchema schema=None, remove_blank_text=False, resolve_entities=True, remove_comments=False, remove_pis=False, strip_cdata=True, target=None, compact=True)</p>
  83 <p>The XML parser.</p>
  84 <p>Parsers can be supplied as additional argument to various parse
  85 functions of the lxml API.  A default parser is always available
  86 and can be replaced by a call to the global function
  87 'set_default_parser'.  New parsers can be created at any time
  88 without a major run-time overhead.</p>
  89 <p>The keyword arguments in the constructor are mainly based on the
  90 libxml2 parser configuration.  A DTD will also be loaded if DTD
  91 validation or attribute default values are requested (unless you
  92 additionally provide an XMLSchema from which the default
  93 attributes can be read).</p>
  94 <p>Available boolean keyword arguments:</p>
  95 <ul>
  96 <li><p class="rst-first">attribute_defaults - inject default attributes from DTD or XMLSchema</p>
  97 </li>
  98 <li><p class="rst-first">dtd_validation     - validate against a DTD referenced by the document</p>
  99 </li>
 100 <li><p class="rst-first">load_dtd           - use DTD for parsing</p>
 101 </li>
 102 <li><p class="rst-first">no_network         - prevent network access for related files (default: True)</p>
 103 </li>
 104 <li><p class="rst-first">ns_clean           - clean up redundant namespace declarations</p>
 105 </li>
 106 <li><p class="rst-first">recover            - try hard to parse through broken XML</p>
 107 </li>
 108 <li><p class="rst-first">remove_blank_text  - discard blank text nodes</p>
 109 </li>
 110 <li><p class="rst-first">remove_comments    - discard comments</p>
 111 </li>
 112 <li><p class="rst-first">remove_pis         - discard processing instructions</p>
 113 </li>
 114 <li><p class="rst-first">strip_cdata        - replace CDATA sections by normal text content (default: True)</p>
 115 </li>
 116 <li><p class="rst-first">compact            - safe memory for short text content (default: True)</p>
 117 </li>
 118 <li><p class="rst-first">resolve_entities   - replace entities by their text value (default: True)</p>
 119 </li>
 120 <li><dl class="rst-first rst-docutils">
 121 <dt>huge_tree          - disable security restrictions and support very deep trees</dt>
 122 <dd><p class="rst-first rst-last">and very long text content (only affects libxml2 2.7+)</p>
 123 </dd>
 124 </dl>
 125 </li>
 126 </ul>
 127 <p>Other keyword arguments:</p>
 128 <ul class="rst-simple">
 129 <li>encoding - override the document encoding</li>
 130 <li>target   - a parser target object that will receive the parse events</li>
 131 <li>schema   - an XMLSchema to validate against</li>
 132 </ul>
 133 <p>Note that you should avoid sharing parsers between threads.  While this is
 134 not harmful, it is more efficient to use separate parsers.  This does not
 135 apply to the default parser.</p>
 136
 137 <!-- ==================== INSTANCE METHODS ==================== -->
 138 <a name="section-InstanceMethods"></a>
 139 <table class="summary" border="1" cellpadding="3"
 140        cellspacing="0" width="100%" bgcolor="white">
 141 <tr bgcolor="#70b0f0" class="table-header">
 142   <td colspan="2" class="table-header">
 143     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 144       <tr valign="top">
 145         <td align="left"><span class="table-header">Instance Methods</span></td>
 146         <td align="right" valign="top"
 147          ><span class="options">[<a href="#section-InstanceMethods"
 148          class="privatelink" onclick="toggle_private();"
 149          >hide private</a>]</span></td>
 150       </tr>
 151     </table>
 152   </td>
 153 </tr>
 154 <tr>
 155     <td width="15%" align="right" valign="top" class="summary">
 156       <span class="summary-type">&nbsp;</span>
 157     </td><td class="summary">
 158       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 159         <tr>
 160           <td><span class="summary-sig"><a href="lxml.etree.XMLParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 161         <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
 162         <span class="summary-sig-arg">attribute_defaults</span>=<span class="summary-sig-default">False</span>,
 163         <span class="summary-sig-arg">dtd_validation</span>=<span class="summary-sig-default">False</span>,
 164         <span class="summary-sig-arg">load_dtd</span>=<span class="summary-sig-default">False</span>,
 165         <span class="summary-sig-arg">no_network</span>=<span class="summary-sig-default">True</span>,
 166         <span class="summary-sig-arg">ns_clean</span>=<span class="summary-sig-default">False</span>,
 167         <span class="summary-sig-arg">recover</span>=<span class="summary-sig-default">False</span>,
 168         <span class="summary-sig-arg">XMLSchema schema</span>=<span class="summary-sig-default">None</span>,
 169         <span class="summary-sig-arg">remove_blank_text</span>=<span class="summary-sig-default">False</span>,
 170         <span class="summary-sig-arg">resolve_entities</span>=<span class="summary-sig-default">True</span>,
 171         <span class="summary-sig-arg">remove_comments</span>=<span class="summary-sig-default">False</span>,
 172         <span class="summary-sig-arg">remove_pis</span>=<span class="summary-sig-default">False</span>,
 173         <span class="summary-sig-arg">strip_cdata</span>=<span class="summary-sig-default">True</span>,
 174         <span class="summary-sig-arg">target</span>=<span class="summary-sig-default">None</span>,
 175         <span class="summary-sig-arg">compact</span>=<span class="summary-sig-default">True</span>)</span><br />
 176       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 177           <td align="right" valign="top">
 178
 179
 180           </td>
 181         </tr>
 182       </table>
 183
 184     </td>
 185   </tr>
 186 <tr>
 187     <td width="15%" align="right" valign="top" class="summary">
 188       <span class="summary-type">a new object with type S, a subtype of T</span>
 189     </td><td class="summary">
 190       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 191         <tr>
 192           <td><span class="summary-sig"><a href="lxml.etree.XMLParser-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 193         <span class="summary-sig-arg">S</span>,
 194         <span class="summary-sig-arg">...</span>)</span></td>
 195           <td align="right" valign="top">
 196
 197
 198           </td>
 199         </tr>
 200       </table>
 201
 202     </td>
 203   </tr>
 204   <tr>
 205     <td colspan="2" class="summary">
 206     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a></code></b>:
 207       <code><a href="lxml.etree._FeedParser-class.html#close">close</a></code>,
 208       <code><a href="lxml.etree._FeedParser-class.html#feed">feed</a></code>
 209       </p>
 210     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a></code></b>:
 211       <code><a href="lxml.etree._BaseParser-class.html#copy">copy</a></code>,
 212       <code><a href="lxml.etree._BaseParser-class.html#makeelement">makeelement</a></code>,
 213       <code><a href="lxml.etree._BaseParser-class.html#setElementClassLookup">setElementClassLookup</a></code>,
 214       <code><a href="lxml.etree._BaseParser-class.html#set_element_class_lookup">set_element_class_lookup</a></code>
 215       </p>
 216     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 217       <code>__delattr__</code>,
 218       <code>__format__</code>,
 219       <code>__getattribute__</code>,
 220       <code>__hash__</code>,
 221       <code>__reduce__</code>,
 222       <code>__reduce_ex__</code>,
 223       <code>__repr__</code>,
 224       <code>__setattr__</code>,
 225       <code>__sizeof__</code>,
 226       <code>__str__</code>,
 227       <code>__subclasshook__</code>
 228       </p>
 229     </td>
 230   </tr>
 231 </table>
 232 <!-- ==================== PROPERTIES ==================== -->
 233 <a name="section-Properties"></a>
 234 <table class="summary" border="1" cellpadding="3"
 235        cellspacing="0" width="100%" bgcolor="white">
 236 <tr bgcolor="#70b0f0" class="table-header">
 237   <td colspan="2" class="table-header">
 238     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 239       <tr valign="top">
 240         <td align="left"><span class="table-header">Properties</span></td>
 241         <td align="right" valign="top"
 242          ><span class="options">[<a href="#section-Properties"
 243          class="privatelink" onclick="toggle_private();"
 244          >hide private</a>]</span></td>
 245       </tr>
 246     </table>
 247   </td>
 248 </tr>
 249   <tr>
 250     <td colspan="2" class="summary">
 251     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a></code></b>:
 252       <code><a href="lxml.etree._FeedParser-class.html#feed_error_log">feed_error_log</a></code>
 253       </p>
 254     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseParser-class.html" onclick="show_private();">_BaseParser</a></code></b>:
 255       <code><a href="lxml.etree._BaseParser-class.html#error_log">error_log</a></code>,
 256       <code><a href="lxml.etree._BaseParser-class.html#resolvers">resolvers</a></code>,
 257       <code><a href="lxml.etree._BaseParser-class.html#target">target</a></code>,
 258       <code><a href="lxml.etree._BaseParser-class.html#version">version</a></code>
 259       </p>
 260     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 261       <code>__class__</code>
 262       </p>
 263     </td>
 264   </tr>
 265 </table>
 266 <!-- ==================== METHOD DETAILS ==================== -->
 267 <a name="section-MethodDetails"></a>
 268 <table class="details" border="1" cellpadding="3"
 269        cellspacing="0" width="100%" bgcolor="white">
 270 <tr bgcolor="#70b0f0" class="table-header">
 271   <td colspan="2" class="table-header">
 272     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 273       <tr valign="top">
 274         <td align="left"><span class="table-header">Method Details</span></td>
 275         <td align="right" valign="top"
 276          ><span class="options">[<a href="#section-MethodDetails"
 277          class="privatelink" onclick="toggle_private();"
 278          >hide private</a>]</span></td>
 279       </tr>
 280     </table>
 281   </td>
 282 </tr>
 283 </table>
 284 <a name="__init__"></a>
 285 <div>
 286 <table class="details" border="1" cellpadding="3"
 287        cellspacing="0" width="100%" bgcolor="white">
 288 <tr><td>
 289   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 290   <tr valign="top"><td>
 291   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 292         <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
 293         <span class="sig-arg">attribute_defaults</span>=<span class="sig-default">False</span>,
 294         <span class="sig-arg">dtd_validation</span>=<span class="sig-default">False</span>,
 295         <span class="sig-arg">load_dtd</span>=<span class="sig-default">False</span>,
 296         <span class="sig-arg">no_network</span>=<span class="sig-default">True</span>,
 297         <span class="sig-arg">ns_clean</span>=<span class="sig-default">False</span>,
 298         <span class="sig-arg">recover</span>=<span class="sig-default">False</span>,
 299         <span class="sig-arg">XMLSchema schema</span>=<span class="sig-default">None</span>,
 300         <span class="sig-arg">remove_blank_text</span>=<span class="sig-default">False</span>,
 301         <span class="sig-arg">resolve_entities</span>=<span class="sig-default">True</span>,
 302         <span class="sig-arg">remove_comments</span>=<span class="sig-default">False</span>,
 303         <span class="sig-arg">remove_pis</span>=<span class="sig-default">False</span>,
 304         <span class="sig-arg">strip_cdata</span>=<span class="sig-default">True</span>,
 305         <span class="sig-arg">target</span>=<span class="sig-default">None</span>,
 306         <span class="sig-arg">compact</span>=<span class="sig-default">True</span>)</span>
 307     <br /><em class="fname">(Constructor)</em>
 308   </h3>
 309   </td><td align="right" valign="top"
 310     >&nbsp;
 311     </td>
 312   </tr></table>
 313
 314   x.__init__(...) initializes x; see help(type(x)) for signature
 315   <dl class="fields">
 316     <dt>Overrides:
 317         object.__init__
 318     </dt>
 319   </dl>
 320 </td></tr></table>
 321 </div>
 322 <a name="__new__"></a>
 323 <div>
 324 <table class="details" border="1" cellpadding="3"
 325        cellspacing="0" width="100%" bgcolor="white">
 326 <tr><td>
 327   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 328   <tr valign="top"><td>
 329   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 330         <span class="sig-arg">S</span>,
 331         <span class="sig-arg">...</span>)</span>
 332   </h3>
 333   </td><td align="right" valign="top"
 334     >&nbsp;
 335     </td>
 336   </tr></table>
 337
 338
 339   <dl class="fields">
 340     <dt>Returns: a new object with type S, a subtype of T</dt>
 341     <dt>Overrides:
 342         object.__new__
 343     </dt>
 344   </dl>
 345 </td></tr></table>
 346 </div>
 347 <br />
 348 <!-- ==================== NAVIGATION BAR ==================== -->
 349 <table class="navbar" border="0" width="100%" cellpadding="0"
 350        bgcolor="#a0c0ff" cellspacing="0">
 351   <tr valign="middle">
 352   <!-- Home link -->
 353       <th>&nbsp;&nbsp;&nbsp;<a
 354         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 355
 356   <!-- Tree link -->
 357       <th>&nbsp;&nbsp;&nbsp;<a
 358         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 359
 360   <!-- Index link -->
 361       <th>&nbsp;&nbsp;&nbsp;<a
 362         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 363
 364   <!-- Help link -->
 365       <th>&nbsp;&nbsp;&nbsp;<a
 366         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 367
 368   <!-- Project homepage -->
 369       <th class="navbar" align="right" width="100%">
 370         <table border="0" cellpadding="0" cellspacing="0">
 371           <tr><th class="navbar" align="center"
 372             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 373           </tr></table></th>
 374   </tr>
 375 </table>
 376 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 377   <tr>
 378     <td align="left" class="footer">
 379     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 380     </td>
 381     <td align="right" class="footer">
 382       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 383         >http://epydoc.sourceforge.net</a>
 384     </td>
 385   </tr>
 386 </table>
 387
 388 <script type="text/javascript">
 389   <!--
 390   // Private objects are initially displayed (because if
 391   // javascript is turned off then we want them to be
 392   // visible); but by default, we want to hide them.  So hide
 393   // them unless we have a cookie that says to show them.
 394   checkCookie();
 395   // -->
 396 </script>
 397 </body>
 398 </html>