Python中xml.etree.ElementTree的使用示例_Python

xml.etree.elementtree（简称elementtree）是python标准库中用于处理xml文件的模块。它提供了简洁且高效的api，适用于解析、创建和修改xml文档。在需要处理xml数据的场景中，比如配置文件、数据交换格式、web服务响应等，elementtree都是非常实用的工具。

一、基本使用场景

解析xml文档：读取并解析xml文档，将其转换为树结构以便进一步操作。
创建xml文档：从头开始构建xml文档，并将其保存到文件中。
修改xml文档：在解析后的xml树中添加、删除或修改元素。
搜索与遍历xml树：查找特定的元素或属性，遍历整个xml树结构。

二、核心api与用法

1. 解析xml文档

解析字符串形式的xml：

import xml.etree.elementtree as et

xml_data = '''<data>
    <user>
        <name>john</name>
        <age>30</age>
    </user>
</data>'''

root = et.fromstring(xml_data)
print(root.tag)

输出：

data

解析xml文件：

import xml.etree.elementtree as et

tree = et.parse('example.xml')
root = tree.getroot()
print(root.tag)

输出：

data

2. 创建xml文档

import xml.etree.elementtree as et

# 创建根元素
root = et.element('data')

# 创建子元素
user = et.subelement(root, 'user')
name = et.subelement(user, 'name')
name.text = 'john'
age = et.subelement(user, 'age')
age.text = '30'

# 将xml树写入文件
tree = et.elementtree(root)
tree.write('output.xml', encoding='utf-8', xml_declaration=true)

生成的output.xml内容：

<?xml version='1.0' encoding='utf-8'?>
<data>
    <user>
        <name>john</name>
        <age>30</age>
    </user>
</data>

3. 修改xml文档

修改现有元素的文本内容：

import xml.etree.elementtree as et

tree = et.parse('output.xml')
root = tree.getroot()

# 修改元素内容
root.find('user/name').text = 'jane'

tree.write('output_modified.xml', encoding='utf-8', xml_declaration=true)

output_modified.xml内容：

<?xml version='1.0' encoding='utf-8'?>
<data>
    <user>
        <name>jane</name>
        <age>30</age>
    </user>
</data>

4. 搜索与遍历xml树

遍历所有子元素：

import xml.etree.elementtree as et

tree = et.parse('output.xml')
root = tree.getroot()

for child in root.iter():
    print(child.tag, child.text)

输出：

data none
user none
name john
age 30

查找特定元素：

import xml.etree.elementtree as et

tree = et.parse('output.xml')
root = tree.getroot()

name = root.find('user/name')
print(name.text)

输出：

john

三、进阶用法

1. 处理带有命名空间的xml

命名空间在复杂xml文档中非常常见，用于区分不同元素的作用域。

解析带有命名空间的xml：

import xml.etree.elementtree as et

xml_data = '''<root xmlns:h="http://www.w3.org/tr/html4/" xmlns:f="http://www.w3schools.com/furniture">
    <h:table>
        <h:tr>
            <h:td>apples</h:td>
            <h:td>bananas</h:td>
        </h:tr>
    </h:table>
    <f:table>
        <f:name>african coffee table</f:name>
        <f:width>80</f:width>
        <f:length>120</f:length>
    </f:table>
</root>'''

root = et.fromstring(xml_data)

# 使用命名空间解析
for table in root.findall('{http://www.w3.org/tr/html4/}table'):
    for td in table.findall('{http://www.w3.org/tr/html4/}td'):
        print(td.text)

输出：

apples
bananas

2. 使用xpath查找元素

虽然elementtree本身不支持完整的xpath语法，但提供了类似的路径查找功能。

import xml.etree.elementtree as et

xml_data = '''<root>
    <users>
        <user id="1">
            <name>john</name>
        </user>
        <user id="2">
            <name>jane</name>
        </user>
    </users>
</root>'''

root = et.fromstring(xml_data)

# 查找id为2的用户的名称
name = root.find('.//user[@id="2"]/name').text
print(name)

输出：

jane

3. 批量处理和转换xml

当需要处理大量的xml数据时，可以利用生成器或者批量处理方法来提高效率。

import xml.etree.elementtree as et

def parse_large_xml(file):
    context = et.iterparse(file, events=('start', 'end'))
    for event, elem in context:
        if event == 'end' and elem.tag == 'user':
            yield elem
            elem.clear()  # 清除元素以节省内存

for user in parse_large_xml('large_users.xml'):
    print(user.find('name').text)

四、常用技巧

1. 使用生成器高效解析大文件

如上所述，使用iterparse()和生成器可以有效节省内存并提高处理速度，适用于大文件的解析。

2. 自动缩进与格式化输出

默认情况下，elementtree生成的xml是无缩进的，可以通过手动调整生成xml的格式来使其更具可读性。

import xml.etree.elementtree as et

def indent(elem, level=0):
    i = "\n" + level*"  "
    if len(elem):
        if not elem.text or not elem.text.strip():
            elem.text = i + "  "
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
        for subelem in elem:
            indent(subelem, level+1)
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
    else:
        if level and (not elem.tail or not elem.tail.strip()):
            elem.tail = i

root = et.element("root")
child = et.subelement(root, "child")
indent(root)
tree = et.elementtree(root)
tree.write("output_pretty.xml", encoding="utf-8", xml_declaration=true)

生成的output_pretty.xml内容：

<?xml version='1.0' encoding='utf-8'?>
<root>
  <child />
</root>

3. 安全处理外部实体

在处理来自不受信任源的xml数据时，最好禁用外部实体，以防止xml外部实体注入（xxe）攻击。

import xml.etree.elementtree as et
from defusedxml.elementtree import parse, fromstring

# 安全地解析xml
tree = parse('example.xml')
root = tree.getroot()

# 或者
root = fromstring(xml_data)

defusedxml库提供了更安全的xml解析方法，防止常见的安全漏洞。

到此这篇关于python中xml.etree.elementtree的使用示例的文章就介绍到这了,更多相关python xml.etree.elementtree内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！