> **Источник:** https://python-all.ru/3.8/library/xml.dom.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # [`xml.dom`](https://python-all.ru/3.8/library/xml.dom.html#module-xml.dom) – **Исходный код:** [Lib/xml/dom/\_\_init\_\_.py](https://python-all.ru/src/3.8/Lib/xml/dom/__init__.py) --- Объектная модель документа (DOM) – это независимый от языка программирования API, разработанный Консорциумом Всемирной паутины (W3C) для доступа к XML-документам и их изменения. Реализация DOM представляет XML-документ в виде древовидной структуры или позволяет клиентскому коду создать такую структуру с нуля. Затем она предоставляет доступ к структуре через набор объектов, которые предоставляют хорошо известные интерфейсы. DOM чрезвычайно полезен для приложений с произвольным доступом. SAX позволяет видеть только один фрагмент документа за раз. Если рассматривается один элемент SAX, доступ к другому отсутствует. Если рассматривается текстовый узел, отсутствует доступ к содержащему его элементу. При написании приложения SAX необходимо отслеживать положение программы в документе в собственном коде – SAX не делает этого автоматически. Кроме того, если требуется заглянуть вперед в XML-документе, это просто невозможно. Некоторые приложения просто невозможны в событийно-ориентированной модели без доступа к дереву. Конечно, можно построить некоторое подобие дерева самостоятельно, обрабатывая события SAX, но DOM позволяет избежать написания такого кода. DOM – это стандартное древовидное представление XML-данных. Объектная модель документа (DOM) определяется W3C поэтапно, или, в их терминологии, по «уровням». Представление API в Python в значительной степени основано на рекомендации DOM уровня 2. Приложения DOM обычно начинают с разбора некоторого XML-документа в DOM. Как это делается, совершенно не описывается в DOM уровня 1, а уровень 2 предоставляет лишь ограниченные улучшения: существует класс объектов `DOMImplementation`, который предоставляет доступ к методам создания `Document`, но нет способа получить доступ к средству чтения/парсера/построителя Document независимо от реализации. Кроме того, нет четко определенного способа доступа к этим методам без существующего объекта `Document`. В Python каждая реализация DOM предоставляет функцию [`getDOMImplementation()`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.getDOMImplementation). DOM уровня 3 добавляет спецификацию Load/Store, которая определяет интерфейс к средству чтения, но она пока недоступна в стандартной библиотеке Python. После получения объекта DOM-документа можно получить доступ к частям XML-документа через его свойства и методы. Эти свойства определены в спецификации DOM; данная часть справочного руководства описывает интерпретацию спецификации в Python. Спецификация, предоставленная W3C, определяет DOM API для Java, ECMAScript и OMG IDL. Представленное здесь отображение на Python в значительной степени основано на IDL-версии спецификации, однако строгое соответствие не требуется (хотя реализации могут поддерживать строгое отображение из IDL). См. раздел [Соответствие](https://python-all.ru/3.8/library/xml.dom.html#dom-conformance) для подробного обсуждения требований к отображению. > **См. также** > > **[Спецификация объектной модели документа (DOM) уровня 2](https://python-all.ru/3.8/library/xml.dom.html)** > > Рекомендация W3C, на которой основан Python DOM API. > > **[Спецификация объектной модели документа (DOM) уровня 1](https://python-all.ru/3.8/library/xml.dom.html)** > > Рекомендация W3C для DOM, поддерживаемая [`xml.dom.minidom`](https://python-all.ru/3.8/library/xml.dom.minidom.html#module-xml.dom.minidom). > > **[Спецификация отображения языка Python](https://python-all.ru/3.8/library/xml.dom.html)** > > Она определяет отображение из OMG IDL на Python. ## Содержимое модуля [`xml.dom`](https://python-all.ru/3.8/library/xml.dom.html#module-xml.dom) содержит следующие функции: #### `xml.dom.registerDOMImplementation(name, factory)` Регистрирует функцию *factory* с именем *name*. Функция-фабрика должна возвращать объект, реализующий интерфейс `DOMImplementation`. Функция-фабрика может возвращать один и тот же объект каждый раз или новый при каждом вызове, в зависимости от конкретной реализации (например, если эта реализация поддерживает некоторую настройку). #### `xml.dom.getDOMImplementation(name=None, features=())` Возвращает подходящую реализацию DOM. *name* может быть широко известным именем, именем модуля реализации DOM или `None`. Если он не равен `None`, импортируется соответствующий модуль и возвращается объект `DOMImplementation`, если импорт успешен. Если имя не задано и установлена переменная окружения `PYTHON_DOM`, эта переменная используется для поиска реализации. Если имя не задано, функция проверяет доступные реализации, чтобы найти одну с требуемым набором возможностей. Если ни одна реализация не найдена, возбуждается исключение [`ImportError`](https://python-all.ru/3.8/library/exceptions.html#ImportError). Список возможностей (features) должен быть последовательностью пар `(feature, version)`, которые передаются методу `hasFeature()` доступных объектов `DOMImplementation`. Также предоставляются некоторые вспомогательные константы: #### `xml.dom.EMPTY_NAMESPACE` Значение, используемое для указания того, что с узлом в DOM не связано ни одного пространства имен. Обычно встречается как `namespaceURI` узла или используется в качестве параметра *namespaceURI* в методах, работающих с пространствами имен. #### `xml.dom.XML_NAMESPACE` URI пространства имен, связанный с зарезервированным префиксом `xml`, как определено в документе [Пространства имен в XML](https://python-all.ru/3.8/library/xml.dom.html) (раздел 4). #### `xml.dom.XMLNS_NAMESPACE` URI пространства имен для объявлений пространств имен, как определено в спецификации [Объектной модели документа (DOM) уровня 2, базовая часть](https://python-all.ru/3.8/library/xml.dom.html) (раздел 1.1.8). #### `xml.dom.XHTML_NAMESPACE` URI пространства имен XHTML, как определено в спецификации [XHTML 1.0: Расширяемый язык гипертекстовой разметки](https://python-all.ru/3.8/library/xml.dom.html) (раздел 3.1.1). Кроме того, [`xml.dom`](https://python-all.ru/3.8/library/xml.dom.html#module-xml.dom) содержит базовый класс `Node` и классы исключений DOM. Класс `Node`, предоставляемый этим модулем, не реализует ни одного метода или атрибута, определенного спецификацией DOM; конкретные реализации DOM должны их предоставлять. Класс `Node`, предоставляемый как часть этого модуля, содержит константы, используемые для атрибута `nodeType` в конкретных объектах `Node`; они находятся внутри класса, а не на уровне модуля, чтобы соответствовать спецификациям DOM. ## Объекты в DOM Исчерпывающая документация по DOM – это спецификация DOM от W3C. Обратите внимание, что атрибуты DOM также могут обрабатываться как узлы, а не как простые строки. Однако это требуется довольно редко, поэтому данное использование ещё не задокументировано. | Интерфейс | Раздел | Назначение | | --- | --- | --- | | `DOMImplementation` | [Объекты DOMImplementation](https://python-all.ru/3.8/library/xml.dom.html#dom-implementation-objects) | Интерфейс для доступа к базовой реализации. | | `Node` | [Объекты Node](https://python-all.ru/3.8/library/xml.dom.html#dom-node-objects) | Базовый интерфейс для большинства объектов в документе. | | `NodeList` | [Объекты NodeList](https://python-all.ru/3.8/library/xml.dom.html#dom-nodelist-objects) | Интерфейс для последовательности узлов. | | `DocumentType` | [Объекты DocumentType](https://python-all.ru/3.8/library/xml.dom.html#dom-documenttype-objects) | Информация об объявлениях, необходимых для обработки документа. | | `Document` | [Объекты Document](https://python-all.ru/3.8/library/xml.dom.html#dom-document-objects) | Объект, представляющий весь документ. | | `Element` | [Объекты Element](https://python-all.ru/3.8/library/xml.dom.html#dom-element-objects) | Узлы элементов в иерархии документа. | | `Attr` | [Объекты Attr](https://python-all.ru/3.8/library/xml.dom.html#dom-attr-objects) | Узлы значений атрибутов на узлах элементов. | | `Comment` | [Объекты Comment](https://python-all.ru/3.8/library/xml.dom.html#dom-comment-objects) | Представление комментариев в исходном документе. | | `Text` | [Объекты Text и CDATASection](https://python-all.ru/3.8/library/xml.dom.html#dom-text-objects) | Узлы, содержащие текстовое содержимое документа. | | `ProcessingInstruction` | [Объекты ProcessingInstruction](https://python-all.ru/3.8/library/xml.dom.html#dom-pi-objects) | Представление инструкций по обработке. | Дополнительный раздел описывает исключения, определённые для работы с DOM в Python. ### Объекты DOMImplementation Интерфейс `DOMImplementation` предоставляет приложениям возможность определять доступность определённых функций в используемом DOM. В DOM Level 2 также была добавлена возможность создавать новые объекты `Document` и `DocumentType` с помощью `DOMImplementation`. #### `DOMImplementation.hasFeature(feature, version)` Возвращает `True`, если функция, определяемая парой строк *feature* и *version*, реализована. #### `DOMImplementation.createDocument(namespaceUri, qualifiedName, doctype)` Возвращает новый объект `Document` (корень DOM) с дочерним объектом `Element`, имеющим указанные *namespaceUri* и *qualifiedName*. *doctype* должен быть объектом `DocumentType`, созданным с помощью [`createDocumentType()`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.DOMImplementation.createDocumentType), или `None`. В Python DOM API первые два аргумента также могут быть `None`, чтобы указать, что дочерний элемент `Element` не должен создаваться. #### `DOMImplementation.createDocumentType(qualifiedName, publicId, systemId)` Возвращает новый объект `DocumentType`, инкапсулирующий заданные строки *qualifiedName*, *publicId* и *systemId*, представляющие информацию, содержащуюся в объявлении типа документа XML. ### Объекты Node Все компоненты XML-документа являются подклассами `Node`. #### `Node.nodeType` Целое число, представляющее тип узла. Символические константы для типов находятся в объекте `Node`: `ELEMENT_NODE`, `ATTRIBUTE_NODE`, `TEXT_NODE`, `CDATA_SECTION_NODE`, `ENTITY_NODE`, `PROCESSING_INSTRUCTION_NODE`, `COMMENT_NODE`, `DOCUMENT_NODE`, `DOCUMENT_TYPE_NODE`, `NOTATION_NODE`. Это атрибут только для чтения. #### `Node.parentNode` Родитель текущего узла или `None` для узла документа. Значение всегда является объектом `Node` или `None`. Для узлов `Element` это будет родительский элемент, за исключением корневого элемента, в этом случае это будет объект `Document`. Для узлов `Attr` это всегда `None`. Это атрибут только для чтения. #### `Node.attributes` `NamedNodeMap` объектов атрибутов. Только элементы имеют актуальные значения для этого; остальные предоставляют `None` для этого атрибута. Это атрибут только для чтения. #### `Node.previousSibling` Узел, непосредственно предшествующий данному и имеющий того же родителя. Например, элемент, закрывающий тег которого находится непосредственно перед открывающим тегом *самого* элемента. Разумеется, XML-документы состоят не только из элементов, поэтому предыдущим соседом может быть текст, комментарий или что-то ещё. Если этот узел является первым потомком родителя, этот атрибут будет равен `None`. Это атрибут только для чтения. #### `Node.nextSibling` Узел, непосредственно следующий за данным и имеющий того же родителя. См. также [`previousSibling`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.Node.previousSibling). Если это последний потомок родителя, этот атрибут будет равен `None`. Это атрибут только для чтения. #### `Node.childNodes` Список узлов, содержащихся в данном узле. Это атрибут только для чтения. #### `Node.firstChild` Первый потомок узла, если таковой имеется, или `None`. Это атрибут только для чтения. #### `Node.lastChild` Последний потомок узла, если таковой имеется, или `None`. Это атрибут только для чтения. #### `Node.localName` Часть `tagName`, следующая за двоеточием, если оно есть, иначе вся `tagName`. Значение – строка. #### `Node.prefix` Часть `tagName`, предшествующая двоеточию, если оно есть, иначе пустая строка. Значение – строка или `None`. #### `Node.namespaceURI` Пространство имён, связанное с именем элемента. Это будет строка или `None`. Это атрибут только для чтения. #### `Node.nodeName` Значение этого атрибута различается для каждого типа узла; подробности см. в спецификации DOM. Ту же информацию всегда можно получить из другого свойства, например, из свойства `tagName` для элементов или свойства `name` для атрибутов. Для всех типов узлов значение этого атрибута будет строкой или `None`. Это атрибут только для чтения. #### `Node.nodeValue` Значение этого атрибута различается для каждого типа узла; подробности см. в спецификации DOM. Ситуация аналогична [`nodeName`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.Node.nodeName). Значение – строка или `None`. #### `Node.hasAttributes()` Возвращает `True`, если узел имеет атрибуты. #### `Node.hasChildNodes()` Возвращает `True`, если у узла есть дочерние узлы. #### `Node.isSameNode(other)` Возвращает `True`, если *other* ссылается на тот же узел, что и текущий. Это особенно полезно для реализаций DOM, использующих какую-либо прокси-архитектуру (поскольку более одного объекта могут ссылаться на один и тот же узел). > **Примечание** > > Это основано на предложенном API DOM Level 3, который всё ещё находится на стадии «рабочего черновика», но данный конкретный интерфейс выглядит не вызывающим споров. Изменения со стороны W3C не обязательно повлияют на этот метод в Python DOM интерфейсе (хотя любые новые API W3C для этого также будут поддерживаться). #### `Node.appendChild(newChild)` Добавляет новый дочерний узел в конец списка дочерних узлов данного узла, возвращая *newChild*. Если узел уже находился в дереве, он сначала удаляется. #### `Node.insertBefore(newChild, refChild)` Вставляет новый дочерний узел перед существующим потомком. Требуется, чтобы *refChild* был потомком данного узла; в противном случае возбуждается [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError). Возвращается *newChild*. Если *refChild* равен `None`, то *newChild* вставляется в конец списка потомков. #### `Node.removeChild(oldChild)` Удаляет дочерний узел. *oldChild* должен быть потомком данного узла; в противном случае возбуждается [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError). В случае успеха возвращается *oldChild*. Если *oldChild* не будет использоваться в дальнейшем, следует вызвать его метод `unlink()`. #### `Node.replaceChild(newChild, oldChild)` Заменяет существующий узел новым узлом. Требуется, чтобы *oldChild* был потомком данного узла; в противном случае возбуждается [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError). #### `Node.normalize()` Объединяет соседние текстовые узлы так, чтобы все отрезки текста хранились в виде одиночных экземпляров `Text`. Это упрощает обработку текста из DOM-дерева для многих приложений. #### `Node.cloneNode(deep)` Клонирует данный узел. Установка *deep* означает клонирование всех дочерних узлов. Возвращает клон. ### Объекты NodeList Объект `NodeList` представляет последовательность узлов. Эти объекты используются двумя способами в рекомендации DOM Core: объект `Element` предоставляет такую последовательность в виде списка дочерних узлов, а методы `getElementsByTagName()` и `getElementsByTagNameNS()` объекта `Node` возвращают объекты с таким интерфейсом для представления результатов запросов. Рекомендация DOM Level 2 определяет один метод и один атрибут для этих объектов: #### `NodeList.item(i)` Возвращает *i*-й элемент из последовательности, если он существует, или `None`. Индекс *i* не может быть меньше нуля или больше или равен длине последовательности. #### `NodeList.length` Количество узлов в последовательности. Кроме того, Python DOM интерфейс требует предоставления дополнительной поддержки, чтобы объекты `NodeList` можно было использовать как последовательности Python. Все реализации `NodeList` должны включать поддержку [`__len__()`](https://python-all.ru/3.8/reference/datamodel.html#object.__len__) и [`__getitem__()`](https://python-all.ru/3.8/reference/datamodel.html#object.__getitem__); это позволяет выполнять итерацию по `NodeList` в циклах [`for`](https://python-all.ru/3.8/reference/compound_stmts.html#for) и корректно поддерживать встроенную функцию [`len()`](https://python-all.ru/3.8/library/functions.html#len). Если реализация DOM поддерживает изменение документа, реализация `NodeList` также должна поддерживать методы [`__setitem__()`](https://python-all.ru/3.8/reference/datamodel.html#object.__setitem__) и [`__delitem__()`](https://python-all.ru/3.8/reference/datamodel.html#object.__delitem__). ### Объекты DocumentType Информация о нотациях и сущностях, объявленных в документе (включая внешнее подмножество, если анализатор его использует и может предоставить эту информацию), доступна из объекта `DocumentType`. Объект `DocumentType` для документа доступен через атрибут `doctype` объекта `Document`; если для документа нет объявления `DOCTYPE`, то атрибут документа `doctype` будет установлен в `None` вместо экземпляра этого интерфейса. `DocumentType` является специализацией `Node` и добавляет следующие атрибуты: #### `DocumentType.publicId` Общедоступный идентификатор для внешнего подмножества определения типа документа. Это строка или `None`. #### `DocumentType.systemId` Системный идентификатор внешнего подмножества определения типа документа. Это будет URI в виде строки или `None`. #### `DocumentType.internalSubset` Строка, содержащая полное внутреннее подмножество документа. В неё не входят скобки, обрамляющие подмножество. Если у документа нет внутреннего подмножества, значение должно быть `None`. #### `DocumentType.name` Имя корневого элемента, указанное в объявлении `DOCTYPE`, если оно присутствует. #### `DocumentType.entities` Это `NamedNodeMap`, содержащий определения внешних сущностей. Для имён сущностей, определённых более одного раза, предоставляется только первое определение (остальные игнорируются, как того требует рекомендация XML). Значение может быть `None`, если анализатор не предоставил эту информацию или не определено ни одной сущности. #### `DocumentType.notations` Это `NamedNodeMap`, содержащий определения нотаций. Для имён нотаций, определённых более одного раза, предоставляется только первое определение (остальные игнорируются, как того требует рекомендация XML). Значение может быть `None`, если анализатор не предоставил эту информацию или не определено ни одной нотации. ### Объекты документа Объект `Document` представляет целый XML-документ, включая элементы, атрибуты, инструкции обработки, комментарии и т. д. Помните, что он наследует свойства от `Node`. #### `Document.documentElement` Единственный корневой элемент документа. #### `Document.createElement(tagName)` Создаёт и возвращает новый узел элемента. При создании элемент не вставляется в документ. Его нужно явно вставить одним из других методов, например `insertBefore()` или `appendChild()`. #### `Document.createElementNS(namespaceURI, tagName)` Создаёт и возвращает новый элемент с пространством имён. *tagName* может содержать префикс. При создании элемент не вставляется в документ. Его нужно явно вставить одним из других методов, например `insertBefore()` или `appendChild()`. #### `Document.createTextNode(data)` Создаёт и возвращает текстовый узел, содержащий данные, переданные в качестве параметра. Как и другие методы создания, этот не вставляет узел в дерево. #### `Document.createComment(data)` Создаёт и возвращает узел комментария, содержащий данные, переданные в качестве параметра. Как и другие методы создания, этот не вставляет узел в дерево. #### `Document.createProcessingInstruction(target, data)` Создаёт и возвращает узел инструкции обработки, содержащий *target* и *data*, переданные в качестве параметров. Как и другие методы создания, этот не вставляет узел в дерево. #### `Document.createAttribute(name)` Создаёт и возвращает узел атрибута. Этот метод не связывает узел атрибута с каким-либо конкретным элементом. Чтобы использовать вновь созданный экземпляр атрибута, нужно применить `setAttributeNode()` к соответствующему объекту `Element`. #### `Document.createAttributeNS(namespaceURI, qualifiedName)` Создаёт и возвращает узел атрибута с пространством имён. *tagName* может содержать префикс. Этот метод не связывает узел атрибута с каким-либо конкретным элементом. Чтобы использовать вновь созданный экземпляр атрибута, нужно применить `setAttributeNode()` к соответствующему объекту `Element`. #### `Document.getElementsByTagName(tagName)` Ищет всех потомков (прямые дочерние элементы, дочерние элементы дочерних и т. д.) с определённым именем типа элемента. #### `Document.getElementsByTagNameNS(namespaceURI, localName)` Ищет всех потомков (прямые дочерние элементы, дочерние элементы дочерних и т. д.) с определённым URI пространства имён и локальным именем. Локальное имя – это часть пространства имён после префикса. ### Объекты Element `Element` является подклассом `Node`, поэтому наследует все атрибуты этого класса. #### `Element.tagName` Имя типа элемента. В документе, использующем пространства имён, может содержать двоеточия. Значение – строка. #### `Element.getElementsByTagName(tagName)` То же, что и эквивалентный метод в классе `Document`. #### `Element.getElementsByTagNameNS(namespaceURI, localName)` То же, что и эквивалентный метод в классе `Document`. #### `Element.hasAttribute(name)` Вернуть `True`, если элемент имеет атрибут с именем *name*. #### `Element.hasAttributeNS(namespaceURI, localName)` Вернуть `True`, если элемент имеет атрибут с именем *namespaceURI* и *localName*. #### `Element.getAttribute(name)` Возвращает значение атрибута с именем *name* в виде строки. Если такого атрибута нет, возвращается пустая строка, как если бы атрибут не имел значения. #### `Element.getAttributeNode(attrname)` Возвращает узел `Attr` для атрибута с именем *attrname*. #### `Element.getAttributeNS(namespaceURI, localName)` Возвращает значение атрибута с именами *namespaceURI* и *localName* в виде строки. Если такого атрибута нет, возвращается пустая строка, как если бы атрибут не имел значения. #### `Element.getAttributeNodeNS(namespaceURI, localName)` Возвращает значение атрибута в виде узла по заданным *namespaceURI* и *localName*. #### `Element.removeAttribute(name)` Удаляет атрибут по имени. Если подходящего атрибута нет, возбуждается [`NotFoundErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.NotFoundErr). #### `Element.removeAttributeNode(oldAttr)` Удаляет и возвращает *oldAttr* из списка атрибутов, если он присутствует. Если *oldAttr* отсутствует, возбуждается [`NotFoundErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.NotFoundErr). #### `Element.removeAttributeNS(namespaceURI, localName)` Удаляет атрибут по имени. Обратите внимание, что используется localName, а не qname. Если подходящего атрибута нет, исключение не возбуждается. #### `Element.setAttribute(name, value)` Устанавливает значение атрибута из строки. #### `Element.setAttributeNode(newAttr)` Добавляет новый узел атрибута к элементу, при необходимости заменяя существующий атрибут, если совпадает атрибут `name`. Если произошла замена, возвращается старый узел атрибута. Если *newAttr* уже используется, возбуждается [`InuseAttributeErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.InuseAttributeErr). #### `Element.setAttributeNodeNS(newAttr)` Добавляет новый узел атрибута к элементу, при необходимости заменяя существующий атрибут, если совпадают атрибуты `namespaceURI` и `localName`. Если произошла замена, возвращается старый узел атрибута. Если *newAttr* уже используется, возбуждается [`InuseAttributeErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.InuseAttributeErr). #### `Element.setAttributeNS(namespaceURI, qname, value)` Устанавливает значение атрибута из строки на основе *namespaceURI* и *qname*. Обратите внимание: qname – это полное имя атрибута. Это отличается от описанного выше. ### Объекты Attr `Attr` наследуется от `Node`, поэтому наследует все его атрибуты. #### `Attr.name` Имя атрибута. В документе, использующем пространства имён, оно может содержать двоеточие. #### `Attr.localName` Часть имени после двоеточия, если оно есть, иначе всё имя целиком. Это атрибут только для чтения. #### `Attr.prefix` Часть имени до двоеточия, если оно есть, иначе пустая строка. #### `Attr.value` Текстовое значение атрибута. Это синоним атрибута `nodeValue`. ### Объекты NamedNodeMap `NamedNodeMap` *не* наследуется от `Node`. #### `NamedNodeMap.length` Длина списка атрибутов. #### `NamedNodeMap.item(index)` Возвращает атрибут по указанному индексу. Порядок получения атрибутов произволен, но остаётся неизменным в течение всего времени существования DOM. Каждый элемент является узлом атрибута. Чтобы получить его значение, используйте атрибут `value`. Существуют также экспериментальные методы, которые добавляют этому классу поведение, схожее со словарём. Вы можете использовать их или воспользоваться стандартизированным семейством методов `getAttribute*()` для объектов `Element`. ### Объекты Comment `Comment` представляет комментарий в XML-документе. Является подклассом `Node`, но не может содержать дочерних узлов. #### `Comment.data` Содержимое комментария в виде строки. Атрибут содержит все символы между открывающим ``, но не включает их. ### Объекты Text и CDATASection Интерфейс `Text` представляет текст в XML-документе. Если анализатор и реализация DOM поддерживают XML-расширение DOM, части текста, заключённые в секции CDATA, сохраняются в объектах `CDATASection`. Эти два интерфейса идентичны, но предоставляют разные значения для атрибута `nodeType`. Эти интерфейсы расширяют интерфейс `Node`. Они не могут содержать дочерних узлов. #### `Text.data` Содержимое текстового узла в виде строки. > **Примечание** > > Использование узла `CDATASection` не означает, что узел представляет полную CDATA-секцию, а лишь то, что содержимое узла было частью CDATA-секции. Одна CDATA-секция может быть представлена более чем одним узлом в дереве документа. Невозможно определить, представляют ли два соседних узла `CDATASection` разные CDATA-секции. ### Объекты ProcessingInstruction Представляет инструкцию по обработке в XML-документе; наследуется от интерфейса `Node` и не может содержать дочерних узлов. #### `ProcessingInstruction.target` Содержимое инструкции по обработке до первого пробельного символа. Это атрибут только для чтения. #### `ProcessingInstruction.data` Содержимое инструкции по обработке, следующее за первым пробельным символом. ### Исключения Рекомендация DOM Level 2 определяет одно исключение, [`DOMException`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.DOMException), и ряд констант, позволяющих приложениям определить, какая именно ошибка произошла. Экземпляры [`DOMException`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.DOMException) имеют атрибут [`code`](https://python-all.ru/3.8/library/code.html#module-code), который содержит соответствующее значение для конкретного исключения. Интерфейс DOM в Python предоставляет эти константы, а также расширяет набор исключений, так что для каждого кода исключения, определённого в DOM, существует своё специфическое исключение. Реализации должны возбуждать соответствующее специфическое исключение, каждое из которых содержит соответствующее значение для атрибута [`code`](https://python-all.ru/3.8/library/code.html#module-code). #### `exception xml.dom.DOMException` Базовый класс исключения, используемый для всех специфических исключений DOM. Этот класс исключения не может быть создан напрямую. #### `exception xml.dom.DomstringSizeErr` Возбуждается, когда указанный диапазон текста не помещается в строку. В реализациях DOM на Python это исключение не используется, но может быть получено от реализаций DOM, написанных не на Python. #### `exception xml.dom.HierarchyRequestErr` Возбуждается при попытке вставить узел туда, где тип узла не разрешён. #### `exception xml.dom.IndexSizeErr` Возбуждается, когда параметр индекса или размера, переданный методу, отрицателен или превышает допустимые значения. #### `exception xml.dom.InuseAttributeErr` Возбуждается при попытке вставить узел `Attr`, который уже присутствует в другом месте документа. #### `exception xml.dom.InvalidAccessErr` Возбуждается, если параметр или операция не поддерживается для базового объекта. #### `exception xml.dom.InvalidCharacterErr` Это исключение возбуждается, когда строковый параметр содержит символ, который не допускается в контексте его использования согласно рекомендации XML 1.0. Например, попытка создать узел `Element` с пробелом в имени типа элемента приведёт к возбуждению этой ошибки. #### `exception xml.dom.InvalidModificationErr` Возбуждается при попытке изменить тип узла. #### `exception xml.dom.InvalidStateErr` Возбуждается при попытке использовать объект, который не определён или больше не пригоден к использованию. #### `exception xml.dom.NamespaceErr` Если предпринимается попытка изменить объект способом, не разрешённым согласно рекомендации [Namespaces in XML](https://python-all.ru/3.8/library/xml.dom.html), возбуждается это исключение. #### `exception xml.dom.NotFoundErr` Исключение, когда узел не существует в указанном контексте. Например, `NamedNodeMap.removeNamedItem()` возбудит это исключение, если переданный узел не существует в отображении. #### `exception xml.dom.NotSupportedErr` Возбуждается, когда реализация не поддерживает запрошенный тип объекта или операции. #### `exception xml.dom.NoDataAllowedErr` Возбуждается, если данные указаны для узла, который не поддерживает данные. #### `exception xml.dom.NoModificationAllowedErr` Возбуждается при попытке изменить объект, в котором изменения не разрешены (например, для узлов, доступных только для чтения). #### `exception xml.dom.SyntaxErr` Возникает при указании недопустимой или неверной строки. #### `exception xml.dom.WrongDocumentErr` Возникает, когда узел вставляется в документ, отличный от того, к которому он в настоящее время принадлежит, и реализация не поддерживает перенос узла из одного документа в другой. Коды исключений, определённые в рекомендации DOM, сопоставляются с описанными выше исключениями согласно следующей таблице: | Константа | Исключение | | --- | --- | | `DOMSTRING_SIZE_ERR` | [`DomstringSizeErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.DomstringSizeErr) | | `HIERARCHY_REQUEST_ERR` | [`HierarchyRequestErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.HierarchyRequestErr) | | `INDEX_SIZE_ERR` | [`IndexSizeErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.IndexSizeErr) | | `INUSE_ATTRIBUTE_ERR` | [`InuseAttributeErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.InuseAttributeErr) | | `INVALID_ACCESS_ERR` | [`InvalidAccessErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.InvalidAccessErr) | | `INVALID_CHARACTER_ERR` | [`InvalidCharacterErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.InvalidCharacterErr) | | `INVALID_MODIFICATION_ERR` | [`InvalidModificationErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.InvalidModificationErr) | | `INVALID_STATE_ERR` | [`InvalidStateErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.InvalidStateErr) | | `NAMESPACE_ERR` | [`NamespaceErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.NamespaceErr) | | `NOT_FOUND_ERR` | [`NotFoundErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.NotFoundErr) | | `NOT_SUPPORTED_ERR` | [`NotSupportedErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.NotSupportedErr) | | `NO_DATA_ALLOWED_ERR` | [`NoDataAllowedErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.NoDataAllowedErr) | | `NO_MODIFICATION_ALLOWED_ERR` | [`NoModificationAllowedErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.NoModificationAllowedErr) | | `SYNTAX_ERR` | [`SyntaxErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.SyntaxErr) | | `WRONG_DOCUMENT_ERR` | [`WrongDocumentErr`](https://python-all.ru/3.8/library/xml.dom.html#xml.dom.WrongDocumentErr) | ## Соответствие В этом разделе описываются требования к соответствию и взаимосвязи между Python DOM API, рекомендациями W3C DOM и отображением OMG IDL для Python. ### Сопоставление типов Типы IDL, используемые в спецификации DOM, сопоставляются с типами Python согласно следующей таблице. | Тип IDL | Тип Python | | --- | --- | | `boolean` | `bool` или `int` | | `int` | `int` | | `long int` | `int` | | `unsigned int` | `int` | | `DOMString` | `str` или `bytes` | | `null` | `None` | ### Методы доступа Отображение из OMG IDL в Python определяет функции доступа для IDL-объявлений `attribute`, во многом так же, как и отображение Java. Сопоставление IDL-объявлений ```python readonly attribute string someValue; attribute string anotherValue; ``` даёт три функции доступа: метод «get» для `someValue` (`_get_someValue()`) и методы «get» и «set» для `anotherValue` (`_get_anotherValue()` и `_set_anotherValue()`). Отображение, в частности, не требует, чтобы атрибуты IDL были доступны как обычные атрибуты Python: `object.someValue` *не* обязан работать и может вызывать исключение [`AttributeError`](https://python-all.ru/3.8/library/exceptions.html#AttributeError). Однако Python DOM API *требует*, чтобы работал обычный доступ к атрибутам. Это означает, что типичные суррогаты, генерируемые компиляторами IDL Python, скорее всего, не будут работать, и могут потребоваться объекты-обёртки на стороне клиента, если объекты DOM доступны через CORBA. Хотя это требует дополнительного внимания для клиентов CORBA DOM, разработчики, имеющие опыт использования DOM через CORBA из Python, не считают это проблемой. Атрибуты, объявленные `readonly`, могут не ограничивать доступ на запись во всех реализациях DOM. В Python DOM API функции доступа не обязательны. Если они предоставляются, они должны принимать форму, определённую отображением IDL Python, но эти методы считаются ненужными, поскольку атрибуты доступны напрямую из Python. Методы доступа «set» никогда не должны предоставляться для атрибутов `readonly`. Определения IDL не в полной мере отражают требования W3C DOM API, например, понятие некоторых объектов, таких как возвращаемое значение `getElementsByTagName()`, как «живых». Python DOM API не требует от реализаций обеспечения таких требований.