doc/html/api/lxml.etree._Document-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._Document</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;_Document
  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._Document-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 _Document</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">_Document</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>Internal base class to reference a libxml document.</p>
  73 <p>When instances of this class are garbage collected, the libxml
  74 document is cleaned up.</p>
  75
  76 <!-- ==================== INSTANCE METHODS ==================== -->
  77 <a name="section-InstanceMethods"></a>
  78 <table class="summary" border="1" cellpadding="3"
  79        cellspacing="0" width="100%" bgcolor="white">
  80 <tr bgcolor="#70b0f0" class="table-header">
  81   <td colspan="2" class="table-header">
  82     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  83       <tr valign="top">
  84         <td align="left"><span class="table-header">Instance Methods</span></td>
  85         <td align="right" valign="top"
  86          ><span class="options">[<a href="#section-InstanceMethods"
  87          class="privatelink" onclick="toggle_private();"
  88          >hide private</a>]</span></td>
  89       </tr>
  90     </table>
  91   </td>
  92 </tr>
  93 <tr>
  94     <td width="15%" align="right" valign="top" class="summary">
  95       <span class="summary-type">a new object with type S, a subtype of T</span>
  96     </td><td class="summary">
  97       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  98         <tr>
  99           <td><span class="summary-sig"><a href="lxml.etree._Document-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 100         <span class="summary-sig-arg">S</span>,
 101         <span class="summary-sig-arg">...</span>)</span></td>
 102           <td align="right" valign="top">
 103
 104
 105           </td>
 106         </tr>
 107       </table>
 108
 109     </td>
 110   </tr>
 111   <tr>
 112     <td colspan="2" class="summary">
 113     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 114       <code>__delattr__</code>,
 115       <code>__format__</code>,
 116       <code>__getattribute__</code>,
 117       <code>__hash__</code>,
 118       <code>__init__</code>,
 119       <code>__reduce__</code>,
 120       <code>__reduce_ex__</code>,
 121       <code>__repr__</code>,
 122       <code>__setattr__</code>,
 123       <code>__sizeof__</code>,
 124       <code>__str__</code>,
 125       <code>__subclasshook__</code>
 126       </p>
 127     </td>
 128   </tr>
 129 </table>
 130 <!-- ==================== PROPERTIES ==================== -->
 131 <a name="section-Properties"></a>
 132 <table class="summary" border="1" cellpadding="3"
 133        cellspacing="0" width="100%" bgcolor="white">
 134 <tr bgcolor="#70b0f0" class="table-header">
 135   <td colspan="2" class="table-header">
 136     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 137       <tr valign="top">
 138         <td align="left"><span class="table-header">Properties</span></td>
 139         <td align="right" valign="top"
 140          ><span class="options">[<a href="#section-Properties"
 141          class="privatelink" onclick="toggle_private();"
 142          >hide private</a>]</span></td>
 143       </tr>
 144     </table>
 145   </td>
 146 </tr>
 147   <tr>
 148     <td colspan="2" class="summary">
 149     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 150       <code>__class__</code>
 151       </p>
 152     </td>
 153   </tr>
 154 </table>
 155 <!-- ==================== METHOD DETAILS ==================== -->
 156 <a name="section-MethodDetails"></a>
 157 <table class="details" border="1" cellpadding="3"
 158        cellspacing="0" width="100%" bgcolor="white">
 159 <tr bgcolor="#70b0f0" class="table-header">
 160   <td colspan="2" class="table-header">
 161     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 162       <tr valign="top">
 163         <td align="left"><span class="table-header">Method Details</span></td>
 164         <td align="right" valign="top"
 165          ><span class="options">[<a href="#section-MethodDetails"
 166          class="privatelink" onclick="toggle_private();"
 167          >hide private</a>]</span></td>
 168       </tr>
 169     </table>
 170   </td>
 171 </tr>
 172 </table>
 173 <a name="__new__"></a>
 174 <div>
 175 <table class="details" border="1" cellpadding="3"
 176        cellspacing="0" width="100%" bgcolor="white">
 177 <tr><td>
 178   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 179   <tr valign="top"><td>
 180   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 181         <span class="sig-arg">S</span>,
 182         <span class="sig-arg">...</span>)</span>
 183   </h3>
 184   </td><td align="right" valign="top"
 185     >&nbsp;
 186     </td>
 187   </tr></table>
 188
 189
 190   <dl class="fields">
 191     <dt>Returns: a new object with type S, a subtype of T</dt>
 192     <dt>Overrides:
 193         object.__new__
 194     </dt>
 195   </dl>
 196 </td></tr></table>
 197 </div>
 198 <br />
 199 <!-- ==================== NAVIGATION BAR ==================== -->
 200 <table class="navbar" border="0" width="100%" cellpadding="0"
 201        bgcolor="#a0c0ff" cellspacing="0">
 202   <tr valign="middle">
 203   <!-- Home link -->
 204       <th>&nbsp;&nbsp;&nbsp;<a
 205         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 206
 207   <!-- Tree link -->
 208       <th>&nbsp;&nbsp;&nbsp;<a
 209         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 210
 211   <!-- Index link -->
 212       <th>&nbsp;&nbsp;&nbsp;<a
 213         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 214
 215   <!-- Help link -->
 216       <th>&nbsp;&nbsp;&nbsp;<a
 217         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 218
 219   <!-- Project homepage -->
 220       <th class="navbar" align="right" width="100%">
 221         <table border="0" cellpadding="0" cellspacing="0">
 222           <tr><th class="navbar" align="center"
 223             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 224           </tr></table></th>
 225   </tr>
 226 </table>
 227 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 228   <tr>
 229     <td align="left" class="footer">
 230     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 231     </td>
 232     <td align="right" class="footer">
 233       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 234         >http://epydoc.sourceforge.net</a>
 235     </td>
 236   </tr>
 237 </table>
 238
 239 <script type="text/javascript">
 240   <!--
 241   // Private objects are initially displayed (because if
 242   // javascript is turned off then we want them to be
 243   // visible); but by default, we want to hide them.  So hide
 244   // them unless we have a cookie that says to show them.
 245   checkCookie();
 246   // -->
 247 </script>
 248 </body>
 249 </html>