Python 标准库之 xml.etree.ElementTree

Python中有多种xml处理API，常用的有xml.dom.*模块、xml.sax.*模块、xml.parser.expat模块和xml.etree.ElementTree模块（以下简称ET）。本文将主要介绍ET的使用，以及它的常用函数。其它模块的简介，请参照文献[1]。

ET使用Element表示xml中的节点、文本、注释等。其主要属性如下：

1. tag：string对象，表示数据代表的种类，当为节点时为节点名称。
2. text：string对象，表示element的内容。
3. attrib：dictionary对象，表示附有的属性。
4. tail：string对象，表示element闭合之后的尾迹。
5. 若干子元素（child elements）。

texttail
    1     3            2             4

PS: ET模块对于那些恶意构造的数据并不是安全的，如果需要解析数据最好了一下xml的弱点[2]。

一、导入ET

在Python标准库中，ElementTree有两种实现方式：一种是纯Python的实现xml.etree.ElementTree，另一种是速度更快一点的xml.etree.cElementTree。如果不确定环境中是否有cElementTree，可以使用如下的方式导入：

try:
    import xml.etree.cElementTree as ET
except ImportError:
    import xml.etree.ElementTree as ET

但从Python 3.3开始，会默认使用cElementTree来加快速度，但是之前的版本最好使用如上的代码，以提高代码的兼容性。

二、解析xml

假设我们现在有如下的xml

   
        1
        2008
        141100
       
       
   
   
        4
        2011
        59900
       
   
   
        68
        2011
        13600
       
       
   

有两种方式可以解析xml

1. 从文件中解析xml文件

>>> import xml.etree.cElementTree as ET
>>> tree = ET.ElementTree(file='doc1.xml')     #载入数据
>>> root = tree.getroot()     #获取根节点

2. 从内存字符串中解析xml

root = ET.fromstring(country_data_as_string)

其中第二种方式可以直接过去根节点。

三、数据的访问

>>> for child in root:
...   print child.tag, child.attrib
...
country {'name': 'Liechtenstein'}
country {'name': 'Singapore'}
country {'name': 'Panama'}

或者直接使用索引寻找子节点：
>>> root[0][1].text
'2008'

或者使用xpath方式进行遍历，但其支持部分xpath方法，其支持的xpath请参照[4]

>>> root.findall("./country/neighbor")

[, , , , ]

四、 处理xml流

如下的程序将从xml文件中一边读入xml一边解析，并将在遇到标签开始或标签结束的时候返回相应的事件。

for event, elem in ET.iterparse(sys.argv[2]):
    if event == 'end':
        if elem.tag == 'location' and elem.text == 'Zimbabwe':
            count += 1
    elem.clear() #  discard the element

这个程序将在检查到标签结束的时候，对指定的标签进行计数。最后的elem.clear()保证了，在解析的之后尽快的释放内存。

五、Element对象

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

  tag:string      元素代表的数据种类。
  text:string     元素的内容。
  tail:string      元素的尾形。
  attrib:dictionary     元素的属性字典。
 
  ＃针对属性的操作
  clear()          清空元素的后代、属性、text和tail也设置为None。
  get(key, default=None)     获取key对应的属性值，如该属性不存在则返回default值。
  items()         根据属性字典返回一个列表，列表元素为(key, value）。
  keys()           返回包含所有元素属性键的列表。
  set(key, value)     设置新的属性键与值。

  ＃针对后代的操作
  append(subelement)     添加直系子元素。
  extend(subelements)    增加一串元素对象作为子元素。＃python2.7新特性
  find(match)                  寻找第一个匹配子元素，匹配对象可以为tag或path。
  findall(match)               寻找所有匹配子元素，匹配对象可以为tag或path。
  findtext(match)             寻找第一个匹配子元素，返回其text值。匹配对象可以为tag或path。
  insert(index, element)   在指定位置插入子元素。
  iter(tag=None)              生成遍历当前元素所有后代或者给定tag的后代的迭代器。＃python2.7新特性
  iterfind(match)              根据tag或path查找所有的后代。
  itertext()                       遍历所有后代并返回text值。
  remove(subelement)      删除子元素。

六、ElementTree对象

class xml.etree.ElementTree.ElementTree(element=None, file=None)
  element如果给定，则为新的ElementTree的根节点。

  _setroot(element)：用给定的element替换当前的根节点。慎用。
 
  ＃  以下方法与Element类中同名方法近似，区别在于它们指定以根节点作为操作对象。
  find(match)
  findall(match)
  findtext(match, default=None)

  iter(tag=None)
  iterfind(match)
  parse(source, parser=None)     装载xml对象，source可以为文件名或文件类型对象

  getroot()     获取根节点
   write(file, encoding="us-ascii", xml_declaration=None, default_namespace=None,method="xml") 

七、模块方法-->用于生成xml文件

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

     ET.Comment(text=None)
2. 生成一个element tree，通过sys.stdout输出，elem可以是元素树或单个元素。这个方法最好只用于debug。 
     ET.dump(elem)
3. text是一个包含XML数据的字符串，与XML()方法类似，返回一个Element实例。 
     ET.fromstring(text)
4. 从字符串的序列对象中解析xml文档。缺省parser为XMLParser，返回Element实例。V2.7中新加属性 
     ET.fromstringlist(sequence, parser=None)
5. 检查是否是一个element对象。 

     ET.iselement(element)
6. 将文件或包含xml数据的文件对象递增解析为element tree，并且报告进度。events是一个汇报列表，如果忽略，将只有end事件会汇报出来。
     注意，iterparse()只会在看见开始标签的">"符号时才会抛出start事件，因此届时属性是已经定义了，但是text和tail属性在那时还没有定义，同样子元素也没有定义，因此他们可能不能被显示出来。如果你想要完整的元素，请查找end事件。
     ET.iterparse(source, events=None, parser=None)

7. 将一个文件或者字符串解析为element tree。 
     ET.parse(source, parser=None)
8. 这个方法会创建一个特别的element，该element被序列化为一个xml处理命令。 
     ET.ProcessingInstruction(target, text=None)
9. 注册命名空间前缀。这个注册是全局有效，任何已经给出的前缀或者命名空间uri的映射关系会被删除。 V2.7新加属性
     ET.register_namespace(prefix, uri)
10. 子元素工厂，创建一个Element实例并追加到已知的节点。 
     ET.SubElement(parent, tag, attrib={}, **extra)
11. 生成一个字符串来表示表示xml的element，包括所有子元素。element是Element实例，method为"xml", "html", "text"。 返回包含了xml数据的字符串。 
     ET.tostring(element, encoding="us-ascii", method="xml")

12. 生成一个字符串来表示表示xml的element，包括所有子元素。element是Element实例，method为"xml","html","text"。返回包含了xml数据的字符串列表。V2.7新添加属性
     ET.tostringlist(element, encoding="us-ascii", method="xml")
13. 从一个字符串常量中解析出xml片段。返回Element实例。 
     ET.XML(text, parser=None)
14. 从字符串常量解析出xml片段，同时返回一个字典，用以映射element的id到其自身。 
     ET.XMLID(text, parser=None)

注：本文的部分内容为参考文献[3]所翻译，本文主要重新调整了一下格式。官方的API帮助文档请参照[4].

参考文献：

[1]  用 ElementTree 在 Python 中解析 XML

[2]  XML vulnerablilities

[3]  Python 标准库之 xml.etree.ElementTree

[4]  xml.etree.ElementTree — The ElementTree XML API