14. Elaborazione di documenti XML

Si consideri il seguente 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>

Analizziamo questo documento per ottenere il seguente output della console:

 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

Dobbiamo sapere come riconoscere:

• un tag di apertura come <training>;
• un tag di chiusura come </teacher>;
• un tag di apertura con attributi come <person gender="F">;
• il corpo di un tag, come "martin" in <name>martin</name>.

Un programma che analizza il codice XML è chiamato parser XML. Due moduli forniscono le funzionalità necessarie per analizzare il codice XML: xml.sax e xml.sax.handler.

Il modulo [xml.sax] ci fornisce un parser XML utilizzando la seguente istruzione:

xml_parser=xml.sax.make_parser()

Questo parser analizza il testo XML in modo sequenziale. Chiama metodi definiti dall'utente in occasione di eventi:

• il metodo startElement su un tag di apertura;
• il metodo endElement su un tag di chiusura;
• il metodo characters sul corpo di un tag.

Dobbiamo indicare al parser quale classe implementa questi metodi:

xml_parser.setContentHandler(XmlHandler())

Passiamo un'istanza di una classe che implementa i metodi startElement, endElement e characters al metodo setContentHandler del parser. La classe utilizzata è una sottoclasse della classe xml.sax.handler.ContentHandler. I metodi precedenti vengono chiamati con i seguenti parametri:

def startElement(self,name,attributs):

• name è il nome del tag di inizio. attributes è il dizionario degli attributi del tag. Pertanto, per il tag <person sex="M">, avremo name="person" e attributes={'sex':'M'}

def endElement(self,name):

• name è il nome del tag di chiusura. Quindi, per il tag </student>, avremo name='student'.

def characters(self,data):

• data è il corpo del tag. Quindi, se il tag è

<nom>
    dupont
</nom>

avremo data='\r\n dupont\r\n '. In genere, rimuoviamo gli spazi bianchi che precedono e seguono i dati.

Ora che questo è stato spiegato, possiamo passare allo script per l'analisi di un documento XML:

---

Il programma (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)

Note:

• Lo script utilizza la libreria di funzioni dei moduli xml.sax e xml.sax.handler (riga 3);
• riga 62: il file XML analizzato;
• riga 68: il parser XML;
• Riga 70: il gestore degli eventi emessi dal parser sarà un'istanza della classe XmlHandler;
• riga 72: inizia l'analisi del documento XML;
• riga 6: la classe che implementa i metodi startElement, endElement e characters. Deriva dalla classe xml.sax.handler.ContentHandler, che implementa i metodi utilizzati dal parser;
• riga 9: il metodo startElement;
• riga 30: il metodo endElement;
• riga 41: il metodo characters.

I risultati sono quelli presentati all'inizio di questo paragrafo.