Python xml.etree.ElementTree读写xml文件实例

 　本文通过实例讲解 Python 中 xml.etree.ElementTree是如何读写，查找，修改，删除xml文件内容的。

以下例子基于如下xml 文件的内容

 1 <user>
 2     <name title="xml example">It is an xml example</name>
 3     <article name="My article">
 4       <algorithm name="a1">
 5         <interval name="n1">1000</interval>
 6      </algorithm>
 7     </article>
 8    <article name="Your article">
 9       <algorithm name="a2">
10         <interval name="n2">1001</interval>
11      </algorithm>
12     </article>
13     <profile>
14     <profile-name>profile_hard_easy</profile-name>
15     <level>
16     <level-value>1</level-value>
17     <level-type>hard</level-type>
18     </level>
19     <level>
20     <level-value>2</level-value>
21     <level-type>easy</level-type>
22     </level>
23     </profile>
24 </user>

xml.etree.ElementTree

Python 标准库中，提供了6种可以用于处理XML的包,本文举实例说明第6种
  1.xml.dom
  2.xml.dom.minidom
  3.xml.dom.pulldom
  4.xml.sax
  5.xml.parse.expat
  6.xml.etree.ElementTree(简称ET)

ET读取xml文件

ET提供了两个对象ElementTree将整个XML文档转化为树， Element则代表着树上的单个节点。对整个XML文档的交互（读取，写入，查找需要的元素）
一般是在 ElementTree层面进行的。对单个XML元素及其子元素，则是在 Element层面进行的。

#获取当前文件所在目录
print(os.path.dirname(__file__))
#路径拼接，得到xml 文件的路径
dirpath = os.path.join(os.path.dirname(__file__),"test2.xml")

#用ET.ElementTree 读取xml文件，将xml文件解析为tree
tree = ET.ElementTree(file=dirpath)
#获取xml 文件的根结点
root = tree.getroot()
#xml 的根结点是一个Element 对象.
'''
Element 对象常用的属性有:
Element.tag --输出标签的名称
Element.text --输出标签包含的内容
Element.attrib --标签的属性
'''
print(root) #输出: <Element 'user' at 0x000001C02A2DB818>
#查看xml根结点root的属性
print(root.tag,root.attrib) #输出: user {}, 根结点没有属性

 

查找xml元素

方法一：可以通过递归方式，遍历根结点的所有子元素，获取数中所有的元素

方法二：使用ElementTree iter() 方法遍历 tree的所有元素

方法三： 通过XPath 查找元素

#方法一：可以通过递归方式，遍历根结点的所有子元素，获取数中所有的元素
for child_root in root:
    print(child_root.tag,child_root.text,child_root.attrib)
'''
输出：
name 
       {}
article 
       {'name': 'My article'}
profile 
      {}
'''
#根据索引访问特定的子元素
print(root[1].tag,root[1].text,root[1].attrib)
'''
输出：
article 
       {'name': 'My article'}
'''

#方法二：使用ElementTree iter() 方法遍历 tree的所有元素
for elem in root.iter():
    print(elem.tag,elem.attrib)
    if elem.tag == "profile":
        print("=========Find it, I can do what I want")

#使用ElementTree iter() 方法，遍历指定tag的元素,找到自己感兴趣的属性

for sub_elem in root.iter(tag="article"):
    print(sub_elem.tag,sub_elem.attrib)
    
#方法三： 通过XPath 查找元素

'''
ElementTree 对象常用到的方法如下,它们的相同点是接收Xpath路径作为参数，不同点是
1. find 返回第一个匹配的子元素
2. findall 以列表的形式返回所有匹配的子元素
3. iterfind 则返回一个所有匹配元素的迭代器（iterator）

Xpath 使用例子：
1. 返回所有tag为article的元素：
findall("article")
2. 返回 tag为article下之下所有tag为algorithm的元素,注意格式必须为 父节点/一代子节点，而不能为父节点/二代子节点，比如article/interval 就会找不到
findall(article/algorithm)

'''
'''
1. find 输出：
algorithm
         {}
'''
for elem in root.find("article"):
    print(elem.tag,elem.text,elem.attrib)

'''
2. findall 和 iterfind 输出：
article
       {'name': 'My article'}
article
       {'name': 'Your article'}
'''
for elem in root.findall("article"):
    print(elem.tag,elem.text,elem.attrib)

for elem in root.findall("article"):
    print(elem.tag,elem.text,elem.attrib)

生成和更改xml文件

'''
ElementTree对象的write方法可以往xml写入内容
'''
#为根节点的第一个子元素增加属性 color=red
print(root[0].tag,root[0].attrib) #name {'title': 'xml example'}
root[0].set("color","red")
print(root[0].tag,root[0].attrib) #name {'title': 'xml example', 'color': 'red'}

#删掉根节点的其中一个子元素
i=0
for item in root:
    print(i,item.tag)
    i=i+1
del root[4] #删掉最后一个子元素 foot
i=0
for item in root:
    print(i,item.tag)
    i=i+1

#将修改后的文件写入到一个新的文件 test3.xml，新文档的元素属性顺序与原文档不同。
# 这是因为ET是以字典的形式保存属性的，而字典是一个无序的数据结构。同时 XML也不关注属性的顺序，故乱序的影响不大
tree.write(os.path.join(os.path.dirname(__file__),"test3.xml"))

构建一个新的xml文件

#生成根元素
root=ET.Element("root")
#生成子元素 A
a=ET.Element("A")
#增加元素A的子元素 child1
a_child=ET.SubElement(a,"child1")
a_child.text="I'm child of A"
#增加元素A的子元素 child2
a_child1=ET.SubElement(a,"child2")
#生成子元素B
b=ET.Element("B")
#增加元素B的子元素child1
b_child=ET.SubElement(b,"child1")
b_child.text="I'm child of B"
b_child.set("name","book") #set() 接收的是 key,value 形式

#将a和b 组成一个元组传入extend()方法中，元素 A和B作为根元素的子元素
root.extend((a,b))
trees=ET.ElementTree(root)
#将trees 写入到文件 test4.xml, 内容为 <root><A><child1>I'm child of A</child1><child2 /></A><B><child1 name="book">I'm child of B</child1></B></root>
trees.write(os.path.join(os.path.dirname(__file__),"test4.xml"))