xml.etree.ElementTree —- ElementTree XML API

源代码：Lib/xml/etree/ElementTree.py

xml.etree.ElementTree 模块实现了一个简单高效的API，用于解析和创建XML数据。

在 3.3 版更改: 只要有可能，这个模块将使用快速实现。xml.etree.cElementTree 模块已弃用。

警告

xml.etree.ElementTree 模块对于恶意构建的数据是不安全的。如果需要解析不可信或未经身份验证的数据，请参见 XML 漏洞 。

教程

这是一个使用 xml.etree.ElementTree （简称 ET ）的简短教程。目标是演示模块的一些构建块和基本概念。

XML树和元素

XML是一种固有的分层数据格式，最自然的表示方法是使用树。为此， ET 有两个类 ElementTree 将整个XML文档表示为一个树， Element 表示该树中的单个节点。与整个文档的交互（读写文件）通常在 ElementTree 级别完成。与单个XML元素及其子元素的交互是在 Element 级别完成的。

解析XML

我们将使用以下XML文档作为本节的示例数据：

  1. <?xml version="1.0"?>
  2. <data>
  3.     <country name="Liechtenstein">
  4.         <rank>1</rank>
  5.         <year>2008</year>
  6.         <gdppc>141100</gdppc>
  7.         <neighbor name="Austria" direction="E"/>
  8.         <neighbor name="Switzerland" direction="W"/>
  9.     </country>
  10.     <country name="Singapore">
  11.         <rank>4</rank>
  12.         <year>2011</year>
  13.         <gdppc>59900</gdppc>
  14.         <neighbor name="Malaysia" direction="N"/>
  15.     </country>
  16.     <country name="Panama">
  17.         <rank>68</rank>
  18.         <year>2011</year>
  19.         <gdppc>13600</gdppc>
  20.         <neighbor name="Costa Rica" direction="W"/>
  21.         <neighbor name="Colombia" direction="E"/>
  22.     </country>
  23. </data>

我们可以通过从文件中读取来导入此数据：

  1. import xml.etree.ElementTree as ET
  2. tree = ET.parse('country_data.xml')
  3. root = tree.getroot()

或直接从字符串中：

  1. root = ET.fromstring(country_data_as_string)

fromstring() 将XML从字符串直接解析为 Element ，该元素是已解析树的根元素。其他解析函数可能会创建一个 ElementTree 。确切的信息请检查文档。

作为一个 Element ， root 有一个标记和一个属性字典:

  1. >>> root.tag
  2. 'data'
  3. >>> root.attrib
  4. {}

它还有我们可以迭代的子节点：

  1. >>> for child in root:
  2. ...     print(child.tag, child.attrib)
  3. ...
  4. country {'name': 'Liechtenstein'}
  5. country {'name': 'Singapore'}
  6. country {'name': 'Panama'}

子级是可以嵌套的，我们可以通过索引访问特定的子级节点：

  1. >>> root[0][1].text
  2. '2008'

注解

并非XML输入的所有元素都将作为解析树的元素结束。目前，此模块跳过输入中的任何XML注释、处理指令和文档类型声明。然而，使用这个模块的API而不是从XML文本解析构建的树可以包含注释和处理指令，生成XML输出时同样包含这些注释和处理指令。可以通过将自定义 TreeBuilder 实例传递给 XMLParser 构造函数来访问文档类型声明。

Pull API进行非阻塞解析

Most parsing functions provided by this module require the whole documentto be read at once before returning any result. It is possible to use anXMLParser and feed data into it incrementally, but it is a push API thatcalls methods on a callback target, which is too low-level and inconvenient formost needs. Sometimes what the user really wants is to be able to parse XMLincrementally, without blocking operations, while enjoying the convenience offully constructed Element objects.

The most powerful tool for doing this is XMLPullParser. It does notrequire a blocking read to obtain the XML data, and is instead fed with dataincrementally with XMLPullParser.feed() calls. To get the parsed XMLelements, call XMLPullParser.read_events(). Here is an example:

  1. >>> parser = ET.XMLPullParser(['start', 'end'])
  2. >>> parser.feed('<mytag>sometext')
  3. >>> list(parser.read_events())
  4. [('start', <Element 'mytag' at 0x7fa66db2be58>)]
  5. >>> parser.feed(' more text</mytag>')
  6. >>> for event, elem in parser.read_events():
  7. ...     print(event)
  8. ...     print(elem.tag, 'text=', elem.text)
  9. ...
  10. end

The obvious use case is applications that operate in a non-blocking fashionwhere the XML data is being received from a socket or read incrementally fromsome storage device. In such cases, blocking reads are unacceptable.

Because it's so flexible, XMLPullParser can be inconvenient to use forsimpler use-cases. If you don't mind your application blocking on reading XMLdata but would still like to have incremental parsing capabilities, take a lookat iterparse(). It can be useful when you're reading a large XML documentand don't want to hold it wholly in memory.

寻找有趣的元素

Element 有一些很有效的方法，可帮助递归遍历其下的所有子树（包括子级，子级的子级，等等）。例如 Element.iter():

  1. >>> for neighbor in root.iter('neighbor'):
  2. ...     print(neighbor.attrib)
  3. ...
  4. {'name': 'Austria', 'direction': 'E'}
  5. {'name': 'Switzerland', 'direction': 'W'}
  6. {'name': 'Malaysia', 'direction': 'N'}
  7. {'name': 'Costa Rica', 'direction': 'W'}
  8. {'name': 'Colombia', 'direction': 'E'}

Element.findall() 仅查找当前元素的直接子元素中带有指定标签的元素。 Element.find() 找带有特定标签的 第一个 子级，然后可以用 Element.text 访问元素的文本内容。 Element.text 访问元素的属性:

  1. >>> for country in root.findall('country'):
  2. ...     rank = country.find('rank').text
  3. ...     name = country.get('name')
  4. ...     print(name, rank)
  5. ...
  6. Liechtenstein 1
  7. Singapore 4
  8. Panama 68

通过使用 XPath ，可以更精确地指定要查找的元素。

修改XML文件

ElementTree 提供了一种构建XML文档并将其写入文件的简单方法。 ElementTree.write() 方法可达到此目的。

创建后可以直接操作 Element 对象。例如：使用 Element.text 修改文本字段，使用 Element.set() 方法添加和修改属性，以及使用 Element.append() 添加新的子元素。

假设我们要在每个国家/地区的中添加一个排名，并在rank元素中添加一个 updated 属性：

  1. >>> for rank in root.iter('rank'):
  2. ...     new_rank = int(rank.text) + 1
  3. ...     rank.text = str(new_rank)
  4. ...     rank.set('updated', 'yes')
  5. ...
  6. >>> tree.write('output.xml')

生成的XML现在看起来像这样：

  1. <?xml version="1.0"?>
  2. <data>
  3.     <country name="Liechtenstein">
  4.         <rank updated="yes">2</rank>
  5.         <year>2008</year>
  6.         <gdppc>141100</gdppc>
  7.         <neighbor name="Austria" direction="E"/>
  8.         <neighbor name="Switzerland" direction="W"/>
  9.     </country>
  10.     <country name="Singapore">
  11.         <rank updated="yes">5</rank>
  12.         <year>2011</year>
  13.         <gdppc>59900</gdppc>
  14.         <neighbor name="Malaysia" direction="N"/>
  15.     </country>
  16.     <country name="Panama">
  17.         <rank updated="yes">69</rank>
  18.         <year>2011</year>
  19.         <gdppc>13600</gdppc>
  20.         <neighbor name="Costa Rica" direction="W"/>
  21.         <neighbor name="Colombia" direction="E"/>
  22.     </country>
  23. </data>

可以使用 Element.remove() 删除元素。假设我们要删除排名高于50的所有国家/地区:

  1. >>> for country in root.findall('country'):
  2. ...     rank = int(country.find('rank').text)
  3. ...     if rank > 50:
  4. ...         root.remove(country)
  5. ...
  6. >>> tree.write('output.xml')

生成的XML现在看起来像这样：

  1. <?xml version="1.0"?>
  2. <data>
  3.     <country name="Liechtenstein">
  4.         <rank updated="yes">2</rank>
  5.         <year>2008</year>
  6.         <gdppc>141100</gdppc>
  7.         <neighbor name="Austria" direction="E"/>
  8.         <neighbor name="Switzerland" direction="W"/>
  9.     </country>
  10.     <country name="Singapore">
  11.         <rank updated="yes">5</rank>
  12.         <year>2011</year>
  13.         <gdppc>59900</gdppc>
  14.         <neighbor name="Malaysia" direction="N"/>
  15.     </country>
  16. </data>

构建XML文档

SubElement() 函数还提供了一种便捷方法来为给定元素创建新的子元素:

  1. >>> a = ET.Element('a')
  2. >>> b = ET.SubElement(a, 'b')
  3. >>> c = ET.SubElement(a, 'c')
  4. >>> d = ET.SubElement(c, 'd')
  5. >>> ET.dump(a)
  6. <a><b /><c><d /></c></a>

使用命名空间解析XML

If the XML input has namespaces, tags and attributeswith prefixes in the form prefix:sometag get expanded to{uri}sometag where the prefix is replaced by the full URI.Also, if there is a default namespace,that full URI gets prepended to all of the non-prefixed tags.

Here is an XML example that incorporates two namespaces, one with theprefix "fictional" and the other serving as the default namespace:

  1. <?xml version="1.0"?>
  2. <actors xmlns:fictional="http://characters.example.com"
  3.         xmlns="http://people.example.com">
  4.     <actor>
  5.         <name>John Cleese</name>
  6.         <fictional:character>Lancelot</fictional:character>
  7.         <fictional:character>Archie Leach</fictional:character>
  8.     </actor>
  9.     <actor>
  10.         <name>Eric Idle</name>
  11.         <fictional:character>Sir Robin</fictional:character>
  12.         <fictional:character>Gunther</fictional:character>
  13.         <fictional:character>Commander Clement</fictional:character>
  14.     </actor>
  15. </actors>

One way to search and explore this XML example is to manually add theURI to every tag or attribute in the xpath of afind() or findall():

  1. root = fromstring(xml_text)
  2. for actor in root.findall('{http://people.example.com}actor'):
  3.     name = actor.find('{http://people.example.com}name')
  4.     print(name.text)
  5.     for char in actor.findall('{http://characters.example.com}character'):
  6.         print(' |-->', char.text)

A better way to search the namespaced XML example is to create adictionary with your own prefixes and use those in the search functions:

  1. ns = {'real_person': 'http://people.example.com',
  2.       'role': 'http://characters.example.com'}
  3.  
  4. for actor in root.findall('real_person:actor', ns):
  5.     name = actor.find('real_person:name', ns)
  6.     print(name.text)
  7.     for char in actor.findall('role:character', ns):
  8.         print(' |-->', char.text)

These two approaches both output:

  1. John Cleese
  2.  |--> Lancelot
  3.  |--> Archie Leach
  4. Eric Idle
  5.  |--> Sir Robin
  6.  |--> Gunther
  7.  |--> Commander Clement

其他资源

See http://effbot.org/zone/element-index.htm for tutorials and links to otherdocs.

XPath支持

This module provides limited support forXPath expressions for locating elements in atree. The goal is to support a small subset of the abbreviated syntax; a fullXPath engine is outside the scope of the module.

示例

Here's an example that demonstrates some of the XPath capabilities of themodule. We'll be using the countrydata XML document from theParsing XML section:

  1. import xml.etree.ElementTree as ET
  2.  
  3. root = ET.fromstring(countrydata)
  4.  
  5. # Top-level elements
  6. root.findall(".")
  7.  
  8. # All 'neighbor' grand-children of 'country' children of the top-level
  9. # elements
  10. root.findall("./country/neighbor")
  11.  
  12. # Nodes with name='Singapore' that have a 'year' child
  13. root.findall(".//year/..[@name='Singapore']")
  14.  
  15. # 'year' nodes that are children of nodes with name='Singapore'
  16. root.findall(".//*[@name='Singapore']/year")
  17.  
  18. # All 'neighbor' nodes that are the second child of their parent
  19. root.findall(".//neighbor[2]")

支持的XPath语法

语法含义
tagSelects all child elements with the given tag.For example, spam selects all child elementsnamed spam, and spam/egg selects allgrandchildren named egg in all children namedspam.
Selects all child elements. For example, /eggselects all grandchildren named egg.
.选择当前节点。这在路径的开头非常有用，用于指示它是相对路径。
//Selects all subelements, on all levels beneath thecurrent element. For example, .//egg selectsall egg elements in the entire tree.
..Selects the parent element. Returns None if thepath attempts to reach the ancestors of the startelement (the element find was called on).
[@attrib]选择具有给定属性的所有元素。
[@attrib='value']选择给定属性具有给定值的所有元素。该值不能包含引号。
[tag]选择所有包含 tag 子元素的元素。只支持直系子元素。
[.='text']选择完整文本内容等于 text 的所有元素（包括后代）。3.7 新版功能.
[tag='text']选择所有包含名为 tag 的子元素的元素，这些子元素（包括后代）的完整文本内容等于给定的 text 。
[position]Selects all elements that are located at the givenposition. The position can be either an integer(1 is the first position), the expression last()(for the last position), or a position relative tothe last position (e.g. last()-1).

谓词（方括号内的表达式）之前必须带有标签名称，星号或其他谓词。position 谓词前必须有标签名称。

参考

函数

  • xml.etree.ElementTree.Comment(text=None)
  • Comment element factory. This factory function creates a special elementthat will be serialized as an XML comment by the standard serializer. Thecomment string can be either a bytestring or a Unicode string. text is astring containing the comment string. Returns an element instancerepresenting a comment.

Note that XMLParser skips over comments in the inputinstead of creating comment objects for them. An ElementTree willonly contain comment nodes if they have been inserted into tothe tree using one of the Element methods.

  • xml.etree.ElementTree.dump(elem)
  • Writes an element tree or element structure to sys.stdout. This functionshould be used for debugging only.

The exact output format is implementation dependent. In this version, it'swritten as an ordinary XML file.

elem is an element tree or an individual element.

  • xml.etree.ElementTree.fromstring(text, parser=None)
  • Parses an XML section from a string constant. Same as XML(). text_is a string containing XML data. _parser is an optional parser instance.If not given, the standard XMLParser parser is used.Returns an Element instance.
  • xml.etree.ElementTree.fromstringlist(sequence, parser=None)
  • Parses an XML document from a sequence of string fragments. sequence is alist or other sequence containing XML data fragments. parser is anoptional parser instance. If not given, the standard XMLParserparser is used. Returns an Element instance.

3.2 新版功能.

  • xml.etree.ElementTree.iselement(element)
  • Check if an object appears to be a valid element object. element is anelement instance. Return True if this is an element object.
  • xml.etree.ElementTree.iterparse(source, events=None, parser=None)
  • Parses an XML section into an element tree incrementally, and reports what'sgoing on to the user. source is a filename or file objectcontaining XML data. events is a sequence of events to report back. Thesupported events are the strings "start", "end", "start-ns" and"end-ns" (the "ns" events are used to get detailed namespaceinformation). If events is omitted, only "end" events are reported.parser is an optional parser instance. If not given, the standardXMLParser parser is used. parser must be a subclass ofXMLParser and can only use the default TreeBuilder as atarget. Returns an iterator providing (event, elem) pairs.

Note that while iterparse() builds the tree incrementally, it issuesblocking reads on source (or the file it names). As such, it's unsuitablefor applications where blocking reads can't be made. For fully non-blockingparsing, see XMLPullParser.

注解

iterparse() only guarantees that it has seen the ">" character of astarting tag when it emits a "start" event, so the attributes are defined,but the contents of the text and tail attributes are undefined at thatpoint. The same applies to the element children; they may or may not bepresent.

If you need a fully populated element, look for "end" events instead.

3.4 版后已移除: parser 参数。

  • xml.etree.ElementTree.parse(source, parser=None)
  • Parses an XML section into an element tree. source is a filename or fileobject containing XML data. parser is an optional parser instance. Ifnot given, the standard XMLParser parser is used. Returns anElementTree instance.
  • xml.etree.ElementTree.ProcessingInstruction(target, text=None)
  • PI element factory. This factory function creates a special element thatwill be serialized as an XML processing instruction. target is a stringcontaining the PI target. text is a string containing the PI contents, ifgiven. Returns an element instance, representing a processing instruction.

Note that XMLParser skips over processing instructionsin the input instead of creating comment objects for them. AnElementTree will only contain processing instruction nodes ifthey have been inserted into to the tree using one of theElement methods.

  • xml.etree.ElementTree.registernamespace(_prefix, uri)
  • Registers a namespace prefix. The registry is global, and any existingmapping for either the given prefix or the namespace URI will be removed.prefix is a namespace prefix. uri is a namespace uri. Tags andattributes in this namespace will be serialized with the given prefix, if atall possible.

3.2 新版功能.

  • xml.etree.ElementTree.SubElement(parent, tag, attrib={}, **extra)
  • Subelement factory. This function creates an element instance, and appendsit to an existing element.

The element name, attribute names, and attribute values can be eitherbytestrings or Unicode strings. parent is the parent element. tag isthe subelement name. attrib is an optional dictionary, containing elementattributes. extra contains additional attributes, given as keywordarguments. Returns an element instance.

  • xml.etree.ElementTree.tostring(element, encoding="us-ascii", method="xml", *, short_empty_elements=True)
  • Generates a string representation of an XML element, including allsubelements. element is an Element instance. encoding1 isthe output encoding (default is US-ASCII). Use encoding="unicode" togenerate a Unicode string (otherwise, a bytestring is generated). method_is either "xml", "html" or "text" (default is "xml")._short_empty_elements has the same meaning as in ElementTree.write().Returns an (optionally) encoded string containing the XML data.

3.4 新版功能: The short_empty_elements parameter.

  • xml.etree.ElementTree.tostringlist(element, encoding="us-ascii", method="xml", *, short_empty_elements=True)
  • Generates a string representation of an XML element, including allsubelements. element is an Element instance. encoding1 isthe output encoding (default is US-ASCII). Use encoding="unicode" togenerate a Unicode string (otherwise, a bytestring is generated). method_is either "xml", "html" or "text" (default is "xml")._short_empty_elements has the same meaning as in ElementTree.write().Returns a list of (optionally) encoded strings containing the XML data.It does not guarantee any specific sequence, except thatb"".join(tostringlist(element)) == tostring(element).

3.2 新版功能.

3.4 新版功能: The short_empty_elements parameter.

  • xml.etree.ElementTree.XML(text, parser=None)
  • Parses an XML section from a string constant. This function can be used toembed "XML literals" in Python code. text is a string containing XMLdata. parser is an optional parser instance. If not given, the standardXMLParser parser is used. Returns an Element instance.
  • xml.etree.ElementTree.XMLID(text, parser=None)
  • Parses an XML section from a string constant, and also returns a dictionarywhich maps from element id:s to elements. text is a string containing XMLdata. parser is an optional parser instance. If not given, the standardXMLParser parser is used. Returns a tuple containing anElement instance and a dictionary.

XInclude 支持

This module provides limited support forXInclude directives, via the xml.etree.ElementInclude helper module. This module can be used to insert subtrees and text strings into element trees, based on information in the tree.

示例

Here's an example that demonstrates use of the XInclude module. To include an XML document in the current document, use the {http://www.w3.org/2001/XInclude}include element and set the parse attribute to "xml", and use the href attribute to specify the document to include.

  1. <?xml version="1.0"?>
  2. <document xmlns:xi="http://www.w3.org/2001/XInclude">
  3.   <xi:include href="source.xml" parse="xml" />
  4. </document>

By default, the href attribute is treated as a file name. You can use custom loaders to override this behaviour. Also note that the standard helper does not support XPointer syntax.

To process this file, load it as usual, and pass the root element to the xml.etree.ElementTree module:

  1. from xml.etree import ElementTree, ElementInclude
  2.  
  3. tree = ElementTree.parse("document.xml")
  4. root = tree.getroot()
  5.  
  6. ElementInclude.include(root)

The ElementInclude module replaces the {http://www.w3.org/2001/XInclude}include element with the root element from the source.xml document. The result might look something like this:

  1. <document xmlns:xi="http://www.w3.org/2001/XInclude">
  2.   <para>This is a paragraph.</para>
  3. </document>

If the parse attribute is omitted, it defaults to "xml". The href attribute is required.

To include a text document, use the {http://www.w3.org/2001/XInclude}include element, and set the parse attribute to "text":

  1. <?xml version="1.0"?>
  2. <document xmlns:xi="http://www.w3.org/2001/XInclude">
  3.   Copyright (c) <xi:include href="year.txt" parse="text" />.
  4. </document>

结果可能如下所示：

  1. <document xmlns:xi="http://www.w3.org/2001/XInclude">
  2.   Copyright (c) 2003.
  3. </document>

参考

函数

  • xml.etree.ElementInclude.defaultloader(_href, parse, encoding=None)
  • Default loader. This default loader reads an included resource from disk. href is a URL.parse is for parse mode either "xml" or "text". _encoding_is an optional text encoding. If not given, encoding is utf-8. Returns theexpanded resource. If the parse mode is "xml", this is an ElementTreeinstance. If the parse mode is "text", this is a Unicode string. If theloader fails, it can return None or raise an exception.
  • xml.etree.ElementInclude.include(elem, loader=None)
  • This function expands XInclude directives. elem is the root element. loader isan optional resource loader. If omitted, it defaults to default_loader().If given, it should be a callable that implements the same interface asdefault_loader(). Returns the expanded resource. If the parse mode is"xml", this is an ElementTree instance. If the parse mode is "text",this is a Unicode string. If the loader fails, it can return None orraise an exception.

元素对象

  • class xml.etree.ElementTree.Element(tag, attrib={}, **extra)
  • Element class. This class defines the Element interface, and provides areference implementation of this interface.

The element name, attribute names, and attribute values can be eitherbytestrings or Unicode strings. tag is the element name. attrib isan optional dictionary, containing element attributes. extra containsadditional attributes, given as keyword arguments.

  • tag

  • 一个标识此元素意味着何种数据的字符串(换句话说，元素类型)。

  • text

  • tail
  • These attributes can be used to hold additional data associated withthe element. Their values are usually strings but may be anyapplication-specific object. If the element is created froman XML file, the text attribute holds either the text betweenthe element's start tag and its first child or end tag, or None, andthe tail attribute holds either the text between the element'send tag and the next tag, or None. For the XML data
  1. <a><b>1<c>2<d/>3</c></b>4</a>

the a element has None for both text and tail attributes,the b element has text "1" and tail "4",the c element has text "2" and tail None,and the d element has text None and tail "3".

To collect the inner text of an element, see itertext(), forexample "".join(element.itertext()).

Applications may store arbitrary objects in these attributes.

  • attrib
  • A dictionary containing the element's attributes. Note that while theattrib value is always a real mutable Python dictionary, an ElementTreeimplementation may choose to use another internal representation, andcreate the dictionary only if someone asks for it. To take advantage ofsuch implementations, use the dictionary methods below whenever possible.

The following dictionary-like methods work on the element attributes.

  • clear()

  • Resets an element. This function removes all subelements, clears allattributes, and sets the text and tail attributes to None.

  • get(key, default=None)

  • Gets the element attribute named key.

Returns the attribute value, or default if the attribute was not found.

  • items()

  • Returns the element attributes as a sequence of (name, value) pairs. Theattributes are returned in an arbitrary order.

  • keys()

  • Returns the elements attribute names as a list. The names are returnedin an arbitrary order.

  • set(key, value)

  • Set the attribute key on the element to value.

The following methods work on the element's children (subelements).

  • append(subelement)

  • Adds the element subelement to the end of this element's internal listof subelements. Raises TypeError if subelement is not anElement.

  • extend(subelements)

  • Appends subelements from a sequence object with zero or more elements.Raises TypeError if a subelement is not an Element.

3.2 新版功能.

  • find(match, namespaces=None)

  • Finds the first subelement matching match. match may be a tag nameor a path. Returns an element instanceor None. namespaces is an optional mapping from namespace prefixto full name.

  • findall(match, namespaces=None)

  • Finds all matching subelements, by tag name orpath. Returns a list containing all matchingelements in document order. namespaces is an optional mapping fromnamespace prefix to full name.

  • findtext(match, default=None, namespaces=None)

  • Finds text for the first subelement matching match. match may bea tag name or a path. Returns the text contentof the first matching element, or default if no element was found.Note that if the matching element has no text content an empty stringis returned. namespaces is an optional mapping from namespace prefixto full name.

  • getchildren()

3.2 版后已移除: Use list(elem) or iteration.

  • getiterator(tag=None)

3.2 版后已移除: Use method Element.iter() instead.

  • insert(index, subelement)

  • Inserts subelement at the given position in this element. RaisesTypeError if subelement is not an Element.

  • iter(tag=None)

  • Creates a tree iterator with the current element as the root.The iterator iterates over this element and all elements below it, indocument (depth first) order. If tag is not None or '*', onlyelements whose tag equals tag are returned from the iterator. If thetree structure is modified during iteration, the result is undefined.

3.2 新版功能.

  • iterfind(match, namespaces=None)
  • Finds all matching subelements, by tag name orpath. Returns an iterable yielding allmatching elements in document order. namespaces is an optional mappingfrom namespace prefix to full name.

3.2 新版功能.

  • itertext()
  • Creates a text iterator. The iterator loops over this element and allsubelements, in document order, and returns all inner text.

3.2 新版功能.

  • makeelement(tag, attrib)

  • Creates a new element object of the same type as this element. Do notcall this method, use the SubElement() factory function instead.

  • remove(subelement)

  • Removes subelement from the element. Unlike the find* methods thismethod compares elements based on the instance identity, not on tag valueor contents.

Element objects also support the following sequence type methodsfor working with subelements: delitem(),getitem(), setitem(),len().

Caution: Elements with no subelements will test as False. This behaviorwill change in future versions. Use specific len(elem) or elem isNone test instead.

  1. element = root.find('foo')
  2.  
  3. if not element:  # careful!
  4.     print("element not found, or element has no subelements")
  5.  
  6. if element is None:
  7.     print("element not found")

ElementTree 对象

  • class xml.etree.ElementTree.ElementTree(element=None, file=None)
  • ElementTree wrapper class. This class represents an entire elementhierarchy, and adds some extra support for serialization to and fromstandard XML.

element is the root element. The tree is initialized with the contentsof the XML file if given.

  • setroot(_element)

  • Replaces the root element for this tree. This discards the currentcontents of the tree, and replaces it with the given element. Use withcare. element is an element instance.

  • find(match, namespaces=None)

  • Same as Element.find(), starting at the root of the tree.

  • findall(match, namespaces=None)

  • Same as Element.findall(), starting at the root of the tree.

  • findtext(match, default=None, namespaces=None)

  • Same as Element.findtext(), starting at the root of the tree.

  • getiterator(tag=None)

3.2 版后已移除: Use method ElementTree.iter() instead.

  • getroot()

  • Returns the root element for this tree.

  • iter(tag=None)

  • Creates and returns a tree iterator for the root element. The iteratorloops over all elements in this tree, in section order. tag is the tagto look for (default is to return all elements).

  • iterfind(match, namespaces=None)

  • Same as Element.iterfind(), starting at the root of the tree.

3.2 新版功能.

  • parse(source, parser=None)

  • Loads an external XML section into this element tree. source is a filename or file object. parser is an optional parser instance.If not given, the standard XMLParser parser is used. Returns thesection root element.

  • write(file, encoding="us-ascii", xml_declaration=None, default_namespace=None, method="xml", *, short_empty_elements=True)

  • Writes the element tree to a file, as XML. file is a file name, or afile object opened for writing. encoding1 is the outputencoding (default is US-ASCII).xml_declaration controls if an XML declaration should be added to thefile. Use False for never, True for always, Nonefor only if not US-ASCII or UTF-8 or Unicode (default is None).default_namespace sets the default XML namespace (for "xmlns").method is either "xml", "html" or "text" (default is"xml").The keyword-only short_empty_elements parameter controls the formattingof elements that contain no content. If True (the default), they areemitted as a single self-closed tag, otherwise they are emitted as a pairof start/end tags.

The output is either a string (str) or binary (bytes).This is controlled by the encoding argument. If encoding is"unicode", the output is a string; otherwise, it's binary. Note thatthis may conflict with the type of file if it's an openfile object; make sure you do not try to write a string to abinary stream and vice versa.

3.4 新版功能: The short_empty_elements parameter.

This is the XML file that is going to be manipulated:

  1. <html>
  2.     <head>
  3.         <title>Example page</title>
  4.     </head>
  5.     <body>
  6.         <p>Moved to <a href="http://example.org/">example.org</a>
  7.         or <a href="http://example.com/">example.com</a>.</p>
  8.     </body>
  9. </html>

Example of changing the attribute "target" of every link in first paragraph:

  1. >>> from xml.etree.ElementTree import ElementTree
  2. >>> tree = ElementTree()
  3. >>> tree.parse("index.xhtml")
  4. <Element 'html' at 0xb77e6fac>
  5. >>> p = tree.find("body/p")     # Finds first occurrence of tag p in body
  6. >>> p
  7. <Element 'p' at 0xb77ec26c>
  8. >>> links = list(p.iter("a"))   # Returns list of all links
  9. >>> links
  10. [<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
  11. >>> for i in links:             # Iterates through all found links
  12. ...     i.attrib["target"] = "blank"
  13. >>> tree.write("output.xhtml")

QName Objects

  • class xml.etree.ElementTree.QName(text_or_uri, tag=None)
  • QName wrapper. This can be used to wrap a QName attribute value, in orderto get proper namespace handling on output. text_or_uri is a stringcontaining the QName value, in the form {uri}local, or, if the tag argumentis given, the URI part of a QName. If tag is given, the first argument isinterpreted as a URI, and this argument is interpreted as a local name.QName instances are opaque.

TreeBuilder Objects

  • class xml.etree.ElementTree.TreeBuilder(element_factory=None)

  • Generic element structure builder. This builder converts a sequence ofstart, data, and end method calls to a well-formed element structure. Youcan use this class to build an element structure using a custom XML parser,or a parser for some other XML-like format. element_factory, when given,must be a callable accepting two positional arguments: a tag anda dict of attributes. It is expected to return a new element instance.

    • close()

    • Flushes the builder buffers, and returns the toplevel documentelement. Returns an Element instance.

    • data(data)

    • Adds text to the current element. data is a string. This should beeither a bytestring, or a Unicode string.

    • end(tag)

    • Closes the current element. tag is the element name. Returns theclosed element.

    • start(tag, attrs)

    • Opens a new element. tag is the element name. attrs is a dictionarycontaining element attributes. Returns the opened element.

In addition, a custom TreeBuilder object can provide thefollowing method:

  • doctype(name, pubid, system)
  • Handles a doctype declaration. name is the doctype name. pubid isthe public identifier. system is the system identifier. This methoddoes not exist on the default TreeBuilder class.

3.2 新版功能.

XMLParser对象

  • class xml.etree.ElementTree.XMLParser(html=0, target=None, encoding=None)
  • This class is the low-level building block of the module. It usesxml.parsers.expat for efficient, event-based parsing of XML. It canbe fed XML data incrementally with the feed() method, and parsingevents are translated to a push API - by invoking callbacks on the target_object. If _target is omitted, the standard TreeBuilder is used.The html argument was historically used for backwards compatibility and isnow deprecated. If encoding1 is given, the value overrides theencoding specified in the XML file.

3.4 版后已移除: The html argument. The remaining arguments should be passed viakeyword to prepare for the removal of the html argument.

  • close()

  • Finishes feeding data to the parser. Returns the result of calling theclose() method of the target passed during construction; by default,this is the toplevel document element.

  • doctype(name, pubid, system)

3.2 版后已移除: Define the TreeBuilder.doctype() method on a custom TreeBuildertarget.

  • feed(data)
  • Feeds data to the parser. data is encoded data.

XMLParser.feed() calls target's start(tag, attrsdict) methodfor each opening tag, its end(tag) method for each closing tag, and datais processed by method data(data). XMLParser.close() calls_target's method close(). XMLParser can be used not only forbuilding a tree structure. This is an example of counting the maximum depthof an XML file:

  1. >>> from xml.etree.ElementTree import XMLParser
  2. >>> class MaxDepth:                     # The target object of the parser
  3. ...     maxDepth = 0
  4. ...     depth = 0
  5. ...     def start(self, tag, attrib):   # Called for each opening tag.
  6. ...         self.depth += 1
  7. ...         if self.depth > self.maxDepth:
  8. ...             self.maxDepth = self.depth
  9. ...     def end(self, tag):             # Called for each closing tag.
  10. ...         self.depth -= 1
  11. ...     def data(self, data):
  12. ...         pass            # We do not need to do anything with data.
  13. ...     def close(self):    # Called when all data has been parsed.
  14. ...         return self.maxDepth
  15. ...
  16. >>> target = MaxDepth()
  17. >>> parser = XMLParser(target=target)
  18. >>> exampleXml = """
  19. ... <a>
  20. ...   <b>
  21. ...   </b>
  22. ...   <b>
  23. ...     <c>
  24. ...       <d>
  25. ...       </d>
  26. ...     </c>
  27. ...   </b>
  28. ... </a>"""
  29. >>> parser.feed(exampleXml)
  30. >>> parser.close()
  31. 4

XMLPullParser对象

  • class xml.etree.ElementTree.XMLPullParser(events=None)

  • A pull parser suitable for non-blocking applications. Its input-side API issimilar to that of XMLParser, but instead of pushing calls to acallback target, XMLPullParser collects an internal list of parsingevents and lets the user read from it. events is a sequence of events toreport back. The supported events are the strings "start", "end","start-ns" and "end-ns" (the "ns" events are used to get detailednamespace information). If events is omitted, only "end" events arereported.

    • feed(data)

    • Feed the given bytes data to the parser.

    • close()

    • Signal the parser that the data stream is terminated. UnlikeXMLParser.close(), this method always returns None.Any events not yet retrieved when the parser is closed can still beread with read_events().

    • read_events()

    • Return an iterator over the events which have been encountered in thedata fed to theparser. The iterator yields (event, elem) pairs, where event is astring representing the type of event (e.g. "end") and elem is theencountered Element object.

Events provided in a previous call to read_events() will not beyielded again. Events are consumed from the internal queue only whenthey are retrieved from the iterator, so multiple readers iterating inparallel over iterators obtained from read_events() will haveunpredictable results.

注解

XMLPullParser only guarantees that it has seen the ">"character of a starting tag when it emits a "start" event, so theattributes are defined, but the contents of the text and tail attributesare undefined at that point. The same applies to the element children;they may or may not be present.

If you need a fully populated element, look for "end" events instead.

3.4 新版功能.

异常

  • class xml.etree.ElementTree.ParseError

  • XML parse error, raised by the various parsing methods in this module whenparsing fails. The string representation of an instance of this exceptionwill contain a user-friendly error message. In addition, it will havethe following attributes available:

    • code

    • A numeric error code from the expat parser. See the documentation ofxml.parsers.expat for the list of error codes and their meanings.

    • position

    • A tuple of line, column numbers, specifying where the error occurred.

备注