`xml.sax.md`

84 строк · 11.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.3/library/xml.sax.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 20.9. [`xml.sax`](https://python-all.ru/3.3/library/xml.sax.html#module-xml.sax) – Поддержка парсеров SAX289Пакет [`xml.sax`](https://python-all.ru/3.3/library/xml.sax.html#module-xml.sax) предоставляет несколько модулей, реализующих интерфейс Simple API for XML (SAX) для Python. Сам пакет предоставляет исключения SAX и вспомогательные функции, которые наиболее часто используются пользователями SAX API.1011> **Предупреждение**12>13> Модуль [`xml.sax`](https://python-all.ru/3.3/library/xml.sax.html#module-xml.sax) не является безопасным для вредоносных данных. Если необходимо обрабатывать непроверенные или неаутентифицированные данные, обратитесь к разделу [*Уязвимости XML*](https://python-all.ru/3.3/library/xml.html#xml-vulnerabilities).1415Удобные функции:1617#### `xml.sax.make_parser(parser_list=[])`1819Создаёт и возвращает объект SAX [`XMLReader`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader). Будет использован первый найденный парсер. Если указан параметр *parser\_list*, он должен быть последовательностью строк, которые называют модули, содержащие функцию `create_parser()`. Модули из *parser\_list* будут использоваться перед модулями из списка парсеров по умолчанию.2021#### `xml.sax.parse(filename_or_stream, handler, error_handler=handler.ErrorHandler())`2223Создаёт парсер SAX и использует его для разбора документа. Документ, передаваемый как *filename\_or\_stream*, может быть именем файла или файловым объектом. Параметр *handler* должен быть экземпляром SAX [`ContentHandler`](https://python-all.ru/3.3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler). Если указан *error\_handler*, он должен быть экземпляром SAX [`ErrorHandler`](https://python-all.ru/3.3/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler); если опущен, будет возбуждаться [`SAXParseException`](https://python-all.ru/3.3/library/xml.sax.html#xml.sax.SAXParseException) при всех ошибках. Возвращаемого значения нет; вся работа должна выполняться переданным *handler*.2425#### `xml.sax.parseString(string, handler, error_handler=handler.ErrorHandler())`2627Аналогична [`parse()`](https://python-all.ru/3.3/library/xml.sax.html#xml.sax.parse), но выполняет разбор из буфера *string*, переданного в качестве параметра.2829Типичное SAX-приложение использует три вида объектов: читатели, обработчики и источники входных данных. «Читатель» в этом контексте – ещё один термин для парсера, т.е. некоторый код, который читает байты или символы из источника входных данных и порождает последовательность событий. Затем эти события распределяются по объектам-обработчикам: читатель вызывает метод на обработчике. Таким образом, SAX-приложение должно получить объект-читатель, создать или открыть источники входных данных, создать обработчики и соединить все эти объекты вместе. На последнем этапе подготовки вызывается читатель для разбора входных данных. Во время разбора вызываются методы объектов-обработчиков на основе структурных и синтаксических событий из входных данных.3031Для этих объектов важны только интерфейсы; они обычно не создаются напрямую приложением. Поскольку в Python нет явного понятия интерфейса, они формально представлены как классы, но приложения могут использовать реализации, которые не наследуются от предоставленных классов. Интерфейсы [`InputSource`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource), [`Locator`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.Locator), `Attributes`, `AttributesNS` и [`XMLReader`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader) определены в модуле [`xml.sax.xmlreader`](https://python-all.ru/3.3/library/xml.sax.reader.html#module-xml.sax.xmlreader). Интерфейсы обработчиков определены в [`xml.sax.handler`](https://python-all.ru/3.3/library/xml.sax.handler.html#module-xml.sax.handler). Для удобства [`InputSource`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource) (который часто создаётся напрямую) и классы обработчиков также доступны из [`xml.sax`](https://python-all.ru/3.3/library/xml.sax.html#module-xml.sax). Эти интерфейсы описаны ниже.3233В дополнение к этим классам, [`xml.sax`](https://python-all.ru/3.3/library/xml.sax.html#module-xml.sax) предоставляет следующие классы исключений.3435#### `exception xml.sax.SAXException(msg, exception=None)`3637Инкапсулирует ошибку или предупреждение XML. Этот класс может содержать базовую информацию об ошибке или предупреждении как от XML-парсера, так и от приложения; его можно подклассифицировать для добавления дополнительной функциональности или локализации. Обратите внимание, что хотя обработчики, определённые в интерфейсе [`ErrorHandler`](https://python-all.ru/3.3/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler), получают экземпляры этого исключения, не требуется фактически возбуждать исключение – он также полезен как контейнер для информации.3839При создании экземпляра *msg* должен быть читаемым описанием ошибки. Необязательный параметр *exception*, если задан, должен быть `None` или исключением, которое было перехвачено кодом разбора и передаётся как информация.4041Это базовый класс для других классов исключений SAX.4243#### `exception xml.sax.SAXParseException(msg, exception, locator)`4445Подкласс [`SAXException`](https://python-all.ru/3.3/library/xml.sax.html#xml.sax.SAXException), возбуждаемый при ошибках разбора. Экземпляры этого класса передаются методам интерфейса SAX [`ErrorHandler`](https://python-all.ru/3.3/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler) для предоставления информации об ошибке разбора. Этот класс поддерживает интерфейс SAX [`Locator`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.Locator), а также интерфейс [`SAXException`](https://python-all.ru/3.3/library/xml.sax.html#xml.sax.SAXException).4647#### `exception xml.sax.SAXNotRecognizedException(msg, exception=None)`4849Подкласс [`SAXException`](https://python-all.ru/3.3/library/xml.sax.html#xml.sax.SAXException), возбуждаемый, когда SAX [`XMLReader`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader) сталкивается с неизвестной возможностью или свойством. Приложения и расширения SAX могут использовать этот класс для аналогичных целей.5051#### `exception xml.sax.SAXNotSupportedException(msg, exception=None)`5253Подкласс [`SAXException`](https://python-all.ru/3.3/library/xml.sax.html#xml.sax.SAXException), возбуждаемый, когда SAX [`XMLReader`](https://python-all.ru/3.3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader) запрашивают включение неподдерживаемой возможности или установку свойства в значение, не поддерживаемое реализацией. Приложения и расширения SAX могут использовать этот класс для аналогичных целей.5455> **См. также**56>57> **[SAX: Простой API для XML](https://python-all.ru/3.3/library/xml.sax.html)**58>59> Этот сайт является центром определения SAX API. Он предоставляет реализацию на Java и онлайн-документацию. Также доступны ссылки на реализации и историческую информацию.60>61> **Модуль [`xml.sax.handler`](https://python-all.ru/3.3/library/xml.sax.handler.html#module-xml.sax.handler)**62>63> Определения интерфейсов для объектов, предоставляемых приложением.64>65> **Модуль [`xml.sax.saxutils`](https://python-all.ru/3.3/library/xml.sax.utils.html#module-xml.sax.saxutils)**66>67> Удобные функции для использования в SAX-приложениях.68>69> **Модуль [`xml.sax.xmlreader`](https://python-all.ru/3.3/library/xml.sax.reader.html#module-xml.sax.xmlreader)**70>71> Определения интерфейсов для объектов, предоставляемых парсером.7273## 20.9.1. Объекты SAXException7475Класс исключения [`SAXException`](https://python-all.ru/3.3/library/xml.sax.html#xml.sax.SAXException) поддерживает следующие методы:7677#### `SAXException.getMessage()`7879Возвращает понятное человеку сообщение, описывающее условие ошибки.8081#### `SAXException.getException()`8283Возвращает инкапсулированный объект исключения или `None`.84