"xml.parsers.expat" --- 使用 Expat 进行快速 XML 解析
****************************************************

======================================================================

备注:

  如果你需要解析不受信任或未经身份验证的数据，请参阅 XML 安全。

The "xml.parsers.expat" module is a Python interface to the Expat non-
validating XML parser. The module provides a single extension type,
"xmlparser", that represents the current state of an XML parser.
After an "xmlparser" object has been created, various attributes of
the object can be set to handler functions.  When an XML document is
then fed to the parser, the handler functions are called for the
character data and markup in the XML document.

此模块使用 "pyexpat" 模块来提供对 Expat 解析器的访问。直接使用
"pyexpat" 模块的方式已被弃用。

此模块提供了一个异常和一个类型对象：

exception xml.parsers.expat.ExpatError

   此异常会在 Expat 报错时被引发。请参阅 ExpatError 异常 一节了解有关
   解读 Expat 错误的更多信息。

exception xml.parsers.expat.error

   "ExpatError" 的别名。

xml.parsers.expat.XMLParserType

   来自 "ParserCreate()" 函数的返回值的类型。

"xml.parsers.expat" 模块包含两个函数：

xml.parsers.expat.ErrorString(errno)

   返回给定错误号 *errno* 的解释性字符串。

xml.parsers.expat.ParserCreate(encoding=None, namespace_separator=None)

   创建并返回一个新的 "xmlparser" 对象。如果指定了 *encoding*，它必须
   为指定 XML 数据所使用的编码格式名称的字符串。Expat 支持的编码格式没
   有 Python 那样多，而且它的编码格式库也不能被扩展；它支持 UTF-8,
   UTF-16, ISO-8859-1 (Latin1) 和 ASCII。如果给出了 *encoding* [1] 则
   它将覆盖隐式或显式指定的文档编码格式。

   通过 "ParserCreate()" 创建的解析器称为“根”解析器，就是说它们没有关
   联任何父解析器。非根解析器则是由
   "parser.ExternalEntityParserCreate" 创建的。

   可以选择让 Expat 为你做 XML 命名空间处理，这是通过提供
   *namespace_separator* 值来启用的。 该值必须是一个单字符的字符串；如
   果字符串的长度不合法则将引发 "ValueError" ("None" 被视为等同于省略)
   。 当命名空间处理被启用时，属于特定命名空间的元素类型名称和属性名称
   将被展开。传递给元素处理器 "StartElementHandler" 和
   "EndElementHandler" 的元素名称将为命名空间 URI，命名空间分隔符和名
   称的本地部分的拼接。 如果命名空间分隔符是一个零字节 ("chr(0)") 则命
   名空间 URI 和本地部分将被直接拼接而不带任何分隔符。

   举例来说，如果 *namespace_separator* 被设为空格符 ("' '") 并对以下
   文档进行解析：

      <?xml version="1.0"?>
      <root xmlns    = "http://default-namespace.org/"
            xmlns:py = "http://www.python.org/ns/">
        <py:elem1 />
        <elem2 xmlns="" />
      </root>

   "StartElementHandler" 将为每个元素获取以下字符串:

      http://default-namespace.org/ root
      http://www.python.org/ns/ elem1
      elem2

   由于 "pyexpat" 所使用的 "Expat" 库的限制，被返回的 "xmlparser" 实例
   只能被用来解析单个 XML 文档。请为每个文档调用 "ParserCreate" 来提供
   单独的解析器实例。

参见:

  The Expat XML Parser
     Expat 项目的主页。


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.SetReparseDeferralEnabled(enabled)

   警告:

     调用 "SetReparseDeferralEnabled(False)" 会对安全产生影响，详情见
     下文；在使用 "SetReparseDeferralEnabled" 方法之前请务必了解这些后
     果。

   Expat 2.6.0 引入了一种名为"重新解析延迟"的安全机制，这种机制可避免
   因重新解析大量词元的二次方运行时间而导致的拒绝服务，而是会在默认情
   况下延迟对未完成词元的重新解析直至达到足够的输入量。 由于这种延迟，
   已注册的处理器有可能 — 具体取决于推送到 Expat 的输入块大小 — 不会在
   向解析器推送新输入后立即被调用。 如果希望获得即时反馈并接管防止因大
   量词元导致的拒绝服务的责任，可以调用
   "SetReparseDeferralEnabled(False)" 暂时或完全禁用当前 Expat 解析器
   实例的重新解析延迟。调用 "SetReparseDeferralEnabled(True)" 可以再次
   启用重新解析延迟。

   "SetReparseDeferralEnabled()" has been backported to some prior
   releases of CPython as a security fix. Check for availability using
   "hasattr()" if used in code running across a variety of Python
   versions.

   Added in version 3.13.

xmlparser.GetReparseDeferralEnabled()

   返回当前是否为给定的 Expat 解析器实例启用了重新解析延迟。

   Added in version 3.13.

"xmlparser" objects have the following methods to tune protections
against some common XML vulnerabilities.

xmlparser.SetBillionLaughsAttackProtectionActivationThreshold(threshold, /)

   Sets the number of output bytes needed to activate protection
   against billion laughs attacks.

   The number of output bytes includes amplification from entity
   expansion and reading DTD files.

   Parser objects usually have a protection activation threshold of 8
   MiB, but the actual default value depends on the underlying Expat
   library.

   如果此方法是在 non-root 解析器上调用则会引发 "ExpatError"。对应的
   "lineno" 和 "offset" 不应被使用因为它们可能没有特别意义。

   "SetBillionLaughsAttackProtectionActivationThreshold()" has been
   backported to some prior releases of CPython as a security fix.
   Check for availability using "hasattr()" if used in code running
   across a variety of Python versions.

   备注:

     Activation thresholds below 4 MiB are known to break support for
     DITA 1.3 payload and are hence not recommended.

   Added in version 3.15.

xmlparser.SetBillionLaughsAttackProtectionMaximumAmplification(max_factor, /)

   Sets the maximum tolerated amplification factor for protection
   against billion laughs attacks.

   The amplification factor is calculated as "(direct + indirect) /
   direct" while parsing, where "direct" is the number of bytes read
   from the primary document in parsing and "indirect" is the number
   of bytes added by expanding entities and reading of external DTD
   files.

   The *max_factor* value must be a non-NaN "float" value greater than
   or equal to 1.0. Peak amplifications of factor 15,000 for the
   entire payload and of factor 30,000 in the middle of parsing have
   been observed with small benign files in practice. In particular,
   the activation threshold should be carefully chosen to avoid false
   positives.

   Parser objects usually have a maximum amplification factor of 100,
   but the actual default value depends on the underlying Expat
   library.

   如果此方法是在 non-root 解析器上调用或者如果 *max_factor* 是在有效
   范围之外则会引发 "ExpatError"。对应的 "lineno" 和 "offset" 不应被使
   用因为它们可能没有特别意义。

   "SetBillionLaughsAttackProtectionMaximumAmplification()" has been
   backported to some prior releases of CPython as a security fix.
   Check for availability using "hasattr()" if used in code running
   across a variety of Python versions.

   备注:

     The maximum amplification factor is only considered if the
     threshold that can be adjusted by
     "SetBillionLaughsAttackProtectionActivationThreshold()" is
     exceeded.

   Added in version 3.15.

xmlparser.SetAllocTrackerActivationThreshold(threshold, /)

   设置动态内存的分配字节数以激活对不适当地使用 RAM 的保护机制。

   Parser objects usually have an allocation activation threshold of
   64 MiB, but the actual default value depends on the underlying
   Expat library.

   如果此方法是在 non-root 解析器上调用则会引发 "ExpatError"。对应的
   "lineno" 和 "offset" 不应被使用因为它们可能没有特别意义。

   "SetAllocTrackerActivationThreshold()" has been backported to some
   prior releases of CPython as a security fix. Check for availability
   using "hasattr()" if used in code running across a variety of
   Python versions.

   Added in version 3.15.

xmlparser.SetAllocTrackerMaximumAmplification(max_factor, /)

   设置直接输入与已分配动态内存字节数量之间的最大放大系数。

   该放大系数在解析时将被计算为 "allocated / direct"，其中 "direct" 是
   在解析中从原始文档读取的字节数量而 "allocated" 是在解析器层级结构中
   已分配的动态内存字节数量。

   *max_factor* 值必须是一个大于等于 1.0 的非 NaN "float" 值。在实践中
   大于 100.0 的放大系数可能出现于解析开始的时候，即使是良性的文件也不
   能避免。具体而言，激活阈值应当谨慎选择以避免假阳性结果。

   Parser objects usually have a maximum amplification factor of 100,
   but the actual default value depends on the underlying Expat
   library.

   如果此方法是在 non-root 解析器上调用或者如果 *max_factor* 是在有效
   范围之外则会引发 "ExpatError"。对应的 "lineno" 和 "offset" 不应被使
   用因为它们可能没有特别意义。

   "SetAllocTrackerMaximumAmplification()" has been backported to some
   prior releases of CPython as a security fix. Check for availability
   using "hasattr()" if used in code running across a variety of
   Python versions.

   备注:

     最大放大系数只有在超出了可由
     "SetAllocTrackerActivationThreshold()" 调整的阈值时才会被纳入考虑
     。

   Added in version 3.15.

"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)

   Called when Expat begins parsing the document type declaration
   ("<!DOCTYPE ...").  The *doctypeName* is provided exactly as
   presented.  The *systemId* and *publicId* parameters give the
   system and public identifiers if specified, or "None" if omitted.
   *has_internal_subset* will be true if the document contains an
   internal document declaration subset. This requires Expat version
   1.2 or newer.

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" 回调来收集必要的信息。请注意字符数据即使很短可
   能会被分块并且你可能会收到多个对 "CharacterDataHandler()" 的调用。
   请将 "buffer_text" 实例属性设为 "True" 来避免此情况。

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)

   警告:

     如果 "xmlparser" 被用于用户提供的 XML 内容则实现一个访问本地文件
     和/或网络的处理器可能导致面对 外部实体攻击 时存在缺陷。 请在实现
     此处理器之前仔细考虑你的 威胁模型。

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

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

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


ExpatError 异常
===============

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

ExpatError.code

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

      from xml.parsers.expat import ParserCreate, ExpatError, errors

      p = ParserCreate()
      try:
          p.Parse(some_xml_document)
      except ExpatError as err:
          print("Error:", errors.messages[err.code])

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

ExpatError.lineno

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

ExpatError.offset

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


示例
====

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

   import xml.parsers.expat

   # 3 处理器函数
   def start_element(name, attrs):
       print('Start element:', name, attrs)
   def end_element(name):
       print('End element:', name)
   def char_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)

来自这个程序的输出是:

   Start element: parent {'id': 'top'}
   Start element: child1 {'name': 'paul'}
   Character data: 'Text goes here'
   End element: child1
   Character data: '\n'
   Start element: child2 {'name': 'fred'}
   Character data: 'More text'
   End element: child2
   Character data: '\n'
   End element: parent


内容模型描述
============

内容模型是使用嵌套的元组来描述的。每个元组包含四个值：类型、限定符、名
称和一个子元组。子元组就是附加的内容模型描述。

The values of the first two fields are constants defined in the
"xml.parsers.expat.model" module.  These constants can be collected in
two groups: the model type group and the quantifier group.

模型类型组中的常量有：

xml.parsers.expat.model.XML_CTYPE_ANY

   模型名称所指定的元素被声明为具有 "ANY" 内容模型。

xml.parsers.expat.model.XML_CTYPE_CHOICE

   命名元素允许从几个选项中选择；这被用于 "(A | B | C)" 形式的内容模型
   。

xml.parsers.expat.model.XML_CTYPE_EMPTY

   被声明为 "EMPTY" 的元素具有此模型类型。

xml.parsers.expat.model.XML_CTYPE_MIXED

xml.parsers.expat.model.XML_CTYPE_NAME

xml.parsers.expat.model.XML_CTYPE_SEQ

   代表彼此相连的一系列模型的模型用此模型类型来指明。这被用于 "(A, B,
   C)" 形式的模型。

限定符组中的常量有：

xml.parsers.expat.model.XML_CQUANT_NONE

   未给出限定符，这样它可以只出现一次，例如 "A"。

xml.parsers.expat.model.XML_CQUANT_OPT

   模型是可选的：它可以出现一次或完全不出现，例如 "A?"。

xml.parsers.expat.model.XML_CQUANT_PLUS

   模型必须出现一次或多次 (例如 "A+")。

xml.parsers.expat.model.XML_CQUANT_REP

   模型必须出现零次或多次，例如 "A*"。


Expat 错误常量
==============

The following constants are provided in the "xml.parsers.expat.errors"
module.  These constants are useful in interpreting some of the
attributes of the "ExpatError" exception objects raised when an error
has occurred. Since for backwards compatibility reasons, the
constants' value is the error *message* and not the numeric error
*code*, you do this by comparing its "code" attribute with
"errors.codes[errors.XML_ERROR_*CONSTANT_NAME*]".

"errors" 模块具有以下属性：

xml.parsers.expat.errors.codes

   将字符串描述映射到其错误代码的字典。

   Added in version 3.2.

xml.parsers.expat.errors.messages

   将数字形式的错误代码映射到其字符串描述的字典。

   Added in version 3.2.

xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY

xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF

   属性值中指向一个外部实体而非内部实体的实体引用。

xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF

   指向一个在 XML 不合法的字符的字符引用 (例如，字符 "0" 或 '"&#0;"')
   。

xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF

   指向一个使用标注声明，因而无法被解析的实体的实体引用。

xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE

   一个属性在一个开始标记中被使用超过一次。

xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING

xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN

   当一个输入字节无法被正确分配给一个字符时引发；例如，在 UTF-8 输入流
   中的 NUL 字节 (值为 "0")。

xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT

   在文档元素之后出现空白符以外的内容。

xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI

   在输入数据开始位置以外的地方发现 XML 声明。

xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS

   文档不包含任何元素（XML 要求所有文档都包含恰好一个最高层级元素）。

xml.parsers.expat.errors.XML_ERROR_NO_MEMORY

   Expat 无法在内部分配内存。

xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF

   在不被允许的位置发现一个参数实体引用。

xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR

   在输入中发现一个不完整的字符。

xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF

   一个实体引用包含了对同一实体的另一个引用；可能是通过不同的名称，并
   可能是间接的引用。

xml.parsers.expat.errors.XML_ERROR_SYNTAX

   遇到了某个未指明的语法错误。

xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH

   一个结束标记不能匹配到最内层的未关闭开始标记。

xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN

   某些记号（例如开始标记）在流结束或遇到下一个记号之前还未关闭。

xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY

   对一个未定义的实体进行了引用。

xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING

   文档编码格式不被 Expat 所支持。

xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION

   一个 CDATA 标记节还未关闭。

xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING

xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE

   解析器确定文档不是“独立的”但它却在 XML 声明中声明自己是独立的，并且
   "NotStandaloneHandler" 被设置为返回 "0"。

xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE

xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE

xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD

   请求了一个需要已编译 DTD 支持的操作，但 Expat 被配置为不带 DTD 支持
   。 此错误绝不应被 "xml.parsers.expat" 模块的标准构建版所报告。

xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING

   在解析开始之后请求一个只能在解析开始之前执行的行为改变。此错误（目
   前）只能由 "UseForeignDTD()" 所引发。

xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX

   当命名空间处理被启用时发现一个未声明的前缀。

xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX

   文档试图移除与某个前缀相关联的命名空间声明。

xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE

   一个参数实体包含不完整的标记。

xml.parsers.expat.errors.XML_ERROR_XML_DECL

   文档完全未包含任何文档元素。

xml.parsers.expat.errors.XML_ERROR_TEXT_DECL

   解析一个外部实体中的文本声明时出现错误。

xml.parsers.expat.errors.XML_ERROR_PUBLICID

   在公有 id 中发现不被允许的字符。

xml.parsers.expat.errors.XML_ERROR_SUSPENDED

   在挂起的解析器上请求执行操作，但未获得允许。这包括提供额外输入或停
   止解析器的尝试。

xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED

   在解析器未被挂起的时候执行恢复解析器的尝试。

xml.parsers.expat.errors.XML_ERROR_ABORTED

   此错误不应当被报告给 Python 应用程序。

xml.parsers.expat.errors.XML_ERROR_FINISHED

   在一个已经完成解析输入的解析器上请求执行操作，但未获得允许。这包括
   提供额外输入或停止解析器的尝试。

xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE

xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML

   有人试图撤销保留的命名空间前缀 "xml" 或将其绑定到另一个命名空间 URI
   。

xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS

   有人试图声明或撤销保留的命名空间前缀 "xmlns"。

xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI

   有人试图将一个保留的命名空间前缀 "xml" 和 "xmlns" 的 URI 绑定到另一
   个命名空间前缀。

xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT

   此错误不应当被报告给 Python 应用程序。

xml.parsers.expat.errors.XML_ERROR_NO_BUFFER

   此错误不应当被报告给 Python 应用程序。

xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH

   输入放大系数的限制（来自 DTD 和实体）已被突破。

xml.parsers.expat.errors.XML_ERROR_NOT_STARTED

   在解析器启动之前尝试停止或挂起它。

   Added in version 3.14.

-[ 备注 ]-

[1] 包括在 XML 输出中的编码格式字符串应当符合适当的标准。例如 "UTF-8"
    是有效的，但 "UTF8" 是无效的。请参阅 https://www.w3.org/TR/2006
    /REC-xml11-20060816/#NT-EncodingDecl 和
    https://www.iana.org/assignments/character-sets/character-
    sets.xhtml.
