`pyexpat.md`

605 строк · 54.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/library/pyexpat.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `xml.parsers.expat` – Быстрый разбор XML с помощью Expat89---1011> **Предупреждение**12>13> Модуль `pyexpat` не защищён от вредоносных данных. Если требуется разбирать непроверенные или неаутентифицированные данные, см. [уязвимости XML](https://python-all.ru/3.12/library/xml.html#xml-vulnerabilities).1415Модуль [`xml.parsers.expat`](https://python-all.ru/3.12/library/pyexpat.html#module-xml.parsers.expat) представляет собой интерфейс Python к непроверяющему XML-парсеру Expat. Модуль предоставляет один тип расширения, `xmlparser`, который представляет текущее состояние XML-парсера. После создания объекта `xmlparser` различные атрибуты объекта можно установить в функции-обработчики. Когда XML-документ затем передается парсеру, функции-обработчики вызываются для символьных данных и разметки в XML-документе.1617Этот модуль использует модуль `pyexpat` для доступа к парсеру Expat. Прямое использование модуля `pyexpat` устарело.1819Этот модуль предоставляет одно исключение и один объект типа:2021#### `exception xml.parsers.expat.ExpatError`2223Исключение, возникающее, когда Expat сообщает об ошибке. См. раздел [Исключения ExpatError](https://python-all.ru/3.12/library/pyexpat.html#expaterror-objects) для получения дополнительной информации об интерпретации ошибок Expat.2425#### `exception xml.parsers.expat.error`2627Псевдоним для [`ExpatError`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError).2829#### `xml.parsers.expat.XMLParserType`3031Тип возвращаемых значений функции [`ParserCreate()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ParserCreate).3233Модуль [`xml.parsers.expat`](https://python-all.ru/3.12/library/pyexpat.html#module-xml.parsers.expat) содержит две функции:3435#### `xml.parsers.expat.ErrorString(errno)`3637Возвращает пояснительную строку для заданного номера ошибки *errno*.3839#### `xml.parsers.expat.ParserCreate(encoding=None, namespace_separator=None)`4041Создает и возвращает новый объект `xmlparser`. *encoding*, если указан, должен быть строкой, задающей кодировку, используемую XML-данными. Expat поддерживает не так много кодировок, как Python, и его набор кодировок не может быть расширен; он поддерживает UTF-8, UTF-16, ISO-8859-1 (Latin1) и ASCII. Если задан *encoding* [\[1\]](https://python-all.ru/3.12/library/pyexpat.html#id3), он переопределяет неявную или явную кодировку документа.4243Парсеры, созданные через `ParserCreate()`, называются «корневыми» парсерами в том смысле, что к ним не прикреплен родительский парсер. Некорневые парсеры создаются с помощью [`parser.ExternalEntityParserCreate`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityParserCreate).4445Expat может опционально выполнять обработку пространств имен XML, что включается предоставлением значения для *namespace\_separator*. Значение должно быть строкой из одного символа; будет возбуждено [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError), если строка имеет недопустимую длину (`None` считается эквивалентом отсутствия). Когда обработка пространств имен включена, имена типов элементов и имена атрибутов, принадлежащие пространству имен, будут расширены. Имя элемента, передаваемое обработчикам элементов `StartElementHandler` и `EndElementHandler`, будет конкатенацией URI пространства имен, символа-разделителя пространства имен и локальной части имени. Если разделитель пространства имен является нулевым байтом (`chr(0)`), то URI пространства имен и локальная часть будут объединены без разделителя.4647Например, если *namespace\_separator* установлен в пробел (`' '`) и разбирается следующий документ:4849```xml50<?xml version="1.0"?>51<root xmlns    = "http://default-namespace.org/"52      xmlns:py = "http://www.python.org/ns/">53  <py:elem1 />54  <elem2 xmlns="" />55</root>56```5758`StartElementHandler` получит следующие строки для каждого элемента:5960```python61http://default-namespace.org/ root62http://www.python.org/ns/ elem163elem264```6566Из-за ограничений в библиотеке `Expat`, используемой `pyexpat`, возвращаемый экземпляр `xmlparser` может использоваться только для разбора одного XML-документа. Вызывайте `ParserCreate` для каждого документа, чтобы получить уникальные экземпляры парсера.6768> **См. также**69>70> **[XML-парсер Expat](https://python-all.ru/3.12/library/pyexpat.html)**71>72> Домашняя страница проекта Expat.7374## Объекты XMLParser7576Объекты `xmlparser` имеют следующие методы:7778#### `xmlparser.Parse(data[, isfinal])`7980Разбирает содержимое строки *data*, вызывая соответствующие функции-обработчики для обработки разобранных данных. *isfinal* должен быть истинным при последнем вызове этого метода; это позволяет разбирать один файл по частям, а не передавать несколько файлов. *data* может быть пустой строкой в любой момент.8182#### `xmlparser.ParseFile(file)`8384Разбирает XML-данные, читая из объекта *file*. *file* должен предоставлять только метод `read(nbytes)`, возвращающий пустую строку, когда данных больше нет.8586#### `xmlparser.SetBase(base)`8788Устанавливает базовый URI, используемый для разрешения относительных URI в системных идентификаторах в объявлениях. Разрешение относительных идентификаторов оставлено на усмотрение приложения: это значение будет передано как аргумент *base* в функции [`ExternalEntityRefHandler()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler), [`NotationDeclHandler()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.NotationDeclHandler) и [`UnparsedEntityDeclHandler()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.UnparsedEntityDeclHandler).8990#### `xmlparser.GetBase()`9192Возвращает строку, содержащую базовый URI, установленный предыдущим вызовом [`SetBase()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.SetBase), или `None`, если [`SetBase()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.SetBase) не вызывался.9394#### `xmlparser.GetInputContext()`9596Возвращает входные данные, которые породили текущее событие, в виде строки. Данные находятся в кодировке сущности, содержащей текст. Если этот метод вызван, когда обработчик события не активен, возвращается значение `None`.9798#### `xmlparser.ExternalEntityParserCreate(context[, encoding])`99100Создаёт «дочерний» анализатор, который можно использовать для разбора внешней разобранной сущности, на которую ссылается содержимое, разобранное родительским анализатором. Параметр *контекст* должен быть строкой, переданной в функцию-обработчик [`ExternalEntityRefHandler()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler), описанную ниже. Дочерний анализатор создаётся с [`ordered_attributes`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ordered_attributes) и [`specified_attributes`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.specified_attributes), установленными в значения этого анализатора.101102#### `xmlparser.SetParamEntityParsing(flag)`103104Управляет разбором сущностей-параметров (включая внешнее подмножество DTD). Возможные значения *флаг*: `XML_PARAM_ENTITY_PARSING_NEVER`, `XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE` и `XML_PARAM_ENTITY_PARSING_ALWAYS`. Возвращает true, если установка флага прошла успешно.105106#### `xmlparser.UseForeignDTD([flag])`107108Вызов этого метода с истинным значением для *флаг* (по умолчанию) приведёт к тому, что Expat вызовет [`ExternalEntityRefHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler) с [`None`](https://python-all.ru/3.12/library/constants.html#None) для всех аргументов, чтобы разрешить загрузку альтернативной DTD. Если документ не содержит объявления типа документа, [`ExternalEntityRefHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler) всё равно будет вызван, но [`StartDoctypeDeclHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.StartDoctypeDeclHandler) и [`EndDoctypeDeclHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.EndDoctypeDeclHandler) вызваны не будут.109110Передача ложного значения для *флаг* отменяет предыдущий вызов, в котором передавалось истинное значение, но в остальном не имеет эффекта.111112Этот метод можно вызывать только до вызова методов [`Parse()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.Parse) или [`ParseFile()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ParseFile); если вызвать его после любого из них, будет возбуждено [`ExpatError`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError) с атрибутом [`code`](https://python-all.ru/3.12/library/code.html#module-code), установленным в `errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]`.113114#### `xmlparser.SetReparseDeferralEnabled(enabled)`115116> **Предупреждение**117>118> Вызов `SetReparseDeferralEnabled(False)` может иметь последствия для безопасности, как описано ниже; убедитесь, что вы понимаете эти последствия, прежде чем использовать метод `SetReparseDeferralEnabled`.119120Expat 2.6.0 ввёл механизм безопасности под названием «отложенное перевыделение» (reparse deferral), при котором вместо того, чтобы вызывать отказ в обслуживании из-за квадратичного времени выполнения при повторном разборе больших токенов, повторный разбор незавершённых токенов теперь по умолчанию откладывается до тех пор, пока не будет получено достаточное количество входных данных. Из-за этой задержки зарегистрированные обработчики могут – в зависимости от размера входных фрагментов, передаваемых Expat – больше не вызываться сразу после передачи новых данных анализатору. Если необходимо как немедленное реагирование, так и взятие на себя ответственности за защиту от отказа в обслуживании из-за больших токенов, вызов `SetReparseDeferralEnabled(False)` отключает отложенное перевыделение для текущего экземпляра экспатовского анализатора (временно или полностью). Вызов `SetReparseDeferralEnabled(True)` позволяет снова включить отложенное перевыделение.121122Обратите внимание, что [`SetReparseDeferralEnabled()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.SetReparseDeferralEnabled) был перенесён в некоторые предыдущие выпуски CPython в качестве исправления безопасности. Проверьте наличие [`SetReparseDeferralEnabled()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.SetReparseDeferralEnabled) с помощью [`hasattr()`](https://python-all.ru/3.12/library/functions.html#hasattr), если этот метод используется в коде, работающем на разных версиях Python.123124Добавлено в версии 3.12.3.125126#### `xmlparser.GetReparseDeferralEnabled()`127128Возвращает, включено ли в данный момент отложенное перевыделение для данного экземпляра анализатора Expat.129130Добавлено в версии 3.12.3.131132У объектов `xmlparser` есть следующие методы для смягчения некоторых распространённых уязвимостей XML.133134#### `xmlparser.SetAllocTrackerActivationThreshold(threshold, /)`135136Устанавливает количество байт динамической памяти, необходимых для активации защиты от непропорционального использования оперативной памяти.137138По умолчанию порог активации отслеживания выделения памяти у объектов-парсеров составляет 64 МиБ, или 67 108 864 байта.139140Исключение [`ExpatError`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError) возникает, если этот метод вызывается для [некорневого](https://python-all.ru/3.12/library/pyexpat.html#xmlparser-non-root) парсера. Соответствующие [`lineno`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError.lineno) и [`offset`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError.offset) не следует использовать, так как они могут не иметь специального значения.141142Добавлено в версии 3.12.13.143144#### `xmlparser.SetAllocTrackerMaximumAmplification(max_factor, /)`145146Устанавливает максимальный коэффициент усиления между прямым вводом и байтами выделенной динамической памяти.147148Коэффициент усиления вычисляется как `allocated / direct` во время разбора, где `direct` – число байт, прочитанных из основного документа при разборе, а `allocated` – число байт динамической памяти, выделенной в иерархии парсера.149150Значение *max\_factor* должно быть не NaN [`float`](https://python-all.ru/3.12/library/functions.html#float) значением больше или равным 1.0. На практике коэффициенты усиления больше 100.0 могут наблюдаться вблизи начала разбора даже для безвредных файлов. В частности, порог активации следует тщательно выбирать, чтобы избежать ложных срабатываний.151152По умолчанию у объектов-парсеров максимальный коэффициент усиления равен 100.0.153154Исключение [`ExpatError`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError) возникает, если этот метод вызывается для [некорневого](https://python-all.ru/3.12/library/pyexpat.html#xmlparser-non-root) парсера или если *max\_factor* находится за пределами допустимого диапазона. Соответствующие [`lineno`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError.lineno) и [`offset`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError.offset) не следует использовать, так как они могут не иметь специального значения.155156> **Примечание**157>158> Максимальный коэффициент усиления учитывается только в том случае, если превышен порог, который можно настроить с помощью [`SetAllocTrackerActivationThreshold()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.SetAllocTrackerActivationThreshold).159160Добавлено в версии 3.12.13.161162Объекты `xmlparser` имеют следующие атрибуты:163164#### `xmlparser.buffer_size`165166Размер буфера, используемого, когда [`buffer_text`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text) истинно. Новый размер буфера можно установить, присвоив новое целое значение этому атрибуту. При изменении размера буфер будет сброшен.167168#### `xmlparser.buffer_text`169170Установка этого атрибута в true заставляет объект `xmlparser` буферизировать текстовое содержимое, возвращаемое Expat, чтобы по возможности избежать множественных вызовов колбэка [`CharacterDataHandler()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.CharacterDataHandler). Это может существенно повысить производительность, поскольку Expat обычно разбивает символьные данные на фрагменты на каждом конце строки. По умолчанию этот атрибут равен false, и его можно изменить в любое время. Обратите внимание: когда он равен false, данные, не содержащие переводов строк, также могут быть разбиты на фрагменты.171172#### `xmlparser.buffer_used`173174Если [`buffer_text`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text) включено, количество байт, хранящихся в буфере. Эти байты представляют текст в кодировке UTF-8. Этот атрибут не имеет осмысленной интерпретации, когда [`buffer_text`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text) равно false.175176#### `xmlparser.ordered_attributes`177178Установка этого атрибута в ненулевое целое число приводит к тому, что атрибуты возвращаются в виде списка, а не словаря. Атрибуты представляются в порядке их появления в тексте документа. Для каждого атрибута возвращаются два элемента списка: имя атрибута и значение атрибута. (Более старые версии этого модуля также использовали этот формат.) По умолчанию этот атрибут равен false; его можно изменить в любое время.179180#### `xmlparser.specified_attributes`181182Если установить в ненулевое целое число, парсер будет сообщать только те атрибуты, которые были указаны в экземпляре документа, а не те, которые получены из объявлений атрибутов. Приложения, устанавливающие этот флаг, должны быть особенно внимательны, чтобы использовать дополнительную информацию из объявлений по мере необходимости для соблюдения стандартов поведения XML-процессоров. По умолчанию этот атрибут равен false; его можно изменить в любое время.183184Следующие атрибуты содержат значения, относящиеся к последней ошибке, возникшей в объекте `xmlparser`, и будут иметь корректные значения только после того, как вызов `Parse()` или `ParseFile()` вызвал исключение [`xml.parsers.expat.ExpatError`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError).185186#### `xmlparser.ErrorByteIndex`187188Индекс байта, на котором произошла ошибка.189190#### `xmlparser.ErrorCode`191192Числовой код, определяющий проблему. Это значение можно передать в функцию [`ErrorString()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ErrorString) или сравнить с одной из констант, определенных в объекте `errors`.193194#### `xmlparser.ErrorColumnNumber`195196Номер столбца, на котором произошла ошибка.197198#### `xmlparser.ErrorLineNumber`199200Номер строки, в которой произошла ошибка.201202Следующие атрибуты содержат значения, относящиеся к текущей позиции разбора в объекте `xmlparser`. Во время колбэка, сообщающего о событии разбора, они указывают местоположение первого символа из последовательности, которая породила это событие. При вызове вне колбэка указанная позиция будет находиться сразу после последнего события разбора (независимо от того, был ли связанный с ним колбэк).203204#### `xmlparser.CurrentByteIndex`205206Текущий индекс байта во входных данных парсера.207208#### `xmlparser.CurrentColumnNumber`209210Текущий номер колонки во входных данных парсера.211212#### `xmlparser.CurrentLineNumber`213214Текущий номер строки во входных данных парсера.215216Вот список обработчиков, которые можно установить. Чтобы установить обработчик на объект `xmlparser` *o*, используйте `o.handlername = func`. *handlername* должен быть взят из следующего списка, а *func* должен быть вызываемым объектом, принимающим правильное количество аргументов. Все аргументы являются строками, если не указано иное.217218#### `xmlparser.XmlDeclHandler(version, encoding, standalone)`219220Вызывается при разборе XML-декларации. XML-декларация – это (необязательное) объявление используемой версии рекомендации XML, кодировки текста документа и необязательное объявление «standalone». *version* и *encoding* будут строками, а *standalone* будет `1`, если документ объявлен как standalone, `0`, если объявлено, что он не является standalone, или `-1`, если атрибут standalone был опущен. Доступно только в Expat версии 1.95.0 или новее.221222#### `xmlparser.StartDoctypeDeclHandler(doctypeName, systemId, publicId, has_internal_subset)`223224Вызывается, когда Expat начинает разбор объявления типа документа (`<!DOCTYPE ...`). Параметр *doctypeName* передаётся в точности так, как представлен. Параметры *systemId* и *publicId* задают системный и публичный идентификаторы, если они указаны, или `None`, если опущены. *has\_internal\_subset* будет иметь значение true, если документ содержит внутреннее подмножество объявления документа. Для этого требуется Expat версии 1.2 или новее.225226#### `xmlparser.EndDoctypeDeclHandler()`227228Вызывается, когда Expat завершил разбор объявления типа документа. Требуется Expat версии 1.2 или новее.229230#### `xmlparser.ElementDeclHandler(name, model)`231232Вызывается один раз для каждого объявления типа элемента. *name* – это имя типа элемента, а *model* – представление модели содержимого.233234#### `xmlparser.AttlistDeclHandler(elname, attname, type, default, required)`235236Вызывается для каждого объявленного атрибута типа элемента. Если в объявлении списка атрибутов объявлено три атрибута, этот обработчик вызывается три раза – по одному на каждый атрибут. *elname* – это имя элемента, к которому относится объявление, а *attname* – имя объявленного атрибута. Тип атрибута – строка, передаваемая как *type*; возможные значения: `'CDATA'`, `'ID'`, `'IDREF'`, … *default* задаёт значение по умолчанию для атрибута, используемое, когда атрибут не указан в экземпляре документа, или `None`, если значение по умолчанию отсутствует (значения `#IMPLIED`). Если атрибут обязателен для указания в экземпляре документа, *required* будет true. Требуется Expat версии 1.95.0 или новее.237238#### `xmlparser.StartElementHandler(name, attributes)`239240Вызывается для начала каждого элемента. *name* – строка, содержащая имя элемента, а *attributes* – атрибуты элемента. Если [`ordered_attributes`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ordered_attributes) равно true, это список (см. [`ordered_attributes`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ordered_attributes) для полного описания). В противном случае это словарь, отображающий имена в значения.241242#### `xmlparser.EndElementHandler(name)`243244Вызывается для конца каждого элемента.245246#### `xmlparser.ProcessingInstructionHandler(target, data)`247248Вызывается для каждой инструкции по обработке.249250#### `xmlparser.CharacterDataHandler(data)`251252Вызывается для символьных данных. Вызывается для обычных символьных данных, содержимого, помеченного CDATA, и игнорируемых пробелов. Приложения, которым необходимо различать эти случаи, могут использовать колбэки [`StartCdataSectionHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.StartCdataSectionHandler), [`EndCdataSectionHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.EndCdataSectionHandler) и [`ElementDeclHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.ElementDeclHandler) для сбора необходимой информации. Обратите внимание, что символьные данные могут быть разбиты на фрагменты, даже если они короткие, поэтому вы можете получить несколько вызовов [`CharacterDataHandler()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.CharacterDataHandler). Чтобы избежать этого, установите атрибут экземпляра [`buffer_text`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text) в `True`.253254#### `xmlparser.UnparsedEntityDeclHandler(entityName, base, systemId, publicId, notationName)`255256Вызывается для объявлений неразобранных (NDATA) сущностей. Присутствует только для версии 1.2 библиотеки Expat; для более новых версий используйте [`EntityDeclHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.EntityDeclHandler). (Базовая функция в библиотеке Expat объявлена устаревшей.)257258#### `xmlparser.EntityDeclHandler(entityName, is_parameter_entity, value, base, systemId, publicId, notationName)`259260Вызывается для всех объявлений сущностей. Для параметрических и внутренних сущностей *value* будет строкой, содержащей объявленное содержимое сущности; для внешних сущностей это будет `None`. Параметр *notationName* будет `None` для разобранных сущностей и именем нотации для неразобранных сущностей. *is\_parameter\_entity* будет true, если сущность является параметрической, и false для общих сущностей (большинству приложений нужно иметь дело только с общими сущностями). Доступно начиная с версии 1.95.0 библиотеки Expat.261262#### `xmlparser.NotationDeclHandler(notationName, base, systemId, publicId)`263264Вызывается для объявлений нотации. *notationName*, *base*, *systemId* и *publicId* являются строками, если заданы. Если public identifier опущен, *publicId* будет `None`.265266#### `xmlparser.StartNamespaceDeclHandler(prefix, uri)`267268Вызывается, когда элемент содержит объявление пространства имён. Объявления пространств имён обрабатываются до вызова [`StartElementHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.StartElementHandler) для элемента, на котором эти объявления находятся.269270#### `xmlparser.EndNamespaceDeclHandler(prefix)`271272Вызывается, когда для элемента, содержащего объявление пространства имён, достигнут закрывающий тег. Этот вызов производится один раз для каждого объявления пространства имён в элементе, в порядке, обратном тому, в котором [`StartNamespaceDeclHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.StartNamespaceDeclHandler) вызывался для обозначения начала области видимости каждого объявления. Вызовы этого обработчика происходят после соответствующего [`EndElementHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.EndElementHandler) для конца элемента.273274#### `xmlparser.CommentHandler(data)`275276Вызывается для комментариев. *data* – текст комментария, без начальных `'<!-``-'` и конечных `'-``->'`.277278#### `xmlparser.StartCdataSectionHandler()`279280Вызывается в начале секции CDATA. Этот обработчик и [`EndCdataSectionHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.EndCdataSectionHandler) нужны, чтобы можно было определить синтаксическое начало и конец секций CDATA.281282#### `xmlparser.EndCdataSectionHandler()`283284Вызывается в конце секции CDATA.285286#### `xmlparser.DefaultHandler(data)`287288Вызывается для любых символов в XML-документе, для которых не был указан подходящий обработчик. Это символы, которые являются частью конструкции, о которой можно было бы сообщить, но для которой не предоставлен обработчик.289290#### `xmlparser.DefaultHandlerExpand(data)`291292То же, что и [`DefaultHandler()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.DefaultHandler), но не подавляет раскрытие внутренних сущностей. Ссылка на сущность не будет передана обработчику по умолчанию.293294#### `xmlparser.NotStandaloneHandler()`295296Вызывается, если XML-документ не был объявлен как самостоятельный (standalone). Это происходит, когда присутствует внешнее подмножество или ссылка на параметрическую сущность, но объявление XML не устанавливает standalone равным `yes`. Если этот обработчик возвращает `0`, то синтаксический анализатор вызовет ошибку `XML_ERROR_NOT_STANDALONE`. Если обработчик не задан, в этом случае анализатор не генерирует исключение.297298#### `xmlparser.ExternalEntityRefHandler(context, base, systemId, publicId)`299300Вызывается для ссылок на внешние сущности. *base* – текущий базовый адрес, заданный предыдущим вызовом [`SetBase()`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.SetBase). Публичный и системный идентификаторы, *systemId* и *publicId*, являются строками, если заданы; если публичный идентификатор не задан, *publicId* будет `None`. Значение *context* непрозрачно и должно использоваться только так, как описано ниже.301302Чтобы внешние сущности были разобраны, этот обработчик должен быть реализован. Он отвечает за создание подчиненного анализатора с помощью `ExternalEntityParserCreate(context)`, его инициализацию соответствующими колбэками и разбор сущности. Обработчик должен возвращать целое число; если возвращается `0`, анализатор вызовет ошибку `XML_ERROR_EXTERNAL_ENTITY_HANDLING`, в противном случае разбор продолжится.303304Если этот обработчик не предоставлен, внешние сущности сообщаются через колбэк [`DefaultHandler`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.xmlparser.DefaultHandler), если он задан.305306## Исключения ExpatError307308Исключения [`ExpatError`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.ExpatError) имеют несколько интересных атрибутов:309310#### `ExpatError.code`311312Внутренний номер ошибки Expat для данной ошибки. Словарь [`errors.messages`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.errors.messages) сопоставляет эти номера с сообщениями об ошибках Expat. Например:313314```python315from xml.parsers.expat import ParserCreate, ExpatError, errors316317p = ParserCreate()318try:319    p.Parse(some_xml_document)320except ExpatError as err:321    print("Error:", errors.messages[err.code])322```323324Модуль [`errors`](https://python-all.ru/3.12/library/pyexpat.html#module-xml.parsers.expat.errors) также предоставляет константы сообщений об ошибках и словарь [`codes`](https://python-all.ru/3.12/library/pyexpat.html#xml.parsers.expat.errors.codes), сопоставляющий эти сообщения обратно с кодами ошибок; см. ниже.325326#### `ExpatError.lineno`327328Номер строки, в которой обнаружена ошибка. Первая строка нумеруется как `1`.329330#### `ExpatError.offset`331332Смещение символов внутри строки, где произошла ошибка. Первый столбец нумеруется как `0`.333334## Пример335336Следующая программа определяет три обработчика, которые просто выводят свои аргументы.337338```python339import xml.parsers.expat340341# 3 функции-обработчика342def start_element(name, attrs):343    print('Start element:', name, attrs)344def end_element(name):345    print('End element:', name)346def char_data(data):347    print('Character data:', repr(data))348349p = xml.parsers.expat.ParserCreate()350351p.StartElementHandler = start_element352p.EndElementHandler = end_element353p.CharacterDataHandler = char_data354355p.Parse("""<?xml version="1.0"?>356<parent id="top"><child1 name="paul">Text goes here</child1>357<child2 name="fred">More text</child2>358</parent>""", 1)359```360361Результат работы этой программы:362363```python364Start element: parent {'id': 'top'}365Start element: child1 {'name': 'paul'}366Character data: 'Text goes here'367End element: child1368Character data: '\n'369Start element: child2 {'name': 'fred'}370Character data: 'More text'371End element: child2372Character data: '\n'373End element: parent374```375376## Описания моделей содержимого377378Модели содержимого описываются с помощью вложенных кортежей. Каждый кортеж содержит четыре значения: тип, квантификатор, имя и кортеж дочерних элементов. Дочерние элементы – это просто дополнительные описания моделей содержимого.379380Значения первых двух полей – это константы, определённые в модуле [`xml.parsers.expat.model`](https://python-all.ru/3.12/library/pyexpat.html#module-xml.parsers.expat.model). Эти константы можно разделить на две группы: группа типов моделей и группа квантификаторов.381382Константы группы типов моделей:383384#### `xml.parsers.expat.model.XML_CTYPE_ANY`385386Элемент, названный именем модели, был объявлен как имеющий модель содержимого `ANY`.387388#### `xml.parsers.expat.model.XML_CTYPE_CHOICE`389390Именованный элемент допускает выбор из нескольких вариантов; это используется для моделей содержимого, таких как `(A | B | C)`.391392#### `xml.parsers.expat.model.XML_CTYPE_EMPTY`393394Элементы, объявленные как `EMPTY`, имеют этот тип модели.395396#### `xml.parsers.expat.model.XML_CTYPE_MIXED`397398#### `xml.parsers.expat.model.XML_CTYPE_NAME`399400#### `xml.parsers.expat.model.XML_CTYPE_SEQ`401402Модели, представляющие последовательность моделей, следующих одна за другой, обозначаются этим типом. Это используется для моделей, таких как `(A, B, C)`.403404Константы группы квантификаторов:405406#### `xml.parsers.expat.model.XML_CQUANT_NONE`407408Модификатор не указан, поэтому элемент может появиться ровно один раз, как в `A`.409410#### `xml.parsers.expat.model.XML_CQUANT_OPT`411412Модель необязательна: может появиться один раз или не появиться вовсе, как в `A?`.413414#### `xml.parsers.expat.model.XML_CQUANT_PLUS`415416Модель должна встречаться один или более раз (как `A+`).417418#### `xml.parsers.expat.model.XML_CQUANT_REP`419420Модель должна встречаться ноль или более раз, как в `A*`.421422## Константы ошибок Expat423424Следующие константы предоставлены в модуле [`xml.parsers.expat.errors`](https://python-all.ru/3.12/library/pyexpat.html#module-xml.parsers.expat.errors). Эти константы полезны для интерпретации некоторых атрибутов объектов исключений `ExpatError`, возникающих при ошибке. Поскольку из соображений обратной совместимости значением констант является *сообщение* об ошибке, а не числовой *код* ошибки, это делается путём сравнения атрибута [`code`](https://python-all.ru/3.12/library/code.html#module-code) с `errors.codes[errors.XML_ERROR_CONSTANT_NAME]`.425426Модуль `errors` имеет следующие атрибуты:427428#### `xml.parsers.expat.errors.codes`429430Словарь, сопоставляющий строковые описания их кодам ошибок.431432Добавлено в версии 3.2.433434#### `xml.parsers.expat.errors.messages`435436Словарь, сопоставляющий числовые коды ошибок их строковым описаниям.437438Добавлено в версии 3.2.439440#### `xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY`441442#### `xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF`443444Ссылка на сущность в значении атрибута указывала на внешнюю сущность вместо внутренней.445446#### `xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF`447448Ссылка на символ указывала на символ, недопустимый в XML (например, символ `0` или ‘`&#0;`’).449450#### `xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF`451452Ссылка на сущность указывала на сущность, объявленную с помощью нотации, поэтому её невозможно разобрать.453454#### `xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE`455456Атрибут был использован более одного раза в одном открывающем теге.457458#### `xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING`459460#### `xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN`461462Возникает, когда входной байт не удаётся правильно сопоставить с символом; например, нулевой байт (значение `0`) во входном потоке UTF-8.463464#### `xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT`465466После корневого элемента встретилось что-то, кроме пробельных символов.467468#### `xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI`469470Объявление XML обнаружено не в начале входных данных.471472#### `xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS`473474Документ не содержит ни одного элемента (XML требует, чтобы каждый документ содержал ровно один корневой элемент).475476#### `xml.parsers.expat.errors.XML_ERROR_NO_MEMORY`477478Expat не смог выделить память внутри себя.479480#### `xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF`481482Ссылка на параметрическую сущность обнаружена там, где она не допускается.483484#### `xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR`485486Во входных данных обнаружен неполный символ.487488#### `xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF`489490Ссылка на сущность содержала другую ссылку на ту же самую сущность; возможно, через другое имя, и возможно, косвенную.491492#### `xml.parsers.expat.errors.XML_ERROR_SYNTAX`493494Обнаружена некоторая неопределённая синтаксическая ошибка.495496#### `xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH`497498Закрывающий тег не соответствует самому внутреннему открытому открывающему тегу.499500#### `xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN`501502Какой-то токен (например, открывающий тег) не был закрыт до конца потока или до встречи следующего токена.503504#### `xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY`505506Ссылка на неопределённую сущность.507508#### `xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING`509510Кодировка документа не поддерживается Expat.511512#### `xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION`513514Раздел CDATA не был закрыт.515516#### `xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING`517518#### `xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE`519520Парсер определил, что документ не является «standalone», хотя в XML-декларации он объявлен таковым, и `NotStandaloneHandler` был установлен и вернул `0`.521522#### `xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE`523524#### `xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE`525526#### `xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD`527528Запрошена операция, требующая встроенной поддержки DTD, но Expat скомпилирован без неё. Стандартная сборка модуля [`xml.parsers.expat`](https://python-all.ru/3.12/library/pyexpat.html#module-xml.parsers.expat) никогда не должна выдавать эту ошибку.529530#### `xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING`531532После начала разбора была запрошена смена поведения, которая возможна только до его начала. В настоящее время это возбуждается только `UseForeignDTD()`.533534#### `xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX`535536При включённой обработке пространств имён обнаружен необъявленный префикс.537538#### `xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX`539540Документ пытается удалить объявление пространства имён, связанное с префиксом.541542#### `xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE`543544Параметрическая сущность содержит неполную разметку.545546#### `xml.parsers.expat.errors.XML_ERROR_XML_DECL`547548В документе отсутствует корневой элемент.549550#### `xml.parsers.expat.errors.XML_ERROR_TEXT_DECL`551552Ошибка при разборе текстовой декларации во внешней сущности.553554#### `xml.parsers.expat.errors.XML_ERROR_PUBLICID`555556В публичном идентификаторе обнаружены недопустимые символы.557558#### `xml.parsers.expat.errors.XML_ERROR_SUSPENDED`559560Запрошенная операция выполнена на приостановленном парсере, но не разрешена. Сюда входят попытки передать дополнительные данные или остановить парсер.561562#### `xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED`563564Попытка возобновить работу парсера, когда он не был приостановлен.565566#### `xml.parsers.expat.errors.XML_ERROR_ABORTED`567568Это не должно сообщаться приложениям Python.569570#### `xml.parsers.expat.errors.XML_ERROR_FINISHED`571572Попытка выполнить операцию над парсером, который уже закончил разбор входных данных, но такая операция запрещена. Сюда относятся попытки передать дополнительные данные или остановить парсер.573574#### `xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE`575576#### `xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML`577578Была предпринята попытка отменить объявление зарезервированного префикса пространства имён `xml` или привязать его к другому URI пространства имён.579580#### `xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS`581582Была предпринята попытка объявить или отменить объявление зарезервированного префикса пространства имён `xmlns`.583584#### `xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI`585586Была предпринята попытка привязать URI одного из зарезервированных префиксов пространства имён `xml` и `xmlns` к другому префиксу пространства имён.587588#### `xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT`589590Это не должно сообщаться приложениям Python.591592#### `xml.parsers.expat.errors.XML_ERROR_NO_BUFFER`593594Это не должно сообщаться приложениям Python.595596#### `xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH`597598Превышен лимит коэффициента усиления входных данных (от DTD и сущностей).599600Сноски601602\[[1](https://python-all.ru/3.12/library/pyexpat.html#id1)\]603604Строка кодировки, указанная в XML-выводе, должна соответствовать соответствующим стандартам. Например, «UTF-8» допустимо, а «UTF8» – нет. См. [https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl](https://python-all.ru/3.12/library/pyexpat.html) и [https://www.iana.org/assignments/character-sets/character-sets.xhtml](https://python-all.ru/3.12/library/pyexpat.html).605