xml.sax.saxutils — Утилиты SAX

Исходный код: Lib/xml/sax/saxutils.py

Модуль xml.sax.saxutils содержит ряд классов и функций, которые часто полезны при создании приложений SAX, как в прямом использовании, так и в качестве базовых классов.

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

Экранировать '&', '<', и '>' в строке данных.

Вы можете экранировать другие строки данных, передав словарь в качестве необязательного параметра entities. Ключи и значения должны быть строками; каждый ключ будет заменён соответствующим значением. Символы '&', '<' и '>' всегда экранируются, даже если entities указан.

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

Разобрать '&', '<', и '>' в строке данных.

Вы можете разобрать другие строки данных, передав словарь в качестве необязательного параметра entities. Ключи и значения должны быть строками; каждый ключ будет заменён соответствующим значением. '&amp', '<', и '>' всегда разбираются, даже если 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)

Этот класс реализует интерфейс ContentHandler, записывая события SAX обратно в документ XML. Другими словами, использование 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; парсеры будут использовать эту функцию для реализации полиморфного аргумента source в их методе parse().