`xml.sax.md`

90 строк · 12.2 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/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.5/library/xml.sax.html#module-xml.sax) – Поддержка парсеров SAX289**Исходный код:** [Lib/xml/sax/\_\_init\_\_.py](https://python-all.ru/src/3.5/Lib/xml/sax/__init__.py)1011---1213Пакет [`xml.sax`](https://python-all.ru/3.5/library/xml.sax.html#module-xml.sax) предоставляет несколько модулей, реализующих интерфейс Simple API for XML (SAX) для Python. Сам пакет предоставляет исключения SAX и удобные функции, которые чаще всего используются пользователями SAX API.1415> **Предупреждение**16>17> Модуль [`xml.sax`](https://python-all.ru/3.5/library/xml.sax.html#module-xml.sax) не защищён от вредоносных данных. Если требуется разбирать непроверенные или неаутентифицированные данные, см. [уязвимости XML](https://python-all.ru/3.5/library/xml.html#xml-vulnerabilities).1819Удобные функции:2021#### `xml.sax.make_parser(parser_list=[])`2223Создаёт и возвращает объект SAX [`XMLReader`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader). Первый найденный парсер будет использован. Если передан *parser\_list*, это должна быть последовательность строк, которые именуют модули, содержащие функцию с именем `create_parser()`. Модули, перечисленные в *parser\_list*, будут использоваться раньше модулей из списка парсеров по умолчанию.2425#### `xml.sax.parse(filename_or_stream, handler, error_handler=handler.ErrorHandler())`2627Создаёт парсер SAX и использует его для разбора документа. Документ, передаваемый как *filename\_or\_stream*, может быть именем файла или файловым объектом. Параметр *handler* должен быть экземпляром SAX [`ContentHandler`](https://python-all.ru/3.5/library/xml.sax.handler.html#xml.sax.handler.ContentHandler). Если указан *error\_handler*, он должен быть экземпляром SAX [`ErrorHandler`](https://python-all.ru/3.5/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler); если он опущен, при всех ошибках будет возбуждаться [`SAXParseException`](https://python-all.ru/3.5/library/xml.sax.html#xml.sax.SAXParseException). Возвращаемое значение отсутствует; вся работа должна выполняться переданным *handler*.2829#### `xml.sax.parseString(string, handler, error_handler=handler.ErrorHandler())`3031Аналогично [`parse()`](https://python-all.ru/3.5/library/xml.sax.html#xml.sax.parse), но разбирает из буфера *string*, полученного в качестве параметра. *string* должен быть экземпляром [`str`](https://python-all.ru/3.5/library/stdtypes.html#str) или [объектом, подобным bytes](https://python-all.ru/3.5/glossary.html#term-bytes-like-object).3233Изменено в версии 3.5: Добавлена поддержка экземпляров [`str`](https://python-all.ru/3.5/library/stdtypes.html#str).3435Типичное SAX-приложение использует три вида объектов: читатели, обработчики и источники входных данных. «Читатель» в этом контексте – ещё один термин для парсера, т.е. некоторый код, который читает байты или символы из источника входных данных и порождает последовательность событий. Затем эти события распределяются по объектам-обработчикам: читатель вызывает метод на обработчике. Таким образом, SAX-приложение должно получить объект-читатель, создать или открыть источники входных данных, создать обработчики и соединить все эти объекты вместе. На последнем этапе подготовки вызывается читатель для разбора входных данных. Во время разбора вызываются методы объектов-обработчиков на основе структурных и синтаксических событий из входных данных.3637Для этих объектов важны только интерфейсы; обычно они не создаются самим приложением. Поскольку в Python нет явного понятия интерфейса, они формально представлены как классы, но приложения могут использовать реализации, которые не наследуются от предоставленных классов. Интерфейсы [`InputSource`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource), [`Locator`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.Locator), `Attributes`, `AttributesNS` и [`XMLReader`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader) определены в модуле [`xml.sax.xmlreader`](https://python-all.ru/3.5/library/xml.sax.reader.html#module-xml.sax.xmlreader). Интерфейсы обработчиков определены в [`xml.sax.handler`](https://python-all.ru/3.5/library/xml.sax.handler.html#module-xml.sax.handler). Для удобства [`InputSource`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource) (который часто создаётся напрямую) и классы обработчиков также доступны из [`xml.sax`](https://python-all.ru/3.5/library/xml.sax.html#module-xml.sax). Эти интерфейсы описаны ниже.3839В дополнение к этим классам [`xml.sax`](https://python-all.ru/3.5/library/xml.sax.html#module-xml.sax) предоставляет следующие классы исключений.4041#### `exception xml.sax.SAXException(msg, exception=None)`4243Инкапсулирует ошибку или предупреждение XML. Этот класс может содержать базовую информацию об ошибке или предупреждении как от XML-парсера, так и от приложения; его можно расширить для добавления дополнительной функциональности или локализации. Обратите внимание, что хотя обработчики, определённые в интерфейсе [`ErrorHandler`](https://python-all.ru/3.5/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler), получают экземпляры этого исключения, фактически возбуждать исключение не требуется – он также полезен как контейнер для информации.4445При создании экземпляра *msg* должен быть человекочитаемым описанием ошибки. Необязательный параметр *исключение*, если задан, должен быть `None` или исключением, которое было перехвачено кодом разбора и передаётся как информация.4647Это базовый класс для других классов исключений SAX.4849#### `exception xml.sax.SAXParseException(msg, exception, locator)`5051Подкласс [`SAXException`](https://python-all.ru/3.5/library/xml.sax.html#xml.sax.SAXException), возбуждаемый при ошибках разбора. Экземпляры этого класса передаются методам интерфейса SAX [`ErrorHandler`](https://python-all.ru/3.5/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler) для предоставления информации об ошибке разбора. Этот класс поддерживает интерфейсы SAX [`Locator`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.Locator) и [`SAXException`](https://python-all.ru/3.5/library/xml.sax.html#xml.sax.SAXException).5253#### `exception xml.sax.SAXNotRecognizedException(msg, exception=None)`5455Подкласс [`SAXException`](https://python-all.ru/3.5/library/xml.sax.html#xml.sax.SAXException), возбуждаемый, когда SAX [`XMLReader`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader) сталкивается с неизвестной функцией или свойством. SAX-приложения и расширения могут использовать этот класс для аналогичных целей.5657#### `exception xml.sax.SAXNotSupportedException(msg, exception=None)`5859Подкласс [`SAXException`](https://python-all.ru/3.5/library/xml.sax.html#xml.sax.SAXException), возбуждаемый, когда SAX [`XMLReader`](https://python-all.ru/3.5/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader) просят включить неподдерживаемую возможность или установить свойство в значение, которое не поддерживается реализацией. SAX-приложения и расширения могут использовать этот класс для аналогичных целей.6061> **См. также**62>63> **[SAX: Простой API для XML](https://python-all.ru/3.5/library/xml.sax.html)**64>65> Этот сайт является центром определения SAX API. Он предоставляет реализацию на Java и онлайн-документацию. Также доступны ссылки на реализации и историческую информацию.66>67> **Модуль [`xml.sax.handler`](https://python-all.ru/3.5/library/xml.sax.handler.html#module-xml.sax.handler)**68>69> Определения интерфейсов для объектов, предоставляемых приложением.70>71> **Модуль [`xml.sax.saxutils`](https://python-all.ru/3.5/library/xml.sax.utils.html#module-xml.sax.saxutils)**72>73> Удобные функции для использования в SAX-приложениях.74>75> **Модуль [`xml.sax.xmlreader`](https://python-all.ru/3.5/library/xml.sax.reader.html#module-xml.sax.xmlreader)**76>77> Определения интерфейсов для объектов, предоставляемых парсером.7879## 20.9.1. Объекты SAXException8081Класс исключений [`SAXException`](https://python-all.ru/3.5/library/xml.sax.html#xml.sax.SAXException) поддерживает следующие методы:8283#### `SAXException.getMessage()`8485Возвращает понятное человеку сообщение, описывающее условие ошибки.8687#### `SAXException.getException()`8889Возвращает инкапсулированный объект исключения или `None`.90