<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>lxml.etree.ElementBase</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="lxml-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="/">lxml API</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="lxml-module.html">Package lxml</a> ::
<a href="lxml.etree-module.html">Module etree</a> ::
Class ElementBase
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="lxml.etree.ElementBase-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ElementBase</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
<a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a> --+
|
<strong class="uidshort">ElementBase</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="lxml.objectify.ObjectifiedElement-class.html">objectify.ObjectifiedElement</a></li><li>, <a href="lxml.html.HtmlElement-class.html">html.HtmlElement</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> </ul>
</dd></dl>
<hr />
<p>ElementBase(<a href="#id1"><span class="rst-problematic" id="rst-rst-rst-id2">*</span></a>children, attrib=None, nsmap=None, <a href="#id3"><span class="rst-problematic" id="rst-rst-rst-id4">**</span></a>_extra)</p>
<p>The public Element class. All custom Element classes must inherit
from this one. To create an Element, use the <a href="lxml.etree-module.html#Element" class="link">Element()</a> factory.</p>
<p>BIG FAT WARNING: Subclasses <em>must not</em> override __init__ or
__new__ as it is absolutely undefined when these objects will be
created or destroyed. All persistent state of Elements must be
stored in the underlying XML. If you really need to initialize
the object after creation, you can implement an <tt class="rst-docutils literal">_init(self)</tt>
method that will be called directly after object creation.</p>
<p>Subclasses of this class can be instantiated to create a new
Element. By default, the tag name will be the class name and the
namespace will be empty. You can modify this with the following
class attributes:</p>
<ul class="rst-simple">
<li>TAG - the tag name, possibly containing a namespace in Clark
notation</li>
<li>NAMESPACE - the default namespace URI, unless provided as part
of the TAG attribute.</li>
<li>HTML - flag if the class is an HTML tag, as opposed to an XML
tag. This only applies to un-namespaced tags and defaults to
false (i.e. XML).</li>
<li>PARSER - the parser that provides the configuration for the
newly created document. Providing an HTML parser here will
default to creating an HTML element.</li>
</ul>
<p>In user code, the latter three are commonly inherited in class
hierarchies that implement a common namespace.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">nsmap</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">*children</span>,
<span class="summary-sig-arg">**_extra</span>)</span><br />
x.__init__(...) initializes x; see help(type(x)) for signature</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">a new object with type S, a subtype of T</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">...</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
<code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
<code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
<code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
<code><a href="lxml.etree._Element-class.html#__delitem__">__delitem__</a></code>,
<code><a href="lxml.etree._Element-class.html#__getitem__">__getitem__</a></code>,
<code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
<code><a href="lxml.etree._Element-class.html#__len__">__len__</a></code>,
<code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
<code><a href="lxml.etree._Element-class.html#__repr__">__repr__</a></code>,
<code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
<code><a href="lxml.etree._Element-class.html#__setitem__">__setitem__</a></code>,
<code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
<code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
<code><a href="lxml.etree._Element-class.html#append">append</a></code>,
<code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
<code><a href="lxml.etree._Element-class.html#cssselect">cssselect</a></code>,
<code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
<code><a href="lxml.etree._Element-class.html#find">find</a></code>,
<code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
<code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
<code><a href="lxml.etree._Element-class.html#get">get</a></code>,
<code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
<code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
<code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
<code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
<code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
<code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
<code><a href="lxml.etree._Element-class.html#index">index</a></code>,
<code><a href="lxml.etree._Element-class.html#insert">insert</a></code>,
<code><a href="lxml.etree._Element-class.html#items">items</a></code>,
<code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
<code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
<code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
<code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
<code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
<code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
<code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
<code><a href="lxml.etree._Element-class.html#keys">keys</a></code>,
<code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
<code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
<code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
<code><a href="lxml.etree._Element-class.html#set">set</a></code>,
<code><a href="lxml.etree._Element-class.html#values">values</a></code>,
<code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
</p>
<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):
<code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
<code><a href="lxml.etree._Element-class.html#attrib">attrib</a></code>,
<code><a href="lxml.etree._Element-class.html#base">base</a></code>,
<code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
<code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
<code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
<code><a href="lxml.etree._Element-class.html#tag">tag</a></code>,
<code><a href="lxml.etree._Element-class.html#tail">tail</a></code>,
<code><a href="lxml.etree._Element-class.html#text">text</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">attrib</span>=<span class="sig-default">None</span>,
<span class="sig-arg">nsmap</span>=<span class="sig-default">None</span>,
<span class="sig-arg">*children</span>,
<span class="sig-arg">**_extra</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
x.__init__(...) initializes x; see help(type(x)) for signature
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__new__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
<span class="sig-arg">S</span>,
<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: a new object with type S, a subtype of T</dt>
<dt>Overrides:
object.__new__
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="lxml-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="/">lxml API</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
on Wed Jun 27 16:05:05 2018
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>