`xml.etree.elementtree.md`

875 строк · 74.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.7/library/xml.etree.elementtree.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`xml.etree.ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) – API ElementTree для XML89**Исходный код:** [Lib/xml/etree/ElementTree.py](https://python-all.ru/src/3.7/Lib/xml/etree/ElementTree.py)1011---1213Модуль [`xml.etree.ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) реализует простой и эффективный API для разбора и создания XML-данных.1415Изменено в версии 3.3: Этот модуль будет использовать быструю реализацию, когда она доступна. Модуль `xml.etree.cElementTree` устарел.1617> **Предупреждение**18>19> Модуль [`xml.etree.ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) не защищён от вредоносных данных. Если нужно разобрать непроверенные или неаутентифицированные данные, см. [уязвимости XML](https://python-all.ru/3.7/library/xml.html#xml-vulnerabilities).2021## Учебное руководство2223Это краткое руководство по использованию [`xml.etree.ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) (`ET` в краткой форме). Цель – продемонстрировать некоторые основные компоненты и базовые концепции модуля.2425### XML-дерево и элементы2627XML – это изначально иерархический формат данных, и наиболее естественный способ его представления – дерево. `ET` содержит два класса для этой цели: [`ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) представляет весь XML-документ как дерево, а [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) представляет отдельный узел в этом дереве. Взаимодействие со всем документом (чтение и запись в файлы/из файлов) обычно выполняется на уровне [`ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree). Взаимодействие с отдельным элементом XML и его дочерними элементами выполняется на уровне [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).2829### Разбор XML3031В этом разделе в качестве примера будет использоваться следующий XML-документ:3233```xml34<?xml version="1.0"?>35<data>36    <country name="Liechtenstein">37        <rank>1</rank>38        <year>2008</year>39        <gdppc>141100</gdppc>40        <neighbor name="Austria" direction="E"/>41        <neighbor name="Switzerland" direction="W"/>42    </country>43    <country name="Singapore">44        <rank>4</rank>45        <year>2011</year>46        <gdppc>59900</gdppc>47        <neighbor name="Malaysia" direction="N"/>48    </country>49    <country name="Panama">50        <rank>68</rank>51        <year>2011</year>52        <gdppc>13600</gdppc>53        <neighbor name="Costa Rica" direction="W"/>54        <neighbor name="Colombia" direction="E"/>55    </country>56</data>57```5859Данные можно импортировать, прочитав файл:6061```python62import xml.etree.ElementTree as ET63tree = ET.parse('country_data.xml')64root = tree.getroot()65```6667Или непосредственно из строки:6869```python70root = ET.fromstring(country_data_as_string)71```7273[`fromstring()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.fromstring) разбирает XML из строки непосредственно в [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element), который является корневым элементом разобранного дерева. Другие функции разбора могут создавать [`ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree). Для уточнения обратитесь к документации.7475Как [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element), `root` имеет тег и словарь атрибутов:7677```python78>>> root.tag79'data'80>>> root.attrib81{}82```8384У него также есть дочерние узлы, которые можно перебирать:8586```python87>>> for child in root:88...     print(child.tag, child.attrib)89...90country {'name': 'Liechtenstein'}91country {'name': 'Singapore'}92country {'name': 'Panama'}93```9495Дочерние узлы вложены, и к конкретным дочерним узлам можно обратиться по индексу:9697```python98>>> root[0][1].text99'2008'100```101102> **Примечание**103>104> Не все элементы XML-входных данных станут элементами разобранного дерева. В настоящее время этот модуль пропускает любые XML-комментарии, инструкции по обработке и объявления типа документа во входных данных. Тем не менее, деревья, построенные с помощью API этого модуля, а не путём разбора XML-текста, могут содержать комментарии и инструкции по обработке; они будут включены при генерации XML-вывода. Доступ к объявлению типа документа можно получить, передав пользовательский экземпляр [`TreeBuilder`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) конструктору [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser).105106### Pull API для неблокирующего разбора107108Большинство функций разбора, предоставляемых этим модулем, требуют, чтобы весь документ был прочитан сразу перед возвратом какого-либо результата. Можно использовать [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) и передавать в него данные постепенно, но это push API, который вызывает методы на целевом колбэке, что является слишком низкоуровневым и неудобным для большинства задач. Иногда пользователю действительно нужно иметь возможность разбирать XML постепенно, без блокирующих операций, пользуясь удобством полностью построенных объектов [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).109110Самый мощный инструмент для этого – [`XMLPullParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser). Он не требует блокирующего чтения для получения XML-данных, а вместо этого получает данные постепенно с помощью вызовов [`XMLPullParser.feed()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.feed). Чтобы получить разобранные XML-элементы, вызовите [`XMLPullParser.read_events()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events). Вот пример:111112```python113>>> parser = ET.XMLPullParser(['start', 'end'])114>>> parser.feed('<mytag>sometext')115>>> list(parser.read_events())116[('start', <Element 'mytag' at 0x7fa66db2be58>)]117>>> parser.feed(' more text</mytag>')118>>> for event, elem in parser.read_events():119...     print(event)120...     print(elem.tag, 'text=', elem.text)121...122end123```124125Очевидный вариант использования – приложения, работающие в неблокирующем режиме, где XML-данные поступают из сокета или читаются постепенно с какого-либо устройства хранения. В таких случаях блокирующие чтения неприемлемы.126127Из-за своей гибкости [`XMLPullParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser) может быть неудобен для более простых задач. Если вы не против того, чтобы ваше приложение блокировалось при чтении XML-данных, но всё же хотите иметь возможность инкрементального разбора, обратите внимание на [`iterparse()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.iterparse). Он может быть полезен при чтении большого XML-документа, который вы не хотите полностью хранить в памяти.128129### Поиск интересующих элементов130131[`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) имеет несколько полезных методов, которые помогают рекурсивно обходить всё поддерево под ним (его дочерние элементы, их дочерние элементы и так далее). Например, [`Element.iter()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.iter):132133```python134>>> for neighbor in root.iter('neighbor'):135...     print(neighbor.attrib)136...137{'name': 'Austria', 'direction': 'E'}138{'name': 'Switzerland', 'direction': 'W'}139{'name': 'Malaysia', 'direction': 'N'}140{'name': 'Costa Rica', 'direction': 'W'}141{'name': 'Colombia', 'direction': 'E'}142```143144[`Element.findall()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findall) находит только элементы с тегом, которые являются прямыми дочерними элементами текущего элемента. [`Element.find()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.find) находит *первый* дочерний элемент с указанным тегом, а [`Element.text`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.text) обращается к текстовому содержимому элемента. [`Element.get()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.get) обращается к атрибутам элемента:145146```python147>>> for country in root.findall('country'):148...     rank = country.find('rank').text149...     name = country.get('name')150...     print(name, rank)151...152Liechtenstein 1153Singapore 4154Panama 68155```156157Более сложное задание критериев поиска элементов возможно с помощью [XPath](https://python-all.ru/3.7/library/xml.etree.elementtree.html#elementtree-xpath).158159### Изменение XML-файла160161[`ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) предоставляет простой способ создания XML-документов и записи их в файлы. Метод [`ElementTree.write()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write) служит этой цели.162163После создания объект [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) можно изменять, напрямую меняя его поля (например, [`Element.text`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.text)), добавляя и изменяя атрибуты (метод [`Element.set()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.set)), а также добавляя новые дочерние элементы (например, с помощью [`Element.append()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.append)).164165Допустим, мы хотим увеличить ранг каждой страны на единицу и добавить атрибут `updated` к элементу ранга:166167```python168>>> for rank in root.iter('rank'):169...     new_rank = int(rank.text) + 1170...     rank.text = str(new_rank)171...     rank.set('updated', 'yes')172...173>>> tree.write('output.xml')174```175176Теперь наш XML выглядит так:177178```xml179<?xml version="1.0"?>180<data>181    <country name="Liechtenstein">182        <rank updated="yes">2</rank>183        <year>2008</year>184        <gdppc>141100</gdppc>185        <neighbor name="Austria" direction="E"/>186        <neighbor name="Switzerland" direction="W"/>187    </country>188    <country name="Singapore">189        <rank updated="yes">5</rank>190        <year>2011</year>191        <gdppc>59900</gdppc>192        <neighbor name="Malaysia" direction="N"/>193    </country>194    <country name="Panama">195        <rank updated="yes">69</rank>196        <year>2011</year>197        <gdppc>13600</gdppc>198        <neighbor name="Costa Rica" direction="W"/>199        <neighbor name="Colombia" direction="E"/>200    </country>201</data>202```203204Элементы можно удалять с помощью [`Element.remove()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.remove). Допустим, мы хотим удалить все страны с рангом выше 50:205206```python207>>> for country in root.findall('country'):208...     rank = int(country.find('rank').text)209...     if rank > 50:210...         root.remove(country)211...212>>> tree.write('output.xml')213```214215Теперь наш XML выглядит так:216217```xml218<?xml version="1.0"?>219<data>220    <country name="Liechtenstein">221        <rank updated="yes">2</rank>222        <year>2008</year>223        <gdppc>141100</gdppc>224        <neighbor name="Austria" direction="E"/>225        <neighbor name="Switzerland" direction="W"/>226    </country>227    <country name="Singapore">228        <rank updated="yes">5</rank>229        <year>2011</year>230        <gdppc>59900</gdppc>231        <neighbor name="Malaysia" direction="N"/>232    </country>233</data>234```235236### Создание XML-документов237238Функция [`SubElement()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.SubElement) также предоставляет удобный способ создания новых дочерних элементов для заданного элемента:239240```python241>>> a = ET.Element('a')242>>> b = ET.SubElement(a, 'b')243>>> c = ET.SubElement(a, 'c')244>>> d = ET.SubElement(c, 'd')245>>> ET.dump(a)246<a><b /><c><d /></c></a>247```248249### Разбор XML с пространствами имён250251Если во входном XML есть [пространства имён](https://python-all.ru/3.7/library/xml.etree.elementtree.html), теги и атрибуты с префиксами вида `prefix:sometag` раскрываются до `{uri}sometag`, где *префикс* заменяется полным *URI*. Кроме того, если есть [пространство имён по умолчанию](https://python-all.ru/3.7/library/xml.etree.elementtree.html), то этот полный URI добавляется в начало всех тегов без префикса.252253Вот пример XML, в котором используются два пространства имён: одно с префиксом «fictional», а другое выступает в качестве пространства имён по умолчанию:254255```xml256<?xml version="1.0"?>257<actors xmlns:fictional="http://characters.example.com"258        xmlns="http://people.example.com">259    <actor>260        <name>John Cleese</name>261        <fictional:character>Lancelot</fictional:character>262        <fictional:character>Archie Leach</fictional:character>263    </actor>264    <actor>265        <name>Eric Idle</name>266        <fictional:character>Sir Robin</fictional:character>267        <fictional:character>Gunther</fictional:character>268        <fictional:character>Commander Clement</fictional:character>269    </actor>270</actors>271```272273Один из способов поиска и изучения этого XML-примера – вручную добавить URI к каждому тегу или атрибуту в XPath-выражении [`find()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.find) или [`findall()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findall):274275```python276root = fromstring(xml_text)277for actor in root.findall('{http://people.example.com}actor'):278    name = actor.find('{http://people.example.com}name')279    print(name.text)280    for char in actor.findall('{http://characters.example.com}character'):281        print(' |-->', char.text)282```283284Более удобный способ поиска в XML с пространствами имён – создать словарь с собственными префиксами и использовать их в функциях поиска:285286```python287ns = {'real_person': 'http://people.example.com',288      'role': 'http://characters.example.com'}289290for actor in root.findall('real_person:actor', ns):291    name = actor.find('real_person:name', ns)292    print(name.text)293    for char in actor.findall('role:character', ns):294        print(' |-->', char.text)295```296297Оба подхода выводят одно и то же:298299```python300John Cleese301 |--> Lancelot302 |--> Archie Leach303Eric Idle304 |--> Sir Robin305 |--> Gunther306 |--> Commander Clement307```308309### Дополнительные ресурсы310311Смотрите [http://effbot.org/zone/element-index.htm](https://python-all.ru/3.7/library/xml.etree.elementtree.html) для обучающих материалов и ссылок на другую документацию.312313## Поддержка XPath314315Этот модуль предоставляет ограниченную поддержку [XPath-выражений](https://python-all.ru/3.7/library/xml.etree.elementtree.html) для поиска элементов в дереве. Цель – поддержать небольшое подмножество сокращённого синтаксиса; полноценный движок XPath выходит за рамки модуля.316317### Пример318319Вот пример, демонстрирующий некоторые возможности XPath этого модуля. Будем использовать XML-документ `countrydata` из раздела [Разбор XML](https://python-all.ru/3.7/library/xml.etree.elementtree.html#elementtree-parsing-xml):320321```python322import xml.etree.ElementTree as ET323324root = ET.fromstring(countrydata)325326# Элементы верхнего уровня327root.findall(".")328329# Все элементы 'neighbor', являющиеся внуками дочерних элементов 'country' верхнего уровня330# элементы331root.findall("./country/neighbor")332333# Узлы с name='Singapore', имеющие дочерний элемент 'year'334root.findall(".//year/..[@name='Singapore']")335336# Элементы 'year', являющиеся дочерними для узлов с name='Singapore'337root.findall(".//*[@name='Singapore']/year")338339# Все элементы 'neighbor', являющиеся вторым дочерним элементом своего родителя340root.findall(".//neighbor[2]")341```342343### Поддерживаемый синтаксис XPath344345| Синтаксис | Значение |346| --- | --- |347| `tag` | Выбирает все дочерние элементы с указанным тегом. Например, `spam` выбирает все дочерние элементы с именем `spam`, а `spam/egg` выбирает все внучатые элементы с именем `egg` во всех дочерних элементах с именем `spam`. |348| `*` | Выбирает все дочерние элементы. Например, `*/egg` выбирает все внучатые элементы с именем `egg`. |349| `.` | Выбирает текущий узел. Это особенно полезно в начале пути, чтобы указать, что это относительный путь. |350| `//` | Выбирает все вложенные элементы на всех уровнях ниже текущего элемента. Например, `.//egg` выбирает все элементы `egg` во всём дереве. |351| `..` | Выбирает родительский элемент. Возвращает `None`, если путь пытается достичь предков начального элемента (элемента, для которого был вызван `find`). |352| `[@attrib]` | Выбирает все элементы, у которых есть указанный атрибут. |353| `[@attrib='value']` | Выбирает все элементы, у которых указанный атрибут имеет заданное значение. Значение не может содержать кавычки. |354| `[tag]` | Выбирает все элементы, у которых есть дочерний элемент с именем `tag`. Поддерживаются только непосредственные дочерние элементы. |355| `[.='text']` | Выбирает все элементы, полное текстовое содержимое которых, включая потомков, равно заданному `text`. Добавлено в версии 3.7. |356| `[tag='text']` | Выбирает все элементы, у которых есть дочерний элемент с именем `tag`, чьё полное текстовое содержимое, включая потомков, равно заданному `text`. |357| `[position]` | Выбирает все элементы, расположенные на указанной позиции. Позиция может быть целым числом (1 – первая позиция), выражением `last()` (для последней позиции) или позицией относительно последней позиции (например, `last()-1`). |358359Предикаты (выражения в квадратных скобках) должны предваряться именем тега, звёздочкой или другим предикатом. Предикаты `position` должны предваряться именем тега.360361## Ссылка362363### Функции364365#### `xml.etree.ElementTree.Comment(text=None)`366367Фабрика элементов Comment. Эта фабричная функция создаёт специальный элемент, который будет сериализован как XML-комментарий стандартным сериализатором. Строка комментария может быть как байтовой строкой, так и строкой Unicode. *text* – это строка, содержащая текст комментария. Возвращает экземпляр элемента, представляющий комментарий.368369Обратите внимание, что [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) пропускает комментарии во входных данных, не создавая для них объекты комментариев. [`ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) будет содержать узлы комментариев только в том случае, если они были вставлены в дерево с помощью одного из методов [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).370371#### `xml.etree.ElementTree.dump(elem)`372373Записывает дерево элементов или структуру элементов в sys.stdout. Эту функцию следует использовать только для отладки.374375Точный формат вывода зависит от реализации. В этой версии он записывается как обычный XML-файл.376377*elem* – это дерево элементов или отдельный элемент.378379#### `xml.etree.ElementTree.fromstring(text, parser=None)`380381Разбирает фрагмент XML из строковой константы. То же, что и [`XML()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XML). *text* – это строка, содержащая XML-данные. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).382383#### `xml.etree.ElementTree.fromstringlist(sequence, parser=None)`384385Разбирает XML-документ из последовательности строковых фрагментов. *sequence* – это список или другая последовательность, содержащая фрагменты XML-данных. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).386387Новое в версии 3.2.388389#### `xml.etree.ElementTree.iselement(element)`390391Проверяет, является ли объект допустимым элементом. *element* – это экземпляр элемента. Возвращает `True`, если это объект элемента.392393#### `xml.etree.ElementTree.iterparse(source, events=None, parser=None)`394395Разбирает фрагмент XML в дерево элементов поэтапно, уведомляя пользователя о ходе процесса. *source* – имя файла или [файловый объект](https://python-all.ru/3.7/glossary.html#term-file-object), содержащий XML-данные. *events* – последовательность событий, о которых нужно сообщать. Поддерживаемые события – это строки `"start"`, `"end"`, `"start-ns"` и `"end-ns"` (события «ns» используются для получения подробной информации о пространствах имён). Если *events* опущено, сообщаются только события `"end"`. *parser* – необязательный экземпляр парсера. Если не указан, используется стандартный парсер [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). *parser* должен быть подклассом [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) и может использовать только [`TreeBuilder`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) в качестве цели по умолчанию. Возвращает [итератор](https://python-all.ru/3.7/glossary.html#term-iterator), предоставляющий пары `(event, elem)`.396397Обратите внимание, что [`iterparse()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.iterparse) строит дерево инкрементально, но выполняет блокирующие чтения из *source* (или указанного файла). Поэтому он не подходит для приложений, где блокирующие чтения недопустимы. Для полностью неблокирующего разбора см. [`XMLPullParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser).398399> **Примечание**400>401> [`iterparse()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.iterparse) гарантирует только, что увидел символ «\>» начального тега, когда генерирует событие «start», поэтому атрибуты определены, но содержимое атрибутов text и tail на этот момент не определено. То же самое относится к дочерним элементам; они могут присутствовать или нет.402>403> Если нужен полностью заполненный элемент, используйте события "end".404405Устарело с версии 3.4: Аргумент *parser*.406407#### `xml.etree.ElementTree.parse(source, parser=None)`408409Разбирает XML-раздел в дерево элементов. *source* – это имя файла или файловый объект, содержащий XML-данные. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree).410411#### `xml.etree.ElementTree.ProcessingInstruction(target, text=None)`412413Фабрика PI-элементов. Эта фабричная функция создаёт специальный элемент, который будет сериализован как инструкция обработки XML. *target* – строка, содержащая цель PI. *text* – строка, содержащая содержимое PI, если задано. Возвращает экземпляр элемента, представляющий инструкцию обработки.414415Обратите внимание, что [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) пропускает инструкции обработки во входных данных, вместо того чтобы создавать для них объекты комментариев. [`ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) будет содержать узлы инструкций обработки, только если они были вставлены в дерево с помощью одного из методов [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).416417#### `xml.etree.ElementTree.register_namespace(prefix, uri)`418419Регистрирует префикс пространства имён. Реестр является глобальным, и любое существующее сопоставление для данного префикса или URI пространства имён будет удалено. *prefix* – префикс пространства имён. *uri* – URI пространства имён. Теги и атрибуты в этом пространстве имён будут сериализованы с указанным префиксом, если это возможно.420421Новое в версии 3.2.422423#### `xml.etree.ElementTree.SubElement(parent, tag, attrib={}, **extra)`424425Фабрика подэлементов. Эта функция создаёт экземпляр элемента и добавляет его к существующему элементу.426427Имя элемента, имена атрибутов и значения атрибутов могут быть как байтовыми строками, так и строками Unicode. *parent* – родительский элемент. *tag* – имя подэлемента. *attrib* – необязательный словарь, содержащий атрибуты элемента. *extra* содержит дополнительные атрибуты, заданные как именованные аргументы. Возвращает экземпляр элемента.428429#### `xml.etree.ElementTree.tostring(element, encoding="us-ascii", method="xml", *, short_empty_elements=True)`430431Генерирует строковое представление XML-элемента, включая все подэлементы. *element* – экземпляр [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element). *encoding* [1](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id8) – выходная кодировка (по умолчанию US-ASCII). Используйте `encoding="unicode"` для генерации строки Unicode (иначе генерируется байтовая строка). *method* может быть `"xml"`, `"html"` или `"text"` (по умолчанию `"xml"`). *short\_empty\_elements* имеет тот же смысл, что и в [`ElementTree.write()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write). Возвращает (опционально) закодированную строку, содержащую XML-данные.432433Новое в версии 3.4: параметр *short\_empty\_elements*.434435#### `xml.etree.ElementTree.tostringlist(element, encoding="us-ascii", method="xml", *, short_empty_elements=True)`436437Генерирует строковое представление XML-элемента, включая все подэлементы. *element* – экземпляр [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element). *encoding* [1](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id8) – выходная кодировка (по умолчанию US-ASCII). Используйте `encoding="unicode"` для генерации строки Unicode (иначе генерируется байтовая строка). *method* может быть `"xml"`, `"html"` или `"text"` (по умолчанию `"xml"`). *short\_empty\_elements* имеет тот же смысл, что и в [`ElementTree.write()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write). Возвращает список (опционально) закодированных строк, содержащих XML-данные. Не гарантируется определённый порядок, за исключением того, что `b"".join(tostringlist(element)) == tostring(element)`.438439Новое в версии 3.2.440441Новое в версии 3.4: параметр *short\_empty\_elements*.442443#### `xml.etree.ElementTree.XML(text, parser=None)`444445Разбирает XML-раздел из строковой константы. Эту функцию можно использовать для встраивания «XML-литералов» в код Python. *text* – строка, содержащая XML-данные. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).446447#### `xml.etree.ElementTree.XMLID(text, parser=None)`448449Разбирает XML-фрагмент из строковой константы и возвращает словарь, сопоставляющий идентификаторы элементов с элементами. *text* – строка, содержащая XML-данные. *parser* – необязательный экземпляр анализатора. Если он не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает кортеж, содержащий экземпляр [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) и словарь.450451## Поддержка XInclude452453Этот модуль предоставляет ограниченную поддержку [директив XInclude](https://python-all.ru/3.7/library/xml.etree.elementtree.html) через вспомогательный модуль `xml.etree.ElementInclude`. Этот модуль можно использовать для вставки поддеревьев и текстовых строк в деревья элементов на основе информации в дереве.454455### Пример456457Вот пример, демонстрирующий использование модуля XInclude. Чтобы включить XML-документ в текущий документ, используйте элемент `{http://www.w3.org/2001/XInclude}include` и установите атрибут **parse** в `"xml"`, а атрибут **href** – для указания включаемого документа.458459```xml460<?xml version="1.0"?>461<document xmlns:xi="http://www.w3.org/2001/XInclude">462  <xi:include href="source.xml" parse="xml" />463</document>464```465466По умолчанию атрибут **href** рассматривается как имя файла. Можно использовать пользовательские загрузчики, чтобы переопределить это поведение. Также обратите внимание, что стандартный вспомогательный модуль не поддерживает синтаксис XPointer.467468Чтобы обработать этот файл, загрузите его как обычно и передайте корневой элемент модулю [`xml.etree.ElementTree`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#module-xml.etree.ElementTree):469470```python471from xml.etree import ElementTree, ElementInclude472473tree = ElementTree.parse("document.xml")474root = tree.getroot()475476ElementInclude.include(root)477```478479Модуль ElementInclude заменяет элемент `{http://www.w3.org/2001/XInclude}include` корневым элементом из документа **source.xml**. Результат может выглядеть примерно так:480481```xml482<document xmlns:xi="http://www.w3.org/2001/XInclude">483  <para>This is a paragraph.</para>484</document>485```486487Если атрибут **parse** опущен, по умолчанию используется «xml». Атрибут href является обязательным.488489Чтобы включить текстовый документ, используйте элемент `{http://www.w3.org/2001/XInclude}include` и установите атрибут **parse** в «text»:490491```xml492<?xml version="1.0"?>493<document xmlns:xi="http://www.w3.org/2001/XInclude">494  Copyright (c) <xi:include href="year.txt" parse="text" />.495</document>496```497498Результат может выглядеть примерно так:499500```xml501<document xmlns:xi="http://www.w3.org/2001/XInclude">502  Copyright (c) 2003.503</document>504```505506## Ссылка507508### Функции509510#### `xml.etree.ElementInclude.default_loader(href, parse, encoding=None)`511512Загрузчик по умолчанию. Этот загрузчик по умолчанию читает включённый ресурс с диска. *href* – это URL. *parse* – это режим разбора: либо «xml», либо «text». *encoding* – необязательная текстовая кодировка. Если не указана, используется `utf-8`. Возвращает развёрнутый ресурс. Если режим разбора – `"xml"`, это экземпляр ElementTree. Если режим разбора – «text», это строка Unicode. Если загрузчику не удаётся загрузить, он может вернуть None или возбудить исключение.513514#### `xml.etree.ElementInclude.include(elem, loader=None)`515516Эта функция обрабатывает директивы XInclude. *elem* – корневой элемент. *loader* – необязательный загрузчик ресурсов. Если он не указан, по умолчанию используется [`default_loader()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.xml.etree.ElementInclude.default_loader). Если задан, это должен быть вызываемый объект, реализующий тот же интерфейс, что и [`default_loader()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.xml.etree.ElementInclude.default_loader). Возвращает обработанный ресурс. Если режим разбора – `"xml"`, возвращается экземпляр ElementTree. Если режим разбора – «text», возвращается строка Unicode. Если загрузчик завершается ошибкой, он может вернуть None или вызвать исключение.517518### Объекты Element519520#### `class xml.etree.ElementTree.Element(tag, attrib={}, **extra)`521522Класс Element. Этот класс определяет интерфейс Element и предоставляет эталонную реализацию этого интерфейса.523524Имя элемента, имена атрибутов и значения атрибутов могут быть либо байтовыми строками, либо строками Unicode. *tag* – имя элемента. *attrib* – необязательный словарь, содержащий атрибуты элемента. *extra* содержит дополнительные атрибуты, заданные как именованные аргументы.525526#### `tag`527528Строка, определяющая, какие данные представляет этот элемент (иначе говоря, тип элемента).529530#### `text`531532#### `tail`533534Эти атрибуты можно использовать для хранения дополнительных данных, связанных с элементом. Их значениями обычно являются строки, но могут быть и любые объекты, специфичные для приложения. Если элемент создан из XML-файла, атрибут *text* содержит либо текст между начальным тегом элемента и его первым дочерним элементом или закрывающим тегом, либо `None`, а атрибут *tail* содержит либо текст между закрывающим тегом элемента и следующим тегом, либо `None`. Для XML-данных535536```xml537<a><b>1<c>2<d/>3</c></b>4</a>538```539540элемент *a* имеет `None` для обоих атрибутов *text* и *tail*, элемент *b* имеет *text* `"1"` и *tail* `"4"`, элемент *c* имеет *text* `"2"` и *tail* `None`, а элемент *d* имеет *text* `None` и *tail* `"3"`.541542Чтобы собрать внутренний текст элемента, см. [`itertext()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.itertext), например `"".join(element.itertext())`.543544Приложения могут хранить в этих атрибутах произвольные объекты.545546#### `attrib`547548Словарь, содержащий атрибуты элемента. Обратите внимание, что хотя значение *attrib* всегда является настоящим изменяемым словарём Python, реализация ElementTree может использовать другое внутреннее представление и создавать словарь только по запросу. Чтобы воспользоваться преимуществами таких реализаций, по возможности используйте приведённые ниже методы словаря.549550Следующие методы, подобные словарным, работают с атрибутами элемента.551552#### `clear()`553554Сбрасывает элемент. Эта функция удаляет все подэлементы, очищает все атрибуты и устанавливает атрибуты text и tail в `None`.555556#### `get(key, default=None)`557558Возвращает атрибут элемента с именем *key*.559560Возвращает значение атрибута или *default*, если атрибут не найден.561562#### `items()`563564Возвращает атрибуты элемента в виде последовательности пар (имя, значение). Атрибуты возвращаются в произвольном порядке.565566#### `keys()`567568Возвращает имена атрибутов элемента в виде списка. Имена возвращаются в произвольном порядке.569570#### `set(key, value)`571572Устанавливает атрибут *key* элемента в *value*.573574Следующие методы работают с дочерними элементами (подэлементами) текущего элемента.575576#### `append(subelement)`577578Добавляет элемент *subelement* в конец внутреннего списка подэлементов текущего элемента. Возбуждает [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError), если *subelement* не является [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).579580#### `extend(subelements)`581582Добавляет *подэлементы* из последовательности с нулём или более элементов. Возбуждает [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError), если подэлемент не является [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).583584Новое в версии 3.2.585586#### `find(match, namespaces=None)`587588Находит первый подэлемент, соответствующий *match*. *match* может быть именем тега или [путём](https://python-all.ru/3.7/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает экземпляр элемента или `None`. *namespaces* – необязательное отображение префикса пространства имён в полное имя.589590#### `findall(match, namespaces=None)`591592Находит все соответствующие подэлементы по имени тега или [пути](https://python-all.ru/3.7/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает список, содержащий все подходящие элементы в порядке документа. *namespaces* – необязательное отображение префикса пространства имён в полное имя.593594#### `findtext(match, default=None, namespaces=None)`595596Находит текст для первого подэлемента, соответствующего *match*. *match* может быть именем тега или [путём](https://python-all.ru/3.7/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает текстовое содержимое первого подходящего элемента или *default*, если элемент не найден. Обратите внимание: если у подходящего элемента нет текстового содержимого, возвращается пустая строка. *namespaces* – необязательное отображение префикса пространства имён в полное имя.597598#### `getchildren()`599600Устарело с версии 3.2: Используйте `list(elem)` или перебор.601602#### `getiterator(tag=None)`603604Устарело с версии 3.2: Вместо этого используйте метод [`Element.iter()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.iter).605606#### `insert(index, subelement)`607608Вставляет *subelement* в указанную позицию в этом элементе. Возбуждает [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError), если *subelement* не является [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).609610#### `iter(tag=None)`611612Создаёт древовидный [итератор](https://python-all.ru/3.7/glossary.html#term-iterator) с текущим элементом в качестве корня. Итератор перебирает этот элемент и все элементы ниже него в порядке документа (сначала в глубину). Если *tag* не равен `None` или `'*'`, из итератора возвращаются только элементы, тег которых равен *tag*. Если структура дерева изменяется во время итерации, результат не определён.613614Новое в версии 3.2.615616#### `iterfind(match, namespaces=None)`617618Находит все подходящие подэлементы по имени тега или [path](https://python-all.ru/3.7/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает итерируемый объект, выдающий все подходящие элементы в порядке документа. *namespaces* – необязательное отображение префикса пространства имён на полное имя.619620Новое в версии 3.2.621622#### `itertext()`623624Создаёт текстовый итератор. Итератор перебирает этот элемент и все подэлементы в порядке документа и возвращает весь внутренний текст.625626Новое в версии 3.2.627628#### `makeelement(tag, attrib)`629630Создаёт новый объект элемента того же типа, что и этот элемент. Не вызывайте этот метод, используйте вместо него фабричную функцию [`SubElement()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.SubElement).631632#### `remove(subelement)`633634Удаляет *subelement* из элемента. В отличие от методов find\*, этот метод сравнивает элементы по идентичности экземпляра, а не по значению тега или содержимому.635636Объекты [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) также поддерживают следующие методы последовательностей для работы с подэлементами: [`__delitem__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__delitem__), [`__getitem__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__getitem__), [`__setitem__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__setitem__), [`__len__()`](https://python-all.ru/3.7/reference/datamodel.html#object.__len__).637638Предупреждение: элементы без подэлементов будут проверяться как `False`. Это поведение изменится в будущих версиях. Вместо этого используйте конкретную проверку `len(elem)` или `elem is None`.639640```python641element = root.find('foo')642643if not element:  # осторожно!644    print("element not found, or element has no subelements")645646if element is None:647    print("element not found")648```649650### Объекты ElementTree651652#### `class xml.etree.ElementTree.ElementTree(element=None, file=None)`653654Класс-обёртка ElementTree. Этот класс представляет целую иерархию элементов и добавляет дополнительную поддержку сериализации в стандартный XML и из него.655656*element* – корневой элемент. Дерево инициализируется содержимым XML-*файла*, если он указан.657658#### `_setroot(element)`659660Заменяет корневой элемент этого дерева. При этом текущее содержимое дерева отбрасывается и заменяется указанным элементом. Используйте с осторожностью. *element* – экземпляр элемента.661662#### `find(match, namespaces=None)`663664То же, что и [`Element.find()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.find), начиная с корня дерева.665666#### `findall(match, namespaces=None)`667668То же, что и [`Element.findall()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findall), начиная с корня дерева.669670#### `findtext(match, default=None, namespaces=None)`671672То же, что и [`Element.findtext()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findtext), начиная с корня дерева.673674#### `getiterator(tag=None)`675676Устарело с версии 3.2: Вместо этого используйте метод [`ElementTree.iter()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.iter).677678#### `getroot()`679680Возвращает корневой элемент этого дерева.681682#### `iter(tag=None)`683684Создаёт и возвращает итератор дерева для корневого элемента. Итератор обходит все элементы этого дерева в порядке следования разделов. *tag* – это тег, который нужно искать (по умолчанию возвращаются все элементы).685686#### `iterfind(match, namespaces=None)`687688То же, что и [`Element.iterfind()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.iterfind), начиная с корня дерева.689690Новое в версии 3.2.691692#### `parse(source, parser=None)`693694Загружает внешний XML-раздел в это дерево элементов. *source* – это имя файла или [файловый объект](https://python-all.ru/3.7/glossary.html#term-file-object). *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает корневой элемент раздела.695696#### `write(file, encoding="us-ascii", xml_declaration=None, default_namespace=None, method="xml", *, short_empty_elements=True)`697698Записывает дерево элементов в файл в формате XML. *file* – это имя файла или [файловый объект](https://python-all.ru/3.7/glossary.html#term-file-object), открытый для записи. *encoding* [1](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id8) – выходная кодировка (по умолчанию US-ASCII). *xml\_declaration* управляет добавлением XML-декларации в файл. Используйте `False` для никогда, `True` для всегда, `None` для только если не US-ASCII или UTF-8 или Unicode (по умолчанию `None`). *default\_namespace* задаёт пространство имён XML по умолчанию (для «xmlns»). *method* – это `"xml"`, `"html"` или `"text"` (по умолчанию `"xml"`). Параметр *short\_empty\_elements* (только по ключевому слову) управляет форматированием элементов, не содержащих содержимого. Если `True` (по умолчанию), они выводятся как один самозакрывающийся тег, иначе – как пара открывающего и закрывающего тегов.699700Результат – либо строка ([`str`](https://python-all.ru/3.7/library/stdtypes.html#str)), либо двоичные данные ([`bytes`](https://python-all.ru/3.7/library/stdtypes.html#bytes)). Это определяется аргументом *encoding*. Если *encoding* равен `"unicode"`, результатом будет строка; в противном случае – двоичные данные. Учтите, что это может конфликтовать с типом *file*, если это открытый [файловый объект](https://python-all.ru/3.7/glossary.html#term-file-object); убедитесь, что не пытаетесь записать строку в двоичный поток и наоборот.701702Новое в версии 3.4: параметр *short\_empty\_elements*.703704Это XML-файл, который будет обрабатываться:705706```python707<html>708    <head>709        <title>Example page</title>710    </head>711    <body>712        <p>Moved to <a href="http://example.org/">example.org</a>713        or <a href="http://example.com/">example.com</a>.</p>714    </body>715</html>716```717718Пример изменения атрибута «target» каждой ссылки в первом абзаце:719720```python721>>> from xml.etree.ElementTree import ElementTree722>>> tree = ElementTree()723>>> tree.parse("index.xhtml")724<Element 'html' at 0xb77e6fac>725>>> p = tree.find("body/p")     # Находит первое вхождение тега p в body726>>> p727<Element 'p' at 0xb77ec26c>728>>> links = list(p.iter("a"))   # Возвращает список всех ссылок729>>> links730[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]731>>> for i in links:             # Перебирает все найденные ссылки732...     i.attrib["target"] = "blank"733>>> tree.write("output.xhtml")734```735736### Объекты QName737738#### `class xml.etree.ElementTree.QName(text_or_uri, tag=None)`739740Обёртка QName. Используется для обёртывания значения атрибута QName, чтобы при выводе обеспечить правильную обработку пространств имён. *text\_or\_uri* – строка, содержащая значение QName в форме {uri}local, или, если передан аргумент tag, – URI-часть QName. Если передан *tag*, то первый аргумент интерпретируется как URI, а этот аргумент – как локальное имя. Экземпляры [`QName`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.QName) непрозрачны.741742### Объекты TreeBuilder743744#### `class xml.etree.ElementTree.TreeBuilder(element_factory=None)`745746Универсальный построитель структуры элементов. Этот построитель преобразует последовательность вызовов методов start, data и end в правильно сформированную структуру элементов. Этот класс можно использовать для построения структуры элементов с помощью пользовательского анализатора XML или анализатора для другого XML-подобного формата. *element\_factory*, если задан, должен быть вызываемым объектом, принимающим два позиционных аргумента: тег и словарь атрибутов. Ожидается, что он возвращает новый экземпляр элемента.747748#### `close()`749750Сбрасывает буферы построителя и возвращает элемент верхнего уровня документа. Возвращает экземпляр [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).751752#### `data(data)`753754Добавляет текст в текущий элемент. *data* является строкой. Это должна быть либо байтовая строка, либо строка Unicode.755756#### `end(tag)`757758Закрывает текущий элемент. *tag* – имя элемента. Возвращает закрытый элемент.759760#### `start(tag, attrs)`761762Открывает новый элемент. *tag* – имя элемента. *attrs* – словарь, содержащий атрибуты элемента. Возвращает открытый элемент.763764Кроме того, пользовательский объект [`TreeBuilder`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) может предоставлять следующий метод:765766#### `doctype(name, pubid, system)`767768Обрабатывает объявление doctype. *name* – имя doctype. *pubid* – публичный идентификатор. *system* – системный идентификатор. Этот метод не существует в классе [`TreeBuilder`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) по умолчанию.769770Новое в версии 3.2.771772### Объекты XMLParser773774#### `class xml.etree.ElementTree.XMLParser(html=0, target=None, encoding=None)`775776Этот класс является низкоуровневым строительным блоком модуля. Он использует [`xml.parsers.expat`](https://python-all.ru/3.7/library/pyexpat.html#module-xml.parsers.expat) для эффективного, событийно-ориентированного разбора XML. Ему можно передавать XML-данные инкрементально с помощью метода [`feed()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.feed), а события разбора преобразуются в push-API – путем вызова колбэков на объекте *target*. Если *target* опущен, используется стандартный [`TreeBuilder`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder). Аргумент *html* исторически использовался для обратной совместимости и теперь является устаревшим. Если указан *encoding* [1](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id8), его значение переопределяет кодировку, заданную в XML-файле.777778Устарело с версии 3.4: Аргумент *html*. Остальные аргументы следует передавать через ключевые слова для подготовки к удалению аргумента *html*.779780#### `close()`781782Завершает передачу данных парсеру. Возвращает результат вызова метода `close()` *цели*, переданной при создании; по умолчанию это корневой элемент документа.783784#### `doctype(name, pubid, system)`785786Устарело с версии 3.2: Определите метод [`TreeBuilder.doctype()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.doctype) на пользовательском целевом объекте TreeBuilder.787788#### `feed(data)`789790Передает данные парсеру. *data* – это закодированные данные.791792[`XMLParser.feed()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.feed) вызывает метод `start(tag, attrs_dict)` объекта *target* для каждого открывающего тега, его метод `end(tag)` для каждого закрывающего тега, а данные обрабатываются методом `data(data)`. [`XMLParser.close()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.close) вызывает метод `close()` объекта *target*. [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) можно использовать не только для построения древовидной структуры. Вот пример подсчета максимальной глубины XML-файла:793794```python795>>> from xml.etree.ElementTree import XMLParser796>>> class MaxDepth:                     # Целевой объект парсера797...     maxDepth = 0798...     depth = 0799...     def start(self, tag, attrib):   # Вызывается для каждого открывающего тега.800...         self.depth += 1801...         if self.depth > self.maxDepth:802...             self.maxDepth = self.depth803...     def end(self, tag):             # Вызывается для каждого закрывающего тега.804...         self.depth -= 1805...     def data(self, data):806...         pass            # С данными ничего делать не нужно.807...     def close(self):    # Вызывается, когда все данные проанализированы.808...         return self.maxDepth809...810>>> target = MaxDepth()811>>> parser = XMLParser(target=target)812>>> exampleXml = """813... <a>814...   <b>815...   </b>816...   <b>817...     <c>818...       <d>819...       </d>820...     </c>821...   </b>822... </a>"""823>>> parser.feed(exampleXml)824>>> parser.close()8254826```827828### Объекты XMLPullParser829830#### `class xml.etree.ElementTree.XMLPullParser(events=None)`831832Pull-парсер, подходящий для неблокирующих приложений. Его API на стороне ввода похож на API [`XMLParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser), но вместо вызова колбэков, [`XMLPullParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser) собирает внутренний список событий разбора и позволяет читать их из него. *events* – это последовательность событий для отчёта. Поддерживаются строки событий `"start"`, `"end"`, `"start-ns"` и `"end-ns"` (события с «ns» используются для получения подробной информации о пространствах имён). Если *events* опущен, сообщаются только события `"end"`.833834#### `feed(data)`835836Передает парсеру данные в виде байтов.837838#### `close()`839840Сигнализирует парсеру, что поток данных завершен. В отличие от [`XMLParser.close()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.close), этот метод всегда возвращает [`None`](https://python-all.ru/3.7/library/constants.html#None). Любые события, еще не извлеченные на момент закрытия парсера, все еще можно прочитать с помощью [`read_events()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events).841842#### `read_events()`843844Возвращает итератор по событиям, которые были встречены в данных, поданных в парсер. Итератор возвращает пары `(event, elem)`, где *event* – это строка, представляющая тип события (например, `"end"`), а *elem* – это встреченный объект [`Element`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).845846События, предоставленные в предыдущем вызове [`read_events()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events), не будут возвращены снова. События потребляются из внутренней очереди только при извлечении из итератора, поэтому несколько читателей, параллельно выполняющих итерацию по итераторам, полученным из [`read_events()`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events), будут иметь непредсказуемые результаты.847848> **Примечание**849>850> [`XMLPullParser`](https://python-all.ru/3.7/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser) гарантирует только, что при генерации события "start" был обнаружен символ "\>" открывающего тега, поэтому атрибуты определены, но содержимое атрибутов text и tail на этом этапе не определено. То же самое относится и к дочерним элементам: они могут присутствовать, а могут и нет.851>852> Если нужен полностью заполненный элемент, используйте события "end".853854Новое в версии 3.4.855856### Исключения857858#### `class xml.etree.ElementTree.ParseError`859860Ошибка разбора XML, возникающая при сбое разбора в различных методах разбора этого модуля. Строковое представление экземпляра этого исключения будет содержать понятное пользователю сообщение об ошибке. Кроме того, будут доступны следующие атрибуты:861862#### `code`863864Числовой код ошибки от парсера expat. Список кодов ошибок и их значений см. в документации [`xml.parsers.expat`](https://python-all.ru/3.7/library/pyexpat.html#module-xml.parsers.expat).865866#### `position`867868Кортеж из номеров строки *line* и столбца *column*, указывающий, где произошла ошибка.869870Сноски871872**1([1](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id1),[2](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id2),[3](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id6),[4](https://python-all.ru/3.7/library/xml.etree.elementtree.html#id7))**873874Строка кодировки, включенная в вывод XML, должна соответствовать соответствующим стандартам. Например, "UTF-8" допустима, а "UTF8" – нет. См. [https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl](https://python-all.ru/3.7/library/xml.etree.elementtree.html) и [https://www.iana.org/assignments/character-sets/character-sets.xhtml](https://python-all.ru/3.7/library/xml.etree.elementtree.html).875