xml.dom.minidom — Минимальная реализация DOM

Объекты DOM

Определение API DOM для Python приведено в документации модуля xml.dom. В этом разделе перечислены различия между API и xml.dom.minidom.

Node.unlink()

Разрывает внутренние ссылки в DOM, чтобы сборщик мусора мог удалить его в версиях Python без циклического сборщика мусора. Даже при наличии циклического сборщика мусора этот метод может раньше освободить большой объём памяти, поэтому рекомендуется вызывать его для объектов DOM сразу после того, как они перестали быть нужны. Вызывать его нужно только для объекта Document, но его можно вызывать и для дочерних узлов, чтобы удалить потомков этого узла.

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

with xml.dom.minidom.parse(datasource) as dom:
    ... # Work with dom.

Node.writexml(writer, indent='', addindent='', newl='', encoding=None, standalone=None)

Записывает XML в объект записи. Объект записи принимает на вход текст, но не байты; у него должен быть метод write(), соответствующий методу интерфейса файлового объекта. Параметр indent задаёт отступ для текущего узла. Параметр addindent задаёт дополнительный отступ для дочерних узлов текущего узла. Параметр newl задаёт строку, которой завершаются строки.

Для узла Document можно дополнительно указать именованный аргумент encoding, задающий поле кодировки в заголовке XML.

Аналогично, явное указание аргумента standalone приводит к добавлению объявления автономности документа в пролог XML-документа. Если значением является True, добавляется standalone="yes", в противном случае устанавливается "no". Если аргумент не указан, объявление в документ добавлено не будет.

Изменено в версии 3.8: Метод writexml() теперь сохраняет заданный пользователем порядок атрибутов.

Изменено в версии 3.9: Добавлен параметр standalone.

Node.toxml(encoding=None, standalone=None)

Возвращает строку или байтовую строку, содержащую XML, представленный узлом DOM.

Если явно задан аргумент encoding [1], результатом будет байтовая строка в указанной кодировке. Если аргумент encoding не задан, результатом будет строка Unicode, а объявление XML в результирующей строке не будет указывать кодировку. Кодирование этой строки в кодировке, отличной от UTF-8, скорее всего, будет ошибочным, поскольку UTF-8 — кодировка XML по умолчанию.

Аргумент standalone работает точно так же, как в writexml().

Изменено в версии 3.8: Метод toxml() теперь сохраняет заданный пользователем порядок атрибутов.

Изменено в версии 3.9: Добавлен параметр standalone.

Node.toprettyxml(indent='\t', newl='\n', encoding=None, standalone=None)

Возвращает красиво отформатированную версию документа. Параметр indent задаёт строку отступа; по умолчанию используется символ табуляции. Параметр newl задаёт строку, выводимую в конце каждой строки; по умолчанию используется \n.

Аргумент encoding работает так же, как соответствующий аргумент toxml().

Аргумент standalone работает точно так же, как в writexml().

Изменено в версии 3.8: Метод toprettyxml() теперь сохраняет заданный пользователем порядок атрибутов.

Изменено в версии 3.9: Добавлен параметр standalone.

Пример DOM

Эта программа представляет собой вполне реалистичный пример простой программы. В данном случае мы не слишком используем гибкость DOM.

import xml.dom.minidom

document = """\
<slideshow>
<title>Demo slideshow</title>
<slide><title>Slide title</title>
<point>This is a demo</point>
<point>Of a program for processing slides</point>
</slide>

<slide><title>Another demo slide</title>
<point>It is important</point>
<point>To have more than</point>
<point>one slide</point>
</slide>
</slideshow>
"""

dom = xml.dom.minidom.parseString(document)

def getText(nodelist):
    rc = []
    for node in nodelist:
        if node.nodeType == node.TEXT_NODE:
            rc.append(node.data)
    return ''.join(rc)

def handleSlideshow(slideshow):
    print("<html>")
    handleSlideshowTitle(slideshow.getElementsByTagName("title")[0])
    slides = slideshow.getElementsByTagName("slide")
    handleToc(slides)
    handleSlides(slides)
    print("</html>")

def handleSlides(slides):
    for slide in slides:
        handleSlide(slide)

def handleSlide(slide):
    handleSlideTitle(slide.getElementsByTagName("title")[0])
    handlePoints(slide.getElementsByTagName("point"))

def handleSlideshowTitle(title):
    print(f"<title>{getText(title.childNodes)}</title>")

def handleSlideTitle(title):
    print(f"<h2>{getText(title.childNodes)}</h2>")

def handlePoints(points):
    print("<ul>")
    for point in points:
        handlePoint(point)
    print("</ul>")

def handlePoint(point):
    print(f"<li>{getText(point.childNodes)}</li>")

def handleToc(slides):
    for slide in slides:
        title = slide.getElementsByTagName("title")[0]
        print(f"<p>{getText(title.childNodes)}</p>")

handleSlideshow(dom)

minidom и стандарт DOM

Модуль xml.dom.minidom по сути представляет собой совместимую с DOM 1.0 реализацию DOM с некоторыми возможностями DOM 2 (главным образом, возможностями работы с пространствами имён).

Использование интерфейса DOM в Python не вызывает сложностей. Применяются следующие правила сопоставления:

• Доступ к интерфейсам осуществляется через объекты-экземпляры. Приложениям не следует создавать экземпляры классов самостоятельно; вместо этого нужно использовать функции создания, доступные в объекте Document. Производные интерфейсы поддерживают все операции (и атрибуты) базовых интерфейсов, а также любые новые операции.
• Операции используются как методы. Поскольку DOM использует только параметры in, аргументы передаются в обычном порядке (слева направо). Необязательных аргументов нет. Операции void возвращают None.
• Атрибуты IDL сопоставляются с атрибутами экземпляров. Для совместимости с сопоставлением языка OMG IDL для Python к атрибуту foo также можно обращаться через методы доступа _get_foo() и _set_foo(). Атрибуты readonly изменять нельзя; это ограничение не проверяется во время выполнения.
• Типы short int, unsigned int, unsigned long long и boolean сопоставляются с целочисленными объектами Python.
• Тип DOMString сопоставляется со строками Python. xml.dom.minidom поддерживает байты или строки, но обычно возвращает строки. Значения типа DOMString также могут быть None, если спецификация DOM W3C разрешает для них значение IDL null.
• Объявления const сопоставляются с переменными в соответствующей области видимости (например, xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE); изменять их нельзя.
• DOMException в настоящее время не поддерживается в xml.dom.minidom. Вместо этого xml.dom.minidom использует стандартные исключения Python, такие как TypeError и AttributeError.
• Объекты NodeList реализованы с помощью встроенного типа list в Python. Эти объекты предоставляют интерфейс, определённый в спецификации DOM, но в ранних версиях Python они не поддерживают официальный API. Однако они гораздо более «питоничны», чем интерфейс, определённый в рекомендациях W3C.

Следующие интерфейсы не реализованы в xml.dom.minidom:

• DOMTimeStamp
• EntityReference

Большая часть этой информации отражает сведения из XML-документа, которые обычно не представляют интереса для большинства пользователей DOM.

Сноски