Документация Python неофициальный перевод
Содержание страницы

xml.sax.handler – Базовые классы для обработчиков SAXxml.sax.handler – Base classes for SAX handlers

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

API SAX определяет пять типов обработчиков: обработчики содержимого, обработчики DTD, обработчики ошибок, преобразователи сущностей и лексические обработчики. Приложениям обычно нужно реализовывать только те интерфейсы, события которых их интересуют; можно реализовать интерфейсы в одном или нескольких объектах. Реализации обработчиков должны наследовать от базовых классов из модуля xml.sax.handler, чтобы все методы получали реализации по умолчанию.

class xml.sax.handler.ContentHandler

Это главный интерфейс колбэков в SAX, самый важный для приложений. Порядок событий в этом интерфейсе соответствует порядку информации в документе.

class xml.sax.handler.DTDHandler

Обработка событий DTD.

Этот интерфейс определяет только те события DTD, которые необходимы для базового разбора (неразобранные сущности и атрибуты).

class xml.sax.handler.EntityResolver

Базовый интерфейс для разрешения сущностей. Если создать объект, реализующий этот интерфейс, и зарегистрировать его в анализаторе, анализатор будет вызывать метод этого объекта для разрешения всех внешних сущностей.

class xml.sax.handler.ErrorHandler

Интерфейс, используемый анализатором для передачи сообщений об ошибках и предупреждениях приложению. Методы этого объекта управляют, преобразуются ли ошибки сразу в исключения или обрабатываются иным способом.

class xml.sax.handler.LexicalHandler

Интерфейс, используемый анализатором для представления редко возникающих событий, которые могут быть неинтересны многим приложениям.

В дополнение к этим классам, xml.sax.handler предоставляет символьные константы для имён возможностей и свойств.

xml.sax.handler.feature_namespaces
значение: "http://xml.org/sax/features/namespaces"
true: Выполнять обработку пространства имён.
false: По желанию не выполнять обработку пространства имён (подразумевает namespace-prefixes; по умолчанию).
доступ: (при разборе) только чтение; (не при разборе) чтение/запись
xml.sax.handler.feature_namespace_prefixes
значение: "http://xml.org/sax/features/namespace-prefixes"
true: Сообщать исходные имена с префиксами и атрибуты, используемые для объявлений пространства имён.
false: Не сообщать атрибуты, используемые для объявлений пространства имён, и по желанию не сообщать исходные имена с префиксами (по умолчанию).
доступ: (при разборе) только чтение; (не при разборе) чтение/запись
xml.sax.handler.feature_string_interning
значение: "http://xml.org/sax/features/string-interning"
true: Все имена элементов, префиксы, имена атрибутов, URI пространства имён и локальные имена интернируются с помощью встроенной функции intern.
false: Имена не обязательно интернируются, хотя могут (по умолчанию).
доступ: (при разборе) только чтение; (не при разборе) чтение/запись
xml.sax.handler.feature_validation
значение: "http://xml.org/sax/features/validation"
true: сообщать обо всех ошибках проверки (подразумеваются external-general-entities и external-parameter-entities).
false: не сообщать об ошибках проверки.
доступ: (при разборе) только чтение; (не при разборе) чтение/запись
xml.sax.handler.feature_external_ges

Предупреждение

Включение открывает уязвимость для атак с использованием внешних сущностей если анализатор используется с XML-содержимым, предоставленным пользователем. Пожалуйста, оцените свою модель угроз перед включением этой функции.

значение: "http://xml.org/sax/features/external-general-entities"
true: включать все внешние общие (текстовые) сущности.
false: не включать внешние общие сущности.
доступ: (при разборе) только чтение; (не при разборе) чтение/запись
xml.sax.handler.feature_external_pes
значение: "http://xml.org/sax/features/external-parameter-entities"
true: включать все внешние сущности параметров, включая внешнее подмножество DTD.
false: не включать внешние сущности параметров, даже внешнее подмножество DTD.
доступ: (при разборе) только чтение; (не при разборе) чтение/запись
xml.sax.handler.all_features

Список всех возможностей.

xml.sax.handler.property_lexical_handler
значение: "http://xml.org/sax/properties/lexical-handler"
тип данных: xml.sax.handler.LexicalHandler (не поддерживается в Python 2)
описание: необязательный обработчик-расширение для лексических событий, таких как комментарии.
доступ: чтение/запись
xml.sax.handler.property_declaration_handler
значение: "http://xml.org/sax/properties/declaration-handler"
тип данных: xml.sax.sax2lib.DeclHandler (не поддерживается в Python 2)
описание: необязательный обработчик-расширение для событий, связанных с DTD, кроме нотаций и неразобранных сущностей.
доступ: чтение/запись
xml.sax.handler.property_dom_node
значение: "http://xml.org/sax/properties/dom-node"
тип данных: org.w3c.dom.Node (не поддерживается в Python 2)
описание: при разборе – текущий узел DOM, который посещается, если это итератор DOM; при отсутствии разбора – корневой узел DOM для итерации.
доступ: (при разборе) только чтение; (не при разборе) чтение/запись
xml.sax.handler.property_xml_string
значение: "http://xml.org/sax/properties/xml-string"
тип данных: Bytes
описание: буквальная строка символов, которая была источником для текущего события.
доступ: только для чтения
xml.sax.handler.all_properties

Список всех известных имен свойств.

Объекты ContentHandlerContentHandler Objects

Ожидается, что пользователи будут создавать подклассы ContentHandler для поддержки своих приложений. Следующие методы вызываются парсером при соответствующих событиях во входном документе:

ContentHandler.setDocumentLocator(locator)

Вызывается парсером, чтобы предоставить приложению локатор для определения источника событий документа.

SAX-парсерам настоятельно рекомендуется (хотя это не является обязательным) предоставлять локатор: если он это делает, то должен передать локатор приложению, вызвав этот метод до вызова любого другого метода в интерфейсе DocumentHandler.

Локатор позволяет приложению определить конечную позицию любого события, связанного с документом, даже если парсер не сообщает об ошибке. Обычно приложение использует эту информацию для сообщения о собственных ошибках (например, содержимое символов, не соответствующее бизнес-правилам приложения). Информация, возвращаемая локатором, вероятно, недостаточна для использования в поисковой системе.

Обратите внимание, что локатор будет возвращать корректную информацию только во время вызова событий этого интерфейса. Приложение не должно пытаться использовать его в любое другое время.

ContentHandler.startDocument()

Получает уведомление о начале документа.

SAX-парсер вызовет этот метод только один раз, перед любыми другими методами в этом интерфейсе или в DTDHandler (за исключением setDocumentLocator()).

ContentHandler.endDocument()

Получает уведомление о конце документа.

SAX-парсер вызовет этот метод только один раз, и это будет последний метод, вызванный во время разбора. Парсер не должен вызывать этот метод, пока он не прекратил разбор (из-за невосстановимой ошибки) или не достиг конца входных данных.

ContentHandler.startPrefixMapping(prefix, uri)

Начинает область действия отображения префикса на URI пространства имен.

Информация из этого события не требуется для обычной обработки пространств имен: SAX-ридер XML автоматически заменяет префиксы для имен элементов и атрибутов, когда включена функция feature_namespaces (по умолчанию).

Однако бывают случаи, когда приложениям необходимо использовать префиксы в символьных данных или значениях атрибутов, где их нельзя безопасно расширить автоматически; события startPrefixMapping() и endPrefixMapping() предоставляют приложению информацию для самостоятельного расширения префиксов в этих контекстах, если это необходимо.

Обратите внимание, что события startPrefixMapping() и endPrefixMapping() не гарантированно правильно вложены друг относительно друга: все события startPrefixMapping() произойдут до соответствующего события startElement(), а все события endPrefixMapping() произойдут после соответствующего события endElement(), но их порядок не гарантируется.

ContentHandler.endPrefixMapping(prefix)

Завершает область действия отображения префикса на URI.

Подробнее см. startPrefixMapping(). Это событие всегда происходит после соответствующего события endElement(), но порядок событий endPrefixMapping() в остальном не гарантируется.

ContentHandler.startElement(name, attrs)

Сигнализирует о начале элемента в режиме без пространств имен.

Параметр name содержит необработанное имя типа элемента в формате XML 1.0 в виде строки, а параметр attrs содержит объект интерфейса Attributes с атрибутами элемента. Объект, передаваемый как attrs, может быть повторно использован парсером; хранение ссылки на него не является надежным способом сохранить копию атрибутов. Чтобы сохранить копию атрибутов, используйте метод copy() объекта attrs.

ContentHandler.endElement(name)

Сигнализирует о конце элемента в режиме без пространства имён.

Параметр name содержит имя типа элемента, как и событие startElement().

ContentHandler.startElementNS(name, qname, attrs)

Сигнализирует о начале элемента в режиме пространства имён.

Параметр name содержит имя типа элемента в виде кортежа (uri, localname), параметр qname содержит необработанное имя XML 1.0, используемое в исходном документе, а параметр attrs содержит экземпляр интерфейса AttributesNS с атрибутами элемента. Если с элементом не связано пространство имён, компонент uri name будет равен None. Объект, переданный как attrs, может быть повторно использован анализатором; сохранение ссылки на него не является надёжным способом сохранить копию атрибутов. Чтобы сохранить копию атрибутов, используйте метод copy() объекта attrs.

Анализаторы могут установить параметр qname в None, если только не активирована функция feature_namespace_prefixes.

ContentHandler.endElementNS(name, qname)

Сигнализирует о конце элемента в режиме пространства имён.

Параметр name содержит имя типа элемента, как и метод startElementNS(), и аналогично параметр qname.

ContentHandler.characters(content)

Получает уведомление о символьных данных.

Анализатор вызывает этот метод для сообщения каждого блока символьных данных. Анализаторы SAX могут возвращать все смежные символьные данные одним блоком или разбивать их на несколько блоков; однако все символы в любом отдельном событии должны происходить из одной и той же внешней сущности, чтобы Locator предоставлял полезную информацию.

content может быть строкой или экземпляром bytes; модуль чтения expat всегда выдаёт строки.

Примечание

Более ранний интерфейс SAX 1, предоставленный Python XML Special Interest Group, использовал более похожий на Java интерфейс для этого метода. Поскольку большинство анализаторов, используемых из Python, не использовали преимущества старого интерфейса, была выбрана более простая сигнатура для его замены. Чтобы преобразовать старый код в новый интерфейс, используйте content вместо нарезки content с помощью старых параметров offset и length.

ContentHandler.ignorableWhitespace(whitespace)

Получает уведомление об игнорируемых пробельных символах в содержимом элемента.

Валидирующие анализаторы должны использовать этот метод для сообщения каждого блока игнорируемых пробельных символов (см. рекомендацию W3C XML 1.0, раздел 2.10): невалидирующие анализаторы также могут использовать этот метод, если они способны анализировать и использовать модели содержимого.

Анализаторы SAX могут возвращать все смежные пробельные символы одним блоком или разбивать их на несколько блоков; однако все символы в любом отдельном событии должны происходить из одной и той же внешней сущности, чтобы Locator предоставлял полезную информацию.

ContentHandler.processingInstruction(target, data)

Получает уведомление об инструкции по обработке.

Анализатор вызывает этот метод один раз для каждой найденной инструкции по обработке; обратите внимание, что инструкции по обработке могут встречаться до или после основного элемента документа.

Анализатор SAX никогда не должен сообщать об объявлении XML (XML 1.0, раздел 2.8) или объявлении текста (XML 1.0, раздел 4.3.1) с помощью этого метода.

ContentHandler.skippedEntity(name)

Получает уведомление о пропущенной сущности.

Анализатор вызывает этот метод один раз для каждой пропущенной сущности. Невалидирующие процессоры могут пропускать сущности, если они не видели объявления (например, если сущность была объявлена во внешнем подмножестве DTD). Все процессоры могут пропускать внешние сущности в зависимости от значений свойств feature_external_ges и feature_external_pes.

Объекты DTDHandlerDTDHandler Objects

Экземпляры DTDHandler предоставляют следующие методы:

DTDHandler.notationDecl(name, publicId, systemId)

Обрабатывает событие объявления нотации.

DTDHandler.unparsedEntityDecl(name, publicId, systemId, ndata)

Обрабатывает событие объявления неразобранной сущности.

Объекты EntityResolverEntityResolver Objects

EntityResolver.resolveEntity(publicId, systemId)

Разрешает системный идентификатор сущности и возвращает либо системный идентификатор для чтения в виде строки, либо InputSource для чтения. Реализация по умолчанию возвращает systemId.

Объекты ErrorHandlerErrorHandler Objects

Объекты с этим интерфейсом используются для получения информации об ошибках и предупреждениях от XMLReader. Если вы создаете объект, реализующий этот интерфейс, и регистрируете его в своем XMLReader, парсер будет вызывать методы вашего объекта для сообщения обо всех предупреждениях и ошибках. Доступны три уровня ошибок: предупреждения, (возможно) восстанавливаемые ошибки и невосстанавливаемые ошибки. Все методы принимают SAXParseException в качестве единственного параметра. Ошибки и предупреждения могут быть преобразованы в исключение путем возбуждения переданного объекта исключения.

ErrorHandler.error(exception)

Вызывается, когда парсер встречает восстанавливаемую ошибку. Если этот метод не возбуждает исключение, разбор может продолжиться, но приложению не следует ожидать дальнейшей информации о документе. Разрешение парсеру продолжить может позволить обнаружить дополнительные ошибки во входном документе.

ErrorHandler.fatalError(exception)

Вызывается, когда парсер встречает ошибку, из которой невозможно восстановиться; ожидается, что разбор завершится при возврате этого метода.

ErrorHandler.warning(exception)

Вызывается, когда парсер передает приложению информацию о незначительном предупреждении. Ожидается, что разбор продолжится при возврате этого метода, и информация о документе будет по-прежнему передаваться приложению. Возбуждение исключения в этом методе приведет к завершению разбора.

Объекты LexicalHandlerLexicalHandler Objects

Необязательный обработчик SAX2 для лексических событий.

Этот обработчик используется для получения лексической информации об XML-документе. Лексическая информация включает сведения об используемой кодировке документа, XML-комментариях, встроенных в документ, а также о границах разделов для DTD и любых секций CDATA. Лексические обработчики используются так же, как и обработчики содержимого.

Установите LexicalHandler для XMLReader с помощью метода setProperty с идентификатором свойства 'http://xml.org/sax/properties/lexical-handler'.

LexicalHandler.comment(content)

Сообщает о комментарии в любом месте документа (включая DTD и вне корневого элемента).

LexicalHandler.startDTD(name, public_id, system_id)

Сообщает о начале объявлений DTD, если документ имеет связанную DTD.

LexicalHandler.endDTD()

Сообщает о конце объявления DTD.

LexicalHandler.startCDATA()

Сообщает о начале секции CDATA.

Содержимое секции CDATA будет передано через обработчик символов.

LexicalHandler.endCDATA()

Сообщает о конце секции CDATA.