> **Источник:** https://python-all.ru/3.16/library/pyexpat.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# `xml.parsers.expat` – Быстрый разбор XML с помощью Expat

---

> **Примечание**
>
> Если требуется разобрать непроверенные или неаутентифицированные данные, см. [Безопасность XML](https://python-all.ru/3.16/library/xml.html#xml-security).

Модуль `xml.parsers.expat` представляет собой интерфейс Python к непроверяющему XML-парсеру Expat. Модуль предоставляет один тип расширения, `xmlparser`, который представляет текущее состояние XML-парсера. После создания объекта `xmlparser` различные атрибуты объекта можно установить в функции-обработчики. Когда XML-документ затем передается парсеру, функции-обработчики вызываются для символьных данных и разметки в XML-документе.

Этот модуль использует модуль `pyexpat` для доступа к парсеру Expat. Прямое использование модуля `pyexpat` устарело.

Этот модуль предоставляет одно исключение и один объект типа:

#### `exception xml.parsers.expat.ExpatError`

Исключение, возникающее, когда Expat сообщает об ошибке. См. раздел [Исключения ExpatError](https://python-all.ru/3.16/library/pyexpat.html#expaterror-objects) для получения дополнительной информации об интерпретации ошибок Expat.

#### `exception xml.parsers.expat.error`

Псевдоним для [`ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError).

#### `xml.parsers.expat.XMLParserType`

Тип возвращаемых значений функции [`ParserCreate()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ParserCreate).

Модуль `xml.parsers.expat` содержит две функции:

#### `xml.parsers.expat.ErrorString(errno)`

Возвращает пояснительную строку для заданного номера ошибки *errno*.

#### `xml.parsers.expat.ParserCreate(encoding=None, namespace_separator=None)`

Создаёт и возвращает новый объект `xmlparser`. *encoding* [\[1\]](https://python-all.ru/3.16/library/pyexpat.html#id3), если указан, должен быть строкой, задающей кодировку, используемую в XML-данных. Если он передан, он переопределит неявную или явную кодировку документа.

**Особенность реализации CPython:** Expat изначально понимает и обрабатывает UTF-8, UTF-16, UTF-16BE, UTF-16LE, ISO-8859-1 и US-ASCII. Для других кодировок (включая псевдонимы вроде Latin1 и ASCII) он переключается на Python. Поддерживаются большинство 8-битных кодировок и многие многобайтовые кодировки, такие как Shift\_JIS, хотя для неродных кодировок поддерживаются только символы из базовой многоязычной плоскости (`U+0000-U+FFFF`) (это ограничение также распространяется на псевдонимы, например UTF8). Эти ограничения действуют, только если *encoding* не указан.

Изменено в версии 3.16.0a0 (не выпущена): Добавлена поддержка многобайтовых кодировок.

Парсеры, созданные через `ParserCreate()`, называются «корневыми» парсерами в том смысле, что к ним не прикреплен родительский парсер. Некорневые парсеры создаются с помощью [`parser.ExternalEntityParserCreate`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityParserCreate).

Expat может опционально выполнять обработку пространств имен XML, что включается предоставлением значения для *namespace\_separator*. Значение должно быть строкой из одного символа; будет возбуждено [`ValueError`](https://python-all.ru/3.16/library/exceptions.html#ValueError), если строка имеет недопустимую длину (`None` считается эквивалентом отсутствия). Когда обработка пространств имен включена, имена типов элементов и имена атрибутов, принадлежащие пространству имен, будут расширены. Имя элемента, передаваемое обработчикам элементов `StartElementHandler` и `EndElementHandler`, будет конкатенацией URI пространства имен, символа-разделителя пространства имен и локальной части имени. Если разделитель пространства имен является нулевым байтом (`chr(0)`), то URI пространства имен и локальная часть будут объединены без разделителя.

Например, если *namespace\_separator* установлен в пробел (`' '`) и разбирается следующий документ:

```xml
<?xml version="1.0"?>
<root xmlns    = "http://default-namespace.org/"
      xmlns:py = "http://www.python.org/ns/">
  <py:elem1 />
  <elem2 xmlns="" />
</root>
```

`StartElementHandler` получит следующие строки для каждого элемента:

```python
http://default-namespace.org/ root
http://www.python.org/ns/ elem1
elem2
```

Из-за ограничений в библиотеке `Expat`, используемой `pyexpat`, возвращаемый экземпляр `xmlparser` может использоваться только для разбора одного XML-документа. Вызывайте `ParserCreate` для каждого документа, чтобы получить уникальные экземпляры парсера.

> **См. также**
>
> **[XML-парсер Expat](https://python-all.ru/3.16/library/pyexpat.html)**
>
> Домашняя страница проекта Expat.

## Объекты XMLParser

Объекты `xmlparser` имеют следующие методы:

#### `xmlparser.Parse(data[, isfinal])`

Разбирает содержимое строки *data*, вызывая соответствующие функции-обработчики для обработки разобранных данных. *isfinal* должен быть истинным при последнем вызове этого метода; это позволяет разбирать один файл по частям, а не передавать несколько файлов. *data* может быть пустой строкой в любой момент.

#### `xmlparser.ParseFile(file)`

Разбирает XML-данные, читая из объекта *file*. *file* должен предоставлять только метод `read(nbytes)`, возвращающий пустую строку, когда данных больше нет.

#### `xmlparser.SetBase(base)`

Устанавливает базовый URI, используемый для разрешения относительных URI в системных идентификаторах в объявлениях. Разрешение относительных идентификаторов оставлено на усмотрение приложения: это значение будет передано как аргумент *base* в функции [`ExternalEntityRefHandler()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler), [`NotationDeclHandler()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.NotationDeclHandler) и [`UnparsedEntityDeclHandler()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.UnparsedEntityDeclHandler).

#### `xmlparser.GetBase()`

Возвращает строку, содержащую базовый URI, установленный предыдущим вызовом [`SetBase()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.SetBase), или `None`, если `SetBase()` не вызывался.

#### `xmlparser.GetInputContext()`

Возвращает входные данные, которые породили текущее событие, в виде строки. Данные находятся в кодировке сущности, содержащей текст. Если этот метод вызван, когда обработчик события не активен, возвращается значение `None`.

#### `xmlparser.ExternalEntityParserCreate(context[, encoding])`

Создаёт «дочерний» анализатор, который можно использовать для разбора внешней разобранной сущности, на которую ссылается содержимое, разобранное родительским анализатором. Параметр *контекст* должен быть строкой, переданной в функцию-обработчик [`ExternalEntityRefHandler()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler), описанную ниже. Дочерний анализатор создаётся с [`ordered_attributes`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ordered_attributes) и [`specified_attributes`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.specified_attributes), установленными в значения этого анализатора.

#### `xmlparser.SetParamEntityParsing(flag)`

Управляет разбором сущностей-параметров (включая внешнее подмножество DTD). Возможные значения *флаг*: `XML_PARAM_ENTITY_PARSING_NEVER`, `XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE` и `XML_PARAM_ENTITY_PARSING_ALWAYS`. Возвращает true, если установка флага прошла успешно.

#### `xmlparser.UseForeignDTD([flag])`

Вызов этого метода с истинным значением для *флаг* (по умолчанию) приведёт к тому, что Expat вызовет [`ExternalEntityRefHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler) с [`None`](https://python-all.ru/3.16/library/constants.html#None) для всех аргументов, чтобы разрешить загрузку альтернативной DTD. Если документ не содержит объявления типа документа, `ExternalEntityRefHandler` всё равно будет вызван, но [`StartDoctypeDeclHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.StartDoctypeDeclHandler) и [`EndDoctypeDeclHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.EndDoctypeDeclHandler) вызваны не будут.

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

Этот метод можно вызывать только до вызова методов [`Parse()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.Parse) или [`ParseFile()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ParseFile); если вызвать его после любого из них, будет возбуждено [`ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError) с атрибутом [`code`](https://python-all.ru/3.16/library/code.html#module-code), установленным в `errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]`.

#### `xmlparser.SetReparseDeferralEnabled(enabled)`

> **Предупреждение**
>
> Вызов `SetReparseDeferralEnabled(False)` может иметь последствия для безопасности, как описано ниже; убедитесь, что вы понимаете эти последствия, прежде чем использовать метод `SetReparseDeferralEnabled`.

Expat 2.6.0 ввёл механизм безопасности под названием «отложенное перевыделение» (reparse deferral), при котором вместо того, чтобы вызывать отказ в обслуживании из-за квадратичного времени выполнения при повторном разборе больших токенов, повторный разбор незавершённых токенов теперь по умолчанию откладывается до тех пор, пока не будет получено достаточное количество входных данных. Из-за этой задержки зарегистрированные обработчики могут – в зависимости от размера входных фрагментов, передаваемых Expat – больше не вызываться сразу после передачи новых данных анализатору. Если необходимо как немедленное реагирование, так и взятие на себя ответственности за защиту от отказа в обслуживании из-за больших токенов, вызов `SetReparseDeferralEnabled(False)` отключает отложенное перевыделение для текущего экземпляра экспатовского анализатора (временно или полностью). Вызов `SetReparseDeferralEnabled(True)` позволяет снова включить отложенное перевыделение.

`SetReparseDeferralEnabled()` была перенесена в некоторые предыдущие выпуски CPython как исправление безопасности. Проверьте доступность с помощью [`hasattr()`](https://python-all.ru/3.16/library/functions.html#hasattr), если код работает на разных версиях Python.

Добавлено в версии 3.13.

#### `xmlparser.GetReparseDeferralEnabled()`

Возвращает, включено ли в данный момент отложенное перевыделение для данного экземпляра анализатора Expat.

Добавлено в версии 3.13.

Объекты `xmlparser` имеют следующие методы для настройки защиты от некоторых распространённых уязвимостей XML.

#### `xmlparser.SetBillionLaughsAttackProtectionActivationThreshold(threshold, /)`

Устанавливает количество выходных байтов, необходимое для активации защиты от атак [«миллиард смеха»](https://python-all.ru/3.16/library/pyexpat.html).

Количество выходных байтов включает усиление от расширения сущностей и чтения файлов DTD.

Объекты-анализаторы обычно имеют порог активации защиты 8 МиБ, но фактическое значение по умолчанию зависит от базовой библиотеки Expat.

Исключение [`ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError) возникает, если этот метод вызывается для [некорневого](https://python-all.ru/3.16/library/pyexpat.html#xmlparser-non-root) парсера. Соответствующие [`lineno`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.lineno) и [`offset`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.offset) не следует использовать, так как они могут не иметь специального значения.

`SetBillionLaughsAttackProtectionActivationThreshold()` была перенесена в некоторые предыдущие выпуски CPython как исправление безопасности. Проверьте доступность с помощью [`hasattr()`](https://python-all.ru/3.16/library/functions.html#hasattr), если код работает на разных версиях Python.

> **Примечание**
>
> Пороги активации ниже 4 МиБ, как известно, нарушают поддержку полезной нагрузки DITA 1.3, поэтому их не рекомендуется использовать.

Добавлено в версии 3.15.

#### `xmlparser.SetBillionLaughsAttackProtectionMaximumAmplification(max_factor, /)`

Устанавливает максимально допустимый коэффициент усиления для защиты от атак [«миллиард смеха»](https://python-all.ru/3.16/library/pyexpat.html).

Коэффициент усиления вычисляется как `(direct + indirect) / direct` во время разбора, где `direct` – количество байтов, прочитанных из основного документа при разборе, а `indirect` – количество байтов, добавленных за счёт расширения сущностей и чтения внешних файлов DTD.

Значение *макс\_фактор* должно быть не-NaN [`float`](https://python-all.ru/3.16/library/functions.html#float) значением, большим или равным 1.0. На практике наблюдались пиковые усиления в 15 000 раз для всей полезной нагрузки и в 30 000 раз в середине разбора для небольших безвредных файлов. В частности, порог активации следует тщательно выбирать, чтобы избежать ложных срабатываний.

Объекты парсера обычно имеют максимальный коэффициент усиления 100, но фактическое значение по умолчанию зависит от используемой библиотеки Expat.

Исключение [`ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError) возникает, если этот метод вызывается для [некорневого](https://python-all.ru/3.16/library/pyexpat.html#xmlparser-non-root) парсера или если *max\_factor* находится за пределами допустимого диапазона. Соответствующие [`lineno`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.lineno) и [`offset`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.offset) не следует использовать, так как они могут не иметь специального значения.

`SetBillionLaughsAttackProtectionMaximumAmplification()` была перенесена в некоторые предыдущие выпуски CPython как исправление безопасности. Проверьте доступность с помощью [`hasattr()`](https://python-all.ru/3.16/library/functions.html#hasattr), если код работает на разных версиях Python.

> **Примечание**
>
> Максимальный коэффициент усиления учитывается только в том случае, если превышен порог, который можно настроить с помощью [`SetBillionLaughsAttackProtectionActivationThreshold()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.SetBillionLaughsAttackProtectionActivationThreshold).

Добавлено в версии 3.15.

#### `xmlparser.SetAllocTrackerActivationThreshold(threshold, /)`

Устанавливает количество байт динамической памяти, необходимых для активации защиты от непропорционального использования оперативной памяти.

Объекты парсера обычно имеют порог активации выделения памяти 64 МиБ, но фактическое значение по умолчанию зависит от используемой библиотеки Expat.

Исключение [`ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError) возникает, если этот метод вызывается для [некорневого](https://python-all.ru/3.16/library/pyexpat.html#xmlparser-non-root) парсера. Соответствующие [`lineno`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.lineno) и [`offset`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.offset) не следует использовать, так как они могут не иметь специального значения.

`SetAllocTrackerActivationThreshold()` была перенесена в некоторые предыдущие выпуски CPython как исправление безопасности. Проверьте доступность с помощью [`hasattr()`](https://python-all.ru/3.16/library/functions.html#hasattr), если код работает на разных версиях Python.

Добавлено в версии 3.15.

#### `xmlparser.SetAllocTrackerMaximumAmplification(max_factor, /)`

Устанавливает максимальный коэффициент усиления между прямым вводом и байтами выделенной динамической памяти.

Коэффициент усиления вычисляется как `allocated / direct` во время разбора, где `direct` – число байт, прочитанных из основного документа при разборе, а `allocated` – число байт динамической памяти, выделенной в иерархии парсера.

Значение *max\_factor* должно быть не NaN [`float`](https://python-all.ru/3.16/library/functions.html#float) значением больше или равным 1.0. На практике коэффициенты усиления больше 100.0 могут наблюдаться вблизи начала разбора даже для безвредных файлов. В частности, порог активации следует тщательно выбирать, чтобы избежать ложных срабатываний.

Объекты парсера обычно имеют максимальный коэффициент усиления 100, но фактическое значение по умолчанию зависит от используемой библиотеки Expat.

Исключение [`ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError) возникает, если этот метод вызывается для [некорневого](https://python-all.ru/3.16/library/pyexpat.html#xmlparser-non-root) парсера или если *max\_factor* находится за пределами допустимого диапазона. Соответствующие [`lineno`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.lineno) и [`offset`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError.offset) не следует использовать, так как они могут не иметь специального значения.

`SetAllocTrackerMaximumAmplification()` была перенесена в некоторые предыдущие выпуски CPython как исправление безопасности. Проверьте доступность с помощью [`hasattr()`](https://python-all.ru/3.16/library/functions.html#hasattr), если код работает на разных версиях Python.

> **Примечание**
>
> Максимальный коэффициент усиления учитывается только в том случае, если превышен порог, который можно настроить с помощью [`SetAllocTrackerActivationThreshold()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.SetAllocTrackerActivationThreshold).

Добавлено в версии 3.15.

Объекты `xmlparser` имеют следующие атрибуты:

#### `xmlparser.buffer_size`

Размер буфера, используемого, когда [`buffer_text`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text) истинно. Новый размер буфера можно установить, присвоив новое целое значение этому атрибуту. При изменении размера буфер будет сброшен.

#### `xmlparser.buffer_text`

Установка этого атрибута в true заставляет объект `xmlparser` буферизировать текстовое содержимое, возвращаемое Expat, чтобы по возможности избежать множественных вызовов колбэка [`CharacterDataHandler()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.CharacterDataHandler). Это может существенно повысить производительность, поскольку Expat обычно разбивает символьные данные на фрагменты на каждом конце строки. По умолчанию этот атрибут равен false, и его можно изменить в любое время. Обратите внимание: когда он равен false, данные, не содержащие переводов строк, также могут быть разбиты на фрагменты.

#### `xmlparser.buffer_used`

Если [`buffer_text`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text) включено, количество байт, хранящихся в буфере. Эти байты представляют текст в кодировке UTF-8. Этот атрибут не имеет осмысленной интерпретации, когда `buffer_text` равно false.

#### `xmlparser.ordered_attributes`

Установка этого атрибута в ненулевое целое число приводит к тому, что атрибуты возвращаются в виде списка, а не словаря. Атрибуты представляются в порядке их появления в тексте документа. Для каждого атрибута возвращаются два элемента списка: имя атрибута и значение атрибута. (Более старые версии этого модуля также использовали этот формат.) По умолчанию этот атрибут равен false; его можно изменить в любое время.

#### `xmlparser.specified_attributes`

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

Следующие атрибуты содержат значения, относящиеся к последней ошибке, возникшей в объекте `xmlparser`, и будут иметь корректные значения только после того, как вызов `Parse()` или `ParseFile()` вызвал исключение [`xml.parsers.expat.ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError).

#### `xmlparser.ErrorByteIndex`

Индекс байта, на котором произошла ошибка.

#### `xmlparser.ErrorCode`

Числовой код, определяющий проблему. Это значение можно передать в функцию [`ErrorString()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ErrorString) или сравнить с одной из констант, определенных в объекте `errors`.

#### `xmlparser.ErrorColumnNumber`

Номер столбца, на котором произошла ошибка.

#### `xmlparser.ErrorLineNumber`

Номер строки, в которой произошла ошибка.

Следующие атрибуты содержат значения, относящиеся к текущей позиции разбора в объекте `xmlparser`. Во время колбэка, сообщающего о событии разбора, они указывают местоположение первого символа из последовательности, которая породила это событие. При вызове вне колбэка указанная позиция будет находиться сразу после последнего события разбора (независимо от того, был ли связанный с ним колбэк).

#### `xmlparser.CurrentByteIndex`

Текущий индекс байта во входных данных парсера.

#### `xmlparser.CurrentColumnNumber`

Текущий номер колонки во входных данных парсера.

#### `xmlparser.CurrentLineNumber`

Текущий номер строки во входных данных парсера.

Вот список обработчиков, которые можно установить. Чтобы установить обработчик на объект `xmlparser` *o*, используйте `o.handlername = func`. *handlername* должен быть взят из следующего списка, а *func* должен быть вызываемым объектом, принимающим правильное количество аргументов. Все аргументы являются строками, если не указано иное.

#### `xmlparser.XmlDeclHandler(version, encoding, standalone)`

Вызывается при разборе XML-декларации. XML-декларация – это (необязательное) объявление используемой версии рекомендации XML, кодировки текста документа и необязательное объявление «standalone». *version* и *encoding* будут строками, а *standalone* будет `1`, если документ объявлен как standalone, `0`, если объявлено, что он не является standalone, или `-1`, если атрибут standalone был опущен. Доступно только в Expat версии 1.95.0 или новее.

#### `xmlparser.StartDoctypeDeclHandler(doctypeName, systemId, publicId, has_internal_subset)`

Вызывается, когда Expat начинает разбирать объявление типа документа (`<!DOCTYPE ...`). *doctypeName* передаётся в точности как представлено. Параметры *systemId* и *publicId* содержат системный и публичный идентификаторы, если они указаны, или `None`, если опущены. *has\_internal\_subset* будет true, если документ содержит внутреннее подмножество объявления документа. Требуется Expat версии 1.2 или новее.

#### `xmlparser.EndDoctypeDeclHandler()`

Вызывается, когда Expat завершил разбор объявления типа документа. Требуется Expat версии 1.2 или новее.

#### `xmlparser.ElementDeclHandler(name, model)`

Вызывается один раз для каждого объявления типа элемента. *name* – это имя типа элемента, а *model* – представление модели содержимого.

#### `xmlparser.AttlistDeclHandler(elname, attname, type, default, required)`

Вызывается для каждого объявленного атрибута типа элемента. Если в объявлении списка атрибутов объявлено три атрибута, этот обработчик вызывается три раза – по одному на каждый атрибут. *elname* – это имя элемента, к которому относится объявление, а *attname* – имя объявленного атрибута. Тип атрибута – строка, передаваемая как *type*; возможные значения: `'CDATA'`, `'ID'`, `'IDREF'`, … *default* задаёт значение по умолчанию для атрибута, используемое, когда атрибут не указан в экземпляре документа, или `None`, если значение по умолчанию отсутствует (значения `#IMPLIED`). Если атрибут обязателен для указания в экземпляре документа, *required* будет true. Требуется Expat версии 1.95.0 или новее.

#### `xmlparser.StartElementHandler(name, attributes)`

Вызывается для начала каждого элемента. *name* – строка, содержащая имя элемента, а *attributes* – атрибуты элемента. Если [`ordered_attributes`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ordered_attributes) равно true, это список (см. `ordered_attributes` для полного описания). В противном случае это словарь, отображающий имена в значения.

#### `xmlparser.EndElementHandler(name)`

Вызывается для конца каждого элемента.

#### `xmlparser.ProcessingInstructionHandler(target, data)`

Вызывается для каждой инструкции по обработке.

#### `xmlparser.CharacterDataHandler(data)`

Вызывается для символьных данных. Вызывается для обычных символьных данных, содержимого, помеченного CDATA, и игнорируемых пробелов. Приложения, которым необходимо различать эти случаи, могут использовать колбэки [`StartCdataSectionHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.StartCdataSectionHandler), [`EndCdataSectionHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.EndCdataSectionHandler) и [`ElementDeclHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.ElementDeclHandler) для сбора необходимой информации. Обратите внимание, что символьные данные могут быть разбиты на фрагменты, даже если они короткие, поэтому вы можете получить несколько вызовов `CharacterDataHandler()`. Чтобы избежать этого, установите атрибут экземпляра [`buffer_text`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text) в `True`.

#### `xmlparser.UnparsedEntityDeclHandler(entityName, base, systemId, publicId, notationName)`

Вызывается для объявлений неразобранных (NDATA) сущностей. Присутствует только для версии 1.2 библиотеки Expat; для более новых версий используйте [`EntityDeclHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.EntityDeclHandler). (Базовая функция в библиотеке Expat объявлена устаревшей.)

#### `xmlparser.EntityDeclHandler(entityName, is_parameter_entity, value, base, systemId, publicId, notationName)`

Вызывается для всех объявлений сущностей. Для параметрических и внутренних сущностей *value* будет строкой, содержащей объявленное содержимое сущности; для внешних сущностей это будет `None`. Параметр *notationName* будет `None` для разобранных сущностей и именем нотации для неразобранных сущностей. *is\_parameter\_entity* будет true, если сущность является параметрической, и false для общих сущностей (большинству приложений нужно иметь дело только с общими сущностями). Доступно начиная с версии 1.95.0 библиотеки Expat.

#### `xmlparser.NotationDeclHandler(notationName, base, systemId, publicId)`

Вызывается для объявлений нотации. *notationName*, *base*, *systemId* и *publicId* являются строками, если заданы. Если public identifier опущен, *publicId* будет `None`.

#### `xmlparser.StartNamespaceDeclHandler(prefix, uri)`

Вызывается, когда элемент содержит объявление пространства имён. Объявления пространств имён обрабатываются до вызова [`StartElementHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.StartElementHandler) для элемента, на котором эти объявления находятся.

#### `xmlparser.EndNamespaceDeclHandler(prefix)`

Вызывается, когда для элемента, содержащего объявление пространства имён, достигнут закрывающий тег. Этот вызов производится один раз для каждого объявления пространства имён в элементе, в порядке, обратном тому, в котором [`StartNamespaceDeclHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.StartNamespaceDeclHandler) вызывался для обозначения начала области видимости каждого объявления. Вызовы этого обработчика происходят после соответствующего [`EndElementHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.EndElementHandler) для конца элемента.

#### `xmlparser.CommentHandler(data)`

Вызывается для комментариев. *data* – текст комментария, без начальных `'<!-``-'` и конечных `'-``->'`.

#### `xmlparser.StartCdataSectionHandler()`

Вызывается в начале секции CDATA. Этот обработчик и [`EndCdataSectionHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.EndCdataSectionHandler) нужны, чтобы можно было определить синтаксическое начало и конец секций CDATA.

#### `xmlparser.EndCdataSectionHandler()`

Вызывается в конце секции CDATA.

#### `xmlparser.DefaultHandler(data)`

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

#### `xmlparser.DefaultHandlerExpand(data)`

То же, что и [`DefaultHandler()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.DefaultHandler), но не подавляет раскрытие внутренних сущностей. Ссылка на сущность не будет передана обработчику по умолчанию.

#### `xmlparser.NotStandaloneHandler()`

Вызывается, если XML-документ не был объявлен как самостоятельный (standalone). Это происходит, когда присутствует внешнее подмножество или ссылка на параметрическую сущность, но объявление XML не устанавливает standalone равным `yes`. Если этот обработчик возвращает `0`, то синтаксический анализатор вызовет ошибку `XML_ERROR_NOT_STANDALONE`. Если обработчик не задан, в этом случае анализатор не генерирует исключение.

#### `xmlparser.ExternalEntityRefHandler(context, base, systemId, publicId)`

> **Предупреждение**
>
> Реализация обработчика, который обращается к локальным файлам и/или сети, может создать уязвимость для [атак с использованием внешних сущностей](https://python-all.ru/3.16/library/pyexpat.html), если `xmlparser` используется с пользовательским содержимым XML. Пожалуйста, продумайте [модель угроз](https://python-all.ru/3.16/library/pyexpat.html) перед реализацией этого обработчика.

Вызывается для ссылок на внешние сущности. *base* – текущий базовый адрес, заданный предыдущим вызовом [`SetBase()`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.SetBase). Публичный и системный идентификаторы, *systemId* и *publicId*, являются строками, если заданы; если публичный идентификатор не задан, *publicId* будет `None`. Значение *context* непрозрачно и должно использоваться только так, как описано ниже.

Чтобы внешние сущности были разобраны, этот обработчик должен быть реализован. Он отвечает за создание подчиненного анализатора с помощью `ExternalEntityParserCreate(context)`, его инициализацию соответствующими колбэками и разбор сущности. Обработчик должен возвращать целое число; если возвращается `0`, анализатор вызовет ошибку `XML_ERROR_EXTERNAL_ENTITY_HANDLING`, в противном случае разбор продолжится.

Если этот обработчик не предоставлен, внешние сущности сообщаются через колбэк [`DefaultHandler`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.xmlparser.DefaultHandler), если он задан.

## Исключения ExpatError

Исключения [`ExpatError`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.ExpatError) имеют несколько интересных атрибутов:

#### `ExpatError.code`

Внутренний номер ошибки Expat для данной ошибки. Словарь [`errors.messages`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.errors.messages) сопоставляет эти номера с сообщениями об ошибках Expat. Например:

```python
from xml.parsers.expat import ParserCreate, ExpatError, errors

p = ParserCreate()
try:
    p.Parse(some_xml_document)
except ExpatError as err:
    print("Error:", errors.messages[err.code])
```

Модуль [`errors`](https://python-all.ru/3.16/library/pyexpat.html#module-xml.parsers.expat.errors) также предоставляет константы сообщений об ошибках и словарь [`codes`](https://python-all.ru/3.16/library/pyexpat.html#xml.parsers.expat.errors.codes), сопоставляющий эти сообщения обратно с кодами ошибок; см. ниже.

#### `ExpatError.lineno`

Номер строки, в которой обнаружена ошибка. Первая строка нумеруется как `1`.

#### `ExpatError.offset`

Смещение символов внутри строки, где произошла ошибка. Первый столбец нумеруется как `0`.

## Пример

Следующая программа определяет три обработчика, которые просто выводят свои аргументы.

```python
import xml.parsers.expat

# 3 функции-обработчика
def start_element(name, attrs):
    print('Start element:', name, attrs)
def end_element(name):
    print('End element:', name)
def char_data(data):
    print('Character data:', repr(data))

p = xml.parsers.expat.ParserCreate()

p.StartElementHandler = start_element
p.EndElementHandler = end_element
p.CharacterDataHandler = char_data

p.Parse("""<?xml version="1.0"?>
<parent id="top"><child1 name="paul">Text goes here</child1>
<child2 name="fred">More text</child2>
</parent>""", 1)
```

Результат работы этой программы:

```python
Start element: parent {'id': 'top'}
Start element: child1 {'name': 'paul'}
Character data: 'Text goes here'
End element: child1
Character data: '\n'
Start element: child2 {'name': 'fred'}
Character data: 'More text'
End element: child2
Character data: '\n'
End element: parent
```

## Описания моделей содержимого

Модели содержимого описываются с помощью вложенных кортежей. Каждый кортеж содержит четыре значения: тип, квантификатор, имя и кортеж дочерних элементов. Дочерние элементы – это просто дополнительные описания моделей содержимого.

Значения первых двух полей – это константы, определённые в модуле `xml.parsers.expat.model`. Эти константы можно разделить на две группы: группа типов моделей и группа квантификаторов.

Константы группы типов моделей:

#### `xml.parsers.expat.model.XML_CTYPE_ANY`

Элемент, названный именем модели, был объявлен как имеющий модель содержимого `ANY`.

#### `xml.parsers.expat.model.XML_CTYPE_CHOICE`

Именованный элемент допускает выбор из нескольких вариантов; это используется для моделей содержимого, таких как `(A | B | C)`.

#### `xml.parsers.expat.model.XML_CTYPE_EMPTY`

Элементы, объявленные как `EMPTY`, имеют этот тип модели.

#### `xml.parsers.expat.model.XML_CTYPE_MIXED`

#### `xml.parsers.expat.model.XML_CTYPE_NAME`

#### `xml.parsers.expat.model.XML_CTYPE_SEQ`

Модели, представляющие последовательность моделей, следующих одна за другой, обозначаются этим типом. Это используется для моделей, таких как `(A, B, C)`.

Константы группы квантификаторов:

#### `xml.parsers.expat.model.XML_CQUANT_NONE`

Модификатор не указан, поэтому элемент может появиться ровно один раз, как в `A`.

#### `xml.parsers.expat.model.XML_CQUANT_OPT`

Модель необязательна: может появиться один раз или не появиться вовсе, как в `A?`.

#### `xml.parsers.expat.model.XML_CQUANT_PLUS`

Модель должна встречаться один или более раз (как `A+`).

#### `xml.parsers.expat.model.XML_CQUANT_REP`

Модель должна встречаться ноль или более раз, как в `A*`.

## Константы ошибок Expat

Следующие константы предоставлены в модуле `xml.parsers.expat.errors`. Эти константы полезны для интерпретации некоторых атрибутов объектов исключений `ExpatError`, возникающих при ошибке. Поскольку из соображений обратной совместимости значением констант является *сообщение* об ошибке, а не числовой *код* ошибки, это делается путём сравнения атрибута [`code`](https://python-all.ru/3.16/library/code.html#module-code) с `errors.codes[errors.XML_ERROR_CONSTANT_NAME]`.

Модуль `errors` имеет следующие атрибуты:

#### `xml.parsers.expat.errors.codes`

Словарь, сопоставляющий строковые описания их кодам ошибок.

Добавлено в версии 3.2.

#### `xml.parsers.expat.errors.messages`

Словарь, сопоставляющий числовые коды ошибок их строковым описаниям.

Добавлено в версии 3.2.

#### `xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY`

#### `xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF`

Ссылка на сущность в значении атрибута указывала на внешнюю сущность вместо внутренней.

#### `xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF`

Ссылка на символ указывала на символ, недопустимый в XML (например, символ `0` или ‘`&#0;`’).

#### `xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF`

Ссылка на сущность указывала на сущность, объявленную с помощью нотации, поэтому её невозможно разобрать.

#### `xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE`

Атрибут был использован более одного раза в одном открывающем теге.

#### `xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING`

#### `xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN`

Возникает, когда входной байт не удаётся правильно сопоставить с символом; например, нулевой байт (значение `0`) во входном потоке UTF-8.

#### `xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT`

После корневого элемента встретилось что-то, кроме пробельных символов.

#### `xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI`

Объявление XML обнаружено не в начале входных данных.

#### `xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS`

Документ не содержит ни одного элемента (XML требует, чтобы каждый документ содержал ровно один корневой элемент).

#### `xml.parsers.expat.errors.XML_ERROR_NO_MEMORY`

Expat не смог выделить память внутри себя.

#### `xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF`

Ссылка на параметрическую сущность обнаружена там, где она не допускается.

#### `xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR`

Во входных данных обнаружен неполный символ.

#### `xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF`

Ссылка на сущность содержала другую ссылку на ту же самую сущность; возможно, через другое имя, и возможно, косвенную.

#### `xml.parsers.expat.errors.XML_ERROR_SYNTAX`

Обнаружена некоторая неопределённая синтаксическая ошибка.

#### `xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH`

Закрывающий тег не соответствует самому внутреннему открытому открывающему тегу.

#### `xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN`

Какой-то токен (например, открывающий тег) не был закрыт до конца потока или до встречи следующего токена.

#### `xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY`

Ссылка на неопределённую сущность.

#### `xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING`

Кодировка документа не поддерживается Expat.

#### `xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION`

Раздел CDATA не был закрыт.

#### `xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING`

#### `xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE`

Парсер определил, что документ не является «standalone», хотя в XML-декларации он объявлен таковым, и `NotStandaloneHandler` был установлен и вернул `0`.

#### `xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE`

#### `xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE`

#### `xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD`

Запрошена операция, требующая встроенной поддержки DTD, но Expat скомпилирован без неё. Стандартная сборка модуля `xml.parsers.expat` никогда не должна выдавать эту ошибку.

#### `xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING`

После начала разбора была запрошена смена поведения, которая возможна только до его начала. В настоящее время это возбуждается только `UseForeignDTD()`.

#### `xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX`

При включённой обработке пространств имён обнаружен необъявленный префикс.

#### `xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX`

Документ пытается удалить объявление пространства имён, связанное с префиксом.

#### `xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE`

Параметрическая сущность содержит неполную разметку.

#### `xml.parsers.expat.errors.XML_ERROR_XML_DECL`

В документе отсутствует корневой элемент.

#### `xml.parsers.expat.errors.XML_ERROR_TEXT_DECL`

Ошибка при разборе текстовой декларации во внешней сущности.

#### `xml.parsers.expat.errors.XML_ERROR_PUBLICID`

В публичном идентификаторе обнаружены недопустимые символы.

#### `xml.parsers.expat.errors.XML_ERROR_SUSPENDED`

Запрошенная операция выполнена на приостановленном парсере, но не разрешена. Сюда входят попытки передать дополнительные данные или остановить парсер.

#### `xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED`

Попытка возобновить работу парсера, когда он не был приостановлен.

#### `xml.parsers.expat.errors.XML_ERROR_ABORTED`

Это не должно сообщаться приложениям Python.

#### `xml.parsers.expat.errors.XML_ERROR_FINISHED`

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

#### `xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE`

#### `xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML`

Была предпринята попытка отменить объявление зарезервированного префикса пространства имён `xml` или привязать его к другому URI пространства имён.

#### `xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS`

Была предпринята попытка объявить или отменить объявление зарезервированного префикса пространства имён `xmlns`.

#### `xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI`

Была предпринята попытка привязать URI одного из зарезервированных префиксов пространства имён `xml` и `xmlns` к другому префиксу пространства имён.

#### `xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT`

Это не должно сообщаться приложениям Python.

#### `xml.parsers.expat.errors.XML_ERROR_NO_BUFFER`

Это не должно сообщаться приложениям Python.

#### `xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH`

Превышен лимит коэффициента усиления входных данных (от DTD и сущностей).

#### `xml.parsers.expat.errors.XML_ERROR_NOT_STARTED`

Была предпринята попытка остановить или приостановить парсер до его запуска.

Добавлено в версии 3.14.

Сноски

\[[1](https://python-all.ru/3.16/library/pyexpat.html#id1)\]

Строка кодировки, включаемая в вывод XML, должна соответствовать соответствующим стандартам. Например, «UTF-8» допустима, а «UTF8» недопустима в объявлении XML-документа, хотя Python принимает её как имя кодировки. См. [https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl](https://python-all.ru/3.16/library/pyexpat.html) и [https://www.iana.org/assignments/character-sets/character-sets.xhtml](https://python-all.ru/3.16/library/pyexpat.html).