# `xml.etree.ElementTree` --- ElementTree XML API

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

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

在 3.3 版更改: 此模块将在可能的情况下使用快速实现。

3.3 版后已移除: `xml.etree.cElementTree` 模块已被弃用。

警告

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

## 教程

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

### XML 树和元素

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

### 解析 XML

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

    <?xml version="1.0"?>
    <data>
        <country name="Liechtenstein">
            <rank>1</rank>
            <year>2008</year>
            <gdppc>141100</gdppc>
            <neighbor name="Austria" direction="E"/>
            <neighbor name="Switzerland" direction="W"/>
        </country>
        <country name="Singapore">
            <rank>4</rank>
            <year>2011</year>
            <gdppc>59900</gdppc>
            <neighbor name="Malaysia" direction="N"/>
        </country>
        <country name="Panama">
            <rank>68</rank>
            <year>2011</year>
            <gdppc>13600</gdppc>
            <neighbor name="Costa Rica" direction="W"/>
            <neighbor name="Colombia" direction="E"/>
        </country>
    </data>

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

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

或直接从字符串中解析：

    root = ET.fromstring(country_data_as_string)

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

作为 `Element` ， `root` 具有标签和属性字典:

    >>> root.tag
    'data'
    >>> root.attrib
    {}

还有可以迭代的子节点：

    >>> for child in root:
    ...     print(child.tag, child.attrib)
    ...
    country {'name': 'Liechtenstein'}
    country {'name': 'Singapore'}
    country {'name': 'Panama'}

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

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

注解

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

### 用于非阻塞解析的拉取 API

此模块所提供了大多数解析函数都要求在返回任何结果之前一次性读取整个文档。 可以使用 `XMLParser` 并以增量方式添加数据，但这是在回调目标上调用方法的推送式 API。 有时用户真正想要的是能够以增量方式解析 XML 而无需阻塞操作，同时享受完整的已构造 `Element` 对象。

针对此需求的最强大工具是 `XMLPullParser`。 它不要求通过阻塞式读取来获得 XML 数据，而是通过执行 `XMLPullParser.feed()` 调用来增量式地添加数据。 要获得已解析的 XML 元素，应调用 `XMLPullParser.read_events()`。 下面是一个示例:

    >>> parser = ET.XMLPullParser(['start', 'end'])
    >>> parser.feed('<mytag>sometext')
    >>> list(parser.read_events())
    [('start', <Element 'mytag' at 0x7fa66db2be58>)]
    >>> parser.feed(' more text</mytag>')
    >>> for event, elem in parser.read_events():
    ...     print(event)
    ...     print(elem.tag, 'text=', elem.text)
    ...
    end

常见的用例是针对以非阻塞方式进行的应用程序，其中 XML 是从套接字接收或从某些存储设备增量式读取的。 在这些用例中，阻塞式读取是不可接受的。

因为其非常灵活，`XMLPullParser` 在更简单的用例中使用起来可能并不方便。 如果你不介意你的应用程序在读取 XML 数据时造成阻塞但仍希望具有增量解析能力，可以考虑 `iterparse()`。 它在你读取大型 XML 文档并且不希望将它完全放去内存时会很适用。

### 查找感兴趣的元素

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

    >>> for neighbor in root.iter('neighbor'):
    ...     print(neighbor.attrib)
    ...
    {'name': 'Austria', 'direction': 'E'}
    {'name': 'Switzerland', 'direction': 'W'}
    {'name': 'Malaysia', 'direction': 'N'}
    {'name': 'Costa Rica', 'direction': 'W'}
    {'name': 'Colombia', 'direction': 'E'}

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

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

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

### 修改XML文件

`ElementTree` 提供了一种构建XML文档并将其写入文件的简单方法。调用 `ElementTree.write()` 方法就可以实现。

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

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

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

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

    <?xml version="1.0"?>
    <data>
        <country name="Liechtenstein">
            <rank updated="yes">2</rank>
            <year>2008</year>
            <gdppc>141100</gdppc>
            <neighbor name="Austria" direction="E"/>
            <neighbor name="Switzerland" direction="W"/>
        </country>
        <country name="Singapore">
            <rank updated="yes">5</rank>
            <year>2011</year>
            <gdppc>59900</gdppc>
            <neighbor name="Malaysia" direction="N"/>
        </country>
        <country name="Panama">
            <rank updated="yes">69</rank>
            <year>2011</year>
            <gdppc>13600</gdppc>
            <neighbor name="Costa Rica" direction="W"/>
            <neighbor name="Colombia" direction="E"/>
        </country>
    </data>

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

    >>> for country in root.findall('country'):
    ...     # using root.findall() to avoid removal during traversal
    ...     rank = int(country.find('rank').text)
    ...     if rank > 50:
    ...         root.remove(country)
    ...
    >>> tree.write('output.xml')

请注意在迭代时进行并发修改可能会导致问题，就像在迭代并修改 Python 列表或字典时那样。 因此，这个示例先通过 `root.findall()` 收集了所有匹配的元素，在此之后再对匹配项列表进行迭代。

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

    <?xml version="1.0"?>
    <data>
        <country name="Liechtenstein">
            <rank updated="yes">2</rank>
            <year>2008</year>
            <gdppc>141100</gdppc>
            <neighbor name="Austria" direction="E"/>
            <neighbor name="Switzerland" direction="W"/>
        </country>
        <country name="Singapore">
            <rank updated="yes">5</rank>
            <year>2011</year>
            <gdppc>59900</gdppc>
            <neighbor name="Malaysia" direction="N"/>
        </country>
    </data>

### 构建 XML 文档

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

    >>> a = ET.Element('a')
    >>> b = ET.SubElement(a, 'b')
    >>> c = ET.SubElement(a, 'c')
    >>> d = ET.SubElement(c, 'd')
    >>> ET.dump(a)
    <a><b /><c><d /></c></a>

### 解析带有命名空间的 XML

如果 XML 输入带有 命名空间，则具有前缀的 `prefix:sometag` 形式的标记和属性将被扩展为 `{uri}sometag`，其中 prefix 会被完整 URI 所替换。 并且，如果存在 默认命名空间，则完整 URI 会被添加到所有未加前缀的标记之前。

下面的 XML 示例包含两个命名空间，一个具有前缀 "fictional" 而另一个则作为默认命名空间:

    <?xml version="1.0"?>
    <actors xmlns:fictional="http://characters.example.com"
            xmlns="http://people.example.com">
        <actor>
            <name>John Cleese</name>
            <fictional:character>Lancelot</fictional:character>
            <fictional:character>Archie Leach</fictional:character>
        </actor>
        <actor>
            <name>Eric Idle</name>
            <fictional:character>Sir Robin</fictional:character>
            <fictional:character>Gunther</fictional:character>
            <fictional:character>Commander Clement</fictional:character>
        </actor>
    </actors>

搜索和探查这个 XML 示例的一种方式是手动为 `find()` 或 `findall()` 的 xpath 中的每个标记或属性添加 URI:

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

一种更好的方式是搜索带命名空间的 XML 示例创建一个字典来存放你自己的前缀并在搜索函数中使用它们:

    ns = {'real_person': 'http://people.example.com',
          'role': 'http://characters.example.com'}

    for actor in root.findall('real_person:actor', ns):
        name = actor.find('real_person:name', ns)
        print(name.text)
        for char in actor.findall('role:character', ns):
            print(' |-->', char.text)

这两种方式都会输出:

    John Cleese
     |--> Lancelot
     |--> Archie Leach
    Eric Idle
     |--> Sir Robin
     |--> Gunther
     |--> Commander Clement

### 其他资源

请访问 http://effbot.org/zone/element-index.htm 获取教程和其他文档的链接。

## XPath支持

此模块提供了对 XPath 表达式 的有限支持用于在树中定位元素。 其目标是支持一个简化语法的较小子集；完整的 XPath 引擎超出了此模块的适用范围。

### 示例

下面是一个演示此模块的部分 XPath 功能的例子。 我们将使用来自 解析 XML 小节的 `countrydata` XML 文档:

    import xml.etree.ElementTree as ET

    root = ET.fromstring(countrydata)

    # Top-level elements
    root.findall(".")

    # All 'neighbor' grand-children of 'country' children of the top-level
    # elements
    root.findall("./country/neighbor")

    # Nodes with name='Singapore' that have a 'year' child
    root.findall(".//year/..[@name='Singapore']")

    # 'year' nodes that are children of nodes with name='Singapore'
    root.findall(".//*[@name='Singapore']/year")

    # All 'neighbor' nodes that are the second child of their parent
    root.findall(".//neighbor[2]")

对于带有命名空间的 XML，应使用通常的限定 `{namespace}tag` 标记法:

    # All dublin-core "title" tags in the document
    root.findall(".//{http://purl.org/dc/elements/1.1/}title")

### 支持的XPath语法

语法 | 含义
--- | ---
`tag` | 选择具有给定标记的所有子元素。 例如，`spam` 是选择名为 `spam` 的所有子元素，而 `spam/egg` 是在名为 `spam` 的子元素中选择所有名为 `egg` 的孙元素，`{*}spam` 是在任意（或无）命名空间中选择名为 `spam` 的标记，而 `{}*` 是只选择不在一个命名空间中的标记。 在 3.8 版更改: 增加了对星号通配符的支持。
`*` | 选择所有子元素，包括注释和处理说明。例如 `*/egg` 选择所有名为 `egg` 的孙元素。
`.` | 选择当前节点。这在路径的开头非常有用，用于指示它是相对路径。
`//` | 选择所有子元素 在当前元素的所有下级中选择所有下级元素。 例如，`.//egg` 是在整个树中选择所有 `egg` 元素。
`..` | 选择父元素。 如果路径试图前往起始元素的上级（元素的 `find` 被调用）则返回 `None`。
`[@attrib]` | 选择具有给定属性的所有元素。
`[@attrib='value']` | 选择给定属性具有给定值的所有元素。该值不能包含引号。
`[tag]` | 选择所有包含 `tag` 子元素的元素。只支持直系子元素。
`[.='text']` | 选择完整文本内容等于 `text` 的所有元素（包括后代）。 3.7 新版功能.
`[tag='text']` | 选择所有包含名为 `tag` 的子元素的元素，这些子元素（包括后代）的完整文本内容等于给定的 `text` 。
`[position]` | 选择位于给定位置的所有元素。 位置可以是一个整数 (1 表示首位)，表达式 `last()` (表示末位)，或者相对于末位的位置 (例如 `last()-1`)。

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

## 参考引用

### 函数

`xml.etree.ElementTree.``canonicalize`(xml_data=None, *, out=None, from_file=None, **options)

  C14N 2.0 转换功能。.

  规整化是标准化 XML 输出的一种方式，该方式允许按字节比较和数字签名。 它降低了 XML 序列化器所具有的自由度并改为生成更受约束的 XML 表示形式。 主要限制涉及命名空间声明的位置、属性的顺序和可忽略的空白符等。

  此函数接受一个 XML 数字字符串 (xml_data) 或文件路径或者文件类对象 (from_file) 作为输入，将其转换为规整形式，并在提供了 out 文件（类）对象的情况下将其写到该对象的话，或者如果未提供则将其作为文本字符串返回。 输出文件接受文本而非字节数据。 因此它应当以使用 `utf-8` 编码格式的文本模式来打开。

  典型使用:

      xml_data = "<root>...</root>"
      print(canonicalize(xml_data))

      with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
          canonicalize(xml_data, out=out_file)

      with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
          canonicalize(from_file="inputfile.xml", out=out_file)

  配置选项 options 如下:

  - with_comments: 设为真值以包括注释 (默认为假值)

  - strip_text: 设为真值以去除文本内容前后的空白符

      （默认值：否）

  - rewrite_prefixes: 设为真值以替换带有 "n{number}" 前缀的命名空间

      （默认值：否）

  - qname_aware_tags: 一组可感知限定名称的标记名称，其中的前缀

      应当在文本内容中被替换 (默认为空值)

  - qname_aware_attrs: 一组可感知限定名称的属性名称，其中的前缀

      应当在文本内容中被替换 (默认为空值)

  - exclude_attrs: 一组不应当被序列化的属性名称

  - exclude_tags: 一组不应当被序列化的标记名称

  在上面的选项列表中，"一组" 是指任意多项集或包含字符串的可迭代对象，排序是不必要的。

  3.8 新版功能.

`xml.etree.ElementTree.``Comment`(text=None)

  注释元素工厂函数。 这个工厂函数可创建一个特殊元素，它将被标准序列化器当作 XML 注释来进行序列化。 注释字串可以是字节串或是 Unicode 字符串。 text 是包含注释字串的字符串。 返回一个表示注释的元素实例。

  请注意 `XMLParser` 会跳过输入中的注释而不会为其创建注释对象。 `ElementTree` 将只在当使用某个 `Element` 方法向树插入了注释节点时才会包含注释节点。

`xml.etree.ElementTree.``dump`(elem)

  将一个元素树或元素结构体写入到 sys.stdout。 此函数应当只被用于调试。

  实际输出格式是依赖于具体实现的。 在这个版本中，它将以普通 XML 文件的格式写入。

  elem 是一个元素树或单独元素。

  在 3.8 版更改: `dump()` 函数现在会保留用户指定的属性顺序。

`xml.etree.ElementTree.``fromstring`(text, parser=None)

  根据一个字符串常量解析 XML 的节。 与 `XML()` 类似。 text 是包含 XML 数据的字符串。 parser 是可选的解析器实例。 如果未给出，则会使用标准 `XMLParser` 解析器。 返回一个 `Element` 实例。

`xml.etree.ElementTree.``fromstringlist`(sequence, parser=None)

  根据一个字符串片段序列解析 XML 文档。 sequence 是包含 XML 数据片段的列表或其他序列对象。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 `XMLParser` 解析器。 返回一个 `Element` 实例。

  3.2 新版功能.

`xml.etree.ElementTree.``indent`(tree, space=" ", level=0)

  添加空格到子树来实现树的缩进效果。 这可以被用来生成美化打印的 XML 输出。 tree 可以为 Element 或 ElementTree。 space 是对应将被插入的每个缩进层级的空格字符串，默认为两个空格符。 要对已缩进的树的部分子树进行缩进，请传入初始缩进层级作为 level。

  3.9 新版功能.

`xml.etree.ElementTree.``iselement`(element)

  检测一个对象是否为有效的元素对象。 element 是一个元素实例。 如果对象是一个元素对象则返回 `True`。

`xml.etree.ElementTree.``iterparse`(source, events=None, parser=None)

  以增量方式将一个 XML 节解析为元素树，并向用户报告执行情况。 source 是包含 XML 数据的文件名或 file object。 events 是要报告的事件序列。 所支持的事件字符串有 `"start"`, `"end"`, `"comment"`, `"pi"`, `"start-ns"` 和 `"end-ns"` ("ns" 事件用于获取详细的命名空间信息)。 如果 events 被省略，则只有 `"end"` 事件会被报告。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 `XMLParser` 解析器。 parser 必须为 `XMLParser` 的子类并且只能使用默认的 `TreeBuilder` 作为目标。 返回一个提供 `(event, elem)` 对的 iterator。

  请注意虽然 `iterparse()` 是以增量方式构建树，但它会对 source (或其所指定的文件) 发出阻塞式读取。 因此，它不适用于不可执行阻塞式读取的应用。 对于完全非阻塞式的解析，请参看 `XMLPullParser`。

  注解

  `iterparse()` 只会确保当发出 "start" 事件时看到了开始标记的 ">" 字符，因而在这个点上属性已被定义，但文本容和末尾属性还未被定义。 这同样适用于元素的下级；它们可能存在也可能不存在。

  如果你需要已完全填充的元素，请改为查找 "end" 事件。

  3.4 版后已移除: parser 参数。

  在 3.8 版更改: 增加了 `comment` 和 `pi` 事件。

`xml.etree.ElementTree.``parse`(source, parser=None)

  将一个 XML 的节解析为元素树。 source 是包含 XML 数据的文件名或文件对象。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 `XMLParser` 解析器。 返回一个 `ElementTree` 实例。

`xml.etree.ElementTree.``ProcessingInstruction`(target, text=None)

  PI 元素工厂函数。 这个工厂函数可创建一个特殊元素，它将被当作 XML 处理指令来进行序列化。 target 是包含 PI 目标的字符串。 text 如果给出则是包含 PI 内容的字符串。 返回一个表示处理指令的元素实例。

  请注意 `XMLParser` 会跳过输入中的处理指令而不会为其创建注释对象。 `ElementTree` 将只在当使用某个 `Element` 方法向树插入了处理指令节点时才会包含处理指令节点。

`xml.etree.ElementTree.``register_namespace`(prefix, uri)

  注册一个命名空间前缀。 这个注册表是全局的，并且任何对应给定前缀或命名空间 URI 的现有映射都会被移除。 prefix 是命名空间前缀。 uri 是命名空间 URI。 如果可能的话，这个命名空间中的标记和属性将附带给定的前缀来进行序列化。

  3.2 新版功能.

`xml.etree.ElementTree.``SubElement`(parent, tag, attrib={}, **extra)

  子元素工厂函数。 这个函数会创建一个元素实例，并将其添加到现有的元素。

  元素名、属性名和属性值可以是字节串或 Unicode 字符串。 parent 是父元素。 tag 是子元素名。 attrib 是一个可选的字典，其中包含元素属性。 extra 包含额外的属性，以关键字参数形式给出。 返回一个元素实例。

`xml.etree.ElementTree.``tostring`(element, encoding="us-ascii", method="xml", *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

  生成一个 XML 元素的字符串表示形式，包括所有子元素。 element 是一个 `Element` 实例。 encoding 1 是输出编码格式（默认为 US-ASCII）。 请使用 `encoding="unicode"` 来生成 Unicode 字符串（否则生成字节串）。 method 是 `"xml"`, `"html"` 或 `"text"` (默认为 `"xml"`)。 xml_declaration, default_namespace 和 short_empty_elements 具有与 `ElementTree.write()` 中一致的含义。 返回一个包含 XML 数据（可选）已编码的字符串。

  3.4 新版功能: short_empty_elements 形参。

  3.8 新版功能: xml_declaration 和 default_namespace 形参。

  在 3.8 版更改: `tostring()` 函数现在会保留用户指定的属性顺序。

`xml.etree.ElementTree.``tostringlist`(element, encoding="us-ascii", method="xml", *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

  生成一个 XML 元素的字符串表示形式，包括所有子元素。 element 是一个 `Element` 实例。 encoding 1 是输出编码格式（默认为 US-ASCII）。 请使用 `encoding="unicode"` 来生成 Unicode 字符串（否则生成字节串）。 method 是 `"xml"`, `"html"` 或 `"text"` (默认为 `"xml"`)。 xml_declaration, default_namespace 和 short_empty_elements 具有与 `ElementTree.write()` 中一致的含义。 返回一个包含 XML 数据（可选）已编码字符串的列表。 它并不保证任何特定的序列，除了 `b"".join(tostringlist(element)) == tostring(element)`。

  3.2 新版功能.

  3.4 新版功能: short_empty_elements 形参。

  3.8 新版功能: xml_declaration 和 default_namespace 形参。

  在 3.8 版更改: `tostringlist()` 函数现在会保留用户指定的属性顺序。

`xml.etree.ElementTree.``XML`(text, parser=None)

  根据一个字符串常量解析 XML 的节。 此函数可被用于在 Python 代码中嵌入“XML 字面值”。 text 是包含 XML 数据的字符串。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 `XMLParser` 解析器。 返回一个 `Element` 实例。

`xml.etree.ElementTree.``XMLID`(text, parser=None)

  根据一个字符串常量解析 XML 的节，并且还将返回一个将元素的 id:s 映射到元素的字典。 text 是包含 XML 数据的字符串。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 `XMLParser` 解析器。 返回一个包含 `Element` 实例和字典的元组。

## XInclude 支持

此模块通过 `xml.etree.ElementInclude` 辅助模块提供了对 XInclude 指令 的有限支持，这个模块可被用来根据元素树的信息在其中插入子树和文本字符串。

### 示例

以下是一个演示 XInclude 模块用法的例子。 要在当前文本中包括一个 XML 文档，请使用 `{http://www.w3.org/2001/XInclude}include` 元素并将 parse 属性设为 `"xml"`，并使用 href 属性来指定要包括的文档。

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

默认情况下，href 属性会被当作文件名来处理。 你可以使用自定义加载器来重载此行为。 还要注意标准辅助器不支持 XPointer 语法。

要处理这个文件，请正常加载它，并将根元素传给 `xml.etree.ElementTree` 模块:

    from xml.etree import ElementTree, ElementInclude

    tree = ElementTree.parse("document.xml")
    root = tree.getroot()

    ElementInclude.include(root)

ElementInclude 模块使用来自 source.xml 文档的根元素替代 `{http://www.w3.org/2001/XInclude}include` 元素。 结果看起来大概是这样:

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

如果省略了 parse 属性，它会取默认的 "xml"。 要求有 href 属性。

要包括文本文档，请使用 `{http://www.w3.org/2001/XInclude}include` 元素，并将 parse 属性设为 "text":

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

结果可能如下所示：

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

## 参考引用

### 函数

`xml.etree.ElementInclude.``default_loader`(href, parse, encoding=None)

  默认的加载器。 这个默认的加载器会从磁盘读取所包括的资源。 href 是一个 URL。 parse 是 "xml" 或 "text" 表示解析模式。 encoding 是可选的文本编码格式。 如果未给出，则编码格式为 `utf-8`。 返回已扩展的资源。 如果解析模式为 `"xml"`，则它是一个 ElementTree 实例。 如果解析模式为 "text"，则它是一个 Unicode 字符串。 如果加载器失败，它可以返回 None 或者引发异常。

`xml.etree.ElementInclude.``include`(elem, loader=None, base_url=None, max_depth=6)

  这个函数会扩展 XInclude 指令。 elem 是根元素。 loader 是可选的资源加载器。 如果省略，则它默认为 `default_loader()`。 如果给出，则它应当是一个实现了与 `default_loader()` 相同的接口的可调用对象。 base_url 是原文件的基准 URL，用于求解相对的包括文件引用。 max_depth 是递归包括的最大数量。 此限制是为了降低恶意内容爆破的风险。 传入一个负值可禁用此限制。

  返回已扩展的资源。 如果解析模式为 `"xml"`，则它是一个 ElementTree 实例。 如果解析模式为 "text"，则它是一个 Unicode 字符串。 如果加载器失败，它可以返回 None 或者引发异常。

  3.9 新版功能: base_url 和 max_depth 形参。

### 元素对象

class `xml.etree.ElementTree.``Element`(tag, attrib={}, **extra)

  元素类。 这个类定义了 Element 接口，并提供了这个接口的引用实现。

  元素名、属性名和属性值可以是字节串或 Unicode 字符串。 tag 是元素名。 attrib 是一个可选的字典，其中包含元素属性。 extra 包含额外的属性，以关键字参数形式给出。

  `tag`

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

  `text`
  `tail`

    这些属性可被用于存放与元素相关联的额外数据。 它们的值通常为字符串但也可以是任何应用专属的对象。 如果元素是基于 XML 文件创建的，text 属性会存放元素的开始标记及其第一个子元素或结束标记之间的文本，或者为 `None`，而 tail 属性会存放元素的结束标记及下一个标记之间的文本，或者为 `None`。 对于 XML 数据

        <a><b>1<c>2<d/>3</c></b>4</a>

    a 元素的 text 和 tail 属性均为 `None`，b 元素的 text 为 `"1"` 而 tail 为 `"4"`，c 元素的 text 为 `"2"` 而 tail 为 `None`，d 元素的 text 为 `None` 而 tail 为 `"3"`。

    要获取一个元素的内部文本，请参阅 `itertext()`，例如 `"".join(element.itertext())`。

    应用程序可以将任意对象存入这些属性。

  `attrib`

    一个包含元素属性的字典。 请注意虽然 attrib 值总是一个真正可变的 Python 字典，但 ElementTree 实现可以选择其他内部表示形式，并只在有需要时才创建字典。 为了发挥这种实现的优势，请在任何可能情况下使用下列字典方法。

  以下字典类方法作用于元素属性。

  `clear`()

    重设一个元素。 此方法会移除所有子元素，清空所有属性，并将 text 和 tail 属性设为 `None`。

  `get`(key, default=None)

    获取名为 key 的元素属性。

    返回属性的值，或者如果属性未找到则返回 default。

  `items`()

    将元素属性以 (name, value) 对序列的形式返回。 所返回属性的顺序任意。

  `keys`()

    将元素属性名称以列表的形式返回。 所返回名称的顺序任意。

  `set`(key, value)

    将元素的 key 属性设为 value。

  以下方法作用于元素的下级（子元素）。

  `append`(subelement)

    将元素 subelement 添加到此元素的子元素内部列表。 如果 subelement 不是一个 `Element` 则会引发 `TypeError`。

  `extend`(subelements)

    使用具有零个或多个元素的序列对象添加 subelements。 如果某个子元素不是 `Element` 则会引发 `TypeError`。

    3.2 新版功能.

  `find`(match, namespaces=None)

    查找第一个匹配 match 的子元素。 match 可以是一个标记名称或者 路径。 返回一个元素实例或 `None`。 namespaces 是可选的从命名空间前缀到完整名称的映射。 传入 `''` 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。

  `findall`(match, namespaces=None)

    根据标记名称或者 路径 查找所有匹配的子元素。 返回一个包含所有匹配元素按文档顺序排序的列表。 namespaces 是可选的从命名空间前缀到完整名称的映射。 传入 `''` 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。

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

    查找第一个匹配 match 的子元素的文本。 match 可以是一个标记名称或者 路径。 反回第一个匹配的元素的文本内容，或者如果元素未找到则返回 default。 请注意如果匹配的元素没有文本内容则会返回一个空字符串。 namespaces 是可选的从命名空间前缀到完整名称的映射。 传入 `''` 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。

  `insert`(index, subelement)

    将 subelement 插入到此元素的给定位置中。 如果 subelement 不是一个 `Element` 则会引发 `TypeError`。

  `iter`(tag=None)

    创建一个以当前元素为根元素的树的 iterator。 该迭代器将以文档（深度优先）顺序迭代此元素及其所有下级元素。 如果 tag 不为 `None` 或 `'*'`，则迭代器只返回标记为 tag 的元素。 如果树结构在迭代期间被修改，则结果是未定义的。

    3.2 新版功能.

  `iterfind`(match, namespaces=None)

    根据标记名称或者 路径 查找所有匹配的子元素。 返回一个按文档顺序产生所有匹配元素的可迭代对象。 namespaces 是可选的从命名空间前缀到完整名称的映射。

    3.2 新版功能.

  `itertext`()

    创建一个文本迭代器。 该迭代器将按文档顺序遍历此元素及其所有子元素，并返回所有内部文本。

    3.2 新版功能.

  `makeelement`(tag, attrib)

    创建一个与此元素类型相同的新元素对象。 请不要调用此方法，而应改用 `SubElement()` 工厂函数。

  `remove`(subelement)

    从元素中移除 subelement。 与 find* 方法不同的是此方法会基于实例的标识来比较元素，而不是基于标记的值或内容。

  `Element` 对象还支持下列序列类型方法以配合子元素使用: `__delitem__()`, `__getitem__()`, `__setitem__()`, `__len__()`。

  注意：不带子元素的元素将被检测为 `False`。 此行为将在未来的版本中发生变化。 请改用 `len(elem)` 或 `elem is None` 进行检测。

      element = root.find('foo')

      if not element:  # careful!
          print("element not found, or element has no subelements")

      if element is None:
          print("element not found")

  在 Python 3.8 之前，元素的 XML 属性的序列化顺序会通过按其名称排序来强制使其可被预期。 由于现在字典已保证是有序的，这个强制重排序在 Python 3.8 中已被移除以保留原本由用户代码解析或创建的属性顺序。

  通常，用户代码应当尽量不依赖于特定的属性顺序，因为 XML 信息设定 明确地排除了用属性顺序转递信息的做法。 代码应当准备好处理任何输入顺序。 对于要求确定性的 XML 输出的情况，例如加密签名或检测数据集等，可以通过规范化 `canonicalize()` 函数来进行传统的序列化。

  对于规范化输出不可用但仍然要求输出特定属性顺序的情况，代码应当设法直接按要求的顺序来创建属性，以避免代码阅读者产生不匹配的感觉。 如果这一点是难以做到的，可以在序列化之前应用以下写法来强制实现顺序不依赖于元素的创建:

      def reorder_attributes(root):
          for el in root.iter():
              attrib = el.attrib
              if len(attrib) > 1:
                  # adjust attribute order, e.g. by sorting
                  attribs = sorted(attrib.items())
                  attrib.clear()
                  attrib.update(attribs)

### ElementTree 对象

class `xml.etree.ElementTree.``ElementTree`(element=None, file=None)

  ElementTree 包装器类。 这个类表示一个完整的元素层级结构，并添加了一些对于标准 XML 序列化的额外支持。

  element 是根元素。 如果给出 XML file 则将使用其内容来初始化树结构。

  `_setroot`(element)

    替换该树结构的根元素。 这将丢弃该树结构的当前内容，并将其替换为给定的元素。 请小心使用。 element 是一个元素实例。

  `find`(match, namespaces=None)

    与 `Element.find()` 类似，从树的根节点开始。

  `findall`(match, namespaces=None)

    与 `Element.findall()` 类似，从树的根节点开始。

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

    与 `Element.findtext()` 类似，从树的根节点开始。

  `getroot`()

    返回这个树的根元素。

  `iter`(tag=None)

    创建并返回根元素的树结构迭代器。 该迭代器会以节顺序遍历这个树的所有元素。 tag 是要查找的标记（默认返回所有元素）。

  `iterfind`(match, namespaces=None)

    与 `Element.iterfind()` 类似，从树的根节点开始。

    3.2 新版功能.

  `parse`(source, parser=None)

    将一个外部 XML 节载入到此元素树。 source 是一个文件名或 file object。 parser 是可选的解析器实例。 如果未给出，则会使用标准的 `XMLParser` 解析器。 返回该节的根元素。

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

    将元素树以 XML 格式写入到文件。 file 为文件名，或是以写入模式打开的 file object。 encoding 1 为输出编码格式 (默认为 US-ASCII)。 xml_declaration 控制是否要将 XML 声明添加到文件中。 使用 `False` 表示从不添加，`True` 表示总是添加，`None` 表示仅在非 US-ASCII 或 UTF-8 或 Unicode 时添加 (默认为 `None`)。 default_namespace 设置默认 XML 命名空间 (用于 "xmlns")。 method 为 `"xml"`, `"html"` 或 `"text"` (默认为 `"xml"`)。 仅限关键字形参 short_empty_elements 控制不包含内容的元素的格式。 如为 `True` (默认值)，它们会被输出为单个自结束标记，否则它们会被输出为一对开始/结束标记。

    输出是一个字符串 (`str`) 或字节串 (`bytes`)。 由*encoding* 参数来控制。 如果 encoding 为 `"unicode"`，则输出是一个字符串；否则为字节串；请注意这可能与 file 的类型相冲突，如果它是一个打开的 file object 的话；请确保你不会试图写入字符串到二进制流或者反向操作。

    3.4 新版功能: short_empty_elements 形参。

    在 3.8 版更改: `write()` 方法现在会保留用户指定的属性顺序。

这是将要被操作的 XML 文件:

    <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>

修改第一段中的每个链接的 "target" 属性的示例:

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

### QName 对象

class `xml.etree.ElementTree.``QName`(text_or_uri, tag=None)

  QName 包装器。 这可被用来包装 QName 属性值，以便在输出中获得适当的命名空间处理。 text_or_uri 是一个包含 QName 值的字符串，其形式为 {uri}local，或者如果给出了 tag 参数，则为 QName 的 URI 部分。 如果给出了 tag，则第一个参数会被解读为 URI，而这个参数会被解读为本地名称。 `QName` 实例是不透明的。

### TreeBuilder 对象

class `xml.etree.ElementTree.``TreeBuilder`(element_factory=None, *, comment_factory=None, pi_factory=None, insert_comments=False, insert_pis=False)

  通用元素结构构建器。 此构建器会将包含 start, data, end, comment 和 pi 方法调用的序列转换为格式良好的元素结构。 你可以通过这个类使用一个自定义 XML 解析器或其他 XML 类格式的解析器来构建元素结构。

  如果给出 element_factory，它必须为接受两个位置参数的可调用对象：一个标记和一个属性字典。 它预期会返回一个新的元素实例。

  如果给出 comment_factory 和 pi_factory 函数，它们的行为应当像 `Comment()` 和 `ProcessingInstruction()` 函数一样创建注释和处理指令。 如果未给出，则将使用默认工厂函数。 当 insert_comments 和/或 insert_pis 为真值时，如果 comments/pis 在根元素之中（但不在其之外）出现则它们将被插入到树中。

  `close`()

    刷新构建器缓存，并返回最高层级的文档元素。 返回一个 `Element` 实例。

  `data`(data)

    将文本添加到当前元素。 data 为要添加的文本。 这应当是一个字节串或 Unicode 字符串。

  `end`(tag)

    关闭当前元素。 tag 是元素名称。 返回已关闭的元素。

  `start`(tag, attrs)

    打开一个新元素。 tag 是元素名称。 attrs 是包含元素属性的字典。 返回打开的元素。

  `comment`(text)

    使用给定的 text 创建一条注释。 如果 `insert_comments` 为真值，这还会将其添加到树结构中。

    3.8 新版功能.

  `pi`(target, text)

    使用给定的 target 名称和 text 创建一条注释。 如果 `insert_pis` 为真值，这还会将其添加到树结构中。

    3.8 新版功能.

  此外，自定义的 `TreeBuilder` 对象还提供了以下方法:

  `doctype`(name, pubid, system)

    处理一条 doctype 声明。 name 为 doctype 名称。 pubid 为公有标识。 system 为系统标识。 此方法不存在于默认的 `TreeBuilder` 类中。

    3.2 新版功能.

  `start_ns`(prefix, uri)

    在定义了 `start()` 回调的打开元素的该回调被调用之前，当解析器遇到新的命名空间声明时都会被调用。 prefix 对于默认命名空间为 `''` 或者在其他情况下为被声明的命名空间前缀名称。 uri 是命名空间 URI。

    3.8 新版功能.

  `end_ns`(prefix)

    在声明了命名空间前缀映射的元素的 `end()` 回调之后被调用，附带超出作用域的 prefix 的名称。

    3.8 新版功能.

class `xml.etree.ElementTree.``C14NWriterTarget`(write, *, with_comments=False, strip_text=False, rewrite_prefixes=False, qname_aware_tags=None, qname_aware_attrs=None, exclude_attrs=None, exclude_tags=None)

  C14N 2.0 写入器。 其参数与 `canonicalize()` 函数的相同。 这个类并不会构建树结构而是使用 write 函数将回调事件直接转换为序列化形式。

  3.8 新版功能.

### XMLParser对象

class `xml.etree.ElementTree.``XMLParser`(*, target=None, encoding=None)

  这个类是此模块的低层级构建单元。 它使用 `xml.parsers.expat` 来实现高效、基于事件的 XML 解析。 它可以通过 `feed()` 方法增量式地收受 XML 数据，并且解析事件会被转换为推送式 API —— 通过在 target 对象上发起对回调的调用。 如果省略 target，则会使用标准的 `TreeBuilder`。 如果给出了 encoding 1 ，该值将覆盖在 XML 文件中指定的编码格式。

  在 3.8 版更改: 所有形参现在都是 仅限关键字形参。 html 参数不再受支持。

  `close`()

    结束向解析器提供数据。 返回调用在构造期间传入的 target 的 `close()` 方法的结果；在默认情况下，这是最高层级的文档元素。

  `feed`(data)

    将数据送入解析器。 data 是编码后的数据。

  `XMLParser.feed()` 会为每个打开的标记调用 target 的 `start(tag, attrs_dict)` 方法，为每个关闭的标记调用它的 `end(tag)` 方法，并通过 `data(data)` 方法来处理数据。 有关更多受支持的回调方法，请参阅 `TreeBuilder` 类。 `XMLParser.close()` 会调用 target 的 `close()` 方法。 `XMLParser` 不仅仅可被用来构建树结构。 下面是一个统计 XML 文件最大深度的示例:

      >>> from xml.etree.ElementTree import XMLParser
      >>> class MaxDepth:                     # The target object of the parser
      ...     maxDepth = 0
      ...     depth = 0
      ...     def start(self, tag, attrib):   # Called for each opening tag.
      ...         self.depth += 1
      ...         if self.depth > self.maxDepth:
      ...             self.maxDepth = self.depth
      ...     def end(self, tag):             # Called for each closing tag.
      ...         self.depth -= 1
      ...     def data(self, data):
      ...         pass            # We do not need to do anything with data.
      ...     def close(self):    # Called when all data has been parsed.
      ...         return self.maxDepth
      ...
      >>> target = MaxDepth()
      >>> parser = XMLParser(target=target)
      >>> exampleXml = """
      ... <a>
      ...   <b>
      ...   </b>
      ...   <b>
      ...     <c>
      ...       <d>
      ...       </d>
      ...     </c>
      ...   </b>
      ... </a>"""
      >>> parser.feed(exampleXml)
      >>> parser.close()
      4

### XMLPullParser对象

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

  适用于非阻塞应用程序的拉取式解析器。 它的输入侧 API 与 `XMLParser` 的类似，但不是向回调目标推送调用，`XMLPullParser` 会收集一个解析事件的内部列表并让用户来读取它。 events 是要报告的事件序列。 受支持的事件字符串有 `"start"`, `"end"`, `"comment"`, `"pi"`, `"start-ns"` 和 `"end-ns"` ("ns" 事件被用于获取详细的命名空间信息)。 如果 events 被省略，则只报告 `"end"` 事件。

  `feed`(data)

    将给定的字节数据送入解析器。

  `close`()

    通知解析器数据流已终结。 不同于 `XMLParser.close()`，此方法总是返回 `None`。 当解析器被关闭时任何还未被获取的事件仍可通过 `read_events()` 被读取。

  `read_events`()

    返回包含在送入解析器的数据中遇到的事件的迭代器。 此迭代器会产生 `(event, elem)` 对，其中 event 是代表事件类型的字符串 (例如 `"end"`) 而 elem 是遇到的 `Element` 对象，或者以下的其他上下文值。

    - `start`, `end`: 当前元素。

    - `comment`, `pi`: 当前注释 / 处理指令

    - `start-ns`: 一个指定所声明命名空间映射的元组 `(prefix, uri)`。

    - `end-ns`: `None` (这可能在未来版本中改变)

    在之前对 `read_events()` 的调用中提供的事件将不会被再次产生。 事件仅当它们从迭代器中被取出时才会在内部队列中被消费，因此多个读取方对获取自 `read_events()` 的迭代器进行平行迭代将产生无法预料的结果。

  注解

  `XMLPullParser` 只会确保当发出 "start" 事件时看到了开始标记的 ">" 字符，因而在这个点上属性已被定义，但文本内容和末尾属性还未被定义。 这同样适用于元素的下级；它们可能存在也可能不存在。

  如果你需要已完全填充的元素，请改为查找 "end" 事件。

  3.4 新版功能.

  在 3.8 版更改: 增加了 `comment` 和 `pi` 事件。

### 异常

class `xml.etree.ElementTree.``ParseError`

  XML 解析器错误，由此模块中的多个解析方法在解析失败时引发。 此异常的实例的字符串表示将包含用户友好的错误消息。 此外，它将具有下列可用属性:

  `code`

    来自外部解析器的数字错误代码。 请参阅 `xml.parsers.expat` 的文档查看错误代码列表及它们的含义。

  `position`

    一个包含 line, column 数值的元组，指明错误发生的位置。

脚注

1(1,2,3,4)

  包括在 XML 输出中的编码格式字符串应当符合适当的标准。 例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。 请参阅 https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl 和 https://www.iana.org/assignments/character-sets/character-sets.xhtml。