使用Python库ElementTree解析XML文件

原文地址：http://blog.sheliw.com/blog/2015/09/05/shi-yong-pythonku-elementtreejie-xi-xmlwen-jian/

最近打算做一个比较两个XML文件的小工具，然后就找到了Python的ElementTree，这个库非常高效，API也非常简洁。Python也有很多其他库可以用来解析XML文件。具体的对比请看这篇文章。

http://pycoders-weekly-chinese.readthedocs.org/en/latest/issue6/processing-xml-in-python-with-element-tree.html

上面这篇文章也介绍了一些使用ElementTree基本的方法。但是我在实际使用过程中遇到了很多其他的问题，比如没法处理XML文件内的注释，转义符等。最后对这些问题我也找到了一些解决办法。

注释

<Text>
<!-- 注释 -->
</Text>

我做的工具是先读取一个XML文件，然后和另一个XML文件做比较，再做一些修改，最后再写回原文件中。但是ElementTree默认会把XML文件的注释给忽略了，也就是XML文件写回去时之前的注释全不见了。最后发现重写xml.etree.cElementTree.XMLTreeBuilder内部的_parser.CommentHandler方法就可以解决这个问题。

import xml.etree.cElementTree as ET

class CommentedTreeBuilder(ET.XMLTreeBuilder):
    def __init__(self):
        ET.XMLTreeBuilder.__init__(self)
        # assumes ElementTree 1.2.X
        self._parser.CommentHandler = self.handle_comment

def handle_comment(self, data):
    self._target.start(ET.Comment, {})
    self._target.data(data)
    self._target.end(ET.Comment)


with open(‘test.xml’, ‘r’) as f: 

        tree = ET.parse(f, parser=CommentedTreeBuilder())

但是这样解析XML文件之后，每一行的注释就会被当成一个普通的Element元素了，如果我们把它当作普通的元素去和其他元素比较，修改的时候就很容易出现问题。不过要判断这种注释元素也很简单，因为这种注释元素的tag类型并不是string类型。

root = tree.getroot()
for item in root:
    iscomment = (type(item.tag) != type('str'))

转义符

用ElementTree的write()方法默认会对以下几种字符做转义，也就是字符串写入XML文件时遇到这三个字符都会被替换。

 

     if "&" in text: 

         text = text.replace("&", "&") 

     if "<" in text: 

         text = text.replace("<", "<") 

     if ">" in text: 

         text = text.replace(">", ">") 

这样虽然能保证生成的XML文件格式不出错。但是如果我还想让生成的XML文件内对空格，双引号，单引号做转义的话就比较难了。就算我在使用write()方法生成XML文件前用 xml.sax.saxutils.escape()方法手动转义，write()方法也会把所有&字符给替换了。因为空格，双引号，单引号被转义后都是有&字符的。

最后没有想到其他好办法，只好把ElementTree库拷贝了一份出来，然后对内部的_escape_cdata方法做了一些修改，然后就大功告成了。如果你有好的办法，欢迎给我留言。