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 colspan="2" class="summary">
 111     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 112       <code>__delattr__</code>,
 113       <code>__format__</code>,
 114       <code>__getattribute__</code>,
 115       <code>__hash__</code>,
 116       <code>__init__</code>,
 117       <code>__reduce__</code>,
 118       <code>__reduce_ex__</code>,
 119       <code>__repr__</code>,
 120       <code>__setattr__</code>,
 121       <code>__sizeof__</code>,
 122       <code>__str__</code>,
 123       <code>__subclasshook__</code>
 124       </p>
 125     </td>
 126   </tr>
 127 </table>
 128 <!-- ==================== PROPERTIES ==================== -->
 129 <a name="section-Properties"></a>
 130 <table class="summary" border="1" cellpadding="3"
 131        cellspacing="0" width="100%" bgcolor="white">
 132 <tr bgcolor="#70b0f0" class="table-header">
 133   <td colspan="2" class="table-header">
 134     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 135       <tr valign="top">
 136         <td align="left"><span class="table-header">Properties</span></td>
 137         <td align="right" valign="top"
 138          ><span class="options">[<a href="#section-Properties"
 139          class="privatelink" onclick="toggle_private();"
 140          >hide private</a>]</span></td>
 141       </tr>
 142     </table>
 143   </td>
 144 </tr>
 145 <tr>
 146     <td width="15%" align="right" valign="top" class="summary">
 147       <span class="summary-type">&nbsp;</span>
 148     </td><td class="summary">
 149         <a name="URL"></a><span class="summary-name">URL</span><br />
 150       The source URL of the document (or None if unknown).
 151     </td>
 152   </tr>
 153 <tr>
 154     <td width="15%" align="right" valign="top" class="summary">
 155       <span class="summary-type">&nbsp;</span>
 156     </td><td class="summary">
 157         <a name="doctype"></a><span class="summary-name">doctype</span><br />
 158       Returns a DOCTYPE declaration string for the document.
 159     </td>
 160   </tr>
 161 <tr>
 162     <td width="15%" align="right" valign="top" class="summary">
 163       <span class="summary-type">&nbsp;</span>
 164     </td><td class="summary">
 165         <a name="encoding"></a><span class="summary-name">encoding</span><br />
 166       Returns the encoding name as declared by the document.
 167     </td>
 168   </tr>
 169 <tr>
 170     <td width="15%" align="right" valign="top" class="summary">
 171       <span class="summary-type">&nbsp;</span>
 172     </td><td class="summary">
 173         <a name="externalDTD"></a><span class="summary-name">externalDTD</span><br />
 174       Returns a DTD validator based on the external subset of the document.
 175     </td>
 176   </tr>
 177 <tr>
 178     <td width="15%" align="right" valign="top" class="summary">
 179       <span class="summary-type">&nbsp;</span>
 180     </td><td class="summary">
 181         <a name="internalDTD"></a><span class="summary-name">internalDTD</span><br />
 182       Returns a DTD validator based on the internal subset of the document.
 183     </td>
 184   </tr>
 185 <tr>
 186     <td width="15%" align="right" valign="top" class="summary">
 187       <span class="summary-type">&nbsp;</span>
 188     </td><td class="summary">
 189         <a name="public_id"></a><span class="summary-name">public_id</span><br />
 190       Returns the public ID of the DOCTYPE.
 191     </td>
 192   </tr>
 193 <tr>
 194     <td width="15%" align="right" valign="top" class="summary">
 195       <span class="summary-type">&nbsp;</span>
 196     </td><td class="summary">
 197         <a name="root_name"></a><span class="summary-name">root_name</span><br />
 198       Returns the name of the root node as defined by the DOCTYPE.
 199     </td>
 200   </tr>
 201 <tr>
 202     <td width="15%" align="right" valign="top" class="summary">
 203       <span class="summary-type">&nbsp;</span>
 204     </td><td class="summary">
 205         <a name="standalone"></a><span class="summary-name">standalone</span><br />
 206       Returns the standalone flag as declared by the document.  The possible
 207 values are True (<tt class="rst-docutils literal"><span class="pre">standalone='yes'</span></tt>), False
 208 (<tt class="rst-docutils literal"><span class="pre">standalone='no'</span></tt> or flag not provided in the declaration),
 209 and None (unknown or no declaration found).  Note that a
 210 normal truth test on this value will always tell if the
 211 <tt class="rst-docutils literal">standalone</tt> flag was set to <tt class="rst-docutils literal">'yes'</tt> or not.
 212     </td>
 213   </tr>
 214 <tr>
 215     <td width="15%" align="right" valign="top" class="summary">
 216       <span class="summary-type">&nbsp;</span>
 217     </td><td class="summary">
 218         <a name="system_url"></a><span class="summary-name">system_url</span><br />
 219       Returns the system ID of the DOCTYPE.
 220     </td>
 221   </tr>
 222 <tr>
 223     <td width="15%" align="right" valign="top" class="summary">
 224       <span class="summary-type">&nbsp;</span>
 225     </td><td class="summary">
 226         <a name="xml_version"></a><span class="summary-name">xml_version</span><br />
 227       Returns the XML version as declared by the document.
 228     </td>
 229   </tr>
 230   <tr>
 231     <td colspan="2" class="summary">
 232     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 233       <code>__class__</code>
 234       </p>
 235     </td>
 236   </tr>
 237 </table>
 238 <!-- ==================== METHOD DETAILS ==================== -->
 239 <a name="section-MethodDetails"></a>
 240 <table class="details" border="1" cellpadding="3"
 241        cellspacing="0" width="100%" bgcolor="white">
 242 <tr bgcolor="#70b0f0" class="table-header">
 243   <td colspan="2" class="table-header">
 244     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 245       <tr valign="top">
 246         <td align="left"><span class="table-header">Method Details</span></td>
 247         <td align="right" valign="top"
 248          ><span class="options">[<a href="#section-MethodDetails"
 249          class="privatelink" onclick="toggle_private();"
 250          >hide private</a>]</span></td>
 251       </tr>
 252     </table>
 253   </td>
 254 </tr>
 255 </table>
 256 <a name="__new__"></a>
 257 <div>
 258 <table class="details" border="1" cellpadding="3"
 259        cellspacing="0" width="100%" bgcolor="white">
 260 <tr><td>
 261   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 262   <tr valign="top"><td>
 263   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 264         <span class="sig-arg">S</span>,
 265         <span class="sig-arg">...</span>)</span>
 266   </h3>
 267   </td><td align="right" valign="top"
 268     >&nbsp;
 269     </td>
 270   </tr></table>
 271
 272
 273   <dl class="fields">
 274     <dt>Returns: a new object with type S, a subtype of T</dt>
 275     <dt>Overrides:
 276         object.__new__
 277     </dt>
 278   </dl>
 279 </td></tr></table>
 280 </div>
 281 <br />
 282 <!-- ==================== NAVIGATION BAR ==================== -->
 283 <table class="navbar" border="0" width="100%" cellpadding="0"
 284        bgcolor="#a0c0ff" cellspacing="0">
 285   <tr valign="middle">
 286   <!-- Home link -->
 287       <th>&nbsp;&nbsp;&nbsp;<a
 288         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 289
 290   <!-- Tree link -->
 291       <th>&nbsp;&nbsp;&nbsp;<a
 292         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 293
 294   <!-- Index link -->
 295       <th>&nbsp;&nbsp;&nbsp;<a
 296         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 297
 298   <!-- Help link -->
 299       <th>&nbsp;&nbsp;&nbsp;<a
 300         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 301
 302   <!-- Project homepage -->
 303       <th class="navbar" align="right" width="100%">
 304         <table border="0" cellpadding="0" cellspacing="0">
 305           <tr><th class="navbar" align="center"
 306             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 307           </tr></table></th>
 308   </tr>
 309 </table>
 310 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 311   <tr>
 312     <td align="left" class="footer">
 313     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 314     </td>
 315     <td align="right" class="footer">
 316       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 317         >http://epydoc.sourceforge.net</a>
 318     </td>
 319   </tr>
 320 </table>
 321
 322 <script type="text/javascript">
 323   <!--
 324   // Private objects are initially displayed (because if
 325   // javascript is turned off then we want them to be
 326   // visible); but by default, we want to hide them.  So hide
 327   // them unless we have a cookie that says to show them.
 328   checkCookie();
 329   // -->
 330 </script>
 331 </body>
 332 </html>