doc/html/api/lxml.etree.EntityBase-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.EntityBase</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;EntityBase
  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.EntityBase-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 EntityBase</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                  <a href="lxml.etree._Entity-class.html" onclick="show_private();">_Entity</a> --+
  73                            |
  74                           <strong class="uidshort">EntityBase</strong>
  75 </pre>
  76
  77 <dl><dt>Known Subclasses:</dt>
  78 <dd>
  79       <ul class="subclass-list">
  80 <li class="private"><a href="lxml.html.HtmlEntity-class.html" onclick="show_private();">html.HtmlEntity</a></li>  </ul>
  81 </dd></dl>
  82
  83 <hr />
  84 <p>All custom Entity classes must inherit from this one.</p>
  85 <p>To create an XML Entity instance, use the <tt class="rst-docutils literal">Entity()</tt> factory.</p>
  86 <p>Subclasses <em>must not</em> override __init__ or __new__ as it is
  87 absolutely undefined when these objects will be created or
  88 destroyed.  All persistent state of Entities must be stored in the
  89 underlying XML.  If you really need to initialize the object after
  90 creation, you can implement an <tt class="rst-docutils literal">_init(self)</tt> method that will be
  91 called after object creation.</p>
  92
  93 <!-- ==================== INSTANCE METHODS ==================== -->
  94 <a name="section-InstanceMethods"></a>
  95 <table class="summary" border="1" cellpadding="3"
  96        cellspacing="0" width="100%" bgcolor="white">
  97 <tr bgcolor="#70b0f0" class="table-header">
  98   <td colspan="2" class="table-header">
  99     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 100       <tr valign="top">
 101         <td align="left"><span class="table-header">Instance Methods</span></td>
 102         <td align="right" valign="top"
 103          ><span class="options">[<a href="#section-InstanceMethods"
 104          class="privatelink" onclick="toggle_private();"
 105          >hide private</a>]</span></td>
 106       </tr>
 107     </table>
 108   </td>
 109 </tr>
 110 <tr>
 111     <td width="15%" align="right" valign="top" class="summary">
 112       <span class="summary-type">&nbsp;</span>
 113     </td><td class="summary">
 114       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 115         <tr>
 116           <td><span class="summary-sig"><a href="lxml.etree.EntityBase-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
 117       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 118           <td align="right" valign="top">
 119
 120
 121           </td>
 122         </tr>
 123       </table>
 124
 125     </td>
 126   </tr>
 127 <tr>
 128     <td width="15%" align="right" valign="top" class="summary">
 129       <span class="summary-type">a new object with type S, a subtype of T</span>
 130     </td><td class="summary">
 131       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 132         <tr>
 133           <td><span class="summary-sig"><a href="lxml.etree.EntityBase-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 134         <span class="summary-sig-arg">S</span>,
 135         <span class="summary-sig-arg">...</span>)</span></td>
 136           <td align="right" valign="top">
 137
 138
 139           </td>
 140         </tr>
 141       </table>
 142
 143     </td>
 144   </tr>
 145   <tr>
 146     <td colspan="2" class="summary">
 147     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Entity-class.html" onclick="show_private();">_Entity</a></code></b>:
 148       <code><a href="lxml.etree._Entity-class.html#__repr__">__repr__</a></code>
 149       </p>
 150     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 151       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
 152       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
 153       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
 154       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
 155       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
 156       <code><a href="lxml.etree.__ContentOnlyElement-class.html#get">get</a></code>,
 157       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
 158       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
 159       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
 160       <code><a href="lxml.etree.__ContentOnlyElement-class.html#set">set</a></code>,
 161       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></code>
 162       </p>
 163     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 164       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
 165       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
 166       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
 167       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
 168       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
 169       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
 170       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
 171       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
 172       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
 173       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
 174       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
 175       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
 176       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
 177       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
 178       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
 179       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
 180       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
 181       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
 182       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
 183       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
 184       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
 185       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
 186       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
 187       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
 188       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
 189       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
 190       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
 191       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
 192       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
 193       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
 194       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
 195       </p>
 196     <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):
 197       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
 198       </p></div>
 199     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 200       <code>__delattr__</code>,
 201       <code>__format__</code>,
 202       <code>__getattribute__</code>,
 203       <code>__hash__</code>,
 204       <code>__reduce__</code>,
 205       <code>__reduce_ex__</code>,
 206       <code>__setattr__</code>,
 207       <code>__sizeof__</code>,
 208       <code>__str__</code>,
 209       <code>__subclasshook__</code>
 210       </p>
 211     </td>
 212   </tr>
 213 </table>
 214 <!-- ==================== PROPERTIES ==================== -->
 215 <a name="section-Properties"></a>
 216 <table class="summary" border="1" cellpadding="3"
 217        cellspacing="0" width="100%" bgcolor="white">
 218 <tr bgcolor="#70b0f0" class="table-header">
 219   <td colspan="2" class="table-header">
 220     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 221       <tr valign="top">
 222         <td align="left"><span class="table-header">Properties</span></td>
 223         <td align="right" valign="top"
 224          ><span class="options">[<a href="#section-Properties"
 225          class="privatelink" onclick="toggle_private();"
 226          >hide private</a>]</span></td>
 227       </tr>
 228     </table>
 229   </td>
 230 </tr>
 231   <tr>
 232     <td colspan="2" class="summary">
 233     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Entity-class.html" onclick="show_private();">_Entity</a></code></b>:
 234       <code><a href="lxml.etree._Entity-class.html#name">name</a></code>,
 235       <code><a href="lxml.etree._Entity-class.html#tag">tag</a></code>,
 236       <code><a href="lxml.etree._Entity-class.html#text">text</a></code>
 237       </p>
 238     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 239       <code><a href="lxml.etree.__ContentOnlyElement-class.html#attrib">attrib</a></code>
 240       </p>
 241     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 242       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
 243       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
 244       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
 245       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
 246       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
 247       </p>
 248     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 249       <code>__class__</code>
 250       </p>
 251     </td>
 252   </tr>
 253 </table>
 254 <!-- ==================== METHOD DETAILS ==================== -->
 255 <a name="section-MethodDetails"></a>
 256 <table class="details" border="1" cellpadding="3"
 257        cellspacing="0" width="100%" bgcolor="white">
 258 <tr bgcolor="#70b0f0" class="table-header">
 259   <td colspan="2" class="table-header">
 260     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 261       <tr valign="top">
 262         <td align="left"><span class="table-header">Method Details</span></td>
 263         <td align="right" valign="top"
 264          ><span class="options">[<a href="#section-MethodDetails"
 265          class="privatelink" onclick="toggle_private();"
 266          >hide private</a>]</span></td>
 267       </tr>
 268     </table>
 269   </td>
 270 </tr>
 271 </table>
 272 <a name="__init__"></a>
 273 <div>
 274 <table class="details" border="1" cellpadding="3"
 275        cellspacing="0" width="100%" bgcolor="white">
 276 <tr><td>
 277   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 278   <tr valign="top"><td>
 279   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
 280     <br /><em class="fname">(Constructor)</em>
 281   </h3>
 282   </td><td align="right" valign="top"
 283     >&nbsp;
 284     </td>
 285   </tr></table>
 286
 287   x.__init__(...) initializes x; see help(type(x)) for signature
 288   <dl class="fields">
 289     <dt>Overrides:
 290         object.__init__
 291     </dt>
 292   </dl>
 293 </td></tr></table>
 294 </div>
 295 <a name="__new__"></a>
 296 <div>
 297 <table class="details" border="1" cellpadding="3"
 298        cellspacing="0" width="100%" bgcolor="white">
 299 <tr><td>
 300   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 301   <tr valign="top"><td>
 302   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 303         <span class="sig-arg">S</span>,
 304         <span class="sig-arg">...</span>)</span>
 305   </h3>
 306   </td><td align="right" valign="top"
 307     >&nbsp;
 308     </td>
 309   </tr></table>
 310
 311
 312   <dl class="fields">
 313     <dt>Returns: a new object with type S, a subtype of T</dt>
 314     <dt>Overrides:
 315         object.__new__
 316     </dt>
 317   </dl>
 318 </td></tr></table>
 319 </div>
 320 <br />
 321 <!-- ==================== NAVIGATION BAR ==================== -->
 322 <table class="navbar" border="0" width="100%" cellpadding="0"
 323        bgcolor="#a0c0ff" cellspacing="0">
 324   <tr valign="middle">
 325   <!-- Home link -->
 326       <th>&nbsp;&nbsp;&nbsp;<a
 327         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 328
 329   <!-- Tree link -->
 330       <th>&nbsp;&nbsp;&nbsp;<a
 331         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 332
 333   <!-- Index link -->
 334       <th>&nbsp;&nbsp;&nbsp;<a
 335         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 336
 337   <!-- Help link -->
 338       <th>&nbsp;&nbsp;&nbsp;<a
 339         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 340
 341   <!-- Project homepage -->
 342       <th class="navbar" align="right" width="100%">
 343         <table border="0" cellpadding="0" cellspacing="0">
 344           <tr><th class="navbar" align="center"
 345             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 346           </tr></table></th>
 347   </tr>
 348 </table>
 349 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 350   <tr>
 351     <td align="left" class="footer">
 352     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 353     </td>
 354     <td align="right" class="footer">
 355       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 356         >http://epydoc.sourceforge.net</a>
 357     </td>
 358   </tr>
 359 </table>
 360
 361 <script type="text/javascript">
 362   <!--
 363   // Private objects are initially displayed (because if
 364   // javascript is turned off then we want them to be
 365   // visible); but by default, we want to hide them.  So hide
 366   // them unless we have a cookie that says to show them.
 367   checkCookie();
 368   // -->
 369 </script>
 370 </body>
 371 </html>