Edit File: xml.etree.elementtree.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>19.7. xml.etree.ElementTree — The ElementTree XML API — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="19. Structured Markup Processing Tools" href="markup.html" /> <link rel="next" title="19.8. xml.dom — The Document Object Model API" href="xml.dom.html" /> <link rel="prev" title="19.5. XML Processing Modules" href="xml.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="xml.dom.html" title="19.8. xml.dom — The Document Object Model API" accesskey="N">next</a> |</li> <li class="right" > <a href="xml.html" title="19.5. XML Processing Modules" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="markup.html" accesskey="U">19. Structured Markup Processing Tools</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-xml.etree.ElementTree"> <span id="xml-etree-elementtree-the-elementtree-xml-api"></span><h1>19.7. <a class="reference internal" href="#module-xml.etree.ElementTree" title="xml.etree.ElementTree: Implementation of the ElementTree API."><tt class="xref py py-mod docutils literal"><span class="pre">xml.etree.ElementTree</span></tt></a> — The ElementTree XML API<a class="headerlink" href="#module-xml.etree.ElementTree" title="Permalink to this headline">¶</a></h1> <p class="versionadded"> <span class="versionmodified">New in version 2.5.</span></p> <p><strong>Source code:</strong> <a class="reference external" href="http://hg.python.org/cpython/file/2.7/Lib/xml/etree/ElementTree.py">Lib/xml/etree/ElementTree.py</a></p> <hr class="docutils" /> <p>The <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> type is a flexible container object, designed to store hierarchical data structures in memory. The type can be described as a cross between a list and a dictionary.</p> <div class="admonition warning"> <p class="first admonition-title">Warning</p> <p class="last">The <a class="reference internal" href="#module-xml.etree.ElementTree" title="xml.etree.ElementTree: Implementation of the ElementTree API."><tt class="xref py py-mod docutils literal"><span class="pre">xml.etree.ElementTree</span></tt></a> module is not secure against maliciously constructed data. If you need to parse untrusted or unauthenticated data see <a class="reference internal" href="xml.html#xml-vulnerabilities"><em>XML vulnerabilities</em></a>.</p> </div> <p>Each element has a number of properties associated with it:</p> <ul class="simple"> <li>a tag which is a string identifying what kind of data this element represents (the element type, in other words).</li> <li>a number of attributes, stored in a Python dictionary.</li> <li>a text string.</li> <li>an optional tail string.</li> <li>a number of child elements, stored in a Python sequence</li> </ul> <p>To create an element instance, use the <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> constructor or the <a class="reference internal" href="#xml.etree.ElementTree.SubElement" title="xml.etree.ElementTree.SubElement"><tt class="xref py py-func docutils literal"><span class="pre">SubElement()</span></tt></a> factory function.</p> <p>The <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><tt class="xref py py-class docutils literal"><span class="pre">ElementTree</span></tt></a> class can be used to wrap an element structure, and convert it from and to XML.</p> <p>A C implementation of this API is available as <tt class="xref py py-mod docutils literal"><span class="pre">xml.etree.cElementTree</span></tt>.</p> <p>See <a class="reference external" href="http://effbot.org/zone/element-index.htm">http://effbot.org/zone/element-index.htm</a> for tutorials and links to other docs. Fredrik Lundh’s page is also the location of the development version of the xml.etree.ElementTree.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.7: </span>The ElementTree API is updated to 1.3. For more information, see <a class="reference external" href="http://effbot.org/zone/elementtree-13-intro.htm">Introducing ElementTree 1.3</a>.</p> <div class="section" id="tutorial"> <h2>19.7.1. Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h2> <p>This is a short tutorial for using <a class="reference internal" href="#module-xml.etree.ElementTree" title="xml.etree.ElementTree: Implementation of the ElementTree API."><tt class="xref py py-mod docutils literal"><span class="pre">xml.etree.ElementTree</span></tt></a> (<tt class="docutils literal"><span class="pre">ET</span></tt> in short). The goal is to demonstrate some of the building blocks and basic concepts of the module.</p> <div class="section" id="xml-tree-and-elements"> <h3>19.7.1.1. XML tree and elements<a class="headerlink" href="#xml-tree-and-elements" title="Permalink to this headline">¶</a></h3> <p>XML is an inherently hierarchical data format, and the most natural way to represent it is with a tree. <tt class="docutils literal"><span class="pre">ET</span></tt> has two classes for this purpose - <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><tt class="xref py py-class docutils literal"><span class="pre">ElementTree</span></tt></a> represents the whole XML document as a tree, and <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> represents a single node in this tree. Interactions with the whole document (reading and writing to/from files) are usually done on the <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><tt class="xref py py-class docutils literal"><span class="pre">ElementTree</span></tt></a> level. Interactions with a single XML element and its sub-elements are done on the <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> level.</p> </div> <div class="section" id="parsing-xml"> <span id="elementtree-parsing-xml"></span><h3>19.7.1.2. Parsing XML<a class="headerlink" href="#parsing-xml" title="Permalink to this headline">¶</a></h3> <p>We’ll be using the following XML document as the sample data for this section:</p> <div class="highlight-xml"><div class="highlight"><pre><span class="cp"><?xml version="1.0"?></span> <span class="nt"><data></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Liechtenstein"</span><span class="nt">></span> <span class="nt"><rank></span>1<span class="nt"></rank></span> <span class="nt"><year></span>2008<span class="nt"></year></span> <span class="nt"><gdppc></span>141100<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Austria"</span> <span class="na">direction=</span><span class="s">"E"</span><span class="nt">/></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Switzerland"</span> <span class="na">direction=</span><span class="s">"W"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Singapore"</span><span class="nt">></span> <span class="nt"><rank></span>4<span class="nt"></rank></span> <span class="nt"><year></span>2011<span class="nt"></year></span> <span class="nt"><gdppc></span>59900<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Malaysia"</span> <span class="na">direction=</span><span class="s">"N"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Panama"</span><span class="nt">></span> <span class="nt"><rank></span>68<span class="nt"></rank></span> <span class="nt"><year></span>2011<span class="nt"></year></span> <span class="nt"><gdppc></span>13600<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Costa Rica"</span> <span class="na">direction=</span><span class="s">"W"</span><span class="nt">/></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Colombia"</span> <span class="na">direction=</span><span class="s">"E"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"></data></span> </pre></div> </div> <p>We have a number of ways to import the data. Reading the file from disk:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">xml.etree.ElementTree</span> <span class="kn">as</span> <span class="nn">ET</span> <span class="n">tree</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'country_data.xml'</span><span class="p">)</span> <span class="n">root</span> <span class="o">=</span> <span class="n">tree</span><span class="o">.</span><span class="n">getroot</span><span class="p">()</span> </pre></div> </div> <p>Reading the data from a string:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">root</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">country_data_as_string</span><span class="p">)</span> </pre></div> </div> <p><a class="reference internal" href="#xml.etree.ElementTree.fromstring" title="xml.etree.ElementTree.fromstring"><tt class="xref py py-func docutils literal"><span class="pre">fromstring()</span></tt></a> parses XML from a string directly into an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a>, which is the root element of the parsed tree. Other parsing functions may create an <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><tt class="xref py py-class docutils literal"><span class="pre">ElementTree</span></tt></a>. Check the documentation to be sure.</p> <p>As an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a>, <tt class="docutils literal"><span class="pre">root</span></tt> has a tag and a dictionary of attributes:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">root</span><span class="o">.</span><span class="n">tag</span> <span class="go">'data'</span> <span class="gp">>>> </span><span class="n">root</span><span class="o">.</span><span class="n">attrib</span> <span class="go">{}</span> </pre></div> </div> <p>It also has children nodes over which we can iterate:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="n">child</span> <span class="ow">in</span> <span class="n">root</span><span class="p">:</span> <span class="gp">... </span> <span class="k">print</span> <span class="n">child</span><span class="o">.</span><span class="n">tag</span><span class="p">,</span> <span class="n">child</span><span class="o">.</span><span class="n">attrib</span> <span class="gp">...</span> <span class="go">country {'name': 'Liechtenstein'}</span> <span class="go">country {'name': 'Singapore'}</span> <span class="go">country {'name': 'Panama'}</span> </pre></div> </div> <p>Children are nested, and we can access specific child nodes by index:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">root</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">text</span> <span class="go">'2008'</span> </pre></div> </div> </div> <div class="section" id="finding-interesting-elements"> <h3>19.7.1.3. Finding interesting elements<a class="headerlink" href="#finding-interesting-elements" title="Permalink to this headline">¶</a></h3> <p><a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> has some useful methods that help iterate recursively over all the sub-tree below it (its children, their children, and so on). For example, <a class="reference internal" href="#xml.etree.ElementTree.Element.iter" title="xml.etree.ElementTree.Element.iter"><tt class="xref py py-meth docutils literal"><span class="pre">Element.iter()</span></tt></a>:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="n">neighbor</span> <span class="ow">in</span> <span class="n">root</span><span class="o">.</span><span class="n">iter</span><span class="p">(</span><span class="s">'neighbor'</span><span class="p">):</span> <span class="gp">... </span> <span class="k">print</span> <span class="n">neighbor</span><span class="o">.</span><span class="n">attrib</span> <span class="gp">...</span> <span class="go">{'name': 'Austria', 'direction': 'E'}</span> <span class="go">{'name': 'Switzerland', 'direction': 'W'}</span> <span class="go">{'name': 'Malaysia', 'direction': 'N'}</span> <span class="go">{'name': 'Costa Rica', 'direction': 'W'}</span> <span class="go">{'name': 'Colombia', 'direction': 'E'}</span> </pre></div> </div> <p><a class="reference internal" href="#xml.etree.ElementTree.Element.findall" title="xml.etree.ElementTree.Element.findall"><tt class="xref py py-meth docutils literal"><span class="pre">Element.findall()</span></tt></a> finds only elements with a tag which are direct children of the current element. <a class="reference internal" href="#xml.etree.ElementTree.Element.find" title="xml.etree.ElementTree.Element.find"><tt class="xref py py-meth docutils literal"><span class="pre">Element.find()</span></tt></a> finds the <em>first</em> child with a particular tag, and <a class="reference internal" href="#xml.etree.ElementTree.Element.text" title="xml.etree.ElementTree.Element.text"><tt class="xref py py-meth docutils literal"><span class="pre">Element.text()</span></tt></a> accesses the element’s text content. <a class="reference internal" href="#xml.etree.ElementTree.Element.get" title="xml.etree.ElementTree.Element.get"><tt class="xref py py-meth docutils literal"><span class="pre">Element.get()</span></tt></a> accesses the element’s attributes:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="n">country</span> <span class="ow">in</span> <span class="n">root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">'country'</span><span class="p">):</span> <span class="gp">... </span> <span class="n">rank</span> <span class="o">=</span> <span class="n">country</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">'rank'</span><span class="p">)</span><span class="o">.</span><span class="n">text</span> <span class="gp">... </span> <span class="n">name</span> <span class="o">=</span> <span class="n">country</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'name'</span><span class="p">)</span> <span class="gp">... </span> <span class="k">print</span> <span class="n">name</span><span class="p">,</span> <span class="n">rank</span> <span class="gp">...</span> <span class="go">Liechtenstein 1</span> <span class="go">Singapore 4</span> <span class="go">Panama 68</span> </pre></div> </div> <p>More sophisticated specification of which elements to look for is possible by using <a class="reference internal" href="#elementtree-xpath"><em>XPath</em></a>.</p> </div> <div class="section" id="modifying-an-xml-file"> <h3>19.7.1.4. Modifying an XML File<a class="headerlink" href="#modifying-an-xml-file" title="Permalink to this headline">¶</a></h3> <p><a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><tt class="xref py py-class docutils literal"><span class="pre">ElementTree</span></tt></a> provides a simple way to build XML documents and write them to files. The <a class="reference internal" href="#xml.etree.ElementTree.ElementTree.write" title="xml.etree.ElementTree.ElementTree.write"><tt class="xref py py-meth docutils literal"><span class="pre">ElementTree.write()</span></tt></a> method serves this purpose.</p> <p>Once created, an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> object may be manipulated by directly changing its fields (such as <a class="reference internal" href="#xml.etree.ElementTree.Element.text" title="xml.etree.ElementTree.Element.text"><tt class="xref py py-attr docutils literal"><span class="pre">Element.text</span></tt></a>), adding and modifying attributes (<a class="reference internal" href="#xml.etree.ElementTree.Element.set" title="xml.etree.ElementTree.Element.set"><tt class="xref py py-meth docutils literal"><span class="pre">Element.set()</span></tt></a> method), as well as adding new children (for example with <a class="reference internal" href="#xml.etree.ElementTree.Element.append" title="xml.etree.ElementTree.Element.append"><tt class="xref py py-meth docutils literal"><span class="pre">Element.append()</span></tt></a>).</p> <p>Let’s say we want to add one to each country’s rank, and add an <tt class="docutils literal"><span class="pre">updated</span></tt> attribute to the rank element:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="n">rank</span> <span class="ow">in</span> <span class="n">root</span><span class="o">.</span><span class="n">iter</span><span class="p">(</span><span class="s">'rank'</span><span class="p">):</span> <span class="gp">... </span> <span class="n">new_rank</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">rank</span><span class="o">.</span><span class="n">text</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="gp">... </span> <span class="n">rank</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">new_rank</span><span class="p">)</span> <span class="gp">... </span> <span class="n">rank</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'updated'</span><span class="p">,</span> <span class="s">'yes'</span><span class="p">)</span> <span class="gp">...</span> <span class="gp">>>> </span><span class="n">tree</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'output.xml'</span><span class="p">)</span> </pre></div> </div> <p>Our XML now looks like this:</p> <div class="highlight-xml"><div class="highlight"><pre><span class="cp"><?xml version="1.0"?></span> <span class="nt"><data></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Liechtenstein"</span><span class="nt">></span> <span class="nt"><rank</span> <span class="na">updated=</span><span class="s">"yes"</span><span class="nt">></span>2<span class="nt"></rank></span> <span class="nt"><year></span>2008<span class="nt"></year></span> <span class="nt"><gdppc></span>141100<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Austria"</span> <span class="na">direction=</span><span class="s">"E"</span><span class="nt">/></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Switzerland"</span> <span class="na">direction=</span><span class="s">"W"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Singapore"</span><span class="nt">></span> <span class="nt"><rank</span> <span class="na">updated=</span><span class="s">"yes"</span><span class="nt">></span>5<span class="nt"></rank></span> <span class="nt"><year></span>2011<span class="nt"></year></span> <span class="nt"><gdppc></span>59900<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Malaysia"</span> <span class="na">direction=</span><span class="s">"N"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Panama"</span><span class="nt">></span> <span class="nt"><rank</span> <span class="na">updated=</span><span class="s">"yes"</span><span class="nt">></span>69<span class="nt"></rank></span> <span class="nt"><year></span>2011<span class="nt"></year></span> <span class="nt"><gdppc></span>13600<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Costa Rica"</span> <span class="na">direction=</span><span class="s">"W"</span><span class="nt">/></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Colombia"</span> <span class="na">direction=</span><span class="s">"E"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"></data></span> </pre></div> </div> <p>We can remove elements using <a class="reference internal" href="#xml.etree.ElementTree.Element.remove" title="xml.etree.ElementTree.Element.remove"><tt class="xref py py-meth docutils literal"><span class="pre">Element.remove()</span></tt></a>. Let’s say we want to remove all countries with a rank higher than 50:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="n">country</span> <span class="ow">in</span> <span class="n">root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">'country'</span><span class="p">):</span> <span class="gp">... </span> <span class="n">rank</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">country</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">'rank'</span><span class="p">)</span><span class="o">.</span><span class="n">text</span><span class="p">)</span> <span class="gp">... </span> <span class="k">if</span> <span class="n">rank</span> <span class="o">></span> <span class="mi">50</span><span class="p">:</span> <span class="gp">... </span> <span class="n">root</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">country</span><span class="p">)</span> <span class="gp">...</span> <span class="gp">>>> </span><span class="n">tree</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'output.xml'</span><span class="p">)</span> </pre></div> </div> <p>Our XML now looks like this:</p> <div class="highlight-xml"><div class="highlight"><pre><span class="cp"><?xml version="1.0"?></span> <span class="nt"><data></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Liechtenstein"</span><span class="nt">></span> <span class="nt"><rank</span> <span class="na">updated=</span><span class="s">"yes"</span><span class="nt">></span>2<span class="nt"></rank></span> <span class="nt"><year></span>2008<span class="nt"></year></span> <span class="nt"><gdppc></span>141100<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Austria"</span> <span class="na">direction=</span><span class="s">"E"</span><span class="nt">/></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Switzerland"</span> <span class="na">direction=</span><span class="s">"W"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"><country</span> <span class="na">name=</span><span class="s">"Singapore"</span><span class="nt">></span> <span class="nt"><rank</span> <span class="na">updated=</span><span class="s">"yes"</span><span class="nt">></span>5<span class="nt"></rank></span> <span class="nt"><year></span>2011<span class="nt"></year></span> <span class="nt"><gdppc></span>59900<span class="nt"></gdppc></span> <span class="nt"><neighbor</span> <span class="na">name=</span><span class="s">"Malaysia"</span> <span class="na">direction=</span><span class="s">"N"</span><span class="nt">/></span> <span class="nt"></country></span> <span class="nt"></data></span> </pre></div> </div> </div> <div class="section" id="building-xml-documents"> <h3>19.7.1.5. Building XML documents<a class="headerlink" href="#building-xml-documents" title="Permalink to this headline">¶</a></h3> <p>The <a class="reference internal" href="#xml.etree.ElementTree.SubElement" title="xml.etree.ElementTree.SubElement"><tt class="xref py py-func docutils literal"><span class="pre">SubElement()</span></tt></a> function also provides a convenient way to create new sub-elements for a given element:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">'a'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">b</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="s">'b'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">c</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="s">'c'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="s">'d'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">ET</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">a</span><span class="p">)</span> <span class="go"><a><b /><c><d /></c></a></span> </pre></div> </div> </div> <div class="section" id="additional-resources"> <h3>19.7.1.6. Additional resources<a class="headerlink" href="#additional-resources" title="Permalink to this headline">¶</a></h3> <p>See <a class="reference external" href="http://effbot.org/zone/element-index.htm">http://effbot.org/zone/element-index.htm</a> for tutorials and links to other docs.</p> </div> </div> <div class="section" id="xpath-support"> <span id="elementtree-xpath"></span><h2>19.7.2. XPath support<a class="headerlink" href="#xpath-support" title="Permalink to this headline">¶</a></h2> <p>This module provides limited support for <a class="reference external" href="http://www.w3.org/TR/xpath">XPath expressions</a> for locating elements in a tree. The goal is to support a small subset of the abbreviated syntax; a full XPath engine is outside the scope of the module.</p> <div class="section" id="example"> <h3>19.7.2.1. Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3> <p>Here’s an example that demonstrates some of the XPath capabilities of the module. We’ll be using the <tt class="docutils literal"><span class="pre">countrydata</span></tt> XML document from the <a class="reference internal" href="#elementtree-parsing-xml"><em>Parsing XML</em></a> section:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">xml.etree.ElementTree</span> <span class="kn">as</span> <span class="nn">ET</span> <span class="n">root</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">countrydata</span><span class="p">)</span> <span class="c"># Top-level elements</span> <span class="n">root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">"."</span><span class="p">)</span> <span class="c"># All 'neighbor' grand-children of 'country' children of the top-level</span> <span class="c"># elements</span> <span class="n">root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">"./country/neighbor"</span><span class="p">)</span> <span class="c"># Nodes with name='Singapore' that have a 'year' child</span> <span class="n">root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">".//year/..[@name='Singapore']"</span><span class="p">)</span> <span class="c"># 'year' nodes that are children of nodes with name='Singapore'</span> <span class="n">root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">".//*[@name='Singapore']/year"</span><span class="p">)</span> <span class="c"># All 'neighbor' nodes that are the second child of their parent</span> <span class="n">root</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">".//neighbor[2]"</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="supported-xpath-syntax"> <h3>19.7.2.2. Supported XPath syntax<a class="headerlink" href="#supported-xpath-syntax" title="Permalink to this headline">¶</a></h3> <table border="1" class="docutils"> <colgroup> <col width="30%" /> <col width="70%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Syntax</th> <th class="head">Meaning</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><tt class="docutils literal"><span class="pre">tag</span></tt></td> <td>Selects all child elements with the given tag. For example, <tt class="docutils literal"><span class="pre">spam</span></tt> selects all child elements named <tt class="docutils literal"><span class="pre">spam</span></tt>, <tt class="docutils literal"><span class="pre">spam/egg</span></tt> selects all grandchildren named <tt class="docutils literal"><span class="pre">egg</span></tt> in all children named <tt class="docutils literal"><span class="pre">spam</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="docutils literal"><span class="pre">*</span></tt></td> <td>Selects all child elements. For example, <tt class="docutils literal"><span class="pre">*/egg</span></tt> selects all grandchildren named <tt class="docutils literal"><span class="pre">egg</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="docutils literal"><span class="pre">.</span></tt></td> <td>Selects the current node. This is mostly useful at the beginning of the path, to indicate that it’s a relative path.</td> </tr> <tr class="row-odd"><td><tt class="docutils literal"><span class="pre">//</span></tt></td> <td>Selects all subelements, on all levels beneath the current element. For example, <tt class="docutils literal"><span class="pre">.//egg</span></tt> selects all <tt class="docutils literal"><span class="pre">egg</span></tt> elements in the entire tree.</td> </tr> <tr class="row-even"><td><tt class="docutils literal"><span class="pre">..</span></tt></td> <td>Selects the parent element.</td> </tr> <tr class="row-odd"><td><tt class="docutils literal"><span class="pre">[@attrib]</span></tt></td> <td>Selects all elements that have the given attribute.</td> </tr> <tr class="row-even"><td><tt class="docutils literal"><span class="pre">[@attrib='value']</span></tt></td> <td>Selects all elements for which the given attribute has the given value. The value cannot contain quotes.</td> </tr> <tr class="row-odd"><td><tt class="docutils literal"><span class="pre">[tag]</span></tt></td> <td>Selects all elements that have a child named <tt class="docutils literal"><span class="pre">tag</span></tt>. Only immediate children are supported.</td> </tr> <tr class="row-even"><td><tt class="docutils literal"><span class="pre">[position]</span></tt></td> <td>Selects all elements that are located at the given position. The position can be either an integer (1 is the first position), the expression <tt class="docutils literal"><span class="pre">last()</span></tt> (for the last position), or a position relative to the last position (e.g. <tt class="docutils literal"><span class="pre">last()-1</span></tt>).</td> </tr> </tbody> </table> <p>Predicates (expressions within square brackets) must be preceded by a tag name, an asterisk, or another predicate. <tt class="docutils literal"><span class="pre">position</span></tt> predicates must be preceded by a tag name.</p> </div> </div> <div class="section" id="reference"> <h2>19.7.3. Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2> <div class="section" id="functions"> <span id="elementtree-functions"></span><h3>19.7.3.1. Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> <dl class="function"> <dt id="xml.etree.ElementTree.Comment"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">Comment</tt><big>(</big><em>text=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Comment" title="Permalink to this definition">¶</a></dt> <dd><p>Comment element factory. This factory function creates a special element that will be serialized as an XML comment by the standard serializer. The comment string can be either a bytestring or a Unicode string. <em>text</em> is a string containing the comment string. Returns an element instance representing a comment.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.dump"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">dump</tt><big>(</big><em>elem</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.dump" title="Permalink to this definition">¶</a></dt> <dd><p>Writes an element tree or element structure to sys.stdout. This function should be used for debugging only.</p> <p>The exact output format is implementation dependent. In this version, it’s written as an ordinary XML file.</p> <p><em>elem</em> is an element tree or an individual element.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.fromstring"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">fromstring</tt><big>(</big><em>text</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.fromstring" title="Permalink to this definition">¶</a></dt> <dd><p>Parses an XML section from a string constant. Same as <a class="reference internal" href="#xml.etree.ElementTree.XML" title="xml.etree.ElementTree.XML"><tt class="xref py py-func docutils literal"><span class="pre">XML()</span></tt></a>. <em>text</em> is a string containing XML data. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instance.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.fromstringlist"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">fromstringlist</tt><big>(</big><em>sequence</em>, <em>parser=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.fromstringlist" title="Permalink to this definition">¶</a></dt> <dd><p>Parses an XML document from a sequence of string fragments. <em>sequence</em> is a list or other sequence containing XML data fragments. <em>parser</em> is an optional parser instance. If not given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><tt class="xref py py-class docutils literal"><span class="pre">XMLParser</span></tt></a> parser is used. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instance.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.iselement"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">iselement</tt><big>(</big><em>element</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.iselement" title="Permalink to this definition">¶</a></dt> <dd><p>Checks if an object appears to be a valid element object. <em>element</em> is an element instance. Returns a true value if this is an element object.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.iterparse"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">iterparse</tt><big>(</big><em>source</em>, <em>events=None</em>, <em>parser=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.iterparse" title="Permalink to this definition">¶</a></dt> <dd><p>Parses an XML section into an element tree incrementally, and reports what’s going on to the user. <em>source</em> is a filename or file object containing XML data. <em>events</em> is a list of events to report back. If omitted, only “end” events are reported. <em>parser</em> is an optional parser instance. If not given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><tt class="xref py py-class docutils literal"><span class="pre">XMLParser</span></tt></a> parser is used. <em>parser</em> is not supported by <tt class="docutils literal"><span class="pre">cElementTree</span></tt>. Returns an <a class="reference internal" href="../glossary.html#term-iterator"><em class="xref std std-term">iterator</em></a> providing <tt class="docutils literal"><span class="pre">(event,</span> <span class="pre">elem)</span></tt> pairs.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p><a class="reference internal" href="#xml.etree.ElementTree.iterparse" title="xml.etree.ElementTree.iterparse"><tt class="xref py py-func docutils literal"><span class="pre">iterparse()</span></tt></a> only guarantees that it has seen the “>” character of a starting tag when it emits a “start” event, so the attributes are defined, but the contents of the text and tail attributes are undefined at that point. The same applies to the element children; they may or may not be present.</p> <p class="last">If you need a fully populated element, look for “end” events instead.</p> </div> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.parse"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">parse</tt><big>(</big><em>source</em>, <em>parser=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.parse" title="Permalink to this definition">¶</a></dt> <dd><p>Parses an XML section into an element tree. <em>source</em> is a filename or file object containing XML data. <em>parser</em> is an optional parser instance. If not given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><tt class="xref py py-class docutils literal"><span class="pre">XMLParser</span></tt></a> parser is used. Returns an <a class="reference internal" href="#xml.etree.ElementTree.ElementTree" title="xml.etree.ElementTree.ElementTree"><tt class="xref py py-class docutils literal"><span class="pre">ElementTree</span></tt></a> instance.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.ProcessingInstruction"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">ProcessingInstruction</tt><big>(</big><em>target</em>, <em>text=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ProcessingInstruction" title="Permalink to this definition">¶</a></dt> <dd><p>PI element factory. This factory function creates a special element that will be serialized as an XML processing instruction. <em>target</em> is a string containing the PI target. <em>text</em> is a string containing the PI contents, if given. Returns an element instance, representing a processing instruction.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.register_namespace"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">register_namespace</tt><big>(</big><em>prefix</em>, <em>uri</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.register_namespace" title="Permalink to this definition">¶</a></dt> <dd><p>Registers a namespace prefix. The registry is global, and any existing mapping for either the given prefix or the namespace URI will be removed. <em>prefix</em> is a namespace prefix. <em>uri</em> is a namespace uri. Tags and attributes in this namespace will be serialized with the given prefix, if at all possible.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.SubElement"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">SubElement</tt><big>(</big><em>parent</em>, <em>tag</em>, <em>attrib={}</em>, <em>**extra</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.SubElement" title="Permalink to this definition">¶</a></dt> <dd><p>Subelement factory. This function creates an element instance, and appends it to an existing element.</p> <p>The element name, attribute names, and attribute values can be either bytestrings or Unicode strings. <em>parent</em> is the parent element. <em>tag</em> is the subelement name. <em>attrib</em> is an optional dictionary, containing element attributes. <em>extra</em> contains additional attributes, given as keyword arguments. Returns an element instance.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.tostring"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">tostring</tt><big>(</big><em>element</em>, <em>encoding="us-ascii"</em>, <em>method="xml"</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.tostring" title="Permalink to this definition">¶</a></dt> <dd><p>Generates a string representation of an XML element, including all subelements. <em>element</em> is an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instance. <em>encoding</em> <a class="footnote-reference" href="#id5" id="id1">[1]</a> is the output encoding (default is US-ASCII). <em>method</em> is either <tt class="docutils literal"><span class="pre">"xml"</span></tt>, <tt class="docutils literal"><span class="pre">"html"</span></tt> or <tt class="docutils literal"><span class="pre">"text"</span></tt> (default is <tt class="docutils literal"><span class="pre">"xml"</span></tt>). Returns an encoded string containing the XML data.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.tostringlist"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">tostringlist</tt><big>(</big><em>element</em>, <em>encoding="us-ascii"</em>, <em>method="xml"</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.tostringlist" title="Permalink to this definition">¶</a></dt> <dd><p>Generates a string representation of an XML element, including all subelements. <em>element</em> is an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instance. <em>encoding</em> <a class="footnote-reference" href="#id5" id="id2">[1]</a> is the output encoding (default is US-ASCII). <em>method</em> is either <tt class="docutils literal"><span class="pre">"xml"</span></tt>, <tt class="docutils literal"><span class="pre">"html"</span></tt> or <tt class="docutils literal"><span class="pre">"text"</span></tt> (default is <tt class="docutils literal"><span class="pre">"xml"</span></tt>). Returns a list of encoded strings containing the XML data. It does not guarantee any specific sequence, except that <tt class="docutils literal"><span class="pre">"".join(tostringlist(element))</span> <span class="pre">==</span> <span class="pre">tostring(element)</span></tt>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.XML"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">XML</tt><big>(</big><em>text</em>, <em>parser=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.XML" title="Permalink to this definition">¶</a></dt> <dd><p>Parses an XML section from a string constant. This function can be used to embed “XML literals” in Python code. <em>text</em> is a string containing XML data. <em>parser</em> is an optional parser instance. If not given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><tt class="xref py py-class docutils literal"><span class="pre">XMLParser</span></tt></a> parser is used. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instance.</p> </dd></dl> <dl class="function"> <dt id="xml.etree.ElementTree.XMLID"> <tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">XMLID</tt><big>(</big><em>text</em>, <em>parser=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.XMLID" title="Permalink to this definition">¶</a></dt> <dd><p>Parses an XML section from a string constant, and also returns a dictionary which maps from element id:s to elements. <em>text</em> is a string containing XML data. <em>parser</em> is an optional parser instance. If not given, the standard <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><tt class="xref py py-class docutils literal"><span class="pre">XMLParser</span></tt></a> parser is used. Returns a tuple containing an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instance and a dictionary.</p> </dd></dl> </div> <div class="section" id="element-objects"> <span id="elementtree-element-objects"></span><h3>19.7.3.2. Element Objects<a class="headerlink" href="#element-objects" title="Permalink to this headline">¶</a></h3> <dl class="class"> <dt id="xml.etree.ElementTree.Element"> <em class="property">class </em><tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">Element</tt><big>(</big><em>tag</em>, <em>attrib={}</em>, <em>**extra</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element" title="Permalink to this definition">¶</a></dt> <dd><p>Element class. This class defines the Element interface, and provides a reference implementation of this interface.</p> <p>The element name, attribute names, and attribute values can be either bytestrings or Unicode strings. <em>tag</em> is the element name. <em>attrib</em> is an optional dictionary, containing element attributes. <em>extra</em> contains additional attributes, given as keyword arguments.</p> <dl class="attribute"> <dt id="xml.etree.ElementTree.Element.tag"> <tt class="descname">tag</tt><a class="headerlink" href="#xml.etree.ElementTree.Element.tag" title="Permalink to this definition">¶</a></dt> <dd><p>A string identifying what kind of data this element represents (the element type, in other words).</p> </dd></dl> <dl class="attribute"> <dt id="xml.etree.ElementTree.Element.text"> <tt class="descname">text</tt><a class="headerlink" href="#xml.etree.ElementTree.Element.text" title="Permalink to this definition">¶</a></dt> <dd><p>The <em>text</em> attribute can be used to hold additional data associated with the element. As the name implies this attribute is usually a string but may be any application-specific object. If the element is created from an XML file the attribute will contain any text found between the element tags.</p> </dd></dl> <dl class="attribute"> <dt id="xml.etree.ElementTree.Element.tail"> <tt class="descname">tail</tt><a class="headerlink" href="#xml.etree.ElementTree.Element.tail" title="Permalink to this definition">¶</a></dt> <dd><p>The <em>tail</em> attribute can be used to hold additional data associated with the element. This attribute is usually a string but may be any application-specific object. If the element is created from an XML file the attribute will contain any text found after the element’s end tag and before the next tag.</p> </dd></dl> <dl class="attribute"> <dt id="xml.etree.ElementTree.Element.attrib"> <tt class="descname">attrib</tt><a class="headerlink" href="#xml.etree.ElementTree.Element.attrib" title="Permalink to this definition">¶</a></dt> <dd><p>A dictionary containing the element’s attributes. Note that while the <em>attrib</em> value is always a real mutable Python dictionary, an ElementTree implementation may choose to use another internal representation, and create the dictionary only if someone asks for it. To take advantage of such implementations, use the dictionary methods below whenever possible.</p> </dd></dl> <p>The following dictionary-like methods work on the element attributes.</p> <dl class="method"> <dt id="xml.etree.ElementTree.Element.clear"> <tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.clear" title="Permalink to this definition">¶</a></dt> <dd><p>Resets an element. This function removes all subelements, clears all attributes, and sets the text and tail attributes to None.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.get"> <tt class="descname">get</tt><big>(</big><em>key</em>, <em>default=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.get" title="Permalink to this definition">¶</a></dt> <dd><p>Gets the element attribute named <em>key</em>.</p> <p>Returns the attribute value, or <em>default</em> if the attribute was not found.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.items"> <tt class="descname">items</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.items" title="Permalink to this definition">¶</a></dt> <dd><p>Returns the element attributes as a sequence of (name, value) pairs. The attributes are returned in an arbitrary order.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.keys"> <tt class="descname">keys</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.keys" title="Permalink to this definition">¶</a></dt> <dd><p>Returns the elements attribute names as a list. The names are returned in an arbitrary order.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.set"> <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.set" title="Permalink to this definition">¶</a></dt> <dd><p>Set the attribute <em>key</em> on the element to <em>value</em>.</p> </dd></dl> <p>The following methods work on the element’s children (subelements).</p> <dl class="method"> <dt id="xml.etree.ElementTree.Element.append"> <tt class="descname">append</tt><big>(</big><em>subelement</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.append" title="Permalink to this definition">¶</a></dt> <dd><p>Adds the element <em>subelement</em> to the end of this elements internal list of subelements.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.extend"> <tt class="descname">extend</tt><big>(</big><em>subelements</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.extend" title="Permalink to this definition">¶</a></dt> <dd><p>Appends <em>subelements</em> from a sequence object with zero or more elements. Raises <a class="reference internal" href="exceptions.html#exceptions.AssertionError" title="exceptions.AssertionError"><tt class="xref py py-exc docutils literal"><span class="pre">AssertionError</span></tt></a> if a subelement is not a valid object.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.find"> <tt class="descname">find</tt><big>(</big><em>match</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.find" title="Permalink to this definition">¶</a></dt> <dd><p>Finds the first subelement matching <em>match</em>. <em>match</em> may be a tag name or path. Returns an element instance or <tt class="docutils literal"><span class="pre">None</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.findall"> <tt class="descname">findall</tt><big>(</big><em>match</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.findall" title="Permalink to this definition">¶</a></dt> <dd><p>Finds all matching subelements, by tag name or path. Returns a list containing all matching elements in document order.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.findtext"> <tt class="descname">findtext</tt><big>(</big><em>match</em>, <em>default=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.findtext" title="Permalink to this definition">¶</a></dt> <dd><p>Finds text for the first subelement matching <em>match</em>. <em>match</em> may be a tag name or path. Returns the text content of the first matching element, or <em>default</em> if no element was found. Note that if the matching element has no text content an empty string is returned.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.getchildren"> <tt class="descname">getchildren</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.getchildren" title="Permalink to this definition">¶</a></dt> <dd><p class="deprecated"> <span class="versionmodified">Deprecated since version 2.7: </span>Use <tt class="docutils literal"><span class="pre">list(elem)</span></tt> or iteration.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.getiterator"> <tt class="descname">getiterator</tt><big>(</big><em>tag=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.getiterator" title="Permalink to this definition">¶</a></dt> <dd><p class="deprecated"> <span class="versionmodified">Deprecated since version 2.7: </span>Use method <a class="reference internal" href="#xml.etree.ElementTree.Element.iter" title="xml.etree.ElementTree.Element.iter"><tt class="xref py py-meth docutils literal"><span class="pre">Element.iter()</span></tt></a> instead.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.insert"> <tt class="descname">insert</tt><big>(</big><em>index</em>, <em>element</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.insert" title="Permalink to this definition">¶</a></dt> <dd><p>Inserts a subelement at the given position in this element.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.iter"> <tt class="descname">iter</tt><big>(</big><em>tag=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.iter" title="Permalink to this definition">¶</a></dt> <dd><p>Creates a tree <a class="reference internal" href="../glossary.html#term-iterator"><em class="xref std std-term">iterator</em></a> with the current element as the root. The iterator iterates over this element and all elements below it, in document (depth first) order. If <em>tag</em> is not <tt class="docutils literal"><span class="pre">None</span></tt> or <tt class="docutils literal"><span class="pre">'*'</span></tt>, only elements whose tag equals <em>tag</em> are returned from the iterator. If the tree structure is modified during iteration, the result is undefined.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.iterfind"> <tt class="descname">iterfind</tt><big>(</big><em>match</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.iterfind" title="Permalink to this definition">¶</a></dt> <dd><p>Finds all matching subelements, by tag name or path. Returns an iterable yielding all matching elements in document order.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.itertext"> <tt class="descname">itertext</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.itertext" title="Permalink to this definition">¶</a></dt> <dd><p>Creates a text iterator. The iterator loops over this element and all subelements, in document order, and returns all inner text.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.makeelement"> <tt class="descname">makeelement</tt><big>(</big><em>tag</em>, <em>attrib</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.makeelement" title="Permalink to this definition">¶</a></dt> <dd><p>Creates a new element object of the same type as this element. Do not call this method, use the <a class="reference internal" href="#xml.etree.ElementTree.SubElement" title="xml.etree.ElementTree.SubElement"><tt class="xref py py-func docutils literal"><span class="pre">SubElement()</span></tt></a> factory function instead.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.Element.remove"> <tt class="descname">remove</tt><big>(</big><em>subelement</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.Element.remove" title="Permalink to this definition">¶</a></dt> <dd><p>Removes <em>subelement</em> from the element. Unlike the find* methods this method compares elements based on the instance identity, not on tag value or contents.</p> </dd></dl> <p><a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> objects also support the following sequence type methods for working with subelements: <a class="reference internal" href="../reference/datamodel.html#object.__delitem__" title="object.__delitem__"><tt class="xref py py-meth docutils literal"><span class="pre">__delitem__()</span></tt></a>, <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><tt class="xref py py-meth docutils literal"><span class="pre">__getitem__()</span></tt></a>, <a class="reference internal" href="../reference/datamodel.html#object.__setitem__" title="object.__setitem__"><tt class="xref py py-meth docutils literal"><span class="pre">__setitem__()</span></tt></a>, <a class="reference internal" href="../reference/datamodel.html#object.__len__" title="object.__len__"><tt class="xref py py-meth docutils literal"><span class="pre">__len__()</span></tt></a>.</p> <p>Caution: Elements with no subelements will test as <tt class="docutils literal"><span class="pre">False</span></tt>. This behavior will change in future versions. Use specific <tt class="docutils literal"><span class="pre">len(elem)</span></tt> or <tt class="docutils literal"><span class="pre">elem</span> <span class="pre">is</span> <span class="pre">None</span></tt> test instead.</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">element</span> <span class="o">=</span> <span class="n">root</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">'foo'</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">element</span><span class="p">:</span> <span class="c"># careful!</span> <span class="k">print</span> <span class="s">"element not found, or element has no subelements"</span> <span class="k">if</span> <span class="n">element</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span> <span class="k">print</span> <span class="s">"element not found"</span> </pre></div> </div> </dd></dl> </div> <div class="section" id="elementtree-objects"> <span id="elementtree-elementtree-objects"></span><h3>19.7.3.3. ElementTree Objects<a class="headerlink" href="#elementtree-objects" title="Permalink to this headline">¶</a></h3> <dl class="class"> <dt id="xml.etree.ElementTree.ElementTree"> <em class="property">class </em><tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">ElementTree</tt><big>(</big><em>element=None</em>, <em>file=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree" title="Permalink to this definition">¶</a></dt> <dd><p>ElementTree wrapper class. This class represents an entire element hierarchy, and adds some extra support for serialization to and from standard XML.</p> <p><em>element</em> is the root element. The tree is initialized with the contents of the XML <em>file</em> if given.</p> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree._setroot"> <tt class="descname">_setroot</tt><big>(</big><em>element</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree._setroot" title="Permalink to this definition">¶</a></dt> <dd><p>Replaces the root element for this tree. This discards the current contents of the tree, and replaces it with the given element. Use with care. <em>element</em> is an element instance.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.find"> <tt class="descname">find</tt><big>(</big><em>match</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.find" title="Permalink to this definition">¶</a></dt> <dd><p>Same as <a class="reference internal" href="#xml.etree.ElementTree.Element.find" title="xml.etree.ElementTree.Element.find"><tt class="xref py py-meth docutils literal"><span class="pre">Element.find()</span></tt></a>, starting at the root of the tree.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.findall"> <tt class="descname">findall</tt><big>(</big><em>match</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.findall" title="Permalink to this definition">¶</a></dt> <dd><p>Same as <a class="reference internal" href="#xml.etree.ElementTree.Element.findall" title="xml.etree.ElementTree.Element.findall"><tt class="xref py py-meth docutils literal"><span class="pre">Element.findall()</span></tt></a>, starting at the root of the tree.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.findtext"> <tt class="descname">findtext</tt><big>(</big><em>match</em>, <em>default=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.findtext" title="Permalink to this definition">¶</a></dt> <dd><p>Same as <a class="reference internal" href="#xml.etree.ElementTree.Element.findtext" title="xml.etree.ElementTree.Element.findtext"><tt class="xref py py-meth docutils literal"><span class="pre">Element.findtext()</span></tt></a>, starting at the root of the tree.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.getiterator"> <tt class="descname">getiterator</tt><big>(</big><em>tag=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.getiterator" title="Permalink to this definition">¶</a></dt> <dd><p class="deprecated"> <span class="versionmodified">Deprecated since version 2.7: </span>Use method <a class="reference internal" href="#xml.etree.ElementTree.ElementTree.iter" title="xml.etree.ElementTree.ElementTree.iter"><tt class="xref py py-meth docutils literal"><span class="pre">ElementTree.iter()</span></tt></a> instead.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.getroot"> <tt class="descname">getroot</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.getroot" title="Permalink to this definition">¶</a></dt> <dd><p>Returns the root element for this tree.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.iter"> <tt class="descname">iter</tt><big>(</big><em>tag=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.iter" title="Permalink to this definition">¶</a></dt> <dd><p>Creates and returns a tree iterator for the root element. The iterator loops over all elements in this tree, in section order. <em>tag</em> is the tag to look for (default is to return all elements)</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.iterfind"> <tt class="descname">iterfind</tt><big>(</big><em>match</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.iterfind" title="Permalink to this definition">¶</a></dt> <dd><p>Finds all matching subelements, by tag name or path. Same as getroot().iterfind(match). Returns an iterable yielding all matching elements in document order.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.parse"> <tt class="descname">parse</tt><big>(</big><em>source</em>, <em>parser=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.parse" title="Permalink to this definition">¶</a></dt> <dd><p>Loads an external XML section into this element tree. <em>source</em> is a file name or file object. <em>parser</em> is an optional parser instance. If not given, the standard XMLParser parser is used. Returns the section root element.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.ElementTree.write"> <tt class="descname">write</tt><big>(</big><em>file</em>, <em>encoding="us-ascii"</em>, <em>xml_declaration=None</em>, <em>default_namespace=None</em>, <em>method="xml"</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.ElementTree.write" title="Permalink to this definition">¶</a></dt> <dd><p>Writes the element tree to a file, as XML. <em>file</em> is a file name, or a file object opened for writing. <em>encoding</em> <a class="footnote-reference" href="#id5" id="id3">[1]</a> is the output encoding (default is US-ASCII). <em>xml_declaration</em> controls if an XML declaration should be added to the file. Use False for never, True for always, None for only if not US-ASCII or UTF-8 (default is None). <em>default_namespace</em> sets the default XML namespace (for “xmlns”). <em>method</em> is either <tt class="docutils literal"><span class="pre">"xml"</span></tt>, <tt class="docutils literal"><span class="pre">"html"</span></tt> or <tt class="docutils literal"><span class="pre">"text"</span></tt> (default is <tt class="docutils literal"><span class="pre">"xml"</span></tt>). Returns an encoded string.</p> </dd></dl> </dd></dl> <p>This is the XML file that is going to be manipulated:</p> <div class="highlight-python"><pre><html> <head> <title>Example page</title> </head> <body> <p>Moved to <a href="http://example.org/">example.org</a> or <a href="http://example.com/">example.com</a>.</p> </body> </html></pre> </div> <p>Example of changing the attribute “target” of every link in first paragraph:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">xml.etree.ElementTree</span> <span class="kn">import</span> <span class="n">ElementTree</span> <span class="gp">>>> </span><span class="n">tree</span> <span class="o">=</span> <span class="n">ElementTree</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">tree</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">"index.xhtml"</span><span class="p">)</span> <span class="go"><Element 'html' at 0xb77e6fac></span> <span class="gp">>>> </span><span class="n">p</span> <span class="o">=</span> <span class="n">tree</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"body/p"</span><span class="p">)</span> <span class="c"># Finds first occurrence of tag p in body</span> <span class="gp">>>> </span><span class="n">p</span> <span class="go"><Element 'p' at 0xb77ec26c></span> <span class="gp">>>> </span><span class="n">links</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">iter</span><span class="p">(</span><span class="s">"a"</span><span class="p">))</span> <span class="c"># Returns list of all links</span> <span class="gp">>>> </span><span class="n">links</span> <span class="go">[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]</span> <span class="gp">>>> </span><span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">links</span><span class="p">:</span> <span class="c"># Iterates through all found links</span> <span class="gp">... </span> <span class="n">i</span><span class="o">.</span><span class="n">attrib</span><span class="p">[</span><span class="s">"target"</span><span class="p">]</span> <span class="o">=</span> <span class="s">"blank"</span> <span class="gp">>>> </span><span class="n">tree</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"output.xhtml"</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="qname-objects"> <span id="elementtree-qname-objects"></span><h3>19.7.3.4. QName Objects<a class="headerlink" href="#qname-objects" title="Permalink to this headline">¶</a></h3> <dl class="class"> <dt id="xml.etree.ElementTree.QName"> <em class="property">class </em><tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">QName</tt><big>(</big><em>text_or_uri</em>, <em>tag=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.QName" title="Permalink to this definition">¶</a></dt> <dd><p>QName wrapper. This can be used to wrap a QName attribute value, in order to get proper namespace handling on output. <em>text_or_uri</em> is a string containing the QName value, in the form {uri}local, or, if the tag argument is given, the URI part of a QName. If <em>tag</em> is given, the first argument is interpreted as an URI, and this argument is interpreted as a local name. <a class="reference internal" href="#xml.etree.ElementTree.QName" title="xml.etree.ElementTree.QName"><tt class="xref py py-class docutils literal"><span class="pre">QName</span></tt></a> instances are opaque.</p> </dd></dl> </div> <div class="section" id="treebuilder-objects"> <span id="elementtree-treebuilder-objects"></span><h3>19.7.3.5. TreeBuilder Objects<a class="headerlink" href="#treebuilder-objects" title="Permalink to this headline">¶</a></h3> <dl class="class"> <dt id="xml.etree.ElementTree.TreeBuilder"> <em class="property">class </em><tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">TreeBuilder</tt><big>(</big><em>element_factory=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder" title="Permalink to this definition">¶</a></dt> <dd><p>Generic element structure builder. This builder converts a sequence of start, data, and end method calls to a well-formed element structure. You can use this class to build an element structure using a custom XML parser, or a parser for some other XML-like format. The <em>element_factory</em> is called to create new <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instances when given.</p> <dl class="method"> <dt id="xml.etree.ElementTree.TreeBuilder.close"> <tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.close" title="Permalink to this definition">¶</a></dt> <dd><p>Flushes the builder buffers, and returns the toplevel document element. Returns an <a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> instance.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.TreeBuilder.data"> <tt class="descname">data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.data" title="Permalink to this definition">¶</a></dt> <dd><p>Adds text to the current element. <em>data</em> is a string. This should be either a bytestring, or a Unicode string.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.TreeBuilder.end"> <tt class="descname">end</tt><big>(</big><em>tag</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.end" title="Permalink to this definition">¶</a></dt> <dd><p>Closes the current element. <em>tag</em> is the element name. Returns the closed element.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.TreeBuilder.start"> <tt class="descname">start</tt><big>(</big><em>tag</em>, <em>attrs</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.start" title="Permalink to this definition">¶</a></dt> <dd><p>Opens a new element. <em>tag</em> is the element name. <em>attrs</em> is a dictionary containing element attributes. Returns the opened element.</p> </dd></dl> <p>In addition, a custom <a class="reference internal" href="#xml.etree.ElementTree.TreeBuilder" title="xml.etree.ElementTree.TreeBuilder"><tt class="xref py py-class docutils literal"><span class="pre">TreeBuilder</span></tt></a> object can provide the following method:</p> <dl class="method"> <dt id="xml.etree.ElementTree.TreeBuilder.doctype"> <tt class="descname">doctype</tt><big>(</big><em>name</em>, <em>pubid</em>, <em>system</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.TreeBuilder.doctype" title="Permalink to this definition">¶</a></dt> <dd><p>Handles a doctype declaration. <em>name</em> is the doctype name. <em>pubid</em> is the public identifier. <em>system</em> is the system identifier. This method does not exist on the default <a class="reference internal" href="#xml.etree.ElementTree.TreeBuilder" title="xml.etree.ElementTree.TreeBuilder"><tt class="xref py py-class docutils literal"><span class="pre">TreeBuilder</span></tt></a> class.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.7.</span></p> </dd></dl> </dd></dl> </div> <div class="section" id="xmlparser-objects"> <span id="elementtree-xmlparser-objects"></span><h3>19.7.3.6. XMLParser Objects<a class="headerlink" href="#xmlparser-objects" title="Permalink to this headline">¶</a></h3> <dl class="class"> <dt id="xml.etree.ElementTree.XMLParser"> <em class="property">class </em><tt class="descclassname">xml.etree.ElementTree.</tt><tt class="descname">XMLParser</tt><big>(</big><em>html=0</em>, <em>target=None</em>, <em>encoding=None</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.XMLParser" title="Permalink to this definition">¶</a></dt> <dd><p><a class="reference internal" href="#xml.etree.ElementTree.Element" title="xml.etree.ElementTree.Element"><tt class="xref py py-class docutils literal"><span class="pre">Element</span></tt></a> structure builder for XML source data, based on the expat parser. <em>html</em> are predefined HTML entities. This flag is not supported by the current implementation. <em>target</em> is the target object. If omitted, the builder uses an instance of the standard TreeBuilder class. <em>encoding</em> <a class="footnote-reference" href="#id5" id="id4">[1]</a> is optional. If given, the value overrides the encoding specified in the XML file.</p> <dl class="method"> <dt id="xml.etree.ElementTree.XMLParser.close"> <tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.XMLParser.close" title="Permalink to this definition">¶</a></dt> <dd><p>Finishes feeding data to the parser. Returns an element structure.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.XMLParser.doctype"> <tt class="descname">doctype</tt><big>(</big><em>name</em>, <em>pubid</em>, <em>system</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.XMLParser.doctype" title="Permalink to this definition">¶</a></dt> <dd><p class="deprecated"> <span class="versionmodified">Deprecated since version 2.7: </span>Define the <a class="reference internal" href="#xml.etree.ElementTree.TreeBuilder.doctype" title="xml.etree.ElementTree.TreeBuilder.doctype"><tt class="xref py py-meth docutils literal"><span class="pre">TreeBuilder.doctype()</span></tt></a> method on a custom TreeBuilder target.</p> </dd></dl> <dl class="method"> <dt id="xml.etree.ElementTree.XMLParser.feed"> <tt class="descname">feed</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#xml.etree.ElementTree.XMLParser.feed" title="Permalink to this definition">¶</a></dt> <dd><p>Feeds data to the parser. <em>data</em> is encoded data.</p> </dd></dl> </dd></dl> <p><a class="reference internal" href="#xml.etree.ElementTree.XMLParser.feed" title="xml.etree.ElementTree.XMLParser.feed"><tt class="xref py py-meth docutils literal"><span class="pre">XMLParser.feed()</span></tt></a> calls <em>target</em>‘s <tt class="xref py py-meth docutils literal"><span class="pre">start()</span></tt> method for each opening tag, its <tt class="xref py py-meth docutils literal"><span class="pre">end()</span></tt> method for each closing tag, and data is processed by method <tt class="xref py py-meth docutils literal"><span class="pre">data()</span></tt>. <a class="reference internal" href="#xml.etree.ElementTree.XMLParser.close" title="xml.etree.ElementTree.XMLParser.close"><tt class="xref py py-meth docutils literal"><span class="pre">XMLParser.close()</span></tt></a> calls <em>target</em>‘s method <tt class="xref py py-meth docutils literal"><span class="pre">close()</span></tt>. <a class="reference internal" href="#xml.etree.ElementTree.XMLParser" title="xml.etree.ElementTree.XMLParser"><tt class="xref py py-class docutils literal"><span class="pre">XMLParser</span></tt></a> can be used not only for building a tree structure. This is an example of counting the maximum depth of an XML file:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">xml.etree.ElementTree</span> <span class="kn">import</span> <span class="n">XMLParser</span> <span class="gp">>>> </span><span class="k">class</span> <span class="nc">MaxDepth</span><span class="p">:</span> <span class="c"># The target object of the parser</span> <span class="gp">... </span> <span class="n">maxDepth</span> <span class="o">=</span> <span class="mi">0</span> <span class="gp">... </span> <span class="n">depth</span> <span class="o">=</span> <span class="mi">0</span> <span class="gp">... </span> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrib</span><span class="p">):</span> <span class="c"># Called for each opening tag.</span> <span class="gp">... </span> <span class="bp">self</span><span class="o">.</span><span class="n">depth</span> <span class="o">+=</span> <span class="mi">1</span> <span class="gp">... </span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">depth</span> <span class="o">></span> <span class="bp">self</span><span class="o">.</span><span class="n">maxDepth</span><span class="p">:</span> <span class="gp">... </span> <span class="bp">self</span><span class="o">.</span><span class="n">maxDepth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">depth</span> <span class="gp">... </span> <span class="k">def</span> <span class="nf">end</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">):</span> <span class="c"># Called for each closing tag.</span> <span class="gp">... </span> <span class="bp">self</span><span class="o">.</span><span class="n">depth</span> <span class="o">-=</span> <span class="mi">1</span> <span class="gp">... </span> <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span> <span class="gp">... </span> <span class="k">pass</span> <span class="c"># We do not need to do anything with data.</span> <span class="gp">... </span> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c"># Called when all data has been parsed.</span> <span class="gp">... </span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">maxDepth</span> <span class="gp">...</span> <span class="gp">>>> </span><span class="n">target</span> <span class="o">=</span> <span class="n">MaxDepth</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">parser</span> <span class="o">=</span> <span class="n">XMLParser</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="n">target</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">exampleXml</span> <span class="o">=</span> <span class="s">"""</span> <span class="gp">... </span><span class="s"><a></span> <span class="gp">... </span><span class="s"> <b></span> <span class="gp">... </span><span class="s"> </b></span> <span class="gp">... </span><span class="s"> <b></span> <span class="gp">... </span><span class="s"> <c></span> <span class="gp">... </span><span class="s"> <d></span> <span class="gp">... </span><span class="s"> </d></span> <span class="gp">... </span><span class="s"> </c></span> <span class="gp">... </span><span class="s"> </b></span> <span class="gp">... </span><span class="s"></a>"""</span> <span class="gp">>>> </span><span class="n">parser</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">exampleXml</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">parser</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="go">4</span> </pre></div> </div> <p class="rubric">Footnotes</p> <table class="docutils footnote" frame="void" id="id5" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label">[1]</td><td>The encoding string included in XML output should conform to the appropriate standards. For example, “UTF-8” is valid, but “UTF8” is not. See <a class="reference external" href="http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl">http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl</a> and <a class="reference external" href="http://www.iana.org/assignments/character-sets">http://www.iana.org/assignments/character-sets</a>.</td></tr> </tbody> </table> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">19.7. <tt class="docutils literal"><span class="pre">xml.etree.ElementTree</span></tt> — The ElementTree XML API</a><ul> <li><a class="reference internal" href="#tutorial">19.7.1. Tutorial</a><ul> <li><a class="reference internal" href="#xml-tree-and-elements">19.7.1.1. XML tree and elements</a></li> <li><a class="reference internal" href="#parsing-xml">19.7.1.2. Parsing XML</a></li> <li><a class="reference internal" href="#finding-interesting-elements">19.7.1.3. Finding interesting elements</a></li> <li><a class="reference internal" href="#modifying-an-xml-file">19.7.1.4. Modifying an XML File</a></li> <li><a class="reference internal" href="#building-xml-documents">19.7.1.5. Building XML documents</a></li> <li><a class="reference internal" href="#additional-resources">19.7.1.6. Additional resources</a></li> </ul> </li> <li><a class="reference internal" href="#xpath-support">19.7.2. XPath support</a><ul> <li><a class="reference internal" href="#example">19.7.2.1. Example</a></li> <li><a class="reference internal" href="#supported-xpath-syntax">19.7.2.2. Supported XPath syntax</a></li> </ul> </li> <li><a class="reference internal" href="#reference">19.7.3. Reference</a><ul> <li><a class="reference internal" href="#functions">19.7.3.1. Functions</a></li> <li><a class="reference internal" href="#element-objects">19.7.3.2. Element Objects</a></li> <li><a class="reference internal" href="#elementtree-objects">19.7.3.3. ElementTree Objects</a></li> <li><a class="reference internal" href="#qname-objects">19.7.3.4. QName Objects</a></li> <li><a class="reference internal" href="#treebuilder-objects">19.7.3.5. TreeBuilder Objects</a></li> <li><a class="reference internal" href="#xmlparser-objects">19.7.3.6. XMLParser Objects</a></li> </ul> </li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="xml.html" title="previous chapter">19.5. XML Processing Modules</a></p> <h4>Next topic</h4> <p class="topless"><a href="xml.dom.html" title="next chapter">19.8. <tt class="docutils literal"><span class="pre">xml.dom</span></tt> — The Document Object Model API</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/xml.etree.elementtree.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="xml.dom.html" title="19.8. xml.dom — The Document Object Model API" >next</a> |</li> <li class="right" > <a href="xml.html" title="19.5. XML Processing Modules" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="markup.html" >19. Structured Markup Processing Tools</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>