Python创建、修改、保存XML文件
XML文件格式介绍
XML tree and elements
将XML文档解析为树(tree)
我们先从基础讲起。XML是一种结构化、层级化的数据格式,最适合体现XML的数据结构就是树。ET提供了两个对象:ElementTree将整个XML文档转化为树,Element则代表着树上的单个节点。对整个XML文档的交互(读取,写入,查找需要的元素),一般是在ElementTree层面进行的。对单个XML元素及其子元素,则是在Element层面进行的。
XML是一种固有的分层数据格式,最自然的表示方法是使用树ET。ET有两个类:
- ElementTree:表示整个XML文档为树,元素表示此树中的单个节点。与整个文档的交互(读取和写入文件)通常是在ElementTree级别上完成的。
- Element:与单个XML元素及其子元素的交互是在Element元素级别上完成的。
tree
和root
分别是ElementTree中两个很重要的类的对象:ElementTree和Element。
下面对XML文件的格式做一些说明:
- Tag: 使用
<>
包围的部分,如:<
表示:start-tag,>
表示:end-tags; - Element:被Tag包围的部分,如:
<rank>68</rank>
中的68,可以认为是一个节点,它可以有子节点; - Attribute:在Tag中可能存在的name/value对,如
<country name="Liechtenstein">
中的name=”Liechtenstein”,一般表示属性。
在Python中处理XML格式文件需要导入的第三方库:
# 导入第三方库
import xml.etree.ElementTree as ET
详细参考:xml.etree.ElementTree的官方文档
XML文件的常见操作
1. 读入xml格式的文件,并显示全部行数据
读入xml格式的文件,并显示全部行数据:
假设有.xml格式文件file_xml,现需要使用Python读入.xml格式文件,并显示全部行数据,执行代码如下:
open_file = open(file_xml) # file_xml为.xml格式文件
read_file = open_file.readlines() # 读入所有行数据
典型范例:
from xml.etree import ElementTree as ET
file_xml = r'/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/anno.xml'
open_file = open(file_xml)
read_file = open_file.readlines() # 读入所有行数据
print(read_file)
>>>
['<annotation>\n',
'\t<folder>id12_玻璃膜疣</folder>\n',
'\t<filename>014f80f346d72001267240b1a62f1b72.jpg</filename>\n',
'\t<path>/Users/edz/Documents/yandi_data/taishi_loading/load_image/原始TXT表/第一批七种病灶/id12_玻璃膜疣/014f80f346d72001267240b1a62f1b72.jpg</path>\n',
'\t<source>\n',
'\t\t<database>Unknown</database>\n',
'\t</source>\n',
'\t<size>\n',
'\t\t<width>1924</width>\n',
'\t\t<height>1556</height>\n',
'\t\t<depth>3</depth>\n',
'\t</size>\n',
'\t<segmented>0</segmented>\n',
'\t<object>\n',
'\t\t<name>id12</name>\n',
'\t\t<pose>Unspecified</pose>\n',
'\t\t<truncated>0</truncated>\n',
'\t\t<difficult>0</difficult>\n',
'\t\t<bndbox>\n',
'\t\t\t<xmin>1378</xmin>\n',
'\t\t\t<ymin>742</ymin>\n',
'\t\t\t<xmax>1700</xmax>\n',
'\t\t\t<ymax>1319</ymax>\n',
'\t\t</bndbox>\n',
'\t</object>\n',
'\t<object>\n',
'</annotation>\n']
2. 解析xml格式的文件
解析xml格式的文件:
欲解析xml格式的文件,需要先以另外一种方式读入一个XML模板文件(如:file_xml),方便后续以它为基础模板,进行增、删、改等操作,得到自定义的目标XML文件。
备注: 个人理解解析xml格式的文件与上边提到的读入xml文件的区别在于:
读入xml文件进行的是只读操作,无法对其进行后续的增、删、改等操作;而解析xml文件则是先读入一个模板xml文件,后续可以对其进行增、删、改等一系列神操作。
在解析xml格式的文件之前,读入模板XML文件(如:file_xml),有两种途径,从文件读入和从字符串读入。
1. 从文件读入: 通过tree = ET.parse(file_xml)
和root = tree.getroot()
两行代码实现,具体示例如下:
import xml.etree.ElementTree as ET
file_xml = r'/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/anno.xml'
tree = ET.parse(file_xml) # 类ElementTree
root = tree.getroot() # 类Element
print(root) # 这时得到的root是一个指向Element的对象
>>> <Element 'annotation' at 0x135444590>
2. 从字符串读入: 通过root = ET.fromstring(sample_as_string)
实现,不太推荐!!!
root = ET.fromstring(sample_as_string) # 没有尝试过
获取XML中的元素
查看一个Element的Tag
和Attribute
的方法
tree
和root
分别是ElementTree中两个很重要的类的对象:ElementTree和Element。
以解析XML文件的方式读入一个xlm文件后,得到的 root
是一个指向Element的对象 ,我们可以通过root.tag
和root.attrib
来分别查看root的tag
和attrib
,从而验证这一点,示例如下:
# - 查看root下的`Tag`和`Attribute`
root.tag
>>> 'data'
root.attrib
>>>{} # 字典为空,表示无属性
上面的代码说明了查看一个Element的Tag
和Attribute
的方法,Tag
是一个字符串,而Attribute
得到的是一个字典。
另外,还可以使用Element.get(AttributeName)
来代替Element.attrib[AttributeName]
来访问(此处的Element即:root)。
获取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'}
1.Element.findall():
只找到带有标签的元素,该标签是当前元素的直接子元素。
2.Element.find()
:找到第一个带有特定标签的子元素,例如:root.find('folder').text
可以查看指向Element的对象root的"folder"项标签对应的内容,即:”玻璃膜疣“。
3.Element.text
: 查看Element的值(或访问标签的内容), 使用root.find('filename').text
查看标签内容时,可以根据缩进层次不同,依次添加多个find(‘xxx’)级层,得到对应层级下的Element的值。
4.Element.get()
:访问标签的属性值
典型范例:
.xml格式的模板文件template_file
的内容如下:
<annotation>
<folder>玻璃膜疣</folder>
<filename>0002.jpg</filename>
<path>/Users/edz/Documents/yandi_data/taishi_loading/load_image/原始TXT表/第一批七种病灶/id12_玻璃膜疣/002.jpg</path>
<source>
<database>Unknown</database>
</source>
<size>
<width>1924</width>
<height>1556</height>
<depth>3</depth>
</size>
<segmented>0</segmented>
<object>
<name>id12</name>
<pose>Unspecified</pose>
<truncated>0</truncated>
<difficult>0</difficult>
<bndbox>
<xmin>1378</xmin>
<ymin>742</ymin>
<xmax>1700</xmax>
<ymax>1319</ymax>
</bndbox>
</object>
</annotation>
使用root.find('filename').text
查看标签内容,并根据缩进层次不同添加多个find(‘xxx’)级层,详细代码如下:
from lxml.etree import Element, SubElement, tostring, ElementTree
from xml.dom import minidom
# 修改自己的路径
template_file = r'/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/anno.xml'
# 通过读取模板xlm文件来导入这些数据:
tree.parse(template_file) # 调用parse()方法,返回解析树
root = tree.getroot() # 获取根节点
# 查看Element的值——我们可以直接用`Element.text`来得到这个Element的值。
# 使用root.find().text查看
root.find('filename').text # 第一层下每一项内容
>>>
0002.jpg
root.find('size').find('height').text # 查看第二层下每一项内容
>>>
1556
root.find('object').find('bndbox').find('xmin').text # 查看第三层下每一项内容
>>>
1378
# 使用root.findall('size')[i].findall('width')[i].text查看
print([root.findall('size')[i].findall('width')[i].text for i in range(len(root.findall('size')[i].findall('width')))]) # 列表生成式输出
# 使用root.iter('filename')循环查看:
for neighbor in root.iter('filename'):
print(neighbor.text)
修改XML文件——修改一个Element
前面已经介绍了如何获取一个Element的对象,以及查看它的Tag、Attribute、值和它的孩子。下面介绍如何修改一个Element并对XML文件进行保存。
修改Element:
- 修改Element可以直接访问
Element.text
。 - 修改Element的
Attribute
,也可以用来新增Attribute
,语法格式为:Element.set('AttributeName','AttributeValue')
,示例如下:
##Element.set('AttributeName','AttributeValue') # 通过修改Element的`Attribute`,实现新增`Attribute`
root[0].set('name','9999')
新增孩子节点:
Element.append(childElement)
删除孩子节点:
Element.remove(childElement)
保存XML文件
保存XML文件:
我们从文件解析的时候,我们用了一个ElementTree的对象tree
,在完成修改之后,还用tree
来保存最终的XML文件,语法格式为:tree=ET.ElementTree(root)
和tree.write(file_path)
两行代码实现。
tree=ET.ElementTree(root) # root为修改后的root
tree.write("/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/99.xml")
构建XML文件
利用ET,很容易就可以完成XML文档构建,并写入保存为文件。ElementTree对象的write方法就可以实现这个需求。
一般来说,有两种主要使用场景:
- 一是你先读取一个XML文档,进行修改,然后再将修改写入文档;
- 二是从头创建一个新XML文档。
构建XML文件:
ElementTree提供了两个静态函数(直接用类名访问,这里我们用的是ET)可以很方便的构建一个XML,语法格式为:root = ET.Element('data')
和b = ET.SubElement(root, 'b')
:用于创建新的子元素b。示例如下:
import xml.etree.ElementTree as ET
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'
tree=ET.ElementTree(root)
tree.write("99.xml")
创建的xml文件内容如下:
<data><country name="Liechtenstein"><rank>1</rank><year>2008</year></country></data>
完整练手实例
实例001:
Target: 本实例旨在帮助大家学习、了解XML文件的解析、元素查询等操作的使用:
准备工作: 下面这段XML文件,我们将它保存为文件sample.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>
功能实现:
(1)解析xml格式的文件:
import xml.etree.ElementTree as ET
#首先从文件读入:
file_xml = r'/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/anno.xml'
tree = ET.parse(file_xml) # 类ElementTree
root = tree.getroot() # 类Element
print(root) # 这时得到的root是一个指向Element的对象
>>> <Element 'annotation' at 0x135444590>
(2)查看一个Element的Tag
和Attribute
的方法:
# 读入xlm文件后得到的root是一个指向Element的对象,我们可以通过查看root的tag和attrib来验证这一点:
root.tag #`Tag`是一个字符串,
>>> 'data'
root.attrib # `Attribute`得到的是一个字典。
>>>{}
###另外,还可以使用`Element.get(AttributeName)`来代替`Element.attrib[AttributeName]`来访问。
(3)获取XML中的元素:
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'}
#1.`Element.findall():` 只找到带有标签的元素,该标签是当前元素的直接子元素。
#2.`Element.find()` :找到第一个带有特定标签的子元素。
#3.`Element.text`:访问标签的内容
#4.`Element.get()`:访问标签的属性值
(4)获取XML中的元素:
#修改Element可以直接访问Element.text。
#修改Element的Attribute,也可以用来新增Attribute,语法如下:Element.set('AttributeName','AttributeValue')
root[0].set('name','9999')
# 新增孩子节点:
Element.append(childElement)
# 删除孩子节点:
Element.remove(childElement)
实例002:
Target: 先打开一个定义好的.xlm格式的模板文件,之后将TXT文件中的标注框信息逐行读入,用于修改xlm文件模板对应的指标数据,最后将修改后的新xlm文件写出保存。
"""核心思想:先打开一个定义好的xlm文件模板,之后将TXT文件中的标注框信息逐行读入,用于修改xlm文件模板对应的指标数据,最后将修改后的新xlm文件写出保存。"""
import copy
from lxml.etree import Element, SubElement, tostring, ElementTree
import cv2
# 模板xlm文件的存储路径
template_file = r'/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/anno.xml'
path = r'/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/'
# TXT文件数据的原始格式
train_files = '014f80f346d72001267240b1a62f1b72.jpg id12 1.3418148e+03, 6.2916492e+02, 1.4483580e+03, 9.2253162e+02, 6.3271374e-01'
trainFile = train_files.split() # trainFile存放全量的原始数据
print('原始数据集格式:{}'.format(trainFile))
>>>
原始数据集格式:['014f80f346d72001267240b1a62f1b72.jpg', 'id12', '1.3418148e+03,', '6.2916492e+02,', '1.4483580e+03,', '9.2253162e+02,', '6.3271374e-01']
file_name = trainFile[0]
print(file_name)
>>>
014f80f346d72001267240b1a62f1b72.jpg
# 定义新的xlm文件的详细指标数据
label = trainFile[1]
xmin = trainFile[2]
ymin = trainFile[3]
xmax = trainFile[4]
ymax = trainFile[5]
############# 读取模板xlm文件——用于存放TXT文件内容:
tree.parse(template_file) # 调用parse()方法,返回解析树
root = tree.getroot() # 获取根节点
##########修改新的xlm文件的详细指标数据
# folder
root.find('folder').text = 'new_folders'
# 修改魔板xlm文件中的内容为目标结果
root.find('filename').text = file_name # 2.Element.find() :找到第一个带有特定标签的子元素。
# # path
root.find('path').text = path + file_name
# 查看部分修改结果
print(root.find('filename').text) # 第一层下每一项内容
print(root.find('path').text) # 第一层下每一项内容
print(root.find('size').find('height').text) # 查看第二层下每一项内容
print(root.find('object').find('bndbox').find('xmin').text) # 查看第三层下每一项内容
>>>
014f80f346d72001267240b1a62f1b72.jpg
/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/014f80f346d72001267240b1a62f1b72.jpg
1556
1378
# size
sz = root.find('size')
im = cv2.imread(path + file_name) # 读取图片信息
sz.find('height').text = str(im.shape[0])
sz.find('width').text = str(im.shape[1])
sz.find('depth').text = str(im.shape[2])
print('iamge height:',im.shape[0])
print('iamge width:',im.shape[1])
print('iamge depth:',im.shape[2])
>>>
iamge height: 1556
iamge width: 1924
iamge depth: 3
# object
obj = root.find('object')
obj.find('name').text = label
bb = obj.find('bndbox')
bb.find('xmin').text = xmin
bb.find('ymin').text = ymin
bb.find('xmax').text = xmax
bb.find('ymax').text = ymax
########## 校验修改后的root是否为新数据
root.find('object').find('bndbox').find('ymax').text
>>>
'9.2253162e+02,' # 符合预期
########## 保存新生成的xlm数据文件
tree=ET.ElementTree(root)
tree.write("/Users/edz/Documents/yandi_data/taishi_loading/to_xlm/99.xml")
参考链接: