<?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._ElementTree</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 _ElementTree
</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._ElementTree-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _ElementTree</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">_ElementTree</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li class="private"><a href="lxml.etree._XSLTResultTree-class.html" onclick="show_private();">_XSLTResultTree</a></li> </ul>
</dd></dl>
<hr />
<!-- ==================== 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 name="__copy__"></a><span class="summary-sig-name">__copy__</span>(<span class="summary-sig-arg">...</span>)</span></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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__deepcopy__"></a><span class="summary-sig-name">__deepcopy__</span>(<span class="summary-sig-arg">...</span>)</span></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._ElementTree-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 class="private">
<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 name="_setroot"></a><span class="summary-sig-name">_setroot</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">root</span>)</span><br />
Relocate the ElementTree to a new root node.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#find" class="summary-sig-name">find</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
Finds the first toplevel element with given tag. Same as
<tt class="rst-docutils literal"><span class="pre">tree.getroot().find(path)</span></tt>.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#findall" class="summary-sig-name">findall</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
Finds all elements matching the ElementPath expression. Same as
getroot().findall(path).</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#findtext" class="summary-sig-name">findtext</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
Finds the text for the first element matching the ElementPath
expression. Same as getroot().findtext(path)</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#getelementpath" class="summary-sig-name">getelementpath</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">element</span>)</span><br />
Returns a structural, absolute ElementPath expression to find the
element. This path can be used in the .find() method to look up
the element, provided that the elements along the path and their
list of immediate children were not modified in between.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#getiterator" class="summary-sig-name">getiterator</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">*tags</span>)</span><br />
Returns a sequence or iterator of all elements in document order
(depth first pre-order), starting with the root element.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#getpath" class="summary-sig-name">getpath</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">element</span>)</span><br />
Returns a structural, absolute XPath expression to find the element.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="getroot"></a><span class="summary-sig-name">getroot</span>(<span class="summary-sig-arg">self</span>)</span><br />
Gets the root element for this tree.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#iter" class="summary-sig-name">iter</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">*tags</span>)</span><br />
Creates an iterator for the root element. The iterator loops over
all elements in this tree, in document order. Note that siblings
of the root element (comments or processing instructions) are not
returned by the iterator.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#iterfind" class="summary-sig-name">iterfind</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span><br />
Iterates over all elements matching the ElementPath expression.
Same as getroot().iterfind(path).</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">source</span>,
<span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">base_url</span>=<span class="summary-sig-default">None</span>)</span><br />
Updates self with the content of source and returns its root</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#relaxng" class="summary-sig-name">relaxng</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">relaxng</span>)</span><br />
Validate this document using other document.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">file</span>,
<span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">method</span>=<span class="summary-sig-default">"xml"</span>,
<span class="summary-sig-arg">pretty_print</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">xml_declaration</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">with_tail</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">standalone</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">doctype</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">compression</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">exclusive</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">with_comments</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">inclusive_ns_prefixes</span>=<span class="summary-sig-default">None</span>)</span><br />
Write the tree to a filename, file or file-like object.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#write_c14n" class="summary-sig-name">write_c14n</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">file</span>,
<span class="summary-sig-arg">exclusive</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">with_comments</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">compression</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">inclusive_ns_prefixes</span>=<span class="summary-sig-default">None</span>)</span><br />
C14N write of document. Always writes UTF-8.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xinclude" class="summary-sig-name">xinclude</a>(<span class="summary-sig-arg">self</span>)</span><br />
Process the XInclude nodes in this document and include the
referenced XML fragments.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xmlschema" class="summary-sig-name">xmlschema</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">xmlschema</span>)</span><br />
Validate this document using other document.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xpath" class="summary-sig-name">xpath</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">_path</span>,
<span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">extensions</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">smart_strings</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">**_variables</span>)</span><br />
XPath evaluate in context of document.</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lxml.etree._ElementTree-class.html#xslt" class="summary-sig-name">xslt</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">_xslt</span>,
<span class="summary-sig-arg">extensions</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">access_control</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**_kw</span>)</span><br />
Transform this document using other document.</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>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__init__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</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 width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="docinfo"></a><span class="summary-name">docinfo</span><br />
Information about the document provided by parser and DTD.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="parser"></a><span class="summary-name">parser</span><br />
The parser that was used to parse the document in this ElementTree.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<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="__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>
<a name="find"></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">find</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Finds the first toplevel element with given tag. Same as
<tt class="rst-docutils literal"><span class="pre">tree.getroot().find(path)</span></tt>.</p>
<p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
prefix-to-namespace mapping that allows the usage of XPath
prefixes in the path expression.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="findall"></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">findall</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Finds all elements matching the ElementPath expression. Same as
getroot().findall(path).</p>
<p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
prefix-to-namespace mapping that allows the usage of XPath
prefixes in the path expression.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="findtext"></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">findtext</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">default</span>=<span class="sig-default">None</span>,
<span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Finds the text for the first element matching the ElementPath
expression. Same as getroot().findtext(path)</p>
<p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
prefix-to-namespace mapping that allows the usage of XPath
prefixes in the path expression.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="getelementpath"></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">getelementpath</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">element</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Returns a structural, absolute ElementPath expression to find the
element. This path can be used in the .find() method to look up
the element, provided that the elements along the path and their
list of immediate children were not modified in between.</p>
<p>ElementPath has the advantage over an XPath expression (as returned
by the .getpath() method) that it does not require additional prefix
declarations. It is always self-contained.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="getiterator"></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">getiterator</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
<span class="sig-arg">*tags</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Returns a sequence or iterator of all elements in document order
(depth first pre-order), starting with the root element.</p>
<p>Can be restricted to find only elements with specific tags,
see <a href="lxml.etree._Element-class.html#iter" class="link">_Element.iter</a>.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Deprecated:</strong>
Note that this method is deprecated as of
ElementTree 1.3 and lxml 2.0. It returns an iterator in
lxml, which diverges from the original ElementTree
behaviour. If you want an efficient iterator, use the
<tt class="rst-docutils literal">tree.iter()</tt> method instead. You should only use this
method in new code if you require backwards compatibility
with older versions of lxml or ElementTree.
</p>
</div></td></tr></table>
</div>
<a name="getpath"></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">getpath</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">element</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Returns a structural, absolute XPath expression to find the element.</p>
<p>For namespaced elements, the expression uses prefixes from the
document, which therefore need to be provided in order to make any
use of the expression in XPath.</p>
<p>Also see the method getelementpath(self, element), which returns a
self-contained ElementPath expression.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="iter"></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">iter</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
<span class="sig-arg">*tags</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Creates an iterator for the root element. The iterator loops over
all elements in this tree, in document order. Note that siblings
of the root element (comments or processing instructions) are not
returned by the iterator.</p>
<p>Can be restricted to find only elements with specific tags,
see <a href="lxml.etree._Element-class.html#iter" class="link">_Element.iter</a>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="iterfind"></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">iterfind</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>,
<span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Iterates over all elements matching the ElementPath expression.
Same as getroot().iterfind(path).</p>
<p>The optional <tt class="rst-docutils literal">namespaces</tt> argument accepts a
prefix-to-namespace mapping that allows the usage of XPath
prefixes in the path expression.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="relaxng"></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">relaxng</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">relaxng</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Validate this document using other document.</p>
<p>The relaxng argument is a tree that should contain a Relax NG schema.</p>
<p>Returns True or False, depending on whether validation
succeeded.</p>
<p>Note: if you are going to apply the same Relax NG schema against
multiple documents, it is more efficient to use the RelaxNG
class directly.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write"></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">write</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">file</span>,
<span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
<span class="sig-arg">method</span>=<span class="sig-default">"xml"</span>,
<span class="sig-arg">pretty_print</span>=<span class="sig-default">False</span>,
<span class="sig-arg">xml_declaration</span>=<span class="sig-default">None</span>,
<span class="sig-arg">with_tail</span>=<span class="sig-default">True</span>,
<span class="sig-arg">standalone</span>=<span class="sig-default">None</span>,
<span class="sig-arg">doctype</span>=<span class="sig-default">None</span>,
<span class="sig-arg">compression</span>=<span class="sig-default">0</span>,
<span class="sig-arg">exclusive</span>=<span class="sig-default">False</span>,
<span class="sig-arg">with_comments</span>=<span class="sig-default">True</span>,
<span class="sig-arg">inclusive_ns_prefixes</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Write the tree to a filename, file or file-like object.</p>
<p>Defaults to ASCII encoding and writing a declaration as needed.</p>
<p>The keyword argument 'method' selects the output method:
'xml', 'html', 'text' or 'c14n'. Default is 'xml'.</p>
<p>The <tt class="rst-docutils literal">exclusive</tt> and <tt class="rst-docutils literal">with_comments</tt> arguments are only
used with C14N output, where they request exclusive and
uncommented C14N serialisation respectively.</p>
<p>Passing a boolean value to the <tt class="rst-docutils literal">standalone</tt> option will
output an XML declaration with the corresponding
<tt class="rst-docutils literal">standalone</tt> flag.</p>
<p>The <tt class="rst-docutils literal">doctype</tt> option allows passing in a plain string that will
be serialised before the XML tree. Note that passing in non
well-formed content here will make the XML output non well-formed.
Also, an existing doctype in the document tree will not be removed
when serialising an ElementTree instance.</p>
<p>The <tt class="rst-docutils literal">compression</tt> option enables GZip compression level 1-9.</p>
<p>The <tt class="rst-docutils literal">inclusive_ns_prefixes</tt> should be a list of namespace strings
(i.e. ['xs', 'xsi']) that will be promoted to the top-level element
during exclusive C14N serialisation. This parameter is ignored if
exclusive mode=False.</p>
<p>If exclusive=True and no list is provided, a namespace will only be
rendered if it is used by the immediate parent or one of its attributes
and its prefix and values have not already been rendered by an ancestor
of the namespace node's parent element.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write_c14n"></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">write_c14n</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">file</span>,
<span class="sig-arg">exclusive</span>=<span class="sig-default">False</span>,
<span class="sig-arg">with_comments</span>=<span class="sig-default">True</span>,
<span class="sig-arg">compression</span>=<span class="sig-default">0</span>,
<span class="sig-arg">inclusive_ns_prefixes</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>C14N write of document. Always writes UTF-8.</p>
<p>The <tt class="rst-docutils literal">compression</tt> option enables GZip compression level 1-9.</p>
<p>The <tt class="rst-docutils literal">inclusive_ns_prefixes</tt> should be a list of namespace strings
(i.e. ['xs', 'xsi']) that will be promoted to the top-level element
during exclusive C14N serialisation. This parameter is ignored if
exclusive mode=False.</p>
<p>If exclusive=True and no list is provided, a namespace will only be
rendered if it is used by the immediate parent or one of its attributes
and its prefix and values have not already been rendered by an ancestor
of the namespace node's parent element.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="xinclude"></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">xinclude</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Process the XInclude nodes in this document and include the
referenced XML fragments.</p>
<p>There is support for loading files through the file system, HTTP and
FTP.</p>
<p>Note that XInclude does not support custom resolvers in Python space
due to restrictions of libxml2 <= 2.6.29.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="xmlschema"></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">xmlschema</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">xmlschema</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Validate this document using other document.</p>
<p>The xmlschema argument is a tree that should contain an XML Schema.</p>
<p>Returns True or False, depending on whether validation
succeeded.</p>
<p>Note: If you are going to apply the same XML Schema against
multiple documents, it is more efficient to use the XMLSchema
class directly.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="xpath"></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">xpath</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">_path</span>,
<span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>,
<span class="sig-arg">extensions</span>=<span class="sig-default">None</span>,
<span class="sig-arg">smart_strings</span>=<span class="sig-default">True</span>,
<span class="sig-arg">**_variables</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>XPath evaluate in context of document.</p>
<p><tt class="rst-docutils literal">namespaces</tt> is an optional dictionary with prefix to namespace URI
mappings, used by XPath. <tt class="rst-docutils literal">extensions</tt> defines additional extension
functions.</p>
<p>Returns a list (nodeset), or bool, float or string.</p>
<p>In case of a list result, return Element for element nodes,
string for text and attribute values.</p>
<p>Note: if you are going to apply multiple XPath expressions
against the same document, it is more efficient to use
XPathEvaluator directly.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="xslt"></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">xslt</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">_xslt</span>,
<span class="sig-arg">extensions</span>=<span class="sig-default">None</span>,
<span class="sig-arg">access_control</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**_kw</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Transform this document using other document.</p>
<p>xslt is a tree that should be XSLT
keyword parameters are XSLT transformation parameters.</p>
<p>Returns the transformed tree.</p>
<p>Note: if you are going to apply the same XSLT stylesheet against
multiple documents, it is more efficient to use the XSLT
class directly.</p>
<dl class="fields">
</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>