使用python xml.sax解析XML实体

Question

我在用 Python 的 xml.sax 解析 XML 文件时，遇到一个问题：我的代码没有捕捉到实体（Entities）。为什么 skippedEntity() 或 resolveEntity() 这两个方法在下面的代码中没有报告任何信息呢？

import os
import cStringIO
import xml.sax
from xml.sax.handler import ContentHandler,EntityResolver,DTDHandler

#Class to parse and run test XML files
class TestHandler(ContentHandler,EntityResolver,DTDHandler):

    #SAX handler - Entity resolver
    def resolveEntity(self,publicID,systemID):
        print "TestHandler.resolveEntity: %s  %s" % (publicID,systemID)

    def skippedEntity(self, name):
        print "TestHandler.skippedEntity: %s" % (name)

    def unparsedEntityDecl(self,publicID,systemID,ndata):
        print "TestHandler.unparsedEntityDecl: %s  %s" % (publicID,systemID)

    def startElement(self,name,attrs):
        # name = string.lower(name)
        summary = '' + attrs.get('summary','')
        arg = '' + attrs.get('arg','')
        print 'TestHandler.startElement(), %s : %s (%s)' % (name,summary,arg)


def run(xml_string):
    try:
        parser = xml.sax.make_parser()
        stream = cStringIO.StringIO(xml_string)

        curHandler = TestHandler()
        parser.setContentHandler(curHandler)
        parser.setDTDHandler( curHandler )
        parser.setEntityResolver( curHandler )

        parser.parse(stream)
        stream.close()
    except (xml.sax.SAXParseException), e:
        print "*** PARSER error: %s" % e;

def main():
    try:
        XML = "<!DOCTYPE page[ <!ENTITY num 'foo'> ]><test summary='step: &num;'>Entity: &not;</test>"
        run(XML)
    except Exception, e:
      print 'FATAL ERROR: %s' % (str(e))

if __name__== '__main__':
    main()

运行代码后，我看到的结果是：

 TestHandler.startElement(), step: foo ()
 *** PARSER error: <unknown>:1:36: undefined entity

为什么我没有看到 # 的 resolveEntity 打印信息，或者 ¬ 的 skipped entry 打印信息呢？

Answer 1

这是你程序的一个修改版本，希望能让你明白。这个版本展示了一个所有 TestHandler 方法都会被调用的情况。

import StringIO
import xml.sax
from xml.sax.handler import ContentHandler

# Inheriting from EntityResolver and DTDHandler is not necessary
class TestHandler(ContentHandler):

    # This method is only called for external entities. Must return a value. 
    def resolveEntity(self, publicID, systemID):
        print "TestHandler.resolveEntity(): %s %s" % (publicID, systemID)
        return systemID

    def skippedEntity(self, name):
        print "TestHandler.skippedEntity(): %s" % (name)

    def unparsedEntityDecl(self, name, publicID, systemID, ndata):
        print "TestHandler.unparsedEntityDecl(): %s %s" % (publicID, systemID)

    def startElement(self, name, attrs):
        summary = attrs.get('summary', '')
        print 'TestHandler.startElement():', summary

def main(xml_string):
    try:
        parser = xml.sax.make_parser()
        curHandler = TestHandler()
        parser.setContentHandler(curHandler)
        parser.setEntityResolver(curHandler)
        parser.setDTDHandler(curHandler)

        stream = StringIO.StringIO(xml_string)
        parser.parse(stream)
        stream.close()
    except xml.sax.SAXParseException, e:
        print "*** PARSER error: %s" % e

XML = """<!DOCTYPE test SYSTEM "test.dtd">
<test summary='step: &num;'>Entity: &not;</test>
"""

main(XML)

test.dtd 文件的内容是：

<!ENTITY num "FOO">
<!ENTITY pic SYSTEM 'bar.gif' NDATA gif>

输出结果：

TestHandler.resolveEntity(): None test.dtd
TestHandler.unparsedEntityDecl(): None bar.gif
TestHandler.startElement(): step: FOO
TestHandler.skippedEntity(): not

加法

根据我的理解，skippedEntity 这个方法只有在使用外部 DTD 的时候才会被调用（至少我想不出反例；如果 文档能更清楚一些就好了）。

亚当在他的回答中提到，resolveEntity 这个方法只有在处理外部 DTD 时才会被调用。但这并不完全正确。resolveEntity 也会在处理内部或外部 DTD 子集中声明的外部实体引用时被调用。例如：

<!DOCTYPE test [
<!ENTITY num SYSTEM "bar.txt">
]>

这里 bar.txt 的内容可能是 FOO。在这种情况下，在属性值中引用实体是不可能的。

Answer 2

我觉得resolveEntity和skippedEntity这两个函数只会在外部DTD（文档类型定义）中被调用。我通过修改XML文件让它正常工作了。

XML = """<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE test SYSTEM "external.dtd" >
<test summary='step: &foo; &bar;'>Entity: &not;</test>
"""

external.dtd文件里有两个简单的实体声明。

<!ENTITY foo "bar">
<!ENTITY bar "foo">

另外，我把resolveEntity去掉了。

这样输出的结果是 -

TestHandler.startElement(), test : step: bar foo ()
TestHandler.skippedEntity: not

希望这对你有帮助。