xml.etree.ElementTree

Python 标准库之 xml.etree.ElementTree

简介

Element类型是一种灵活的容器对象，用于在内存中存储结构化数据。

［注意］xml.etree.ElementTree模块在应对恶意结构数据时显得并不安全。

每个element对象都具有以下属性：

 1 　　1. tag：string对象，表示数据代表的种类。
 2 
 3 　　2. attrib：dictionary对象，表示附有的属性。
 4 
 5 　　3. text：string对象，表示element的内容。
 6 
 7 　　4. tail：string对象，表示element闭合之后的尾迹。
 8 
 9 　　5. 若干子元素（child elements）。
10 
11 <tag attrib1=1>text</tag>tail
12   1     2        3         4

创建元素的方法有Element或者SubElement()，前者称作元素的构建函数(constructor)，用以构建任一独存的元素；后者称作元素的制造函数(factory function)，用以制造某一元素的子元素。

有了一串元素之后，使用ElementTree类来将其打包，把一串元素转换为xml文件或者从xml文件中解析出来。

若想加快速度，可以使用C语言编译的API xml.etree.cElementTree。

导入ElementTree

在使用xml.etree.ElementTree时，一般都按如下导入：

1 try:
2     import xml.etree.cElementTree as ET
3 except ImportError:
4     import xml.etree.ElementTree as ET

XML是中结构化数据形式，在ET中使用ElementTree代表整个XML文档，并视其为一棵树，Element代表这个文档树中的单个节点。

ET对象具有多种方法从不同来源导入数据，如下：

＃从硬盘的xml文件读取数据

1 import xml.etree.ElementTree as ET
2 tree = ET.parse('country_data.xml')    #载入数据
3 root = tree.getroot()    ＃获取根节点

＃从字符串读取数据

1 root = ET.fromstring(country_data_as_string)

［注意］fromstring()是直接获取string对象中的根节点，因此以上root其实是一个Element。

作为一个Element对象，本身是具有子元素，因此可以直接对Element进行迭代取值：

 1 >>> for child in root:
 2 ...   print child.tag, child.attrib
 3 ...
 4 country {'name': 'Liechtenstein'}
 5 country {'name': 'Singapore'}
 6 country {'name': 'Panama'}
 7 
 8 或者直接使用索引寻找子节点：
 9 >>> root[0][1].text
10 '2008'

Element中的遍历与查询

Element.iter(tag=None)：遍历该Element所有后代，也可以指定tag进行遍历寻找。

Element.findall(path)：查找当前元素下tag或path能够匹配的直系节点。

Element.find(path)：查找当前元素下tag或path能够匹配的首个直系节点。

Element.text: 获取当前元素的text值。

Element.get(key, default=None)：获取元素指定key对应的属性值，如果没有该属性，则返回default值。

Element对象

 1 class xml.etree.ElementTree.Element(tag, attrib={}, **extra)
 2 
 3 　　tag：string，元素代表的数据种类。
 4 　　text：string，元素的内容。
 5 　　tail：string，元素的尾形。
 6 　　attrib：dictionary，元素的属性字典。
 7 　　
 8 　　＃针对属性的操作
 9 　　clear()：清空元素的后代、属性、text和tail也设置为None。
10 　　get(key, default=None)：获取key对应的属性值，如该属性不存在则返回default值。
11 　　items()：根据属性字典返回一个列表，列表元素为(key, value）。
12 　　keys()：返回包含所有元素属性键的列表。
13 　　set(key, value)：设置新的属性键与值。
14 
15 　　＃针对后代的操作
16 　　append(subelement)：添加直系子元素。
17 　　extend(subelements)：增加一串元素对象作为子元素。＃python2.7新特性
18 　　find(match)：寻找第一个匹配子元素，匹配对象可以为tag或path。
19 　　findall(match)：寻找所有匹配子元素，匹配对象可以为tag或path。
20 　　findtext(match)：寻找第一个匹配子元素，返回其text值。匹配对象可以为tag或path。
21 　　insert(index, element)：在指定位置插入子元素。
22 　　iter(tag=None)：生成遍历当前元素所有后代或者给定tag的后代的迭代器。＃python2.7新特性
23 　　iterfind(match)：根据tag或path查找所有的后代。
24 　　itertext()：遍历所有后代并返回text值。
25 　　remove(subelement)：删除子元素。

ElementTree对象

 1 class xml.etree.ElementTree.ElementTree(element=None, file=None)
 2 　　element如果给定，则为新的ElementTree的根节点。
 3 
 4 　　_setroot(element)：用给定的element替换当前的根节点。慎用。
 5 　　
 6 　　＃ 以下方法与Element类中同名方法近似，区别在于它们指定以根节点作为操作对象。
 7 　　find(match)
 8 　　findall(match)
 9 　　findtext(match, default=None)
10 　　getroot()：获取根节点.
11 　　iter(tag=None)
12 　　iterfind(match)
13 　　parse(source, parser=None)：装载xml对象，source可以为文件名或文件类型对象.
14 　　write(file, encoding="us-ascii", xml_declaration=None, default_namespace=None,method="xml")

模块方法

1 xml.etree.ElementTree.Comment(text=None)

创建一个特别的element，通过标准序列化使其代表了一个comment。comment可以为bytestring或unicode。

1 xml.etree.ElementTree.dump(elem)

生成一个element tree，通过sys.stdout输出，elem可以是元素树或单个元素。这个方法最好只用于debug。

1 xml.etree.ElementTree.fromstring(text)

text是一个包含XML数据的字符串，与XML()方法类似，返回一个Element实例。

1 xml.etree.ElementTree.fromstringlist(sequence, parser=None)

从字符串的序列对象中解析xml文档。缺省parser为XMLParser，返回Element实例。

New in version 2.7.

xml.etree.ElementTree.iselement(element)

检查是否是一个element对象。

xml.etree.ElementTree.iterparse(source, events=None, parser=None)

将文件或包含xml数据的文件对象递增解析为element tree，并且报告进度。events是一个汇报列表，如果忽略，将只有end事件会汇报出来。

注意，iterparse()只会在看见开始标签的">"符号时才会抛出start事件，因此届时属性是已经定义了，但是text和tail属性在那时还没有定义，同样子元素也没有定义，因此他们可能不能被显示出来。如果你想要完整的元素，请查找end事件。

xml.etree.ElementTree.parse(source, parser=None)

将一个文件或者字符串解析为element tree。

xml.etree.ElementTree.ProcessingInstruction(target, text=None)

这个方法会创建一个特别的element，该element被序列化为一个xml处理命令。

xml.etree.ElementTree.register_namespace(prefix, uri)

注册命名空间前缀。这个注册是全局有效，任何已经给出的前缀或者命名空间uri的映射关系会被删除。

New in version 2.7.

xml.etree.ElementTree.SubElement(parent, tag, attrib={}, **extra)

子元素工厂，创建一个Element实例并追加到已知的节点。

xml.etree.ElementTree.tostring(element, encoding="us-ascii", method="xml")

生成一个字符串来表示表示xml的element，包括所有子元素。element是Element实例，method为"xml","html","text"。返回包含了xml数据的字符串。

xml.etree.ElementTree.tostringlist(element, encoding="us-ascii", method="xml")

生成一个字符串来表示表示xml的element，包括所有子元素。element是Element实例，method为"xml","html","text"。返回包含了xml数据的字符串列表。

New in version 2.7.

xml.etree.ElementTree.XML(text, parser=None)

从一个字符串常量中解析出xml片段。返回Element实例。

xml.etree.ElementTree.XMLID(text, parser=None)

从字符串常量解析出xml片段，同时返回一个字典，用以映射element的id到其自身。