doc/html/api/lxml.etree._Entity-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._Entity</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="http://codespeak.net/lxml/">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;_Entity
  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._Entity-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 _Entity</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66       object --+
  67                |
  68         <a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a> --+
  69                    |
  70 <a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a> --+
  71                        |
  72                       <strong class="uidshort">_Entity</strong>
  73 </pre>
  74
  75 <dl><dt>Known Subclasses:</dt>
  76 <dd>
  77       <ul class="subclass-list">
  78 <li><a href="lxml.etree.EntityBase-class.html">EntityBase</a></li>  </ul>
  79 </dd></dl>
  80
  81 <hr />
  82 <!-- ==================== INSTANCE METHODS ==================== -->
  83 <a name="section-InstanceMethods"></a>
  84 <table class="summary" border="1" cellpadding="3"
  85        cellspacing="0" width="100%" bgcolor="white">
  86 <tr bgcolor="#70b0f0" class="table-header">
  87   <td colspan="2" class="table-header">
  88     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  89       <tr valign="top">
  90         <td align="left"><span class="table-header">Instance Methods</span></td>
  91         <td align="right" valign="top"
  92          ><span class="options">[<a href="#section-InstanceMethods"
  93          class="privatelink" onclick="toggle_private();"
  94          >hide private</a>]</span></td>
  95       </tr>
  96     </table>
  97   </td>
  98 </tr>
  99 <tr>
 100     <td width="15%" align="right" valign="top" class="summary">
 101       <span class="summary-type">a new object with type S, a subtype of T</span>
 102     </td><td class="summary">
 103       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 104         <tr>
 105           <td><span class="summary-sig"><a href="lxml.etree._Entity-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 106         <span class="summary-sig-arg">S</span>,
 107         <span class="summary-sig-arg">...</span>)</span></td>
 108           <td align="right" valign="top">
 109
 110
 111           </td>
 112         </tr>
 113       </table>
 114
 115     </td>
 116   </tr>
 117 <tr>
 118     <td width="15%" align="right" valign="top" class="summary">
 119       <span class="summary-type">&nbsp;</span>
 120     </td><td class="summary">
 121       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 122         <tr>
 123           <td><span class="summary-sig"><a href="lxml.etree._Entity-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 124       repr(x)</td>
 125           <td align="right" valign="top">
 126
 127
 128           </td>
 129         </tr>
 130       </table>
 131
 132     </td>
 133   </tr>
 134   <tr>
 135     <td colspan="2" class="summary">
 136     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 137       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
 138       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
 139       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
 140       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
 141       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
 142       <code><a href="lxml.etree.__ContentOnlyElement-class.html#get">get</a></code>,
 143       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
 144       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
 145       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
 146       <code><a href="lxml.etree.__ContentOnlyElement-class.html#set">set</a></code>,
 147       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></code>
 148       </p>
 149     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 150       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
 151       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
 152       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
 153       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
 154       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
 155       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
 156       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
 157       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
 158       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
 159       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
 160       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
 161       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
 162       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
 163       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
 164       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
 165       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
 166       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
 167       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
 168       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
 169       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
 170       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
 171       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
 172       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
 173       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
 174       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
 175       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
 176       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
 177       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
 178       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
 179       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
 180       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
 181       </p>
 182     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b> (private):
 183       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
 184       </p></div>
 185     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 186       <code>__delattr__</code>,
 187       <code>__getattribute__</code>,
 188       <code>__hash__</code>,
 189       <code>__init__</code>,
 190       <code>__reduce__</code>,
 191       <code>__reduce_ex__</code>,
 192       <code>__setattr__</code>,
 193       <code>__str__</code>
 194       </p>
 195     </td>
 196   </tr>
 197 </table>
 198 <!-- ==================== PROPERTIES ==================== -->
 199 <a name="section-Properties"></a>
 200 <table class="summary" border="1" cellpadding="3"
 201        cellspacing="0" width="100%" bgcolor="white">
 202 <tr bgcolor="#70b0f0" class="table-header">
 203   <td colspan="2" class="table-header">
 204     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 205       <tr valign="top">
 206         <td align="left"><span class="table-header">Properties</span></td>
 207         <td align="right" valign="top"
 208          ><span class="options">[<a href="#section-Properties"
 209          class="privatelink" onclick="toggle_private();"
 210          >hide private</a>]</span></td>
 211       </tr>
 212     </table>
 213   </td>
 214 </tr>
 215 <tr>
 216     <td width="15%" align="right" valign="top" class="summary">
 217       <span class="summary-type">&nbsp;</span>
 218     </td><td class="summary">
 219         <a name="name"></a><span class="summary-name">name</span>
 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="tag"></a><span class="summary-name">tag</span><br />
 227       Element tag
 228     </td>
 229   </tr>
 230 <tr>
 231     <td width="15%" align="right" valign="top" class="summary">
 232       <span class="summary-type">&nbsp;</span>
 233     </td><td class="summary">
 234         <a name="text"></a><span class="summary-name">text</span><br />
 235       Text before the first subelement.
 236     </td>
 237   </tr>
 238   <tr>
 239     <td colspan="2" class="summary">
 240     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 241       <code><a href="lxml.etree.__ContentOnlyElement-class.html#attrib">attrib</a></code>
 242       </p>
 243     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 244       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
 245       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
 246       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
 247       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
 248       <code><a href="lxml.etree._Element-class.html#tail">tail</a></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="__new__"></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">__new__</span>(<span class="sig-arg">T</span>,
 282         <span class="sig-arg">S</span>,
 283         <span class="sig-arg">...</span>)</span>
 284   </h3>
 285   </td><td align="right" valign="top"
 286     >&nbsp;
 287     </td>
 288   </tr></table>
 289
 290
 291   <dl class="fields">
 292     <dt>Returns: a new object with type S, a subtype of T</dt>
 293     <dt>Overrides:
 294         object.__new__
 295     </dt>
 296   </dl>
 297 </td></tr></table>
 298 </div>
 299 <a name="__repr__"></a>
 300 <div>
 301 <table class="details" border="1" cellpadding="3"
 302        cellspacing="0" width="100%" bgcolor="white">
 303 <tr><td>
 304   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 305   <tr valign="top"><td>
 306   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 307     <br /><em class="fname">(Representation operator)</em>
 308   </h3>
 309   </td><td align="right" valign="top"
 310     >&nbsp;
 311     </td>
 312   </tr></table>
 313
 314   repr(x)
 315   <dl class="fields">
 316     <dt>Overrides:
 317         object.__repr__
 318         <dd><em class="note">(inherited documentation)</em></dd>
 319     </dt>
 320   </dl>
 321 </td></tr></table>
 322 </div>
 323 <br />
 324 <!-- ==================== NAVIGATION BAR ==================== -->
 325 <table class="navbar" border="0" width="100%" cellpadding="0"
 326        bgcolor="#a0c0ff" cellspacing="0">
 327   <tr valign="middle">
 328   <!-- Home link -->
 329       <th>&nbsp;&nbsp;&nbsp;<a
 330         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 331
 332   <!-- Tree link -->
 333       <th>&nbsp;&nbsp;&nbsp;<a
 334         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 335
 336   <!-- Index link -->
 337       <th>&nbsp;&nbsp;&nbsp;<a
 338         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 339
 340   <!-- Help link -->
 341       <th>&nbsp;&nbsp;&nbsp;<a
 342         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 343
 344   <!-- Project homepage -->
 345       <th class="navbar" align="right" width="100%">
 346         <table border="0" cellpadding="0" cellspacing="0">
 347           <tr><th class="navbar" align="center"
 348             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
 349           </tr></table></th>
 350   </tr>
 351 </table>
 352 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 353   <tr>
 354     <td align="left" class="footer">
 355     Generated by Epydoc 3.0 on Fri Oct 30 14:51:46 2009
 356     </td>
 357     <td align="right" class="footer">
 358       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 359         >http://epydoc.sourceforge.net</a>
 360     </td>
 361   </tr>
 362 </table>
 363
 364 <script type="text/javascript">
 365   <!--
 366   // Private objects are initially displayed (because if
 367   // javascript is turned off then we want them to be
 368   // visible); but by default, we want to hide them.  So hide
 369   // them unless we have a cookie that says to show them.
 370   checkCookie();
 371   // -->
 372 </script>
 373 </body>
 374 </html>