Pythonxml.parsers.expat使用Expat的快速XML解析

XMLParser对象¶

xmlparser 对象具有以下方法:

xmlparser.Parse(data[, isfinal])¶

解析字符串 data 的内容，调用适当的处理函数来处理解析后的数据。 在对此方法的最后一次调用时 isfinal 必须为真值；它允许以片段形式解析单个文件，而不是提交多个文件。 data 在任何时候都可以为空字符串。

xmlparser.ParseFile(file)¶

解析从对象 file 读取的 XML 数据。 file 仅需提供 read(nbytes) 方法，当没有更多数据可读时将返回空字符串。

xmlparser.SetBase(base)¶

设置要用于解析声明中的系统标识符的相对 URI 的基准。 解析相对标识符的任务会留给应用程序进行：这个值将作为 base 参数传递给 ExternalEntityRefHandler(), NotationDeclHandler() 和 UnparsedEntityDeclHandler() 函数。

xmlparser.GetBase()¶

返回包含之前调用 SetBase() 所设置的基准位置的字符串，或者如果未调用 SetBase() 则返回 None。

xmlparser.GetInputContext()¶

将生成当前事件的输入数据以字符串形式返回。 数据为包含文本的实体的编码格式。 如果被调用时未激活事件处理句柄，则返回值将为 None。

xmlparser.ExternalEntityParserCreate(context[, encoding])¶

创建一个“子”解析器，可被用来解析由父解析器解析的内容所引用的外部解析实体。 context 形参应当是传递给 ExternalEntityRefHandler() 处理函数的字符串，具体如下所述。 子解析器创建时 ordered_attributes 和 specified_attributes 会被设为此解析器的值。

xmlparser.SetParamEntityParsing(flag)¶

控制参数实体（包括外部 DTD 子集）的解析。 可能的 flag 值有 XML_PARAM_ENTITY_PARSING_NEVER, XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE 和 XML_PARAM_ENTITY_PARSING_ALWAYS。 如果该旗标设置成功则返回真值。

xmlparser.UseForeignDTD([flag])¶

调用时将 flag 设为真值（默认）将导致 Expat 调用 ExternalEntityRefHandler 时将所有参数设为 None 以允许加载替代的 DTD。 如果文档不包含文档类型声明，ExternalEntityRefHandler 仍然会被调用，但 StartDoctypeDeclHandler 和 EndDoctypeDeclHandler 将不会被调用。

为 flag 传入假值将将撤消之前传入真值的调用，除此之外没有其他影响。

此方法只能在调用 Parse() 或 ParseFile() 方法之前被调用；在已调用过这两个方法之后调用它会导致引发 ExpatError 且 code 属性被设为 errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]。

xmlparser 对象具有下列属性:

xmlparser.buffer_size¶

当 buffer_text 为真值时所使用的缓冲区大小。 可以通过将此属性赋一个新的整数值来设置一个新的缓冲区大小。 当大小发生改变时，缓冲区将被刷新。

xmlparser.buffer_text¶

将此属性设为真值会使得 xmlparser 对象缓冲 Expat 所返回的文本内容以尽可能地避免多次调用 CharacterDataHandler() 回调。 这可以显著地提升性能，因为 Expat 通常会将字符数据在每个行结束的位置上进行分块。 此属性默认为假值，但可以在任何时候被更改。

xmlparser.buffer_used¶

当 buffer_text 被启用时，缓冲区中存储的字节数。 这些字节数据表示以 UTF-8 编码的文本。 当 buffer_text 为假值时此属性没有任何实际意义。

xmlparser.ordered_attributes¶

将该属性设为非零整数会使得各个属性被报告为列表而非字典。 各个属性会按照在文档文本中的出现顺序显示。 对于每个属性，将显示两个列表条目：属性名和属性值。 （该模块的较旧版本也使用了此格式。） 默认情况下，该属性为假值；它可以在任何时候被更改。

xmlparser.specified_attributes¶

如果设为非零整数，解析器将只报告在文档实例中指明的属性而不报告来自属性声明的属性。 设置此属性的应用程序需要特别小心地使用从声明中获得的附加信息以符合 XML 处理程序的行为标准。 默认情况下，该属性为假值；它可以在任何时候被更改。

下列属性包含与 xmlparser 对象遇到的最近发生的错误有关联的值，并且一旦对 Parse() 或 ParseFile() 的调用引发了 xml.parsers.expat.ExpatError 异常就将只包含正确的值。

xmlparser.ErrorByteIndex¶

错误发生位置的字节索引号。

xmlparser.ErrorCode¶

指明问题的的数字代码。 该值可被传给 ErrorString() 函数，或是与在 errors 对象中定义的常量之一进行比较。

xmlparser.ErrorColumnNumber¶

错误发生位置的列号。

xmlparser.ErrorLineNumber¶

错误发生位置的行号。

下列属性包含 xmlparser 对象中关联到当前解析位置的值。 在回调报告解析事件期间它们将指示生成事件的字符序列的第一个字符的位置。 当在回调的外部被调用时，所指示的位置将恰好位于最后的解析事件之后（无论是否存在关联的回调）。

xmlparser.CurrentByteIndex¶

解析器输入的当前字节索引号。

xmlparser.CurrentColumnNumber¶

解析器输入的当前列号。

xmlparser.CurrentLineNumber¶

解析器输入的当前行号。

可被设置的处理句柄列表。 要在一个 xmlparser 对象 o 上设置处理句柄，请使用 o.handlername=func。 handlername 必须从下面的列表中获取，而 func 必须为接受正确数量参数的可调用对象。 所有参数均为字符串，除非另外指明。

xmlparser.XmlDeclHandler(version, encoding, standalone)¶

当解析 XML 声明时被调用。 XML 声明是 XML 建议适用版本、文档文本的编码格式，以及可选的“独立”声明的（可选）声明。 version 和 encoding 将为字符串，而 standalone 在文档被声明为独立时将为 1，在文档被声明为非独立时将为 0，或者在 standalone 短语被省略时则为 -1。 这仅适用于 Expat 的 1.95.0 或更新版本。

xmlparser.StartDoctypeDeclHandler(doctypeName, systemId, publicId, has_internal_subset)¶

当 Expat 开始解析文档类型声明 (<!DOCTYPE...) 时被调用。 doctypeName 会完全按所显示的被提供。 systemId 和 publicId 形参给出所指定的系统和公有标识符，如果被省略则为 None。 如果文档包含内部文档声明子集则 has_internal_subset 将为真值。 这要求 Expat 1.2 或更新的版本。

xmlparser.EndDoctypeDeclHandler()¶

当 Expat 完成解析文档类型声明时被调用。 这要求 Expat 1.2 或更新版本。

xmlparser.ElementDeclHandler(name, model)¶

为每个元素类型声明调用一次。 name 为元素类型名称，而 model 为内容模型的表示形式。

xmlparser.AttlistDeclHandler(elname, attname, type, default, required)¶

为一个元素类型的每个已声明属性执行调用。 如果一个属性列表声明声明了三个属性，这个处理句柄会被调用三次，每个属性一次。 elname 是声明所适用的元素的名称而 attname 是已声明的属性的名称。 属性类型是作为 type 传入的字符串；可能的值有 'CDATA', 'ID', 'IDREF', ... default 给出了当属性未被文档实例所指明时该属性的默认值，或是为 None，如果没有默认值 (#IMPLIED 值) 的话。 如果属性必须在文档实例中给出，则 required 将为真值。 这要求 Expat 1.95.0 或更新的版本。

xmlparser.StartElementHandler(name, attributes)¶

在每个元素开始时被调用。 name 是包含元素名称的字符串，而 attributes 是元素的属性。 如果 ordered_attributes 为真值，则属性为列表形式 (完整描述参见 ordered_attributes)。 否则为将名称映射到值的字典。

xmlparser.EndElementHandler(name)¶

在每个元素结束时被调用。

xmlparser.ProcessingInstructionHandler(target, data)¶

在每次处理指令时调用。

xmlparser.CharacterDataHandler(data)¶

针对字符数据调用。 此方法将被用于普通字符数据、CDATA 标记内容以及可忽略的空白符。 需要区分这几种情况的应用程序可以使用 StartCdataSectionHandler, EndCdataSectionHandler 和 ElementDeclHandler 回调来收集必要的信息。

xmlparser.UnparsedEntityDeclHandler(entityName, base, systemId, publicId, notationName)¶

针对未解析（NDATA）实体声明调用。 此方法仅存在于 Expat 库的 1. 2 版；对于更新的版本，请改用 EntityDeclHandler。 （下层 Expat 库中的对应函数已被声明为过时。）

xmlparser.EntityDeclHandler(entityName, is_parameter_entity, value, base, systemId, publicId, notationName)¶

针对所有实体声明被调用。 对于形参和内部实体，value 将为给出实体的声明内容的字符串；对于外部实体将为 None。 notationName 形参对于已解析实体将为 None，对于未解析实体则为标注的名称。 如果实体为形参实体则 is_parameter_entity 将为真值而如果为普通实体则为假值（大多数应用程序只需要关注普通实体）。 此方法仅从 1.95.0 版 Expat 库开始才可用。

xmlparser.NotationDeclHandler(notationName, base, systemId, publicId)¶

针对标注声明被调用。 notationName, base, systemId 和 publicId 如果给出则均应为字符串。 如果省略公有标识符，则 publicId 将为 None。

xmlparser.StartNamespaceDeclHandler(prefix, uri)¶

当一个元素包含命名空间声明时被调用。 命名空间声明会在为声明所在的元素调用 StartElementHandler 之前被处理。

xmlparser.EndNamespaceDeclHandler(prefix)¶

当到达包含命名空间声明的元素的关闭标记时被调用。 此方法会按照调用 StartNamespaceDeclHandler 以指明每个命名空间作用域的开始的逆顺序为元素上的每个命名空间声明调用一次。 对这个处理句柄的调用是在相应的 EndElementHandler 之后针对元素的结束而进行的。

xmlparser.CommentHandler(data)¶

针对注释被调用。 data 是注释的文本，不包括开头的 '<!--' 和末尾的 '-->'。

xmlparser.StartCdataSectionHandler()¶

在一个 CDATA 节的开头被调用。 需要此方法和 EndCdataSectionHandler 以便能够标识 CDATA 节的语法开始和结束。

xmlparser.EndCdataSectionHandler()¶

在一个 CDATA 节的末尾被调用。

xmlparser.DefaultHandler(data)¶

针对 XML 文档中没有指定适用处理句柄的任何字符被调用。 这包括了所有属于可被报告的结构的一部分，但未提供处理句柄的字符。

xmlparser.DefaultHandlerExpand(data)¶

这与 DefaultHandler() 相同，但不会抑制内部实体的扩展。 实体引用将不会被传递给默认处理句柄。

xmlparser.NotStandaloneHandler()¶

当 XML 文档未被声明为独立文档时被调用。 这种情况发生在出现外部子集或对参数实体的引用，但 XML 声明没有在 XML 声明中将 standalone 设为 yes 的时候。 如果这个处理句柄返回 0，那么解析器将引发 XML_ERROR_NOT_STANDALONE 错误。 如果这个处理句柄没有被设置，那么解析器就不会为这个条件引发任何异常。

xmlparser.ExternalEntityRefHandler(context, base, systemId, publicId)¶

为对外部实体的引用执行调用。 base 为当前的基准，由之前对 SetBase() 的调用设置。 公有和系统标识符 systemId 和 publicId 如果给出则圴为字符串；如果公有标识符未给出，则 publicId 将为 None。 context 是仅根据以下说明来使用的不透明值。

对于要解析的外部实体，这个处理句柄必须被实现。 它负责使用 ExternalEntityParserCreate(context) 来创建子解析器，通过适当的回调将其初始化，并对实体进行解析。 这个处理句柄应当返回一个整数；如果它返回 0，则解析器将引发 XML_ERROR_EXTERNAL_ENTITY_HANDLING 错误，否则解析将会继续。

如果未提供这个处理句柄，外部实体会由 DefaultHandler 回调来报告，如果提供了该回调的话。

ExpatError 异常¶

ExpatError 异常包含几个有趣的属性:

ExpatError.code¶

Expat 对于指定错误的内部错误号。 errors.messages 字典会将这些错误号映射到 Expat 的错误消息。 例如:

fromxml.parsers.expatimportParserCreate,ExpatError,errors
p=ParserCreate()
try:
p.Parse(some_xml_document)
exceptExpatErroraserr:
print("Error:",errors.messages[err.code])

errors 模块也提供了一些错误消息常量和一个将这些消息映射回错误码的字典 codes，参见下文。

ExpatError.lineno¶

检测到错误所在的行号。 首行的行号为 1。

ExpatError.offset¶

错误发生在行中的字符偏移量。 首列的列号为 0。

示例¶

以下程序定义了三个处理句柄，会简单地打印出它们的参数。:

importxml.parsers.expat
# 3 handler functions
defstart_element(name,attrs):
print('Start element:',name,attrs)
defend_element(name):
print('End element:',name)
defchar_data(data):
print('Character data:',repr(data))
p=xml.parsers.expat.ParserCreate()
p.StartElementHandler=start_element
p.EndElementHandler=end_element
p.CharacterDataHandler=char_data
p.Parse("""<?xml version="1.0"?>
<parent id="top"><child1 name="paul">Text goes here</child1>
<child2 name="fred">More text</child2>
</parent>""",1)

来自这个程序的输出是:

Startelement:parent{'id':'top'}
Startelement:child1{'name':'paul'}
Characterdata:'Text goes here'
Endelement:child1
Characterdata:'\n'
Startelement:child2{'name':'fred'}
Characterdata:'More text'
Endelement:child2
Characterdata:'\n'
Endelement:parent