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