14. Processamento de documentos XML

Considere o seguinte documento XML:

<tribu>
  <enseignant>
    <personne sexe="M">
      <nom>dupont</nom>
      <prenom>jean</prenom>
      <age>28</age>
      ceci est un commentaire
    </personne>
    <section>27</section>
  </enseignant>
  <etudiant>
    <personne sexe="F">
      <nom>martin</nom>
      <prenom>charline</prenom>
      <age>22</age>
    </personne>
    <formation>dess IAIE</formation>
  </etudiant>
</tribu>

Analisamos este documento para produzir a seguinte saída na consola:

 tribu
  enseignant
   (personne,(sexe,M) )
    nom
     [dupont]
    /nom
    prenom
     [jean]
    /prenom
    age
     [28]
    /age
   /personne
   section
    [27]
   /section
  /enseignant
  etudiant
   (personne,(sexe,F) )
    nom
     [martin]
    /nom
    prenom
     [charline]
    /prenom
    age
     [22]
    /age
   /personne
   formation
    [dess IAIE]
   /formation
  /etudiant
 /tribu

Precisamos de saber como reconhecer:

• uma tag de início, como <training>;
• uma tag de encerramento, como </teacher>;
• uma tag de início com atributos, como <person gender="F">;
• o corpo de uma tag, como «martin» em <name>martin</name>.

Um programa que analisa código XML é chamado de analisador XML. Dois módulos fornecem a funcionalidade necessária para analisar código XML: xml.sax e xml.sax.handler.

O módulo [xml.sax] fornece-nos um analisador XML utilizando a seguinte instrução:

xml_parser=xml.sax.make_parser()

Este analisador analisa o texto XML sequencialmente. Ele chama métodos definidos pelo utilizador em eventos:

• o método startElement numa tag de início;
• o método endElement numa tag de fecho;
• o método characters no corpo de uma tag.

Precisamos indicar ao analisador qual a classe que implementa estes métodos:

xml_parser.setContentHandler(XmlHandler())

Passamos uma instância de uma classe que implementa os métodos startElement, endElement e characters para o método setContentHandler do analisador. A classe utilizada é uma subclasse da classe xml.sax.handler.ContentHandler. Os métodos anteriores são chamados com parâmetros:

def startElement(self,name,attributs):

• name é o nome da tag de início. attributes é o dicionário dos atributos da tag. Assim, para a tag <person sex="M">, teremos name="person" e attributes={'sex':'M'}

def endElement(self,name):

• name é o nome da tag de encerramento. Assim, para a tag </student>, teremos name='student'.

def characters(self,data):

• data é o corpo da tag. Assim, se a tag for

<nom>
    dupont
</nom>

teremos data='\r\n dupont\r\n '. Geralmente, removemos os espaços em branco que precedem e seguem os dados.

Agora que isto está explicado, podemos passar ao script para analisar um documento XML:

---

O programa (xml_sax_01)

---

#    -*- coding=utf-8 -*-

import xml.sax, xml.sax.handler,re

#    management class XML
class XmlHandler(xml.sax.handler.ContentHandler):

    #  function called when a start tag is encountered
    def startElement(self,name,attributs):
        global depth
        #    a sequence of spaces (indentation)
        print " " * depth,
        #    attributes
        precisions=""
        for (attrib,valeur) in attributs.items():
            precisions+="(%s,%s) " % (attrib,valeur)
        #  displays the tag name and any attributes
        if precisions :
            print "(%s,%s)" % (name,precisions)
        else :
            print name
        #    an extra level of tree structure
        depth+=1
        #  is it a data tag?
        global balisesDonnees,baliseDeDonnees
        if balisesDonnees.has_key(name.lower()):
            baliseDeDonnees=1

    #  the function called when an end tag is encountered
    def endElement(self,name):
        #    end of tag
        #    indentation level
        global depth
        depth-=1
        #    a sequence of spaces (indentation)
        print " " * depth,
        #    tag name
        print "/%s" % (name)

    #    data display function
    def characters(self,data):
        #    data
        global baliseDeDonnees

        #  is the current tag a data tag?
        if not baliseDeDonnees :
            return
        #    indentation level
        global depth
        #    a sequence of spaces (indentation)
        print " " * depth,
        #  data are displayed
        match=re.match(r"^\s*(.*)\s*$",data)
        if match:
            print "[%s]" % (match.groups()[0])
        #    end of data tag
        baliseDeDonnees=False

#    ------------------------------------------- main  
#  the program
#    data
file="data.xml"       #  the xml file
depth=0               #  indentation level=depth in tree structure
balisesDonnees={"nom":1,"prenom":1,"age":1,"section":1,"formation":1}
baliseDeDonnees=True     #    to true, indicates a data tag

#    create an xml text analysis object
xml_parser=xml.sax.make_parser()
#  the tag manager
xml_parser.setContentHandler(XmlHandler())
#    xml file processing
xml_parser.parse(file)

Notas:

• O script utiliza a biblioteca de funções dos módulos xml.sax e xml.sax.handler (linha 3);
• linha 62: o ficheiro XML analisado;
• linha 68: o analisador XML;
• Linha 70: O manipulador para eventos emitidos pelo analisador será uma instância da classe XmlHandler;
• linha 72: a análise do documento XML começa;
• linha 6: a classe que implementa os métodos startElement, endElement e characters. É derivada da classe xml.sax.handler.ContentHandler, que implementa métodos utilizados pelo analisador;
• linha 9: o método startElement;
• linha 30: o método endElement;
• linha 41: o método characters.

Os resultados são os apresentados no início deste parágrafo.