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