doc/html/api/lxml.etree.DocInfo-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.DocInfo</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;DocInfo
  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.DocInfo-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 DocInfo</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">DocInfo</strong>
  69 </pre>
  70
  71 <hr />
  72 Document information provided by parser and DTD.
  73
  74 <!-- ==================== INSTANCE METHODS ==================== -->
  75 <a name="section-InstanceMethods"></a>
  76 <table class="summary" border="1" cellpadding="3"
  77        cellspacing="0" width="100%" bgcolor="white">
  78 <tr bgcolor="#70b0f0" class="table-header">
  79   <td colspan="2" class="table-header">
  80     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  81       <tr valign="top">
  82         <td align="left"><span class="table-header">Instance Methods</span></td>
  83         <td align="right" valign="top"
  84          ><span class="options">[<a href="#section-InstanceMethods"
  85          class="privatelink" onclick="toggle_private();"
  86          >hide private</a>]</span></td>
  87       </tr>
  88     </table>
  89   </td>
  90 </tr>
  91 <tr>
  92     <td width="15%" align="right" valign="top" class="summary">
  93       <span class="summary-type">a new object with type S, a subtype of T</span>
  94     </td><td class="summary">
  95       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  96         <tr>
  97           <td><span class="summary-sig"><a href="lxml.etree.DocInfo-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
  98         <span class="summary-sig-arg">S</span>,
  99         <span class="summary-sig-arg">...</span>)</span></td>
 100           <td align="right" valign="top">
 101
 102
 103           </td>
 104         </tr>
 105       </table>
 106
 107     </td>
 108   </tr>
 109 <tr>
 110     <td width="15%" align="right" valign="top" class="summary">
 111       <span class="summary-type">&nbsp;</span>
 112     </td><td class="summary">
 113       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 114         <tr>
 115           <td><span class="summary-sig"><a name="clear"></a><span class="summary-sig-name">clear</span>(<span class="summary-sig-arg">...</span>)</span><br />
 116       Removes DOCTYPE and internal subset from the document.</td>
 117           <td align="right" valign="top">
 118
 119
 120           </td>
 121         </tr>
 122       </table>
 123
 124     </td>
 125   </tr>
 126   <tr>
 127     <td colspan="2" class="summary">
 128     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 129       <code>__delattr__</code>,
 130       <code>__format__</code>,
 131       <code>__getattribute__</code>,
 132       <code>__hash__</code>,
 133       <code>__init__</code>,
 134       <code>__reduce__</code>,
 135       <code>__reduce_ex__</code>,
 136       <code>__repr__</code>,
 137       <code>__setattr__</code>,
 138       <code>__sizeof__</code>,
 139       <code>__str__</code>,
 140       <code>__subclasshook__</code>
 141       </p>
 142     </td>
 143   </tr>
 144 </table>
 145 <!-- ==================== PROPERTIES ==================== -->
 146 <a name="section-Properties"></a>
 147 <table class="summary" border="1" cellpadding="3"
 148        cellspacing="0" width="100%" bgcolor="white">
 149 <tr bgcolor="#70b0f0" class="table-header">
 150   <td colspan="2" class="table-header">
 151     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 152       <tr valign="top">
 153         <td align="left"><span class="table-header">Properties</span></td>
 154         <td align="right" valign="top"
 155          ><span class="options">[<a href="#section-Properties"
 156          class="privatelink" onclick="toggle_private();"
 157          >hide private</a>]</span></td>
 158       </tr>
 159     </table>
 160   </td>
 161 </tr>
 162 <tr>
 163     <td width="15%" align="right" valign="top" class="summary">
 164       <span class="summary-type">&nbsp;</span>
 165     </td><td class="summary">
 166         <a name="URL"></a><span class="summary-name">URL</span><br />
 167       The source URL of the document (or None if unknown).
 168     </td>
 169   </tr>
 170 <tr>
 171     <td width="15%" align="right" valign="top" class="summary">
 172       <span class="summary-type">&nbsp;</span>
 173     </td><td class="summary">
 174         <a name="doctype"></a><span class="summary-name">doctype</span><br />
 175       Returns a DOCTYPE declaration string for the document.
 176     </td>
 177   </tr>
 178 <tr>
 179     <td width="15%" align="right" valign="top" class="summary">
 180       <span class="summary-type">&nbsp;</span>
 181     </td><td class="summary">
 182         <a name="encoding"></a><span class="summary-name">encoding</span><br />
 183       Returns the encoding name as declared by the document.
 184     </td>
 185   </tr>
 186 <tr>
 187     <td width="15%" align="right" valign="top" class="summary">
 188       <span class="summary-type">&nbsp;</span>
 189     </td><td class="summary">
 190         <a name="externalDTD"></a><span class="summary-name">externalDTD</span><br />
 191       Returns a DTD validator based on the external subset of the document.
 192     </td>
 193   </tr>
 194 <tr>
 195     <td width="15%" align="right" valign="top" class="summary">
 196       <span class="summary-type">&nbsp;</span>
 197     </td><td class="summary">
 198         <a name="internalDTD"></a><span class="summary-name">internalDTD</span><br />
 199       Returns a DTD validator based on the internal subset of the document.
 200     </td>
 201   </tr>
 202 <tr>
 203     <td width="15%" align="right" valign="top" class="summary">
 204       <span class="summary-type">&nbsp;</span>
 205     </td><td class="summary">
 206         <a href="lxml.etree.DocInfo-class.html#public_id" class="summary-name">public_id</a><br />
 207       Public ID of the DOCTYPE.
 208     </td>
 209   </tr>
 210 <tr>
 211     <td width="15%" align="right" valign="top" class="summary">
 212       <span class="summary-type">&nbsp;</span>
 213     </td><td class="summary">
 214         <a name="root_name"></a><span class="summary-name">root_name</span><br />
 215       Returns the name of the root node as defined by the DOCTYPE.
 216     </td>
 217   </tr>
 218 <tr>
 219     <td width="15%" align="right" valign="top" class="summary">
 220       <span class="summary-type">&nbsp;</span>
 221     </td><td class="summary">
 222         <a name="standalone"></a><span class="summary-name">standalone</span><br />
 223       Returns the standalone flag as declared by the document.  The possible
 224 values are True (<tt class="rst-docutils literal"><span class="pre">standalone='yes'</span></tt>), False
 225 (<tt class="rst-docutils literal"><span class="pre">standalone='no'</span></tt> or flag not provided in the declaration),
 226 and None (unknown or no declaration found).  Note that a
 227 normal truth test on this value will always tell if the
 228 <tt class="rst-docutils literal">standalone</tt> flag was set to <tt class="rst-docutils literal">'yes'</tt> or not.
 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 href="lxml.etree.DocInfo-class.html#system_url" class="summary-name">system_url</a><br />
 236       System ID of the DOCTYPE.
 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 name="xml_version"></a><span class="summary-name">xml_version</span><br />
 244       Returns the XML version as declared by the document.
 245     </td>
 246   </tr>
 247   <tr>
 248     <td colspan="2" class="summary">
 249     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 250       <code>__class__</code>
 251       </p>
 252     </td>
 253   </tr>
 254 </table>
 255 <!-- ==================== METHOD DETAILS ==================== -->
 256 <a name="section-MethodDetails"></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">Method Details</span></td>
 264         <td align="right" valign="top"
 265          ><span class="options">[<a href="#section-MethodDetails"
 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="__new__"></a>
 274 <div>
 275 <table class="details" border="1" cellpadding="3"
 276        cellspacing="0" width="100%" bgcolor="white">
 277 <tr><td>
 278   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 279   <tr valign="top"><td>
 280   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 281         <span class="sig-arg">S</span>,
 282         <span class="sig-arg">...</span>)</span>
 283   </h3>
 284   </td><td align="right" valign="top"
 285     >&nbsp;
 286     </td>
 287   </tr></table>
 288
 289
 290   <dl class="fields">
 291     <dt>Returns: a new object with type S, a subtype of T</dt>
 292     <dt>Overrides:
 293         object.__new__
 294     </dt>
 295   </dl>
 296 </td></tr></table>
 297 </div>
 298 <br />
 299 <!-- ==================== PROPERTY DETAILS ==================== -->
 300 <a name="section-PropertyDetails"></a>
 301 <table class="details" border="1" cellpadding="3"
 302        cellspacing="0" width="100%" bgcolor="white">
 303 <tr bgcolor="#70b0f0" class="table-header">
 304   <td colspan="2" class="table-header">
 305     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 306       <tr valign="top">
 307         <td align="left"><span class="table-header">Property Details</span></td>
 308         <td align="right" valign="top"
 309          ><span class="options">[<a href="#section-PropertyDetails"
 310          class="privatelink" onclick="toggle_private();"
 311          >hide private</a>]</span></td>
 312       </tr>
 313     </table>
 314   </td>
 315 </tr>
 316 </table>
 317 <a name="public_id"></a>
 318 <div>
 319 <table class="details" border="1" cellpadding="3"
 320        cellspacing="0" width="100%" bgcolor="white">
 321 <tr><td>
 322   <h3 class="epydoc">public_id</h3>
 323   <p>Public ID of the DOCTYPE.</p>
 324 <p>Mutable.  May be set to a valid string or None.  If a DTD does not
 325 exist, setting this variable (even to None) will create one.</p>
 326   <dl class="fields">
 327   </dl>
 328 </td></tr></table>
 329 </div>
 330 <a name="system_url"></a>
 331 <div>
 332 <table class="details" border="1" cellpadding="3"
 333        cellspacing="0" width="100%" bgcolor="white">
 334 <tr><td>
 335   <h3 class="epydoc">system_url</h3>
 336   <p>System ID of the DOCTYPE.</p>
 337 <p>Mutable.  May be set to a valid string or None.  If a DTD does not
 338 exist, setting this variable (even to None) will create one.</p>
 339   <dl class="fields">
 340   </dl>
 341 </td></tr></table>
 342 </div>
 343 <br />
 344 <!-- ==================== NAVIGATION BAR ==================== -->
 345 <table class="navbar" border="0" width="100%" cellpadding="0"
 346        bgcolor="#a0c0ff" cellspacing="0">
 347   <tr valign="middle">
 348   <!-- Home link -->
 349       <th>&nbsp;&nbsp;&nbsp;<a
 350         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 351
 352   <!-- Tree link -->
 353       <th>&nbsp;&nbsp;&nbsp;<a
 354         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 355
 356   <!-- Index link -->
 357       <th>&nbsp;&nbsp;&nbsp;<a
 358         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 359
 360   <!-- Help link -->
 361       <th>&nbsp;&nbsp;&nbsp;<a
 362         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 363
 364   <!-- Project homepage -->
 365       <th class="navbar" align="right" width="100%">
 366         <table border="0" cellpadding="0" cellspacing="0">
 367           <tr><th class="navbar" align="center"
 368             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 369           </tr></table></th>
 370   </tr>
 371 </table>
 372 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 373   <tr>
 374     <td align="left" class="footer">
 375     Generated by Epydoc 3.0.1
 376     on Thu Jul  9 18:29:53 2020
 377     </td>
 378     <td align="right" class="footer">
 379       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 380         >http://epydoc.sourceforge.net</a>
 381     </td>
 382   </tr>
 383 </table>
 384
 385 <script type="text/javascript">
 386   <!--
 387   // Private objects are initially displayed (because if
 388   // javascript is turned off then we want them to be
 389   // visible); but by default, we want to hide them.  So hide
 390   // them unless we have a cookie that says to show them.
 391   checkCookie();
 392   // -->
 393 </script>
 394 </body>
 395 </html>