ElementTree是 Python 常用的处理 XML 文件的类。本文将介绍使用 ElementTree 解析、查找、修改 XML 的方法。

一、引用方法

ElementTree 所在文件保存在 Lib/xml/etree/ElementTree.py，所以我们通过下面的代码引用它，之后就可以使用 ET. 来访问 ElementTree 中的函数。

1
import xml.etree.ElementTree as ET

二、一个 XML 例子

下面所有的操作都将下面这段 XML 为例，我们将它保存为sample.xml。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?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>

先对 XML 的格式做一些说明：

  • Tag： 使用 < 和 > 包围的部分，如 成为 start-tag，是 end-tags；
  • Element：被 Tag 包围的部分，如68，可以认为是一个节点，它可以有子节点；
  • Attribute：在 Tag 中可能存在的 name/value 对，如 中的 name=”Liechtenstein”，一般表示属性。

三、解析 XML

读入 XML 数据

首先读入 XML，有两种途径，从文件读入和从字符串读入。
从文件读入：

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

从字符串读入：

1
root = ET.fromstring(sample_as_string)

tree 和 root 分布是 ElementTree 中两个很重要的类的对象：

  • ElementTree
  • Element

查看 Tag 和 Attribute

这时得到的 root 是一个指向Element 对象，我们可以通过查看 root 的 tag 和 attrib 来验证这一点：

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

上面的代码说明了查看一个 Element 的 Tag 和 Attribute 的方法，Tag 是一个 字符串 ，而 Attribute 得到的是一个 字典。

另外，还可以使用

  • Element.get(AttributeName)

来代替 Element.attrib[AttributeName]来访问。

查看孩子

root.attrib 返回的是一个空字典，如果看 root 的孩子，可以得到非空的 attrib 字典。

1、使用 for…in…访问

1
2
for child in root:
    print child.tag, child.attrib

得到

country {‘name’: ‘Liechtenstein’}
country {‘name’: ‘Singapore’}
country {‘name’: ‘Panama’}

2、使用下标访问

如:

1
2
3
4
>>> print root[0].tag
country
>>> print root[0][0].tag
rank

3、使用 Tag 名称访问

下标访问的方法虽然简单，但是在未知 XML 具体结构的时候并不适用，通过 Tag 名称访问的方法更具有普适性。这里用到 Element 类的几个函数，分别是

  • Element.iter()
  • Element.findall()
  • Element.find()

这两个函数使用的场景有所差异：
Element.iter()用来寻找 所有 符合要求的 Tag，注意，这里查找的范围 是所有孩子和孩子的孩子 and so on。如果查看所有的 year，可以使用下面的代码：

1
2
for neighbor in root.iter('year'):
    print neighbor.text

返回

2008
2011
2011

Element.findall()只查找 直接的孩子 ，返回所有符合要求的 Tag 的 Element，而Element.find() 只返回符合要求的第一个 Element。如果查看 Singapore 的 year 的值，可以使用下面的代码：

1
2
3
4
for country in root.findall('country'):
        if country.attrib['name'] == 'Singapore':
            year = country.find('year')  # 使用 Element.find()
            print year.text

1
2
3
4
for country in root.findall('country'):
        if country.attrib['name'] == 'Singapore':
            years = country.findall('year')  # 使用 Element.findall()
            print years[0].text  # 注意和上段的区别

查看 Element 的值

我们可以直接用 Element.text 来得到这个 Element 的值。

四、修改 XML

前面已经介绍了如何获取一个 Element 的对象，以及查看它的 Tag、Attribute、值和它的孩子。下面介绍如何修改一个 Element 并对 XML 文件进行保存

修改 Element

修改 Element 可以直接访问 Element.text。
修改 Element 的 Attribute，也可以用来新增 Attribute：

Element.set(‘AttributeName’,’AttributeValue’)

新增孩子节点：

Element.append(childElement)

删除孩子节点：

Element.remove(childElement)

保存 XML

我们从文件解析的时候，我们用了一个 ElementTree 的对象 tree，在完成修改之后，还用 tree 来保存 XML 文件。

1
tree.write('output.xml')

构建 XML

ElementTree 提供了两个静态函数（直接用类名访问，这里我们用的是 ET）可以很方便的构建一个 XML，如：

1
2
3
4
5
6
7
root = ET.Element('data') 
    country = ET.SubElement(root,'country', {'name':'Liechtenstein'})
    rank = ET.SubElement(country,'rank')
    rank.text = '1'
    year = ET.SubElement(country,'year')
    year.text = '2008'
    ET.dump(root)

就可以得到

12008

五、XPath 支持

XPath 表达式用来在 XML 中定位 Element，下面给一个例子来说明：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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]")

参考

ElementTree 主页
ElementTree 的函数与类介绍

2014/5/30