# `xml.sax.saxutils` --- SAX 工具集

源代码: Lib/xml/sax/saxutils.py

`xml.sax.saxutils` 模块包含一些在创建 SAX 应用时常用的类和函数，它们可以直接使用，也可以作为基类。

xml.sax.saxutils.escape(data, entities={})

  对数据字符串中的 `'&'`, `'<'` 和 `'>'` 进行转义。

  你可以通过传入一个字典作为可选的 entities 形参来对其他字符串数据进行转义。 字典的键和值必须为字符串；每个键将被替换为其所对应的值。 字符 `'&'`, `'<'` 和 `'>'` 总是会被转义，即使提供了 entities。

  备注

  此函数应当仅用于对无法直接在 XML 中使用的字符进行转义。 请不要将此函数用作通用的字符串转换函数。

xml.sax.saxutils.unescape(data, entities={})

  对字符串数据中的 `'&amp;'`, `'&lt;'` 和 `'&gt;'` 进行反转义。

  你可以通过传入一个字典作为可选的 entities 形参来对其他数据字符串进行反转义；字典的键和值必须都为字符串；每个键将被替换为其对应的值。 `'&amp;'`, `'&lt;'` 和 `'&gt;'` 将总是被反转义，即使提供了 entities。

xml.sax.saxutils.quoteattr(data, entities={})

  类似于 `escape()`，但还会对 data 进行处理以将其用作属性值。 返回值是 data 加上任何额外要求的替换的带引号版本。 `quoteattr()` 将基于 data 的内容选择一个引号字符，以尽量避免在字符串中编码任何引号字符。 如果单双引号字符在 data 中都存在，则双引号字符将被编码并且 data 将使用双引号来标记。 结果字符串可被直接用作属性值:

      >>> print("<element attr=%s>" % quoteattr("ab ' cd \" ef"))
      <element attr="ab ' cd &quot; ef">

  此函数适用于为 HTML 或任何使用引用具体语法的 SGML 生成属性值。

class xml.sax.saxutils.XMLGenerator(out=None, encoding='iso-8859-1', short_empty_elements=False)

  这个类通过将 SAX 事件写回到 XML 文档来实现 `ContentHandler` 接口。 换句话说，使用 `XMLGenerator` 作为内容处理程序将重新产生所解析的原始文档。 out 应当为一个文件型对象，它默认将为 sys.stdout。 encoding 为输出流的编码格式，它默认将为 `'iso-8859-1'`。 short_empty_elements 控制不包含内容的元素的格式化：如为 `False` (默认值) 则它们会以开始/结束标记对的形式被发送，如果设为 `True` 则它们会以单个自结束标记的形式被发送。

  在 3.2 版本发生变更: 增加了 short_empty_elements 形参。

class xml.sax.saxutils.XMLFilterBase(base)

  这个类被设计用来分隔 `XMLReader` 和客户端应用的事件处理程序。 在默认情况下，它除了将请求传送给读取器并将事件传送给处理程序之外什么都不做，但其子类可以重载特定的方法以在传送它们的时候修改事件流或配置请求。

xml.sax.saxutils.prepare_input_source(source, base='')

  此函数接受一个输入源和一个可选的基准 URL 并返回一个经过完整解析可供读取的 `InputSource` 对象。 输入源的给出形式可以是字符串、文件型对象或 `InputSource` 对象；解析器将使用此函数来针对它们的 `parse()` 方法实现多态 source 参数。