`xml.etree.elementtree.md`

1013 строк · 93.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.10/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.10/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) – API ElementTree для XML89**Исходный код:** [Lib/xml/etree/ElementTree.py](https://python-all.ru/src/3.10/Lib/xml/etree/ElementTree.py)1011---1213Модуль [`xml.etree.ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) реализует простой и эффективный API для разбора и создания XML-данных.1415Изменено в версии 3.3: Этот модуль использует быструю реализацию, если она доступна.1617Устарело с версии 3.3: Модуль `xml.etree.cElementTree` устарел.1819> **Предупреждение**20>21> Модуль [`xml.etree.ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) не защищён от вредоносных данных. Если нужно разобрать непроверенные или неаутентифицированные данные, см. [уязвимости XML](https://python-all.ru/3.10/library/xml.html#xml-vulnerabilities).2223## Учебное руководство2425Это краткое руководство по использованию [`xml.etree.ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#module-xml.etree.ElementTree) (`ET` в краткой форме). Цель – продемонстрировать некоторые основные компоненты и базовые концепции модуля.2627### XML-дерево и элементы2829XML – это изначально иерархический формат данных, и наиболее естественный способ его представления – дерево. `ET` содержит два класса для этой цели: [`ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) представляет весь XML-документ как дерево, а [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) представляет отдельный узел в этом дереве. Взаимодействие со всем документом (чтение и запись в файлы/из файлов) обычно выполняется на уровне [`ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree). Взаимодействие с отдельным элементом XML и его дочерними элементами выполняется на уровне [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).3031### Разбор XML3233В этом разделе в качестве примера будет использоваться следующий XML-документ:3435```xml36<?xml version="1.0"?>37<data>38    <country name="Liechtenstein">39        <rank>1</rank>40        <year>2008</year>41        <gdppc>141100</gdppc>42        <neighbor name="Austria" direction="E"/>43        <neighbor name="Switzerland" direction="W"/>44    </country>45    <country name="Singapore">46        <rank>4</rank>47        <year>2011</year>48        <gdppc>59900</gdppc>49        <neighbor name="Malaysia" direction="N"/>50    </country>51    <country name="Panama">52        <rank>68</rank>53        <year>2011</year>54        <gdppc>13600</gdppc>55        <neighbor name="Costa Rica" direction="W"/>56        <neighbor name="Colombia" direction="E"/>57    </country>58</data>59```6061Данные можно импортировать, прочитав файл:6263```python64import xml.etree.ElementTree as ET65tree = ET.parse('country_data.xml')66root = tree.getroot()67```6869Или непосредственно из строки:7071```python72root = ET.fromstring(country_data_as_string)73```7475[`fromstring()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.fromstring) разбирает XML из строки непосредственно в [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element), который является корневым элементом разобранного дерева. Другие функции разбора могут создавать [`ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree). Для уточнения обратитесь к документации.7677Как [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element), `root` имеет тег и словарь атрибутов:7879```python80>>> root.tag81'data'82>>> root.attrib83{}84```8586У него также есть дочерние узлы, которые можно перебирать:8788```python89>>> for child in root:90...     print(child.tag, child.attrib)91...92country {'name': 'Liechtenstein'}93country {'name': 'Singapore'}94country {'name': 'Panama'}95```9697Дочерние узлы вложены, и к конкретным дочерним узлам можно обратиться по индексу:9899```python100>>> root[0][1].text101'2008'102```103104> **Примечание**105>106> Не все элементы XML-входных данных станут элементами разобранного дерева. В настоящее время этот модуль пропускает любые XML-комментарии, инструкции по обработке и объявления типа документа во входных данных. Тем не менее, деревья, построенные с помощью API этого модуля, а не путём разбора XML-текста, могут содержать комментарии и инструкции по обработке; они будут включены при генерации XML-вывода. Доступ к объявлению типа документа можно получить, передав пользовательский экземпляр [`TreeBuilder`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) конструктору [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser).107108### Pull API для неблокирующего разбора109110Большинство функций разбора, предоставляемых этим модулем, требуют, чтобы весь документ был прочитан сразу перед возвратом какого-либо результата. Можно использовать [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) и передавать в него данные постепенно, но это push API, который вызывает методы на целевом колбэке, что является слишком низкоуровневым и неудобным для большинства задач. Иногда пользователю действительно нужно иметь возможность разбирать XML постепенно, без блокирующих операций, пользуясь удобством полностью построенных объектов [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).111112Самый мощный инструмент для этого – [`XMLPullParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser). Он не требует блокирующего чтения для получения XML-данных, а вместо этого получает данные постепенно с помощью вызовов [`XMLPullParser.feed()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.feed). Чтобы получить разобранные XML-элементы, вызовите [`XMLPullParser.read_events()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events). Вот пример:113114```python115>>> parser = ET.XMLPullParser(['start', 'end'])116>>> parser.feed('<mytag>sometext')117>>> list(parser.read_events())118[('start', <Element 'mytag' at 0x7fa66db2be58>)]119>>> parser.feed(' more text</mytag>')120>>> for event, elem in parser.read_events():121...     print(event)122...     print(elem.tag, 'text=', elem.text)123...124end125```126127Очевидный вариант использования – приложения, работающие в неблокирующем режиме, где XML-данные поступают из сокета или читаются постепенно с какого-либо устройства хранения. В таких случаях блокирующие чтения неприемлемы.128129Из-за своей гибкости [`XMLPullParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser) может быть неудобен для более простых задач. Если вы не против того, чтобы ваше приложение блокировалось при чтении XML-данных, но всё же хотите иметь возможность инкрементального разбора, обратите внимание на [`iterparse()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.iterparse). Он может быть полезен при чтении большого XML-документа, который вы не хотите полностью хранить в памяти.130131Там, где требуется *немедленная* обратная связь через события, вызов метода [`XMLPullParser.flush()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.flush) может помочь уменьшить задержку; пожалуйста, обязательно изучите соответствующие замечания по безопасности.132133### Поиск интересующих элементов134135[`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) имеет несколько полезных методов, которые помогают рекурсивно обходить всё поддерево под ним (его дочерние элементы, их дочерние элементы и так далее). Например, [`Element.iter()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.iter):136137```python138>>> for neighbor in root.iter('neighbor'):139...     print(neighbor.attrib)140...141{'name': 'Austria', 'direction': 'E'}142{'name': 'Switzerland', 'direction': 'W'}143{'name': 'Malaysia', 'direction': 'N'}144{'name': 'Costa Rica', 'direction': 'W'}145{'name': 'Colombia', 'direction': 'E'}146```147148[`Element.findall()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findall) находит только элементы с тегом, которые являются прямыми дочерними элементами текущего элемента. [`Element.find()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.find) находит *первый* дочерний элемент с указанным тегом, а [`Element.text`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.text) обращается к текстовому содержимому элемента. [`Element.get()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.get) обращается к атрибутам элемента:149150```python151>>> for country in root.findall('country'):152...     rank = country.find('rank').text153...     name = country.get('name')154...     print(name, rank)155...156Liechtenstein 1157Singapore 4158Panama 68159```160161Более сложное задание критериев поиска элементов возможно с помощью [XPath](https://python-all.ru/3.10/library/xml.etree.elementtree.html#elementtree-xpath).162163### Изменение XML-файла164165[`ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) предоставляет простой способ создания XML-документов и записи их в файлы. Метод [`ElementTree.write()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write) служит этой цели.166167После создания объект [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) можно изменять, напрямую меняя его поля (например, [`Element.text`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.text)), добавляя и изменяя атрибуты (метод [`Element.set()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.set)), а также добавляя новые дочерние элементы (например, с помощью [`Element.append()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.append)).168169Допустим, мы хотим увеличить ранг каждой страны на единицу и добавить атрибут `updated` к элементу ранга:170171```python172>>> for rank in root.iter('rank'):173...     new_rank = int(rank.text) + 1174...     rank.text = str(new_rank)175...     rank.set('updated', 'yes')176...177>>> tree.write('output.xml')178```179180Теперь наш XML выглядит так:181182```xml183<?xml version="1.0"?>184<data>185    <country name="Liechtenstein">186        <rank updated="yes">2</rank>187        <year>2008</year>188        <gdppc>141100</gdppc>189        <neighbor name="Austria" direction="E"/>190        <neighbor name="Switzerland" direction="W"/>191    </country>192    <country name="Singapore">193        <rank updated="yes">5</rank>194        <year>2011</year>195        <gdppc>59900</gdppc>196        <neighbor name="Malaysia" direction="N"/>197    </country>198    <country name="Panama">199        <rank updated="yes">69</rank>200        <year>2011</year>201        <gdppc>13600</gdppc>202        <neighbor name="Costa Rica" direction="W"/>203        <neighbor name="Colombia" direction="E"/>204    </country>205</data>206```207208Элементы можно удалять с помощью [`Element.remove()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.remove). Допустим, мы хотим удалить все страны с рангом выше 50:209210```python211>>> for country in root.findall('country'):212...     # использование root.findall() для предотвращения удаления во время обхода213...     rank = int(country.find('rank').text)214...     if rank > 50:215...         root.remove(country)216...217>>> tree.write('output.xml')218```219220Обратите внимание: одновременное изменение коллекции во время итерации может привести к проблемам, так же как при итерации и изменении списков или словарей Python. Поэтому в примере сначала собираются все подходящие элементы с помощью `root.findall()`, и только потом выполняется итерация по списку совпадений.221222Теперь наш XML выглядит так:223224```xml225<?xml version="1.0"?>226<data>227    <country name="Liechtenstein">228        <rank updated="yes">2</rank>229        <year>2008</year>230        <gdppc>141100</gdppc>231        <neighbor name="Austria" direction="E"/>232        <neighbor name="Switzerland" direction="W"/>233    </country>234    <country name="Singapore">235        <rank updated="yes">5</rank>236        <year>2011</year>237        <gdppc>59900</gdppc>238        <neighbor name="Malaysia" direction="N"/>239    </country>240</data>241```242243### Создание XML-документов244245Функция [`SubElement()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.SubElement) также предоставляет удобный способ создания новых дочерних элементов для заданного элемента:246247```python248>>> a = ET.Element('a')249>>> b = ET.SubElement(a, 'b')250>>> c = ET.SubElement(a, 'c')251>>> d = ET.SubElement(c, 'd')252>>> ET.dump(a)253<a><b /><c><d /></c></a>254```255256### Разбор XML с пространствами имён257258Если во входном XML есть [пространства имён](https://python-all.ru/3.10/library/xml.etree.elementtree.html), теги и атрибуты с префиксами вида `prefix:sometag` раскрываются до `{uri}sometag`, где *префикс* заменяется полным *URI*. Кроме того, если есть [пространство имён по умолчанию](https://python-all.ru/3.10/library/xml.etree.elementtree.html), то этот полный URI добавляется в начало всех тегов без префикса.259260Вот пример XML, в котором используются два пространства имён: одно с префиксом «fictional», а другое выступает в качестве пространства имён по умолчанию:261262```xml263<?xml version="1.0"?>264<actors xmlns:fictional="http://characters.example.com"265        xmlns="http://people.example.com">266    <actor>267        <name>John Cleese</name>268        <fictional:character>Lancelot</fictional:character>269        <fictional:character>Archie Leach</fictional:character>270    </actor>271    <actor>272        <name>Eric Idle</name>273        <fictional:character>Sir Robin</fictional:character>274        <fictional:character>Gunther</fictional:character>275        <fictional:character>Commander Clement</fictional:character>276    </actor>277</actors>278```279280Один из способов поиска и изучения этого XML-примера – вручную добавить URI к каждому тегу или атрибуту в XPath-выражении [`find()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.find) или [`findall()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findall):281282```python283root = fromstring(xml_text)284for actor in root.findall('{http://people.example.com}actor'):285    name = actor.find('{http://people.example.com}name')286    print(name.text)287    for char in actor.findall('{http://characters.example.com}character'):288        print(' |-->', char.text)289```290291Более удобный способ поиска в XML с пространствами имён – создать словарь с собственными префиксами и использовать их в функциях поиска:292293```python294ns = {'real_person': 'http://people.example.com',295      'role': 'http://characters.example.com'}296297for actor in root.findall('real_person:actor', ns):298    name = actor.find('real_person:name', ns)299    print(name.text)300    for char in actor.findall('role:character', ns):301        print(' |-->', char.text)302```303304Оба подхода выводят одно и то же:305306```python307John Cleese308 |--> Lancelot309 |--> Archie Leach310Eric Idle311 |--> Sir Robin312 |--> Gunther313 |--> Commander Clement314```315316## Поддержка XPath317318Этот модуль предоставляет ограниченную поддержку [XPath-выражений](https://python-all.ru/3.10/library/xml.etree.elementtree.html) для поиска элементов в дереве. Цель – поддержать небольшое подмножество сокращённого синтаксиса; полноценный движок XPath выходит за рамки модуля.319320### Пример321322Вот пример, демонстрирующий некоторые возможности XPath этого модуля. Будем использовать XML-документ `countrydata` из раздела [Разбор XML](https://python-all.ru/3.10/library/xml.etree.elementtree.html#elementtree-parsing-xml):323324```python325import xml.etree.ElementTree as ET326327root = ET.fromstring(countrydata)328329# Элементы верхнего уровня330root.findall(".")331332# Все элементы 'neighbor', являющиеся внуками дочерних элементов 'country' верхнего уровня333# элементы334root.findall("./country/neighbor")335336# Узлы с name='Singapore', имеющие дочерний элемент 'year'337root.findall(".//year/..[@name='Singapore']")338339# Элементы 'year', являющиеся дочерними для узлов с name='Singapore'340root.findall(".//*[@name='Singapore']/year")341342# Все элементы 'neighbor', являющиеся вторым дочерним элементом своего родителя343root.findall(".//neighbor[2]")344```345346Для XML с пространствами имён используйте обычную нотацию с `{namespace}tag`:347348```python349# Все теги dublin-core "title" в документе350root.findall(".//{http://purl.org/dc/elements/1.1/}title")351```352353### Поддерживаемый синтаксис XPath354355| Синтаксис | Значение |356| --- | --- |357| `tag` | Выбирает все дочерние элементы с заданным тегом. Например, `spam` выбирает все дочерние элементы с именем `spam`, а `spam/egg` выбирает все внучатые элементы с именем `egg` среди всех дочерних с именем `spam`. `{namespace}*` выбирает все теги в заданном пространстве имён, `{*}spam` выбирает теги с именем `spam` в любом (или ни в каком) пространстве имён, а `{}*` выбирает только теги, не принадлежащие ни одному пространству имён. Изменено в версии 3.8: Добавлена поддержка подстановочных символов в виде звёздочки. |358| `*` | Выбирает все дочерние элементы, включая комментарии и инструкции обработки. Например, `*/egg` выбирает все внучатые элементы с именем `egg`. |359| `.` | Выбирает текущий узел. Это особенно полезно в начале пути, чтобы указать, что это относительный путь. |360| `//` | Выбирает все вложенные элементы на всех уровнях ниже текущего элемента. Например, `.//egg` выбирает все элементы `egg` во всём дереве. |361| `..` | Выбирает родительский элемент. Возвращает `None`, если путь пытается достичь предков начального элемента (элемента, для которого был вызван `find`). |362| `[@attrib]` | Выбирает все элементы, у которых есть указанный атрибут. |363| `[@attrib='value']` | Выбирает все элементы, у которых указанный атрибут имеет заданное значение. Значение не может содержать кавычки. |364| `[@attrib!='value']` | Выбирает все элементы, у которых указанный атрибут не равен заданному значению. Значение не может содержать кавычки. Новое в версии 3.10. |365| `[tag]` | Выбирает все элементы, у которых есть дочерний элемент с именем `tag`. Поддерживаются только непосредственные дочерние элементы. |366| `[.='text']` | Выбирает все элементы, полное текстовое содержимое которых, включая потомков, равно заданному `text`. Добавлено в версии 3.7. |367| `[.!='text']` | Выбирает все элементы, полное текстовое содержимое которых, включая потомков, не равно заданному `text`. Новое в версии 3.10. |368| `[tag='text']` | Выбирает все элементы, у которых есть дочерний элемент с именем `tag`, чьё полное текстовое содержимое, включая потомков, равно заданному `text`. |369| `[tag!='text']` | Выбирает все элементы, у которых есть дочерний элемент с именем `tag`, чьё полное текстовое содержимое, включая потомков, не равно заданному `text`. Новое в версии 3.10. |370| `[position]` | Выбирает все элементы, расположенные на указанной позиции. Позиция может быть целым числом (1 – первая позиция), выражением `last()` (для последней позиции) или позицией относительно последней позиции (например, `last()-1`). |371372Предикаты (выражения в квадратных скобках) должны предваряться именем тега, звёздочкой или другим предикатом. Предикаты `position` должны предваряться именем тега.373374## Ссылка375376### Функции377378#### `xml.etree.ElementTree.canonicalize(xml_data=None, *, out=None, from_file=None, **options)`379380Функция преобразования [C14N 2.0](https://python-all.ru/3.10/library/xml.etree.elementtree.html).381382Канонизация – это способ нормализации XML-вывода, позволяющий побайтовое сравнение и цифровые подписи. Она сокращает свободу XML-сериализаторов и вместо этого генерирует более ограниченное XML-представление. Основные ограничения касаются размещения объявлений пространств имен, порядка атрибутов и игнорируемых пробелов.383384Эта функция принимает на вход строку XML-данных (*xml\_data*) или путь к файлу или файлоподобный объект (*from\_file*), преобразует их в каноническую форму и записывает результат с помощью файлоподобного объекта *out*, если он указан, или возвращает его в виде текстовой строки, если не указан. Выходной файл получает текст, а не байты. Поэтому он должен быть открыт в текстовом режиме с кодировкой `utf-8`.385386Типичное использование:387388```python389xml_data = "<root>...</root>"390print(canonicalize(xml_data))391392with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:393    canonicalize(xml_data, out=out_file)394395with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:396    canonicalize(from_file="inputfile.xml", out=out_file)397```398399Параметры конфигурации *options* следующие:400401- *with\_comments*: установите true, чтобы включить комментарии (по умолчанию: false)402- ***strip\_text*: установите true, чтобы удалять пробелы до и после текстового содержимого**403404  (по умолчанию: false)405- ***rewrite\_prefixes*: установите true, чтобы заменять префиксы пространств имён на “n{number}”**406407  (по умолчанию: false)408- ***qname\_aware\_tags*: набор имен тегов, учитывающих qname, в которых префиксы**409410  должны заменяться в текстовом содержимом (по умолчанию: пусто)411- ***qname\_aware\_attrs*: набор имен атрибутов, учитывающих qname, в которых префиксы**412413  должны заменяться в текстовом содержимом (по умолчанию: пусто)414- *exclude\_attrs*: набор имен атрибутов, которые не должны сериализоваться415- *exclude\_tags*: набор имен тегов, которые не должны сериализоваться416417В приведённом выше списке параметров под «набором» понимается любая коллекция или итерабельный объект из строк, порядок не важен.418419Новое в версии 3.8.420421#### `xml.etree.ElementTree.Comment(text=None)`422423Фабрика элементов Comment. Эта фабричная функция создаёт специальный элемент, который будет сериализован как XML-комментарий стандартным сериализатором. Строка комментария может быть как байтовой строкой, так и строкой Unicode. *text* – это строка, содержащая текст комментария. Возвращает экземпляр элемента, представляющий комментарий.424425Обратите внимание, что [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) пропускает комментарии во входных данных, не создавая для них объекты комментариев. [`ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) будет содержать узлы комментариев только в том случае, если они были вставлены в дерево с помощью одного из методов [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).426427#### `xml.etree.ElementTree.dump(elem)`428429Записывает дерево элементов или структуру элементов в sys.stdout. Эту функцию следует использовать только для отладки.430431Точный формат вывода зависит от реализации. В этой версии он записывается как обычный XML-файл.432433*elem* – это дерево элементов или отдельный элемент.434435Изменено в версии 3.8: Функция [`dump()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.dump) теперь сохраняет порядок атрибутов, заданный пользователем.436437#### `xml.etree.ElementTree.fromstring(text, parser=None)`438439Разбирает фрагмент XML из строковой константы. То же, что и [`XML()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XML). *text* – это строка, содержащая XML-данные. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).440441#### `xml.etree.ElementTree.fromstringlist(sequence, parser=None)`442443Разбирает XML-документ из последовательности строковых фрагментов. *sequence* – это список или другая последовательность, содержащая фрагменты XML-данных. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).444445Новое в версии 3.2.446447#### `xml.etree.ElementTree.indent(tree, space=' ', level=0)`448449Добавляет пробелы в поддерево для визуального отступа дерева. Это можно использовать для создания красиво отформатированного XML-вывода. *tree* может быть элементом Element или ElementTree. *space* – строка пробелов, которая будет вставлена для каждого уровня отступа, по умолчанию два пробела. Для отступа частичных поддеревьев внутри уже отформатированного дерева передайте начальный уровень отступа как *level*.450451Новое в версии 3.9.452453#### `xml.etree.ElementTree.iselement(element)`454455Проверяет, является ли объект допустимым элементом. *element* – это экземпляр элемента. Возвращает `True`, если это объект элемента.456457#### `xml.etree.ElementTree.iterparse(source, events=None, parser=None)`458459Постепенно разбирает XML-раздел в дерево элементов и сообщает пользователю о происходящем. *source* – это имя файла или [файловый объект](https://python-all.ru/3.10/glossary.html#term-file-object) с XML-данными. *events* – это последовательность событий, о которых нужно сообщать. Поддерживаемые события – строки `"start"`, `"end"`, `"comment"`, `"pi"`, `"start-ns"` и `"end-ns"` (события “ns” используются для получения подробной информации о пространствах имён). Если *events* опущен, сообщаются только события `"end"`. *parser* – необязательный экземпляр парсера. Если он не указан, используется стандартный парсер [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). *parser* должен быть подклассом [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) и может использовать только стандартный [`TreeBuilder`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) в качестве цели. Возвращает [итератор](https://python-all.ru/3.10/glossary.html#term-iterator), предоставляющий пары `(event, elem)`.460461Обратите внимание, что [`iterparse()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.iterparse) строит дерево инкрементально, но выполняет блокирующие чтения из *source* (или указанного файла). Поэтому он не подходит для приложений, где блокирующие чтения недопустимы. Для полностью неблокирующего разбора см. [`XMLPullParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser).462463> **Примечание**464>465> [`iterparse()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.iterparse) гарантирует только, что увидел символ «\>» начального тега, когда генерирует событие «start», поэтому атрибуты определены, но содержимое атрибутов text и tail на этот момент не определено. То же самое относится к дочерним элементам; они могут присутствовать или нет.466>467> Если нужен полностью заполненный элемент, используйте события "end".468469Устарело с версии 3.4: Аргумент *parser*.470471Изменено в версии 3.8: Были добавлены события `comment` и `pi`.472473#### `xml.etree.ElementTree.parse(source, parser=None)`474475Разбирает XML-раздел в дерево элементов. *source* – это имя файла или файловый объект, содержащий XML-данные. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree).476477#### `xml.etree.ElementTree.ProcessingInstruction(target, text=None)`478479Фабрика PI-элементов. Эта фабричная функция создаёт специальный элемент, который будет сериализован как инструкция обработки XML. *target* – строка, содержащая цель PI. *text* – строка, содержащая содержимое PI, если задано. Возвращает экземпляр элемента, представляющий инструкцию обработки.480481Обратите внимание, что [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) пропускает инструкции обработки во входных данных, вместо того чтобы создавать для них объекты комментариев. [`ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree) будет содержать узлы инструкций обработки, только если они были вставлены в дерево с помощью одного из методов [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).482483#### `xml.etree.ElementTree.register_namespace(prefix, uri)`484485Регистрирует префикс пространства имён. Реестр является глобальным, и любое существующее сопоставление для данного префикса или URI пространства имён будет удалено. *prefix* – префикс пространства имён. *uri* – URI пространства имён. Теги и атрибуты в этом пространстве имён будут сериализованы с указанным префиксом, если это возможно.486487Новое в версии 3.2.488489#### `xml.etree.ElementTree.SubElement(parent, tag, attrib={}, **extra)`490491Фабрика подэлементов. Эта функция создаёт экземпляр элемента и добавляет его к существующему элементу.492493Имя элемента, имена атрибутов и значения атрибутов могут быть как байтовыми строками, так и строками Unicode. *parent* – родительский элемент. *tag* – имя подэлемента. *attrib* – необязательный словарь, содержащий атрибуты элемента. *extra* содержит дополнительные атрибуты, заданные как именованные аргументы. Возвращает экземпляр элемента.494495#### `xml.etree.ElementTree.tostring(element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)`496497Создаёт строковое представление XML-элемента, включая все подэлементы. *element* – это экземпляр [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element). *encoding* [1](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id9) – выходная кодировка (по умолчанию US-ASCII). Используйте `encoding="unicode"` для создания строки Unicode (в противном случае создаётся байтовая строка). *method* – это либо `"xml"`, `"html"` или `"text"` (по умолчанию `"xml"`). *xml\_declaration*, *default\_namespace* и *short\_empty\_elements* имеют тот же смысл, что и в [`ElementTree.write()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write). Возвращает (опционально) закодированную строку, содержащую XML-данные.498499Новое в версии 3.4: Параметр *short\_empty\_elements*.500501Новое в версии 3.8: Параметры *xml\_declaration* и *default\_namespace*.502503Изменено в версии 3.8: Функция [`tostring()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring) теперь сохраняет порядок атрибутов, заданный пользователем.504505#### `xml.etree.ElementTree.tostringlist(element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)`506507Создаёт строковое представление XML-элемента, включая все подэлементы. *element* – это экземпляр [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element). *encoding* [1](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id9) – выходная кодировка (по умолчанию US-ASCII). Используйте `encoding="unicode"` для создания строки Unicode (в противном случае создаётся байтовая строка). *method* – это либо `"xml"`, `"html"` или `"text"` (по умолчанию `"xml"`). *xml\_declaration*, *default\_namespace* и *short\_empty\_elements* имеют тот же смысл, что и в [`ElementTree.write()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write). Возвращает список (опционально) закодированных строк, содержащих XML-данные. Не гарантируется никакой конкретный порядок, за исключением того, что `b"".join(tostringlist(element)) == tostring(element)`.508509Новое в версии 3.2.510511Новое в версии 3.4: Параметр *short\_empty\_elements*.512513Новое в версии 3.8: Параметры *xml\_declaration* и *default\_namespace*.514515Изменено в версии 3.8: Функция [`tostringlist()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostringlist) теперь сохраняет порядок атрибутов, заданный пользователем.516517#### `xml.etree.ElementTree.XML(text, parser=None)`518519Разбирает XML-раздел из строковой константы. Эту функцию можно использовать для встраивания «XML-литералов» в код Python. *text* – строка, содержащая XML-данные. *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает экземпляр [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).520521#### `xml.etree.ElementTree.XMLID(text, parser=None)`522523Разбирает XML-фрагмент из строковой константы и возвращает словарь, сопоставляющий идентификаторы элементов с элементами. *text* – строка, содержащая XML-данные. *parser* – необязательный экземпляр анализатора. Если он не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает кортеж, содержащий экземпляр [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) и словарь.524525## Поддержка XInclude526527Этот модуль предоставляет ограниченную поддержку [директив XInclude](https://python-all.ru/3.10/library/xml.etree.elementtree.html) через вспомогательный модуль `xml.etree.ElementInclude`. Этот модуль можно использовать для вставки поддеревьев и текстовых строк в деревья элементов на основе информации в дереве.528529### Пример530531Вот пример, демонстрирующий использование модуля XInclude. Чтобы включить XML-документ в текущий документ, используйте элемент `{http://www.w3.org/2001/XInclude}include` и установите атрибут **parse** в `"xml"`, а атрибут **href** – для указания включаемого документа.532533```xml534<?xml version="1.0"?>535<document xmlns:xi="http://www.w3.org/2001/XInclude">536  <xi:include href="source.xml" parse="xml" />537</document>538```539540По умолчанию атрибут **href** рассматривается как имя файла. Можно использовать пользовательские загрузчики, чтобы переопределить это поведение. Также обратите внимание, что стандартный вспомогательный модуль не поддерживает синтаксис XPointer.541542Чтобы обработать этот файл, загрузите его как обычно и передайте корневой элемент модулю [`xml.etree.ElementTree`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#module-xml.etree.ElementTree):543544```python545from xml.etree import ElementTree, ElementInclude546547tree = ElementTree.parse("document.xml")548root = tree.getroot()549550ElementInclude.include(root)551```552553Модуль ElementInclude заменяет элемент `{http://www.w3.org/2001/XInclude}include` корневым элементом из документа **source.xml**. Результат может выглядеть примерно так:554555```xml556<document xmlns:xi="http://www.w3.org/2001/XInclude">557  <para>This is a paragraph.</para>558</document>559```560561Если атрибут **parse** опущен, по умолчанию используется «xml». Атрибут href является обязательным.562563Чтобы включить текстовый документ, используйте элемент `{http://www.w3.org/2001/XInclude}include` и установите атрибут **parse** в «text»:564565```xml566<?xml version="1.0"?>567<document xmlns:xi="http://www.w3.org/2001/XInclude">568  Copyright (c) <xi:include href="year.txt" parse="text" />.569</document>570```571572Результат может выглядеть примерно так:573574```xml575<document xmlns:xi="http://www.w3.org/2001/XInclude">576  Copyright (c) 2003.577</document>578```579580## Ссылка581582### Функции583584#### `xml.etree.ElementInclude.default_loader(href, parse, encoding=None)`585586Загрузчик по умолчанию. Этот загрузчик по умолчанию читает включённый ресурс с диска. *href* – это URL. *parse* – это режим разбора: либо «xml», либо «text». *encoding* – необязательная текстовая кодировка. Если не указана, используется `utf-8`. Возвращает развёрнутый ресурс. Если режим разбора – `"xml"`, это экземпляр ElementTree. Если режим разбора – «text», это строка Unicode. Если загрузчику не удаётся загрузить, он может вернуть None или возбудить исключение.587588#### `xml.etree.ElementInclude.include(elem, loader=None, base_url=None, max_depth=6)`589590Эта функция разворачивает директивы XInclude. *elem* – корневой элемент. *loader* – необязательный загрузчик ресурсов. Если опущен, по умолчанию используется [`default_loader()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementInclude.default_loader). Если указан, это должен быть вызываемый объект, реализующий тот же интерфейс, что и [`default_loader()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementInclude.default_loader). *base\_url* – базовый URL исходного файла для разрешения относительных путей включённых файлов. *max\_depth* – максимальное количество рекурсивных включений. Ограничено для снижения риска взрыва вредоносного содержимого. Передайте отрицательное значение, чтобы отключить ограничение.591592Возвращает развёрнутый ресурс. Если режим разбора – `"xml"`, это экземпляр ElementTree. Если режим разбора – «text», это строка Unicode. Если загрузчику не удаётся загрузить, он может вернуть None или возбудить исключение.593594Новое в версии 3.9: Параметры *base\_url* и *max\_depth*.595596### Объекты Element597598#### `class xml.etree.ElementTree.Element(tag, attrib={}, **extra)`599600Класс Element. Этот класс определяет интерфейс Element и предоставляет эталонную реализацию этого интерфейса.601602Имя элемента, имена атрибутов и значения атрибутов могут быть либо байтовыми строками, либо строками Unicode. *tag* – имя элемента. *attrib* – необязательный словарь, содержащий атрибуты элемента. *extra* содержит дополнительные атрибуты, заданные как именованные аргументы.603604#### `tag`605606Строка, определяющая, какие данные представляет этот элемент (иначе говоря, тип элемента).607608#### `text`609610#### `tail`611612Эти атрибуты можно использовать для хранения дополнительных данных, связанных с элементом. Их значениями обычно являются строки, но могут быть и любые объекты, специфичные для приложения. Если элемент создан из XML-файла, атрибут *text* содержит либо текст между начальным тегом элемента и его первым дочерним элементом или закрывающим тегом, либо `None`, а атрибут *tail* содержит либо текст между закрывающим тегом элемента и следующим тегом, либо `None`. Для XML-данных613614```xml615<a><b>1<c>2<d/>3</c></b>4</a>616```617618элемент *a* имеет `None` для обоих атрибутов *text* и *tail*, элемент *b* имеет *text* `"1"` и *tail* `"4"`, элемент *c* имеет *text* `"2"` и *tail* `None`, а элемент *d* имеет *text* `None` и *tail* `"3"`.619620Чтобы собрать внутренний текст элемента, см. [`itertext()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.itertext), например `"".join(element.itertext())`.621622Приложения могут хранить в этих атрибутах произвольные объекты.623624#### `attrib`625626Словарь, содержащий атрибуты элемента. Обратите внимание, что хотя значение *attrib* всегда является настоящим изменяемым словарём Python, реализация ElementTree может использовать другое внутреннее представление и создавать словарь только по запросу. Чтобы воспользоваться преимуществами таких реализаций, по возможности используйте приведённые ниже методы словаря.627628Следующие методы, подобные словарным, работают с атрибутами элемента.629630#### `clear()`631632Сбрасывает элемент. Эта функция удаляет все подэлементы, очищает все атрибуты и устанавливает атрибуты text и tail в `None`.633634#### `get(key, default=None)`635636Возвращает атрибут элемента с именем *key*.637638Возвращает значение атрибута или *default*, если атрибут не найден.639640#### `items()`641642Возвращает атрибуты элемента в виде последовательности пар (имя, значение). Атрибуты возвращаются в произвольном порядке.643644#### `keys()`645646Возвращает имена атрибутов элемента в виде списка. Имена возвращаются в произвольном порядке.647648#### `set(key, value)`649650Устанавливает атрибут *key* элемента в *value*.651652Следующие методы работают с дочерними элементами (подэлементами) текущего элемента.653654#### `append(subelement)`655656Добавляет элемент *subelement* в конец внутреннего списка подэлементов текущего элемента. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если *subelement* не является [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).657658#### `extend(subelements)`659660Добавляет *подэлементы* из последовательности с нулём или более элементов. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если подэлемент не является [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).661662Новое в версии 3.2.663664#### `find(match, namespaces=None)`665666Находит первый подэлемент, соответствующий *match*. *match* может быть именем тега или [path](https://python-all.ru/3.10/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает экземпляр элемента или `None`. *namespaces* – необязательное отображение префикса пространства имён на полное имя. Передайте `''` в качестве префикса, чтобы переместить все имена тегов без префикса в выражении в указанное пространство имён.667668#### `findall(match, namespaces=None)`669670Находит все подходящие подэлементы по имени тега или [path](https://python-all.ru/3.10/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает список, содержащий все подходящие элементы в порядке документа. *namespaces* – необязательное отображение префикса пространства имён на полное имя. Передайте `''` в качестве префикса, чтобы переместить все имена тегов без префикса в выражении в указанное пространство имён.671672#### `findtext(match, default=None, namespaces=None)`673674Находит текст для первого подэлемента, соответствующего *match*. *match* может быть именем тега или [path](https://python-all.ru/3.10/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает текстовое содержимое первого подходящего элемента или *default*, если элемент не найден. Обратите внимание: если у подходящего элемента нет текстового содержимого, возвращается пустая строка. *namespaces* – необязательное отображение префикса пространства имён на полное имя. Передайте `''` в качестве префикса, чтобы переместить все имена тегов без префикса в выражении в указанное пространство имён.675676#### `insert(index, subelement)`677678Вставляет *subelement* в указанную позицию в этом элементе. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если *subelement* не является [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).679680#### `iter(tag=None)`681682Создаёт древовидный [итератор](https://python-all.ru/3.10/glossary.html#term-iterator) с текущим элементом в качестве корня. Итератор перебирает этот элемент и все элементы ниже него в порядке документа (сначала в глубину). Если *tag* не равен `None` или `'*'`, из итератора возвращаются только элементы, тег которых равен *tag*. Если структура дерева изменяется во время итерации, результат не определён.683684Новое в версии 3.2.685686#### `iterfind(match, namespaces=None)`687688Находит все подходящие подэлементы по имени тега или [path](https://python-all.ru/3.10/library/xml.etree.elementtree.html#elementtree-xpath). Возвращает итерируемый объект, выдающий все подходящие элементы в порядке документа. *namespaces* – необязательное отображение префикса пространства имён на полное имя.689690Новое в версии 3.2.691692#### `itertext()`693694Создаёт текстовый итератор. Итератор перебирает этот элемент и все подэлементы в порядке документа и возвращает весь внутренний текст.695696Новое в версии 3.2.697698#### `makeelement(tag, attrib)`699700Создаёт новый объект элемента того же типа, что и этот элемент. Не вызывайте этот метод, используйте вместо него фабричную функцию [`SubElement()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.SubElement).701702#### `remove(subelement)`703704Удаляет *subelement* из элемента. В отличие от методов find\*, этот метод сравнивает элементы по идентичности экземпляра, а не по значению тега или содержимому.705706Объекты [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) также поддерживают следующие методы последовательностей для работы с подэлементами: [`__delitem__()`](https://python-all.ru/3.10/reference/datamodel.html#object.__delitem__), [`__getitem__()`](https://python-all.ru/3.10/reference/datamodel.html#object.__getitem__), [`__setitem__()`](https://python-all.ru/3.10/reference/datamodel.html#object.__setitem__), [`__len__()`](https://python-all.ru/3.10/reference/datamodel.html#object.__len__).707708Предупреждение: элементы без подэлементов будут проверяться как `False`. Это поведение изменится в будущих версиях. Вместо этого используйте конкретную проверку `len(elem)` или `elem is None`.709710```python711element = root.find('foo')712713if not element:  # осторожно!714    print("element not found, or element has no subelements")715716if element is None:717    print("element not found")718```719720До Python 3.8 порядок сериализации XML-атрибутов элементов искусственно делался предсказуемым за счёт сортировки атрибутов по имени. Опираясь на теперь гарантированный порядок словарей, это произвольное переупорядочивание было удалено в Python 3.8, чтобы сохранять тот порядок, в котором атрибуты были исходно разобраны или созданы пользовательским кодом.721722В целом пользовательскому коду не следует полагаться на определённый порядок атрибутов, поскольку [набор XML-информации](https://python-all.ru/3.10/library/xml.etree.elementtree.html) явно исключает порядок атрибутов из передачи информации. Код должен быть готов обрабатывать любой порядок на входе. В случаях, когда требуется детерминированный вывод XML, например для криптографической подписи или тестовых наборов данных, доступна каноническая сериализация с помощью функции [`canonicalize()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.canonicalize).723724В случаях, когда канонический вывод неприменим, но определённый порядок атрибутов всё же желателен, коду следует стремиться создавать атрибуты непосредственно в нужном порядке, чтобы избежать несоответствий для читающих код. Если это трудно реализовать, можно применить следующий приём перед сериализацией, чтобы задать порядок независимо от создания элемента:725726```python727def reorder_attributes(root):728    for el in root.iter():729        attrib = el.attrib730        if len(attrib) > 1:731            # измените порядок атрибутов, например, сортировкой732            attribs = sorted(attrib.items())733            attrib.clear()734            attrib.update(attribs)735```736737### Объекты ElementTree738739#### `class xml.etree.ElementTree.ElementTree(element=None, file=None)`740741Класс-обёртка ElementTree. Этот класс представляет целую иерархию элементов и добавляет дополнительную поддержку сериализации в стандартный XML и из него.742743*element* – корневой элемент. Дерево инициализируется содержимым XML-*файла*, если он указан.744745#### `_setroot(element)`746747Заменяет корневой элемент этого дерева. При этом текущее содержимое дерева отбрасывается и заменяется указанным элементом. Используйте с осторожностью. *element* – экземпляр элемента.748749#### `find(match, namespaces=None)`750751То же, что и [`Element.find()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.find), начиная с корня дерева.752753#### `findall(match, namespaces=None)`754755То же, что и [`Element.findall()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findall), начиная с корня дерева.756757#### `findtext(match, default=None, namespaces=None)`758759То же, что и [`Element.findtext()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findtext), начиная с корня дерева.760761#### `getroot()`762763Возвращает корневой элемент этого дерева.764765#### `iter(tag=None)`766767Создаёт и возвращает итератор дерева для корневого элемента. Итератор обходит все элементы этого дерева в порядке следования разделов. *tag* – это тег, который нужно искать (по умолчанию возвращаются все элементы).768769#### `iterfind(match, namespaces=None)`770771То же, что и [`Element.iterfind()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.iterfind), начиная с корня дерева.772773Новое в версии 3.2.774775#### `parse(source, parser=None)`776777Загружает внешний XML-раздел в это дерево элементов. *source* – это имя файла или [файловый объект](https://python-all.ru/3.10/glossary.html#term-file-object). *parser* – необязательный экземпляр анализатора. Если не указан, используется стандартный анализатор [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser). Возвращает корневой элемент раздела.778779#### `write(file, encoding='us-ascii', xml_declaration=None, default_namespace=None, method='xml', *, short_empty_elements=True)`780781Записывает дерево элементов в файл в формате XML. *file* – это имя файла или [файловый объект](https://python-all.ru/3.10/glossary.html#term-file-object), открытый для записи. *encoding* [1](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id9) – выходная кодировка (по умолчанию 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` (по умолчанию), они выводятся как один самозакрывающийся тег, иначе – как пара открывающего и закрывающего тегов.782783Результат – либо строка ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)), либо двоичные данные ([`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes)). Это определяется аргументом *encoding*. Если *encoding* равен `"unicode"`, результатом будет строка; в противном случае – двоичные данные. Учтите, что это может конфликтовать с типом *file*, если это открытый [файловый объект](https://python-all.ru/3.10/glossary.html#term-file-object); убедитесь, что не пытаетесь записать строку в двоичный поток и наоборот.784785Новое в версии 3.4: параметр *short\_empty\_elements*.786787Изменено в версии 3.8: Метод [`write()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write) теперь сохраняет порядок атрибутов, заданный пользователем.788789Это XML-файл, который будет обрабатываться:790791```python792<html>793    <head>794        <title>Example page</title>795    </head>796    <body>797        <p>Moved to <a href="http://example.org/">example.org</a>798        or <a href="http://example.com/">example.com</a>.</p>799    </body>800</html>801```802803Пример изменения атрибута «target» каждой ссылки в первом абзаце:804805```python806>>> from xml.etree.ElementTree import ElementTree807>>> tree = ElementTree()808>>> tree.parse("index.xhtml")809<Element 'html' at 0xb77e6fac>810>>> p = tree.find("body/p")     # Находит первое вхождение тега p в body811>>> p812<Element 'p' at 0xb77ec26c>813>>> links = list(p.iter("a"))   # Возвращает список всех ссылок814>>> links815[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]816>>> for i in links:             # Перебирает все найденные ссылки817...     i.attrib["target"] = "blank"818>>> tree.write("output.xhtml")819```820821### Объекты QName822823#### `class xml.etree.ElementTree.QName(text_or_uri, tag=None)`824825Обёртка QName. Используется для обёртывания значения атрибута QName, чтобы при выводе обеспечить правильную обработку пространств имён. *text\_or\_uri* – строка, содержащая значение QName в форме {uri}local, или, если передан аргумент tag, – URI-часть QName. Если передан *tag*, то первый аргумент интерпретируется как URI, а этот аргумент – как локальное имя. Экземпляры [`QName`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.QName) непрозрачны.826827### Объекты TreeBuilder828829#### `class xml.etree.ElementTree.TreeBuilder(element_factory=None, *, comment_factory=None, pi_factory=None, insert_comments=False, insert_pis=False)`830831Универсальный построитель структуры элементов. Этот построитель преобразует последовательность вызовов методов start, data, end, comment и pi в правильно сформированную структуру элементов. Этот класс можно использовать для построения структуры элементов с помощью собственного XML-парсера или парсера для какого-либо другого XML-подобного формата.832833*element\_factory*, если задан, должен быть вызываемым объектом, принимающим два позиционных аргумента: tag и словарь атрибутов. Ожидается, что он вернёт новый экземпляр элемента.834835Функции *comment\_factory* и *pi\_factory*, если заданы, должны вести себя как функции [`Comment()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Comment) и [`ProcessingInstruction()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.ProcessingInstruction) для создания комментариев и инструкций обработки. Если они не заданы, используются фабрики по умолчанию. Если *insert\_comments* и/или *insert\_pis* равно true, комментарии/инструкции обработки будут вставлены в дерево, если они появляются внутри корневого элемента (но не вне его).836837#### `close()`838839Сбрасывает буферы построителя и возвращает элемент верхнего уровня документа. Возвращает экземпляр [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element).840841#### `data(data)`842843Добавляет текст в текущий элемент. *data* является строкой. Это должна быть либо байтовая строка, либо строка Unicode.844845#### `end(tag)`846847Закрывает текущий элемент. *tag* – имя элемента. Возвращает закрытый элемент.848849#### `start(tag, attrs)`850851Открывает новый элемент. *tag* – имя элемента. *attrs* – словарь, содержащий атрибуты элемента. Возвращает открытый элемент.852853#### `comment(text)`854855Создаёт комментарий с заданным *text*. Если `insert_comments` равно true, он также будет добавлен в дерево.856857Новое в версии 3.8.858859#### `pi(target, text)`860861Создаёт комментарий с указанным именем *target* и текстом *text*. Если `insert_pis` истинно, также добавляет его в дерево.862863Новое в версии 3.8.864865Кроме того, пользовательский объект [`TreeBuilder`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) может предоставлять следующие методы:866867#### `doctype(name, pubid, system)`868869Обрабатывает объявление doctype. *name* – имя doctype. *pubid* – публичный идентификатор. *system* – системный идентификатор. Этот метод не существует в классе [`TreeBuilder`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder) по умолчанию.870871Новое в версии 3.2.872873#### `start_ns(prefix, uri)`874875Вызывается всякий раз, когда парсер встречает новое объявление пространства имён, перед колбэком `start()` для открывающего элемента, который его определяет. *prefix* равен `''` для пространства имён по умолчанию и имени объявленного префикса пространства имён в противном случае. *uri* – URI пространства имён.876877Новое в версии 3.8.878879#### `end_ns(prefix)`880881Вызывается после колбэка `end()` элемента, который объявил отображение префикса пространства имён, с именем *prefix*, вышедшего из области видимости.882883Новое в версии 3.8.884885#### `class xml.etree.ElementTree.C14NWriterTarget(write, *, with_comments=False, strip_text=False, rewrite_prefixes=False, qname_aware_tags=None, qname_aware_attrs=None, exclude_attrs=None, exclude_tags=None)`886887Писатель [C14N 2.0](https://python-all.ru/3.10/library/xml.etree.elementtree.html). Аргументы такие же, как у функции [`canonicalize()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.canonicalize). Этот класс не строит дерево, а преобразует события колбэков напрямую в сериализованную форму с помощью функции *write*.888889Новое в версии 3.8.890891### Объекты XMLParser892893#### `class xml.etree.ElementTree.XMLParser(*, target=None, encoding=None)`894895Этот класс является низкоуровневым строительным блоком модуля. Он использует [`xml.parsers.expat`](https://python-all.ru/3.10/library/pyexpat.html#module-xml.parsers.expat) для эффективного, основанного на событиях разбора XML. В него можно по частям подавать XML-данные с помощью метода [`feed()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.feed), а события разбора преобразуются в push-API путём вызова колбэков на объекте *target*. Если *target* опущен, используется стандартный [`TreeBuilder`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder). Если задан *encoding* [1](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id9), значение переопределяет кодировку, указанную в XML-файле.896897Изменено в версии 3.8: Параметры теперь [только по ключевым словам](https://python-all.ru/3.10/glossary.html#keyword-only-parameter). Аргумент *html* больше не поддерживается.898899#### `close()`900901Завершает передачу данных парсеру. Возвращает результат вызова метода `close()` *цели*, переданной при создании; по умолчанию это корневой элемент документа.902903#### `feed(data)`904905Передает данные парсеру. *data* – это закодированные данные.906907#### `flush()`908909Запускает разбор любых ранее переданных, но еще не разобранных данных. Это может использоваться для обеспечения более оперативной обратной связи, особенно с Expat \>=2.6.0. Реализация [`flush()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.flush) временно отключает отложенный переразбор в Expat (если он включен) и запускает переразбор. Отключение отложенного переразбора имеет последствия для безопасности; подробнее см. [`xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()`](https://python-all.ru/3.10/library/pyexpat.html#xml.parsers.expat.xmlparser.SetReparseDeferralEnabled).910911Обратите внимание, что [`flush()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.flush) был перенесен в некоторые предыдущие версии CPython как исправление безопасности. Проверяйте доступность [`flush()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.flush) с помощью [`hasattr()`](https://python-all.ru/3.10/library/functions.html#hasattr), если используется в коде, работающем в разных версиях Python.912913Новое в версии 3.10.14.914915[`XMLParser.feed()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.feed) вызывает метод *цели* `start(tag, attrs_dict)` для каждого открывающего тега, метод `end(tag)` – для каждого закрывающего тега, а данные обрабатываются методом `data(data)`. Дополнительные поддерживаемые методы колбэков см. в классе [`TreeBuilder`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder). [`XMLParser.close()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.close) вызывает метод *цели* `close()`. [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser) может использоваться не только для построения древовидной структуры. Ниже приведен пример подсчета максимальной глубины XML-файла:916917```python918>>> from xml.etree.ElementTree import XMLParser919>>> class MaxDepth:                     # Целевой объект парсера920...     maxDepth = 0921...     depth = 0922...     def start(self, tag, attrib):   # Вызывается для каждого открывающего тега.923...         self.depth += 1924...         if self.depth > self.maxDepth:925...             self.maxDepth = self.depth926...     def end(self, tag):             # Вызывается для каждого закрывающего тега.927...         self.depth -= 1928...     def data(self, data):929...         pass            # С данными ничего делать не нужно.930...     def close(self):    # Вызывается, когда все данные проанализированы.931...         return self.maxDepth932...933>>> target = MaxDepth()934>>> parser = XMLParser(target=target)935>>> exampleXml = """936... <a>937...   <b>938...   </b>939...   <b>940...     <c>941...       <d>942...       </d>943...     </c>944...   </b>945... </a>"""946>>> parser.feed(exampleXml)947>>> parser.close()9484949```950951### Объекты XMLPullParser952953#### `class xml.etree.ElementTree.XMLPullParser(events=None)`954955Pull-парсер, подходящий для неблокирующих приложений. Его API на стороне ввода похож на API [`XMLParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser), но вместо передачи вызовов целевому колбэку [`XMLPullParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser) собирает внутренний список событий разбора и позволяет читать из него. *events* – это последовательность событий для отчета. Поддерживаются строки событий: `"start"`, `"end"`, `"comment"`, `"pi"`, `"start-ns"` и `"end-ns"` (события "ns" используются для получения подробной информации о пространствах имен). Если *events* опущен, сообщаются только события `"end"`.956957#### `feed(data)`958959Передает парсеру данные в виде байтов.960961#### `flush()`962963Запускает разбор любых ранее переданных, но еще не разобранных данных. Это может использоваться для обеспечения более оперативной обратной связи, особенно с Expat \>=2.6.0. Реализация [`flush()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.flush) временно отключает отложенный переразбор в Expat (если он включен) и запускает переразбор. Отключение отложенного переразбора имеет последствия для безопасности; подробнее см. [`xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()`](https://python-all.ru/3.10/library/pyexpat.html#xml.parsers.expat.xmlparser.SetReparseDeferralEnabled).964965Обратите внимание, что [`flush()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.flush) был перенесен в некоторые предыдущие версии CPython как исправление безопасности. Проверяйте доступность [`flush()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.flush) с помощью [`hasattr()`](https://python-all.ru/3.10/library/functions.html#hasattr), если используется в коде, работающем в разных версиях Python.966967Новое в версии 3.10.14.968969#### `close()`970971Сигнализирует парсеру, что поток данных завершен. В отличие от [`XMLParser.close()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.close), этот метод всегда возвращает [`None`](https://python-all.ru/3.10/library/constants.html#None). Любые события, еще не извлеченные на момент закрытия парсера, все еще можно прочитать с помощью [`read_events()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events).972973#### `read_events()`974975Возвращает итератор по событиям, которые были обнаружены в данных, переданных парсеру. Итератор выдает пары `(event, elem)`, где *event* – строка, представляющая тип события (например, `"end"`), а *elem* – обнаруженный объект [`Element`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) или другое контекстное значение, как указано ниже.976977- `start`, `end`: текущий элемент.978- `comment`, `pi`: текущий комментарий / инструкция по обработке.979- `start-ns`: кортеж `(prefix, uri)`, именующий объявленное пространство имен.980- `end-ns`: [`None`](https://python-all.ru/3.10/library/constants.html#None) (может измениться в будущей версии).981982События, предоставленные в предыдущем вызове [`read_events()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events), не будут возвращены снова. События потребляются из внутренней очереди только при извлечении из итератора, поэтому несколько читателей, параллельно выполняющих итерацию по итераторам, полученным из [`read_events()`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events), будут иметь непредсказуемые результаты.983984> **Примечание**985>986> [`XMLPullParser`](https://python-all.ru/3.10/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser) гарантирует только, что при генерации события "start" был обнаружен символ "\>" открывающего тега, поэтому атрибуты определены, но содержимое атрибутов text и tail на этом этапе не определено. То же самое относится и к дочерним элементам: они могут присутствовать, а могут и нет.987>988> Если нужен полностью заполненный элемент, используйте события "end".989990Новое в версии 3.4.991992Изменено в версии 3.8: Были добавлены события `comment` и `pi`.993994### Исключения995996#### `class xml.etree.ElementTree.ParseError`997998Ошибка разбора XML, возникающая при сбое разбора в различных методах разбора этого модуля. Строковое представление экземпляра этого исключения будет содержать понятное пользователю сообщение об ошибке. Кроме того, будут доступны следующие атрибуты:9991000#### `code`10011002Числовой код ошибки от парсера expat. Список кодов ошибок и их значений см. в документации [`xml.parsers.expat`](https://python-all.ru/3.10/library/pyexpat.html#module-xml.parsers.expat).10031004#### `position`10051006Кортеж из номеров строки *line* и столбца *column*, указывающий, где произошла ошибка.10071008Сноски10091010**1([1](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id1),[2](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id2),[3](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id6),[4](https://python-all.ru/3.10/library/xml.etree.elementtree.html#id8))**10111012Строка кодировки, включенная в вывод XML, должна соответствовать соответствующим стандартам. Например, "UTF-8" допустима, а "UTF8" – нет. См. [https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl](https://python-all.ru/3.10/library/xml.etree.elementtree.html) и [https://www.iana.org/assignments/character-sets/character-sets.xhtml](https://python-all.ru/3.10/library/xml.etree.elementtree.html).1013