Python基础(12) 使用ElementTree解析XML

0. 前言

• Python 的 xml 操作方式有好几种，我只关心最普通、最简单的，也就是 ElementTree 形式。
• 参考资料：Python 官方文档
• 本文只是简单实用，有及格方面不涉及
  • Pull API for non-blocking parsing
  • Parsing XML with Namespaces
  • XPath support

1. 解析操作

1.1. 读取xml文件

• 从文件路径读取
  • 假设已经有文件路径
  • 则可以通过 tree = ET.parse('country_data.xml')
  • 如果要获取根节点，则还要进行一步操作 root = tree.getroot()
• 根据文件内容读取
  • 假设已经将文件内容读取为字符串保存。
  • 则可以通过 root = ET.fromstring(xml_data_as_string) 直接获取根节点对象。

1.2. 获取节点以及相关信息

• 获取节点的名称：Element.tag
• 根据条件获取节点
  • Element.iter('node_name')
    • 获取迭代器，跌倒所有名称为 node_name的节点。
    • 会处理所有子节点、子节点的子节点，等等。
  • Element.findall(match)：获取所有匹配的节点。
  • Element.find(match)：获取第一个匹配的节点。

1.3. 获取属性与文本

• 获取节点属性的方法
  • Element.attrib，得到一个字典。
  • Element.get(key)：根据key获取属性值
• 获取文本（例如 <year>2020</year>）：Element.text

2. 修改文件

2.1. 基本流程

• 构建ElementTree对象。
• 通过一些方法修改ElementTree对象中的Element。具体有哪些后面稍微介绍下。
• 在修改了ElementTree对象后，调用ElementTree.write(file_path)方法，就可以将修改的内容保存到本地。

2.2. 修改ElementTree的方式

• 修改属性：Element.set(key, value)
  • 之前提到过，Element.get(key)就是获取属性。这个就是对应的set方法。
• 添加子元素：Element.append(son_element)
• 删除子元素：Element.remove(son_element)
• 为指定元素创建子元素：ET.SubElement(father_element, 'son_element_tag')
• 凭空创建元素：ET.Element('tag_name')

3. 举例

• 例子来自官方文档，这里只是稍微改一下。

• 假设有一个名为 country_data.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>

3.1. 解析实例

import xml.etree.ElementTree as ET

# 读取、解析文件，获取跟元素
tree = ET.parse('country_data.xml')
root = tree.getroot()

# 获取根元素的标签名称以及所有属性
# data
print(root.tag)
# country {'name': 'Liechtenstein'}
# country {'name': 'Singapore'}
# country {'name': 'Panama'}
print(root.attrib)

# 获取text
# 2008
print(root[0][1].text)

# 遍历名为 neighbor 的所有元素，并输出其对应的属性值
# {'name': 'Austria', 'direction': 'E'}
# {'name': 'Switzerland', 'direction': 'W'}
# {'name': 'Malaysia', 'direction': 'N'}
# {'name': 'Costa Rica', 'direction': 'W'}
# {'name': 'Colombia', 'direction': 'E'}
for neighbor in root.iter('neighbor'):
    print(neighbor.attrib)

# 一次性获取所有名为 country 的元素、然后遍历
# 寻找名为 rank 的子节点，获取其text
# 获取 country 元素中的 name 属性
# Liechtenstein 1
# Singapore 4
# Panama 68
for country in root.findall('country'):
    rank = country.find('rank').text
    name = country.get('name')
    print(name, rank)

3.2. 修改实例

import xml.etree.ElementTree as ET

# 读取、解析文件，获取跟元素
tree = ET.parse('country_data.xml')
root = tree.getroot()

# 修改 root

# 修改rank元素的值，并增加属性updated，属性值为yes
for rank in root.iter('rank'):
    new_rank = int(rank.text) + 1
    rank.text = str(new_rank)
    rank.set('updated', 'yes')

# 删除所有rank大于50的country元素
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')

3.3. 构建新的xml文件

a = ET.Element('a')
b = ET.SubElement(a, 'b')
c = ET.SubElement(a, 'c')
d = ET.SubElement(c, 'd')

# 获取普通xml文件字符串
# <a><b /><c><d /></c></a>
print(ET.dump(a))