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">
6 <title>xml.etree.ElementTree.ElementTree</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
18 <th> <a
19 href="lxml-module.html">Home</a> </th>
22 <th> <a
23 href="module-tree.html">Trees</a> </th>
26 <th> <a
27 href="identifier-index.html">Indices</a> </th>
30 <th> <a
31 href="help.html">Help</a> </th>
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>
41 <table width="100%" cellpadding="0" cellspacing="0">
44 <span class="breadcrumbs">
49 Class ElementTree
53 <table cellpadding="0" cellspacing="0">
54 <!-- hide/show private -->
55 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56 onclick="toggle_private();">hide private</a>]</span></td></tr>
57 <tr><td align="right"><span class="options"
58 >[<a href="frames.html" target="_top">frames</a
59 >] | <a href="xml.etree.ElementTree.ElementTree-class.html"
60 target="_top">no frames</a>]</span></td></tr>
65 <!-- ==================== CLASS DESCRIPTION ==================== -->
66 <h1 class="epydoc">Class ElementTree</h1><p class="nomargin-top"><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree">source code</a></span></p>
67 <pre class="base-tree">
70 <strong class="uidshort">ElementTree</strong>
74 <!-- ==================== INSTANCE METHODS ==================== -->
75 <a name="section-InstanceMethods"></a>
76 <table class="summary" border="1" cellpadding="3"
77 cellspacing="0" width="100%" bgcolor="white">
78 <tr bgcolor="#70b0f0" class="table-header">
79 <td colspan="2" class="table-header">
80 <table border="0" cellpadding="0" cellspacing="0" width="100%">
82 <td align="left"><span class="table-header">Instance Methods</span></td>
83 <td align="right" valign="top"
84 ><span class="options">[<a href="#section-InstanceMethods"
85 class="privatelink" onclick="toggle_private();"
86 >hide private</a>]</span></td>
92 <td width="15%" align="right" valign="top" class="summary">
93 <span class="summary-type"> </span>
94 </td><td class="summary">
95 <table width="100%" cellpadding="0" cellspacing="0" border="0">
97 <td><span class="summary-sig"><a href="xml.etree.ElementTree.ElementTree-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
98 <span class="summary-sig-arg">element</span>=<span class="summary-sig-default">None</span>,
99 <span class="summary-sig-arg">file</span>=<span class="summary-sig-default">None</span>)</span><br />
100 x.__init__(...) initializes x; see help(type(x)) for signature</td>
101 <td align="right" valign="top">
102 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.__init__">source code</a></span>
111 <td width="15%" align="right" valign="top" class="summary">
112 <span class="summary-type"> </span>
113 </td><td class="summary">
114 <table width="100%" cellpadding="0" cellspacing="0" border="0">
116 <td><span class="summary-sig"><a name="_setroot"></a><span class="summary-sig-name">_setroot</span>(<span class="summary-sig-arg">self</span>,
117 <span class="summary-sig-arg">element</span>)</span></td>
118 <td align="right" valign="top">
119 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree._setroot">source code</a></span>
128 <td width="15%" align="right" valign="top" class="summary">
129 <span class="summary-type"> </span>
130 </td><td class="summary">
131 <table width="100%" cellpadding="0" cellspacing="0" border="0">
133 <td><span class="summary-sig"><a name="find"></a><span class="summary-sig-name">find</span>(<span class="summary-sig-arg">self</span>,
134 <span class="summary-sig-arg">path</span>,
135 <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
136 <td align="right" valign="top">
137 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.find">source code</a></span>
146 <td width="15%" align="right" valign="top" class="summary">
147 <span class="summary-type"> </span>
148 </td><td class="summary">
149 <table width="100%" cellpadding="0" cellspacing="0" border="0">
151 <td><span class="summary-sig"><a name="findall"></a><span class="summary-sig-name">findall</span>(<span class="summary-sig-arg">self</span>,
152 <span class="summary-sig-arg">path</span>,
153 <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
154 <td align="right" valign="top">
155 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.findall">source code</a></span>
164 <td width="15%" align="right" valign="top" class="summary">
165 <span class="summary-type"> </span>
166 </td><td class="summary">
167 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <td><span class="summary-sig"><a name="findtext"></a><span class="summary-sig-name">findtext</span>(<span class="summary-sig-arg">self</span>,
170 <span class="summary-sig-arg">path</span>,
171 <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>,
172 <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
173 <td align="right" valign="top">
174 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.findtext">source code</a></span>
183 <td width="15%" align="right" valign="top" class="summary">
184 <span class="summary-type"> </span>
185 </td><td class="summary">
186 <table width="100%" cellpadding="0" cellspacing="0" border="0">
188 <td><span class="summary-sig"><a name="getiterator"></a><span class="summary-sig-name">getiterator</span>(<span class="summary-sig-arg">self</span>,
189 <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span></td>
190 <td align="right" valign="top">
191 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.getiterator">source code</a></span>
200 <td width="15%" align="right" valign="top" class="summary">
201 <span class="summary-type"> </span>
202 </td><td class="summary">
203 <table width="100%" cellpadding="0" cellspacing="0" border="0">
205 <td><span class="summary-sig"><a name="getroot"></a><span class="summary-sig-name">getroot</span>(<span class="summary-sig-arg">self</span>)</span></td>
206 <td align="right" valign="top">
207 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.getroot">source code</a></span>
216 <td width="15%" align="right" valign="top" class="summary">
217 <span class="summary-type"> </span>
218 </td><td class="summary">
219 <table width="100%" cellpadding="0" cellspacing="0" border="0">
221 <td><span class="summary-sig"><a name="iter"></a><span class="summary-sig-name">iter</span>(<span class="summary-sig-arg">self</span>,
222 <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span></td>
223 <td align="right" valign="top">
224 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.iter">source code</a></span>
233 <td width="15%" align="right" valign="top" class="summary">
234 <span class="summary-type"> </span>
235 </td><td class="summary">
236 <table width="100%" cellpadding="0" cellspacing="0" border="0">
238 <td><span class="summary-sig"><a name="iterfind"></a><span class="summary-sig-name">iterfind</span>(<span class="summary-sig-arg">self</span>,
239 <span class="summary-sig-arg">path</span>,
240 <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>)</span></td>
241 <td align="right" valign="top">
242 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.iterfind">source code</a></span>
251 <td width="15%" align="right" valign="top" class="summary">
252 <span class="summary-type"> </span>
253 </td><td class="summary">
254 <table width="100%" cellpadding="0" cellspacing="0" border="0">
256 <td><span class="summary-sig"><a name="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">self</span>,
257 <span class="summary-sig-arg">source</span>,
258 <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span></td>
259 <td align="right" valign="top">
260 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.parse">source code</a></span>
269 <td width="15%" align="right" valign="top" class="summary">
270 <span class="summary-type"> </span>
271 </td><td class="summary">
272 <table width="100%" cellpadding="0" cellspacing="0" border="0">
274 <td><span class="summary-sig"><a name="write"></a><span class="summary-sig-name">write</span>(<span class="summary-sig-arg">self</span>,
275 <span class="summary-sig-arg">file_or_filename</span>,
276 <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
277 <span class="summary-sig-arg">xml_declaration</span>=<span class="summary-sig-default">None</span>,
278 <span class="summary-sig-arg">default_namespace</span>=<span class="summary-sig-default">None</span>,
279 <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">None</span>)</span></td>
280 <td align="right" valign="top">
281 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.write">source code</a></span>
290 <td width="15%" align="right" valign="top" class="summary">
291 <span class="summary-type"> </span>
292 </td><td class="summary">
293 <table width="100%" cellpadding="0" cellspacing="0" border="0">
295 <td><span class="summary-sig"><a name="write_c14n"></a><span class="summary-sig-name">write_c14n</span>(<span class="summary-sig-arg">self</span>,
296 <span class="summary-sig-arg">file</span>)</span></td>
297 <td align="right" valign="top">
298 <span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.write_c14n">source code</a></span>
307 <td colspan="2" class="summary">
308 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
309 <code>__delattr__</code>,
310 <code>__format__</code>,
311 <code>__getattribute__</code>,
312 <code>__hash__</code>,
313 <code>__new__</code>,
314 <code>__reduce__</code>,
315 <code>__reduce_ex__</code>,
316 <code>__repr__</code>,
317 <code>__setattr__</code>,
318 <code>__sizeof__</code>,
319 <code>__str__</code>,
320 <code>__subclasshook__</code>
325 <!-- ==================== PROPERTIES ==================== -->
326 <a name="section-Properties"></a>
327 <table class="summary" border="1" cellpadding="3"
328 cellspacing="0" width="100%" bgcolor="white">
329 <tr bgcolor="#70b0f0" class="table-header">
330 <td colspan="2" class="table-header">
331 <table border="0" cellpadding="0" cellspacing="0" width="100%">
333 <td align="left"><span class="table-header">Properties</span></td>
334 <td align="right" valign="top"
335 ><span class="options">[<a href="#section-Properties"
336 class="privatelink" onclick="toggle_private();"
337 >hide private</a>]</span></td>
343 <td colspan="2" class="summary">
344 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
345 <code>__class__</code>
350 <!-- ==================== METHOD DETAILS ==================== -->
351 <a name="section-MethodDetails"></a>
352 <table class="details" border="1" cellpadding="3"
353 cellspacing="0" width="100%" bgcolor="white">
354 <tr bgcolor="#70b0f0" class="table-header">
355 <td colspan="2" class="table-header">
356 <table border="0" cellpadding="0" cellspacing="0" width="100%">
358 <td align="left"><span class="table-header">Method Details</span></td>
359 <td align="right" valign="top"
360 ><span class="options">[<a href="#section-MethodDetails"
361 class="privatelink" onclick="toggle_private();"
362 >hide private</a>]</span></td>
368 <a name="__init__"></a>
370 <table class="details" border="1" cellpadding="3"
371 cellspacing="0" width="100%" bgcolor="white">
373 <table width="100%" cellpadding="0" cellspacing="0" border="0">
374 <tr valign="top"><td>
375 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
376 <span class="sig-arg">element</span>=<span class="sig-default">None</span>,
377 <span class="sig-arg">file</span>=<span class="sig-default">None</span>)</span>
378 <br /><em class="fname">(Constructor)</em>
380 </td><td align="right" valign="top"
381 ><span class="codelink"><a href="xml.etree.ElementTree-pysrc.html#ElementTree.__init__">source code</a></span>
385 x.__init__(...) initializes x; see help(type(x)) for signature
389 <dd><em class="note">(inherited documentation)</em></dd>
395 <!-- ==================== NAVIGATION BAR ==================== -->
396 <table class="navbar" border="0" width="100%" cellpadding="0"
397 bgcolor="#a0c0ff" cellspacing="0">
400 <th> <a
401 href="lxml-module.html">Home</a> </th>
404 <th> <a
405 href="module-tree.html">Trees</a> </th>
408 <th> <a
409 href="identifier-index.html">Indices</a> </th>
412 <th> <a
413 href="help.html">Help</a> </th>
415 <!-- Project homepage -->
416 <th class="navbar" align="right" width="100%">
417 <table border="0" cellpadding="0" cellspacing="0">
418 <tr><th class="navbar" align="center"
419 ><a class="navbar" target="_top" href="/">lxml API</a></th>
423 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
425 <td align="left" class="footer">
426 Generated by Epydoc 3.0.1
427 on Wed Jan 29 12:26:21 2020
429 <td align="right" class="footer">
430 <a target="mainFrame" href="http://epydoc.sourceforge.net"
431 >http://epydoc.sourceforge.net</a>
436 <script type="text/javascript">
438 // Private objects are initially displayed (because if
439 // javascript is turned off then we want them to be
440 // visible); but by default, we want to hide them. So hide
441 // them unless we have a cookie that says to show them.