ElementTree之Xml文档处理

• ElementTree： 表示整个XML层级结构
• Element： 表示树形结构中所有的父节点
• SubElement： 表示树形结构中所有的子节点

有些节点既是父节点，又是子节点

下面来看下这两个类的定义及其提供的函数：

Element类

class xml.etree.ElementTree.Element(tag, attrib={}, **extra)

Element类对应的是树形结构中的每个节点，对应的是XML文档中的标签对。我们上面提到过XML标签有以下几个特征，除了子标签外都有相应的属性与之对应：

标签特征	对应的类属性	数据类型
标签名称	tag	字符串
属性	attrib	字典，所有属性和属性值的集合
标签值	text	通常是字符串
与下一个标签之间的值	tail	通常是字符串
子标签	无	标签的父子关系是在SubElement中指定的

关于Element.text和Element.tail属性的说明：

• 它们可被用于保存于该Element相关的额外数据；
• 它们的值通常是字符串，但是也可以是任何应用特定的对象类型；
• 如果Element对象是由一个XML创建而来的，那么text属性保存的是这个element的开始标签与它的第一个子标签或结束标签之间的文本，或者是None；而tail保存的是这个element的结束标签与下一个标签之间的文件或None，可以看下面的例子。

<a><b>1<c>2<d/>3</c></b>4</a>

• element a 的text和tail属性值都是None；
• element b 的text属性值是1，tail属性值是4;
• element c 的text属性值是2， tail属性值是None；
• element d 的text属性值是None， tail的属性值是3；

Element类中用于操作标签属性attrib的方法（类似于字典的方法）：

# 以一个(name, value)的序列的形式返回该element所有属性，且属性在序列是随机的
items()

# 返回该element所有属性的名称列表，属性名称顺序随机
keys()

# 获取该element指定属性key的值
get(key, default=None)

# 设置该element指定属性的值
set(key, value)

# 重置当前element：删除所有的 subelemnts、清空所有属性、设置text和tail属性值为None
clear()

Element类中用于操作子标签（subelement）的方法：

# 向最后添加一个子标签
append(subelement)

# 向最后追加多个子标签，subelements是一个Element序列；这是Python 3.2中新增的方法
extends(subelements)

# 像该element的指定位置插入一个subelement
insert(index, subelement)

# 返回第一个与match匹配的subelement或None，match可以是一个tag名称（标签名称），也可以是一个path
find(match, namespaces=None)

# 返回所有与match匹配的subelement列表或None，match可以是一个tag名称（标签名称），也可以是一个path
findall(match, namespaces=None)

# 返回第一个与match匹配的subelement的text属性值，如果匹配到的element没有text属性则返回一个空字符串，如果没有匹配到subelement则返回default参数定义的值
findtext(match, default=None, namespaces=None)

# Python 3.2开始已将该方法废弃，请使用list(elem)或迭代
getchildren()

# Python 3.2开始已将该方法废弃，改用Element.iter()
getiterator(tag=None)

# 这是Python 3.2中新增的方法。以当前element作为根创建一个tree迭代器，该迭代器会议深度优先的方式迭代这个element及其下面的所有elements。如果tag不是None或'*'，则只有tag值等于tag参数所指定值的element才会被这个迭代器返回；如果树形结构在迭代过程中被修改，则结果为undefined。
iter(tag=None)

# 这是Python 3.2中新增的方法。查找与match参数指定的tag名称或path相匹配的所有subelements，返回一个以文档顺序产生所有匹配element的可迭代对象。
iterfind(match, namespaces=None)

# 这是Python 3.2中新增的方法。创建一个迭代器，这个迭代器以文档顺序循环当前element和所有subelements并返回所有内部文本。
itertext()

# 从当前element中移除指定的subelement
remove(subelement)

SubElement类

SubElement(parent, tag, attrib={}, **extra)

parent参数表示父节点（标签对），它应该是一个Element类的实例。SubElement的其他属性和函数与Element相同。

ElementTree类

ElementTree表示的是整个element层级关系，并且该类还添加了一些对标准XML序列化和反序列化的额外支持。

class xml.etree.ElementTree.ElementTree(element=None, file=None)

element： 是一个Element实例，表示root element；

file： 是一个XML文件文成，如果该参数被给出，则会以该文件的内容初始化树形层次结构；

下面是ElementTree提供的方法：

# 以指定的element实例替换当前tree的root element，相当于把整个XML的内容替换掉了
_setroot(element)

# 返回当前树形层级结构的root element
getroot()

# 与Element.find()功能相同，只是它是从树形结构的root element开始查找
find(match, namespaces=None)

# 与Element.findall()功能相同，只是它是从树形结构的root element开始查找
findall(match, namespaces=None)

# 与Element.findtext()功能相同，只是它是从树形结构的root element开始查找
findtext(match, default=None, namespaces=None)

# Python 3.2开始已将该方法废弃，改用ElementTree.iter()
getiterator(tag=None)

# Python 3.2新增的方法。为当前root element创建并返回一个树迭代器，该迭代器将会按顺序循环这个树形结构的中的所有与tag匹配的elements，默认返回所有elements
iter(tag=None)

# Python 3.2新增的方法。与Element.iterfind()功能相同，只是它是从树形结构的root element开始查找
iterfind(match, namespaces=None)

# 加载一个外部XML片断到当前element树并返回该XML片断的root element。source是一个文件名称或文件对象。parser是一个可选的parser实例，如果没有给出该参数，将会使用标准的XMLParser解析器。
parse(source, parser=None)

# 将当前element tree以XML形式写入一个文件中。
# file 是一个文件名称或一个以写模式打开的文件对象
# encoding 用于指定输出编码
# xml_declaration 用于控制师傅将一个XML声明也添加到文件中（False表示添加、True表示不添加、None表示只有编码不是"US-ASCII"或"UTF-8"或"Unicode"时才添加）
# default_namespace 设置默认的XML命名空间(“xmlns”)
# method 可取值为"xml"、"html"和"text"，默认为"xml"
# short_empty_elements 是唯一一个关键字参数，是Python 3.4新增加的参数。它用于控制那些不包含任何内容的elements的格式，如果该参数值为Ture则这些标签将会被输出为一个单独的自关闭标签（如: <a/>）,如果值为False则这些标签将会被输出为一个标签对（如：<a></a>）
write(file, encoding="us-ascii", xml_declaration=None, default_namespace=None, method="xml", *, short_empty_elements=True)

注意：

write()方法的输出可以是一个字符串(str)，可以可以是二进制(bytes)。这是受encoding参数控制的：

• 如果encoding参数值为"unicode"，则输出是一个字符串；
• 否则，输出时二进制字节。
  如果file是一个（以可写模式）打开的文件对象，这有可能会发生冲突。因此，我们需要确定不会尝试将一个字符串写入一个二进制流，反之亦然。

3. xml.etree.ElementTree模块提供的函数

xml.etree.ElementTree模块也直接提供了一些函数便于我们直接对XML进行操作，下面来介绍几个常用的函数：

# 解析包含XML数据的字符串，返回一个Element实例
xml.etree.ElementTree.fromstring(text)

# 生成并返回指定的Element实例对应的包含XML数据的字符串（encoding="unicode"）或字节流
# 参数讲解请参考上面的ElementTree类的write()方法
xml.etree.ElementTree.toString(element, encoding="us-ascii", method="xml", *, short_empty_elements=True)

# 解析包含XML数据的文件名或文件对象，返回一个ElementTree实例
xml.etree.ElementTree.parse(source, parser=None)

# 将XML数据以递增的方式解析到元素树中，并向用户报告发生了什么（类似SAX的回调机制），最终返回一个提供(event, elem)对的迭代器(iterator)。
# source 是一个包含XML数据的文件名称或文件对象
# events 是一个包含要报告的事件序列，这里支持的事件包括："start"、"end"、"start-ns"、"end-ns"(“ns”事件用于获取详细的命名空间信息)。如果event参数被省略，则仅报告"end"事件。
# parser是一个可选的解析器实例，如果为给出则使用标准的XMLParser解析器
xml.etree.ElementTree.iterparse(source, events=None, parser=None)

关于xml.etree.ElementTree.iterparse()方法的说明：

• 虽然它以递增的方式构建元素树，但是它仍然会锁定对source的读取操作。因此，它不适用于不能接受读阻塞的应用。
• 它只保证在发出一个“start”事件时，它已经看到了起始标签(tag)的">"结束字符，因此此时它定义了atrrib属性，但是text和tail属性的内容在那一时刻是没有被定义的（这同样适用于子元素）。如果你需要一个完全填充的元素，请查找“end”事件。