Cours sur la programmation DOM en Python

Introduction

DOM, pour Document Object Model, vise à fournir un modèle d'un document semi-structuré, autrement dit d'un document XML. Il s'agit en particulier de définir des méthodes d'accès et de modification opérant sur un tel document.

DOM est défini par des recommandations du W3C, trois niveaux ont aujourd'hui été définis. Certaines parties de ces recommandations sont dédiées au traitement de documents XHTML. L'API DOM est définie dans la majorité des langages de programmation mais l'utilisation majeure qui en est faite de nos jours réside dans le JavaScript des navigateurs web pour manipuler des documents html.

Le modèle DOM reflète la nature arborescente des documents XML : il nous permet d'accéder à la racine ou à des nœuds quelconques, d'obtenir les fils d'un nœud précis, ou encore ses frères. L'implémentation réelle du modèle présent en mémoire après le chargement du document XML est cachée dans un objet et peut varier avec le langage de programmation utilisé. Par contre les méthodes d'accès et de modification de l'arbre DOM sont standardisées par le W3C et sont donc les mêmes d'un langage à l'autre.

En pratique, DOM permet de charger un document XML tout entier en mémoire et s'oppose sur ce point à SAX (qui permet de traiter un document XML en une passe, sans occupation mémoire). Au minimum, DOM utilise une zone mémoire équivalente à la taille du fichier XML lu. Dans les faits, c'est souvent plus et cela pour se préparer à répondre de manière efficace à des interrogations complexes.

Précisons que chaque information présente dans le document d'origine se retrouve en mémoire comme un nœud de l'arbre DOM : les éléments, les attributs, les textes, les commentaires, etc. sont autant de nœuds accessibles dans l'arbre DOM.

Nous nous concentrons ici sur le noyau de DOM fournissant des méthodes valables pour tout document XML (en particulier, des documents non-HTML) et les exemples sont donnés en Python).

En Python, le programme minimal qui charge un document XML sous forme de DOM est le suivant :

from xml.dom.minidom import parse

dom = parse("fichier.xml")

Ou, si l'on souhaite lire le nom du fichier depuis la ligne de commande :

from xml.dom.minidom import parse
import sys

xmlfilename = sys.argv[1]
dom         = parse(xmlfilename)

Les nœuds du DOM

Nous venons de percevoir le rôle central des nœuds dans DOM, il convient de savoir les manipuler.

Informations sur un nœud

Étant donné un nœud de l'arbre DOM, nous pouvons obtenir son nom, sa valeur et son type.

Obtenir un nœud

À partir de l'objet DOM, il est possible d'obtenir :

• l'élément racine du document XML à l'aide de documentElement ;
• le nœud élément portant un nom particulier à l'aide de getElementsByTagName.

Si l'on possède déjà un nœud, il est alors possible d'en obtenir d'autres qui lui sont liés dans le document d'origine :

• childNodes : la liste des nœuds fils ;
• parentNode : le père ;
• firstChild : le premier fils ;
• lastChild : le dernier fils ;
• nextSibling : le frère droit ;
• previousSibling : le frère gauche.

À noter que le nœud demandé peut ne pas exister : la racine n'a pas de père, un fils ainé n'a pas de frère gauche, etc. Dans ces cas, en Python, on obtient la valeur None. Si un nœud n'a pas de fils, childNodes renvoie logiquement une liste vide.

Enfin les attributs d'un élément sont accessibles grâce à la méthode attributes (qui fournit donc un ensemble de nœuds de type 2).

Premiers exemples de programmes Python & DOM

from xml.dom.minidom import parse
import sys

xmlfilename = sys.argv[1]
dom         = parse(xmlfilename)

titres  = dom.getElementsByTagName("titre")
premier = titres[0]
texte   = premier.childNodes[0]

print(texte.nodeValue)

from xml.dom.minidom import parse
import sys

xmlfilename = sys.argv[1]
dom         = parse(xmlfilename)

sites = dom.getElementsByTagName('site')

for site in sites:
    attrs   = site.attributes
    urlnode = attrs['url']
    print(urlnode.nodeValue)

from xml.dom.minidom import parse
import sys

xmlfilename = sys.argv[1]
dom         = parse(xmlfilename)

racine = dom.documentElement;
fils   = racine.childNodes

print('racine=',racine.nodeName)

for f in fils:
  if f.nodeType==1:
    print(f.nodeName,'=',f.childNodes[0].nodeValue)

Modifier le DOM

Un nouveau DOM

impl        = getDOMImplementation()
newdoc      = impl.createDocument(None,"laracine",None)
top_element = newdoc.documentElement

Définir un nœud ou un attribut

new_element = newdoc.createElement('nomelement')
new_element.setAttribute('nom_attribut','valeurattribut')

copie = noeud.cloneNode(True)
copie.removeAttribute('nom_attribut_à_supprimer')

Placer un nœud dans la structure

top_element.appendChild(new_element)

Produire du XML

Produire du XML à partir d'un nœud n : n.toxml() ou n.toprettyxml().

newdoc.toxml()
newdoc.toprettyxml()

Et pour plus de DOM...

Récapitulatif synthétique de DOM niveau 2 par Benjamin Habegger (format PDF, version 2004).