xml.dom — Το API του Μοντέλου Αντικειμένων Εγγράφου (DOM)

Πηγαίος κώδικας:Lib/xml/dom/__init__.py


Το Μοντέλο Αντικειμένων Εγγράφου, ή αλλιώς «DOM,» είναι ένα API πολλών γλωσσών από το World Wide Web Consortium (W3C) για την πρόσβαση και την τροποποίηση εγγράφων XML. Μια υλοποίηση DOM παρουσιάζει ένα έγγραφο XML ως μια δενδρική δομή, ή επιτρέπει στον χρήστη να κατασκευάσει μια τέτοια δομή από το μηδέν. Στη συνέχεια, παρέχει πρόσβαση στη δομή μέσω ενός συνόλου αντικειμένων που προσφέρουν καθορισμένες διεπαφές.

Το DOM είναι εξαιρετικά χρήσιμο για εφαρμογές με τυχαία πρόσβαση. Το SAX σου επιτρέπει μόνο, να βλέπεις μόνο ένα κομμάτι του εγγράφου κάθε φορά. Αν εξετάζεις ένα στοιχείο SAX, δεν έχεις πρόσβαση σε κάποιο άλλο. Αν εξετάζεις έναν κόμβο κειμένου, δεν έχεις πρόσβαση στο στοιχείο που τον περιέχει. Όταν γράφεις μια εφαρμογή με χρήση του SAX, πρέπει να παρακολουθείς τη θέση του προγράμματος σου μέσα στο έγγραφο στον δικό σου κώδικα - το SAX δεν το κάνει αυτό για εσένα. Επίσης, αν χρειαστεί να κοιτάξεις μπροστά στο XML έγγραφο, δεν έχεις αυτή τη δυνατότητα.

Ορισμένες εφαρμογές είναι απλώς αδύναμες σε ένα μοντέλο βασισμένο σε γεγονότα χωρίς πρόσβαση σε δέντρο. Φυσικά, θα μπορούσες να κατασκευάσεις ένα δέντρο μόνος σου μέσω των γεγονότων του SAX, αλλά το DOM σου επιτρέπει να αποφύγεις την υλοποίηση αυτού του κώδικα. Το DOM είναι μια πρότυπη αναπαράσταση δέντρου για δεδομένα XML.

Το Document Object Model ορίζεται από το W3C σε στάδια, ή «επίπεδα» σύμφωνα με την ορολογία τους. Η αντιστοίχιση της διεπαφής προγραμματισμού εφαρμογών (API) στην Python βασίζεται σε μεγάλο βαθμό στη σύσταση του DOM Επιπέδου 2.

Οι εφαρμογές DOM συνήθως ξεκινούν αναλύοντας κάποιο XML σε DOM. Το πως επιτυγχάνεται αυτό δεν καλύπτεται καθόλου από το DOM Επίπεδο 1, ενώ το Επίπεδο 2 παρέχει μόνο περιορισμένες βελτιώσεις: Υπάρχει μια κλάση αντικειμένουDOMImplementation που παρέχει πρόσβαση σε μεθόδους δημιουργίαςDocument, αλλά δεν υπάρχει τρόπος πρόσβασης σε αναγνώστη XML/αναλυτή/κατασκευαστή εγγράφων με τρόπο ανεξάρτητο από την υλοποίηση. Επίσης, δεν υπάρχει καλά ορισμένος τρόπος πρόσβασης σε αυτές τις μεθόδους χωρίς ένα υπάρχον αντικείμενοDocument. Στην Python, κάθε υλοποίηση DOM θα παρέχει μια συνάρτησηgetDOMImplementation(). Το DOM Επίπεδο 3 προσθέτει μια προδιαγραφή Load/Store, η οποία ορίζει μια διεπαφή προς τον αναγνώστη, αλλά αυτή δεν είναι ακόμα διαθέσιμη στη στάνταρ βιβλιοθήκη της Python.

Αφού έχετε ένα αντικείμενο εγγράφου DOM, μπορείτε να αποκτήσετε πρόσβαση στα τμήματα του XML εγγράφου σας μέσω των ιδιοτήτων και των μεθόδων του. Αυτές οι ιδιότητες ορίζονται στις προδιαγραφές του DOM· αυτό το τμήμα του εγχειριδίου αναφοράς περιγράφει την ερμηνεία των προδιαγραφών στην Python.

Η προδιαγραφή που παρέχεται από το W3C ορίζει το API του DOM για τις γλώσσες Java, ECMAScript και OMG IDL. Η παρούσα αντιστοίχιση στην Python βασίζεται σε μεγάλο βαθμό στην έκδοση της προδιαγραφής με χρήση IDL, αλλά δεν απαιτείται αυστηρή συμμόρφωση (αν και οι υλοποιήσεις είναι ελεύθερες να υποστηρίζουν την αυστηρή αντιστοίχιση από IDL). Δείτε την ενότηταΣυμμόρφωση για μια λεπτομερή συζήτηση των απαιτήσεων αντιστοίχισης.

Δείτε επίσης

Document Object Model (DOM) Level 2 Specification

Η σύσταση του W3C πάνω στην οποία βασίζεται το DOM API της Python.

Document Object Model (DOM) Level 1 Specification

Η σύσταση του W3C για το DOM που υποστηρίζεται από τοxml.dom.minidom.

Python Language Mapping Specification

Αυτό καθορίζει την αντιστοίχιση από το OMG IDL στην Python.

Περιεχόμενα Module

Τοxml.dom περιέχει τις παρακάτω συναρτήσεις:

xml.dom.registerDOMImplementation(name,factory)

Καταχωρεί την συνάρτησηfactory με το όνομαname. Η συνάρτηση factory θα πρέπει να επιστρέφει ένα αντικείμενο που υλοποιεί το interfaceDOMImplementation. Η συνάρτηση factory μπορεί να επιστρέφει το ίδιο αντικείμενο κάθε φορά ή ένα νέο αντικείμενο σε κάθε κλήση, ανάλογα με την υλοποίηση (π.χ. αν η υλοποίηση υποστηρίζει κάποια παραμετροποίηση).

xml.dom.getDOMImplementation(name=None,features=())

Επιστρέφει μια κατάλληλη υλοποίηση DOM. Τοname είναι είτε ένα γνωστό όνομα, είτε το όνομα ενός module που υλοποιεί DOM, είτεNone. Αν δεν είναιNone, το αντίστοιχο module γίνεται import και επιστρέφεται ένα αντικείμενοDOMImplementation αν το import πετύχει. Αν δεν δοθεί όνομα και έχει οριστεί η μεταβλητή περιβάλλοντοςPYTHON_DOM, τότε χρησιμοποιείται αυτή η μεταβλητή για την εύρεση της υλοποίησης.

Αν δεν δοθεί το όνομα, τότε εξετάζονται οι διαθέσιμες υλοποιήσεις για να βρεθεί μία που να υποστηρίζει το απαιτούμενο σύνολο χαρακτηριστικών. Αν δεν βρεθεί κατάλληλη υλοποίηση, γίνεται raiseImportError. Η λίστα χαρακτηριστικών πρέπει να είναι μία ακολουθία από ζεύγη(feature,version), τα οποία περνιούνται στη μέθοδοhasFeature() των διαθέσιμων αντικειμένωνDOMImplementation.

Παρέχονται επίσης μερικές σταθερές ευκολίας:

xml.dom.EMPTY_NAMESPACE

Η τιμή που χρησιμοποιείται για να υποδείξει ότι δεν συνδέεται κάποιο namespace με έναν κόμβο στο DOM. Συνήθως, αυτή η τιμή εμφανίζεται ως τοnamespaceURI ενός κόμβου ή χρησιμοποιείται ως παράμετροςnamespaceURI σε μεθόδους που σχετίζονται με namespaces.

xml.dom.XML_NAMESPACE

Το URI του namespace που σχετίζεται με το δεσμευμένο πρόθεμαxml, όπως ορίζεται από το έγγραφοNamespaces in XML (ενότητα 4).

xml.dom.XMLNS_NAMESPACE

Το URI του namespace για δηλώσεις namespaces, όπως ορίζεται από τοDocument Object Model (DOM) Level 2 Core Specification (ενότητα 1.1.8).

xml.dom.XHTML_NAMESPACE

Το URL του namespace XHTML όπως ορίζεται από τοXHTML 1.0: The Extensible HyperText Markup Language (ενότητα 3.1.1).

Επιπλέον, τοxml.dom περιέχει την βασική κλάσηNode και τις εξαιρέσεις DOM. Η κλάσηNode που παρέχεται από αυτό το module δεν υλοποιεί καμία από τις μεθόδους ή τα χαρακτηριστικά που ορίζονται από την προδιαγραφή DOM. Οι συγκεκριμένες υλοποιήσεις DOM πρέπει να παρέχουν αυτά τα χαρακτηριστικά. Η κλάσηNode που παρέχεται ως μέρος αυτού του module παρέχει τις σταθερές που χρησιμοποιούνται για το χαρακτηριστικόnodeType σε συγκεκριμένα αντικείμεναNode· αυτές βρίσκονται μέσα στην κλάση και όχι στο επίπεδο του module, προκειμένου να συμβαδίζουν με τις προδιαγραφές DOM.

Αντικείμενα στο DOM

Η οριστική τεκμηρίωση για το DOM είναι η προδιαγραφή DOM από το W3C.

Σημειώστε ότι τα χαρακτηριστικά του DOM μπορεί να χειρίζονται και ως κόμβοι αντί για απλές συμβολοσειρές. Ωστόσο, είναι αρκετά σπάνιο να πρέπει να το κάνετε αυτό, οπότε αυτή η χρήση δεν έχει τεκμηριωθεί ακόμα.

Διεπαφή

Ενότητα

Σκοπός

DOMImplementation

Αντικείμενα DOMImplementation

Διεπαφή με την υποκείμενη υλοποίηση.

Node

Αντικείμενα κόμβων

Βασική διεπαφή για τα περισσότερα αντικείμενα σε ένα έγγραφο.

NodeList

Αντικείμενα NodeList

Διεπαφή για μια ακολουθία κόμβων.

DocumentType

Αντικείμενα DocumentType

Πληροφορίες για τις δηλώσεις που απαιτούνται για την επεξεργασία ενός εγγράφου.

Document

Αντικείμενα Document

Αντικείμενο που αναπαριστά ολόκληρο το έγγραφο.

Element

Αντικείμενα Element

Κόμβοι στοιχείων στην ιεραρχία του εγγράφου.

Attr

Αντικείμενα Attr

Κόμβοι τιμών χαρακτηριστικών στους κόμβους στοιχείων.

Comment

Αντικείμενα Comment

Αναπαράσταση σχολίων στο αρχικό έγγραφο.

Text

Αντικείμενα Text και CDATASection

Κόμβοι που περιέχουν το κειμενικό περιεχόμενο του εγγράφου.

ProcessingInstruction

Αντικείμενα ProcessingInstruction

Αναπαράσταση εντολής επεξεργασίας.

Μια επιπλέον ενότητα περιγράφει τις εξαιρέσεις που ορίζονται για την εργασία με το DOM στην Python.

Αντικείμενα DOMImplementation

Η διεπαφήDOMImplementation παρέχει έναν τρόπο για τις εφαρμογές να προσδιορίζουν τη διαθεσιμότητα συγκεκριμένων δυνατοτήτων στο DOM που χρησιμοποιούν. Το DOM Επιπέδου 2 πρόσθεσε τη δυνατότητα δημιουργίας νέων αντικειμένωνDocument καιDocumentType μέσω τηςDOMImplementation.

DOMImplementation.hasFeature(feature,version)

ΕπιστρέφειTrue εάν εφαρμοστεί το χαρακτηριστικό που προσδιορίζεται από το ζεύγος των συμβολοσειρώνfeature καιversion είναι υλοποιημένη.

DOMImplementation.createDocument(namespaceUri,qualifiedName,doctype)

Επιστρέφει ένα νέο αντικείμενοDocument (η ρίζα του DOM), με ένα παιδικό αντικείμενοElement που έχει τα δοσμέναnamespaceUri καιqualifiedName. Η παράμετροςdoctype πρέπει να είναι ένα αντικείμενοDocumentType που έχει δημιουργηθεί με τη μέθοδοcreateDocumentType(), ήNone. Στο API του DOM για την Python, τα δύο πρώτα ορίσματα μπορούν επίσης να είναιNone ώστε να δηλώνουν ότι δεν θα δημιουργηθεί παιδίElement.

DOMImplementation.createDocumentType(qualifiedName,publicId,systemId)

Επιστρέφει ένα νέο αντικείμενοDocumentType που περιλαμβάνει τις δοσμένες συμβολοσειρέςqualifiedName,publicId καιsystemId, οι οποίες αντιπροσωπεύουν τις πληροφορίες που περιέχονται σε μια δήλωση τύπου εγγράφου XML.

Αντικείμενα κόμβων

Όλα τα συστατικά ενός εγγράφου 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

Ο κόμβος που προηγείται αμέσως αυτού με τον ίδιο γονέα. Για παράδειγμα, το στοιχείο του οποίου η ετικέτα κλεισίματος προηγείται ακριβώς της ετικέτας έναρξης τουself στοιχείου. Φυσικά, τα έγγραφα XML αποτελούνται και από άλλα στοιχεία εκτός από tags, οπότε ο προηγούμενος αδελφικός κόμβος μπορεί να είναι κείμενο, σχόλιο ή κάτι άλλο. Αν αυτός ο κόμβος είναι το πρώτο παιδί του γονέα, αυτό το χαρακτηριστικό θα είναιNone. Αυτό είναι ένα χαρακτηριστικό μόνο για ανάγνωση.

Node.nextSibling

Ο κόμβος που ακολουθεί αμέσως αυτόν με τον ίδιο γονέα. Δείτε επίσης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. Η τιμή είναι συμβολοσειρά ήNone.

Node.hasAttributes()

ΕπιστρέφειTrue αν ο κόμβος έχει οποιαδήποτε ιδιότητα.

Node.hasChildNodes()

ΕπιστρέφειTrue αν ο κόμβος έχει οποιονδήποτε παιδικό κόμβο.

Node.isSameNode(other)

ΕπιστρέφειTrue αν τοother αναφέρεται στον ίδιο κόμβο με αυτόν τον κόμβο. Αυτό είναι ιδιαίτερα χρήσιμο για υλοποιήσεις DOM που χρησιμοποιούν αρχιτεκτονική proxy (καθώς περισσότερα από ένα αντικείμενα μπορούν να αναφέρονται στον ίδιο κόμβο).

Σημείωση

Αυτό βασίζεται σε μια προτεινόμενη διεπαφή του DOM Επιπέδου 3 που βρίσκεται ακόμη στο στάδιο του «προσωρινού σχεδίου», αλλά αυτή η συγκεκριμένη διεπαφή φαίνεται να είναι ανεπίμαχη. Οι αλλαγές από το W3C δεν θα επηρεάσουν απαραίτητα αυτή την μέθοδο στην διεπαφή DOM της Python (αν και οποιοδήποτε νέο API του W3C για αυτό θα υποστηρίζεται επίσης).

Node.appendChild(newChild)

Προσθέτει έναν νέο παιδικό κόμβο σε αυτόν τον κόμβο στο τέλος της λίστας των παιδιών, επιστρέφοντας τοnewChild. Αν ο κόμβος υπήρχε ήδη στο δέντρο, αφαιρείται πρώτα.

Node.insertBefore(newChild,refChild)

Εισάγει έναν νέο παιδικό κόμβο πριν από έναν υπάρχοντα παιδικό κόμβο. ΤοrefChild πρέπει να είναι παιδί αυτού του κόμβου· διαφορετικά, γίνεται raise μια εξαίρεσηValueError. Επιστρέφεται τοnewChild. Αν τοrefChild είναιNone, τοnewChild εισάγεται στο τέλος της λίστας των παιδιών.

Node.removeChild(oldChild)

Αφαιρεί έναν παιδικό κόμβο. ΤοoldChild πρέπει να είναι παιδί αυτού του κόμβου· διαφορετικά, γίνεται raise μια εξαίρεσηValueError. Επιστρέφεται τοoldChild σε περίπτωση επιτυχίας. Αν τοoldChild δεν πρόκειται να χρησιμοποιηθεί ξανά, θα πρέπει να κληθεί η μέθοδοςunlink().

Node.replaceChild(newChild,oldChild)

Αντικαθιστά έναν υπάρχοντα κόμβο με νέο κόμβο. ΤοoldChild πρέπει να είναι παιδί αυτού του κόμβου· διαφορετικά, γίνεται raise μια εξαίρεσηValueError.

Node.normalize()

Συγκεντρώνει γειτονικούς κόμβους κειμένου έτσι ώστε όλα τα τμήματα κειμένου να αποθηκεύονται ως μεμονωμένα αντικείμεναText. Αυτό απλοποιεί την επεξεργασία του κειμένου από ένα DOM δέντρο για πολλές εφαρμογές.

Node.cloneNode(deep)

Κλωνοποιεί αυτόν τον κόμβο. Η ρύθμιση τουdeep σημαίνει την κλωνοποίηση όλων των παιδικών κόμβων επίσης. Αυτό επιστρέφει τον κλώνο.

Αντικείμενα NodeList

ΜιαNodeList αντιπροσωπεύει μια ακολουθία κόμβων. Αυτά τα αντικείμενα χρησιμοποιούνται με δύο τρόπους στην σύσταση του DOM Core: ένα αντικείμενοElement παρέχει μια ως τη λίστα των παιδικών κόμβων του, και οι μέθοδοιgetElementsByTagName() καιgetElementsByTagNameNS() τουNode επιστρέφουν αντικείμενα με αυτή τη διεπαφή για να αντιπροσωπεύσουν τα αποτελέσματα ενός ερωτήματος.

Η σύσταση DOM Επιπέδου 2 ορίζει μια μέθοδο και ένα χαρακτηριστικό για αυτά τα αντικείμενα:

NodeList.item(i)

Επιστρέφει τοi-οστό στοιχείο από τη σειρά, αν υπάρχει, ήNone. O δείκτηςi δεν επιτρέπεται να είναι μικρότερος από το μηδέν ή ίσος με το μήκος της σειράς.

NodeList.length

Ο αριθμός των κόμβων στη σειρά.

Επιπλέον, η διεπαφή Python DOM απαιτεί να παρέχεται κάποια επιπλέον υποστήριξη για να επιτρέπεται η χρήση των αντικειμένωνNodeList ως ακολουθίες Python. Όλες οι υλοποιήσειςNodeList πρέπει να περιλαμβάνουν υποστήριξη για τις μεθόδους__len__() και__getitem__`()· αυτό επιτρέπει την επανάληψη μέσω τουNodeList σε δηλώσειςfor και την κατάλληλη υποστήριξη για τη συνάρτησηlen().

Αν μια υλοποίηση του DOM υποστηρίζει την τροποποίηση του εγγράφου, η υλοποίηση τηςNodeList πρέπει επίσης να υποστηρίζει τις μεθόδους__setitem__() και__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

Μια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)

Δημιουργεί και επιστρέφει έναν κόμβο χαρακτηριστικού με ένα namespace. ΤοtagName μπορεί να έχει πρόθεμα. Αυτή η μέθοδος δεν συνδέει τον κόμβο χαρακτηριστικού με κάποιο συγκεκριμένο στοιχείο. Πρέπει να χρησιμοποιήσετε τη μέθοδοsetAttributeNode() στο κατάλληλο αντικείμενοElement για να χρησιμοποιήσετε το νέο δημιουργημένο χαρακτηριστικό.

Document.getElementsByTagName(tagName)

Αναζητήστε όλους τους απογόνους (άμεσα παιδιά, παιδιά των παιδιών κ.λπ.) με ένα συγκεκριμένο όνομα τύπου στοιχείου.

Document.getElementsByTagNameNS(namespaceURI,localName)

Αναζητήστε όλους τους απογόνους (άμεσα παιδιά, παιδιά των παιδιών κ.λπ.) με ένα συγκεκριμένο URI ονόματος χώρου ονομάτων και τοπικό όνομα. Το τοπικό όνομα είναι το μέρος του ονόματος χώρου μετά το πρόθεμα.

Αντικείμενα Element

ΗElement είναι υποκλάση τηςNode, επομένως κληρονομεί όλα τα χαρακτηριστικά αυτής της κλάσης.

Element.tagName

Το όνομα του τύπου του στοιχείου. Σε έγγραφα που χρησιμοποιούν namespace μπορεί να περιέχει άνω κάτω τελείες. Η τιμή είναι μια συμβολοσειρά.

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)

Αφαιρεί ένα χαρακτηριστικό με βάση το όνομα του. Αν δεν υπάρχει αντίστοιχη ιδιότητα, γίνεται raise μια εξαίρεσηNotFoundErr.

Element.removeAttributeNode(oldAttr)

Αφαιρεί και επιστρέφει τοoldAttr από την λίστα των χαρακτηριστικών, εάν υπάρχει. Αν τοoldAttr δεν υπάρχει, γίνεται raise μια εξαίρεσηNotFoundErr.

Element.removeAttributeNS(namespaceURI,localName)

Αφαιρεί ένα χαρακτηριστικό με το όνομα. Σημειώστε ότι χρησιμοποιεί το localName, όχι το qname. Δεν γίνεται raise μια εξαίρεση αν δεν υπάρχει το αντίστοιχο χαρακτηριστικό.

Element.setAttribute(name,value)

Ορίζει μια τιμή χαρακτηριστικού από μια συμβολοσειρά.

Element.setAttributeNode(newAttr)

Προσθέτει ένα νέο κόμβο χαρακτηριστικού στο στοιχείο, αντικαθιστώντας ένα υπάρχον χαρακτηριστικό αν είναι απαραίτητο, εάν το χαρακτηριστικόname ταιριάζει. Εάν γίνει αντικατάσταση, ο παλιός κόμβος χαρακτηριστικού θα επιστραφεί. Εάν τοnewAttr είναι ήδη σε χρήση, θα γίνει raise η εξαίρεσηInuseAttributeErr.

Element.setAttributeNodeNS(newAttr)

Προσθέτει ένα νέο κόμβο χαρακτηριστικού στο στοιχείο, αντικαθιστώντας ένα υπάρχον χαρακτηριστικό αν είναι απαραίτητο, εάν τα χαρακτηριστικάnamespaceURI καιlocalName ταιριάζουν. Εάν γίνει αντικατάσταση, ο παλιός κόμβος χαρακτηριστικού θα επιστραφεί. Εάν τοnewAttr είναι ήδη σε χρήση, θα γίνει raise μια εξαίρεσηInuseAttributeErr.

Element.setAttributeNS(namespaceURI,qname,value)

Ορίζει την τιμή ενός χαρακτηριστικού από μια συμβολοσειρά, δεδομένα ταnamespaceURI καιqname. Σημειώστε ότι το qname είναι το πλήρες όνομα του χαρακτηριστικού. Αυτό διαφέρει από τα παραπάνω.

Αντικείμενα Attr

ΗAttr κληρονομεί από τηνNode, οπότε κληρονομεί όλα τα χαρακτηριστικά της.

Attr.name

Το όνομα του χαρακτηριστικού. Σε έγγραφο που χρησιμοποιεί namespaces μπορεί να περιλαμβάνει άνω κάτω τελεία.

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 Επιπέδου 2 ορίζει μία μόνο εξαίρεση, τηνDOMException, και μια σειρά από σταθερές που επιτρέπουν στις εφαρμογές να προσδιορίσουν το είδος του σφάλματος που προέκυψε. Τα στιγμιότυπαDOMException μεταφέρουν ένα χαρακτηριστικόcode που παρέχει την κατάλληλη τιμή για την συγκεκριμένη εξαίρεση.

Η διεπαφή Python DOM παρέχει τις σταθερές, αλλά επεκτείνει επίσης το σύνολο των εξαιρέσεων, ώστε να υπάρχει μια συγκεκριμένη εξαίρεση για κάθε έναν από τους κωδικούς εξαιρέσεων που ορίζονται από το DOM. Οι υλοποιήσεις πρέπει να κάνουν raise την κατάλληλη εξαίρεση, καθεμία από τις οποίες μεταφέρει την κατάλληλη τιμή για το χαρακτηριστικόcode.

exceptionxml.dom.DOMException

Βασική κλάση εξαίρεσης που χρησιμοποιείται για όλες τις συγκεκριμένες εξαιρέσεις DOM. Αυτή η κλάση εξαίρεσης δεν μπορεί να δημιουργηθεί άμεσα.

exceptionxml.dom.DomstringSizeErr

Γίνεται raise όταν μια καθορισμένη περιοχή κειμένου δεν χωράει σε μία συμβολοσειρά. Αυτό δεν είναι γνωστό ότι χρησιμοποιείται στις υλοποιήσεις Python DOM, αλλά μπορεί να ληφθεί από υλοποιήσεις DOM που δεν είναι γραμμένες σε Python.

exceptionxml.dom.HierarchyRequestErr

Γίνεται raise όταν γίνεται προσπάθεια εισαγωγής ενός κόμβου όπου ο τύπος του κόμβου δεν επιτρέπεται.

exceptionxml.dom.IndexSizeErr

Γίνεται raise όταν μια παράμετρος ευρετηρίου ή μεγέθους σε μια μέθοδο είναι αρνητική ή υπερβαίνει τις επιτρεπόμενες τιμές.

exceptionxml.dom.InuseAttributeErr

Γίνεται raise όταν γίνεται προσπάθεια εισαγωγής ενός κόμβουAttr που υπάρχει ήδη αλλού στο έγγραφο.

exceptionxml.dom.InvalidAccessErr

Γίνεται raise εάν μια παράμετρος ή μια λειτουργία δεν υποστηρίζεται στο υποκείμενο αντικείμενο.

exceptionxml.dom.InvalidCharacterErr

Αυτή η παράμετρος γίνεται raise όταν μια παράμετρος συμβολοσειράς περιέχει έναν χαρακτήρα που δεν επιτρέπεται στο πλαίσιο χρήσης του σύμφωνα με τη σύσταση XML 1.0. Για παράδειγμα, η προσπάθεια δημιουργίας ενός κόμβουElement με κενό στο όνομα του τύπου του στοιχείου θα προκαλέσει αυτό το σφάλμα.

exceptionxml.dom.InvalidModificationErr

Γίνεται raise όταν γίνεται προσπάθεια τροποποίησης ενός κόμβου.

exceptionxml.dom.InvalidStateErr

Γίνεται raise όταν γίνεται προσπάθεια χρήσης ενός αντικειμένου που δεν είναι ορισμένο ή δεν είναι πλέον χρησιμοποιήσιμο.

exceptionxml.dom.NamespaceErr

Εάν γίνει προσπάθεια αλλαγής οποιουδήποτε αντικειμένου με τρόπο που δεν επιτρέπεται σύμφωνα με τη σύστασηNamespaces in XML, γίνεται raise αυτή η εξαίρεση.

exceptionxml.dom.NotFoundErr

Εξαίρεση όταν ένας κόμβος δεν υπάρχει στο αναφερόμενο πλαίσιο. Για παράδειγμα τοNamedNodeMap.removeNamedItem() θα κάνει raise αυτή την εξαίρεση αν ο κόμβος που περνάει δεν υπάρχει στο χάρτη.

exceptionxml.dom.NotSupportedErr

Γίνεται raise όταν η υλοποίηση δεν υποστηρίζει τον ζητούμενο τύπο αντικειμένου ή λειτουργίας.

exceptionxml.dom.NoDataAllowedErr

Γίνεται raise εάν καθορίζονται δεδομένα για έναν κόμβο που δεν υποστηρίζει δεδομένα.

exceptionxml.dom.NoModificationAllowedErr

Γίνεται raise σε προσπάθειες τροποποίησης ενός αντικειμένου όπου οι τροποποιήσεις δεν επιτρέπονται (όπως για κόμβους μόνο για ανάγνωση).

exceptionxml.dom.SyntaxErr

Γίνεται raise όταν καθορίζεται μια μη έγκυρη ή παράνομη συμβολοσειρά.

exceptionxml.dom.WrongDocumentErr

Γίνεται raise όταν ένας κόμβος εισάγεται σε διαφορετικό έγγραφο από αυτό που ανήκει, και η υλοποίηση δεν υποστηρίζει τη μετεγκατάσταση του κόμβου από το ένα έγγραφο στο άλλο.

Οι κωδικοί εξαιρέσεων που ορίζονται στη σύσταση DOM αντιστοιχούν στις εξαιρέσεις που περιγράφονται παραπάνω σύμφωνα με τον παρακάτω πίνακα:

Σταθερά

Εξαίρεση

DOMSTRING_SIZE_ERR

DomstringSizeErr

HIERARCHY_REQUEST_ERR

HierarchyRequestErr

INDEX_SIZE_ERR

IndexSizeErr

INUSE_ATTRIBUTE_ERR

InuseAttributeErr

INVALID_ACCESS_ERR

InvalidAccessErr

INVALID_CHARACTER_ERR

InvalidCharacterErr

INVALID_MODIFICATION_ERR

InvalidModificationErr

INVALID_STATE_ERR

InvalidStateErr

NAMESPACE_ERR

NamespaceErr

NOT_FOUND_ERR

NotFoundErr

NOT_SUPPORTED_ERR

NotSupportedErr

NO_DATA_ALLOWED_ERR

NoDataAllowedErr

NO_MODIFICATION_ALLOWED_ERR

NoModificationAllowedErr

SYNTAX_ERR

SyntaxErr

WRONG_DOCUMENT_ERR

WrongDocumentErr

Συμμόρφωση

Αυτή η ενότητα περιγράφει τις απαιτήσεις συμμόρφωσης και τις σχέσεις μεταξύ της Python DOM API, των συστάσεων W3C DOM και της αντιστοίχισης OMG IDL για την Python.

Αντιστοίχηση Τύπων

Οι τύποι IDL που χρησιμοποιούνται στις προδιαγραφές DOM αντιστοιχίζονται σε τύπους Python σύμφωνα με τον παρακάτω πίνακα.

Τύπος IDL

Τύπος Python

boolean

bool ήint

int

int

longint

int

unsignedint

int

DOMString

str ήbytes

null

None

Μέθοδοι Πρόσβασης

Η αντιστοίχιση από OMG IDL σε Python ορίζει συναρτήσεις πρόσβασης για δηλώσεις IDLattribute με παρόμοιο τρόπο όπως γίνεται και στην αντιστοίχιση Java. Αντιστοίχιση των δηλώσεων IDL:

readonlyattributestringsomeValue;attributestringanotherValue;

παράγει τρεις συναρτήσεις πρόσβασης: μια μέθοδο «get» για τοsomeValue (_get_someValue()), και μεθόδους «get» και «set» για τοanotherValue (_get_anotherValue() και_set_anotherValue()). Η αντιστοίχιση, συγκεκριμένα, δεν απαιτεί τα IDL χαρακτηριστικά να είναι προσβάσιμα ως συνηθισμένα Python χαρακτηριστικά: τοobject.someValueδεν απαιτείται να λειτουργεί και μπορεί να κάνει raiseAttributeError.

Ωστόσο, η Python DOM APIαπαιτεί η κανονική πρόσβαση στα χαρακτηριστικά να λειτουργεί. Αυτό σημαίνει ότι οι τυπικοί εκπρόσωποι που δημιουργούνται από μεταγλωττιστές Python IDL πιθανόν να μην λειτουργούν, και ενδέχεται να απαιτούνται wrapper αντικείμενα από την πλευρά του client εάν τα DOM αντικείμενα προσπελαύνονται μέσω CORBA. Παρόλο που αυτό απαιτεί κάποια επιπλέον προσοχή για CORBA DOM clients, οι υλοποιητές με εμπειρία στη χρήση DOM μέσω CORBA από Python δεν το θεωρούν πρόβλημα. Τα χαρακτηριστικά που δηλώνονται ωςreadon ενδέχεται να μην περιορίζουν την εγγραφή σε όλες τις DOM υλοποιήσεις.

Στην Python DOM API, οι συναρτήσεις πρόσβασης δεν απαιτούνται. Εάν παρέχονται, θα πρέπει να ακολουθούν τη μορφή που ορίζεται από την αντιστοίχιση Python IDL, αλλά αυτές οι μέθοδοι θεωρούνται αναγκαίες μόνο όταν τα attributes δεν είναι άμεσα προσβάσιμα από Python. Γιαreadonly χαρακτηριστικά, δεν θα πρέπει ποτέ να παρέχονται συναρτήσεις «Set» πρόσβασης.

Οι ορισμοί IDL δεν ενσωματώνουν πλήρως τις απαιτήσεις της W3C DOM API, όπως η έννοια ορισμένων αντικειμένων για παράδειγμα, η τιμή επιστροφής τηςgetElementsByTagName() να είναι «live». Η Python DOM API δεν απαιτεί από τις υλοποιήσεις να εφαρμόζουν τέτοιες απαιτήσεις.