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