FM / library

/usr/share/doc/python3-docs/html/_sources/library/

/usr/share/doc/python3-docs/html/_sources/library

Name	Size	Mode	Actions
2to3.rst.txt	15898	0644	edit dl rm
abc.rst.txt	11805	0644	edit dl rm
aifc.rst.txt	7503	0644	edit dl rm
allos.rst.txt	678	0644	edit dl rm
archiving.rst.txt	440	0644	edit dl rm
argparse.rst.txt	77480	0644	edit dl rm
array.rst.txt	10812	0644	edit dl rm
ast.rst.txt	10159	0644	edit dl rm
asynchat.rst.txt	8528	0644	edit dl rm
asyncio-dev.rst.txt	13398	0644	edit dl rm
asyncio-eventloop.rst.txt	33701	0644	edit dl rm
asyncio-eventloops.rst.txt	7660	0644	edit dl rm
asyncio-protocol.rst.txt	25170	0644	edit dl rm
asyncio-queue.rst.txt	4328	0644	edit dl rm
asyncio-stream.rst.txt	14363	0644	edit dl rm
asyncio-subprocess.rst.txt	15544	0644	edit dl rm
asyncio-sync.rst.txt	9078	0644	edit dl rm
asyncio-task.rst.txt	25406	0644	edit dl rm
asyncio.rst.txt	2272	0644	edit dl rm
asyncore.rst.txt	13624	0644	edit dl rm
atexit.rst.txt	3669	0644	edit dl rm
audioop.rst.txt	10712	0644	edit dl rm
base64.rst.txt	10371	0644	edit dl rm
bdb.rst.txt	12985	0644	edit dl rm
binary.rst.txt	654	0644	edit dl rm
binascii.rst.txt	6539	0644	edit dl rm
binhex.rst.txt	1709	0644	edit dl rm
bisect.rst.txt	5398	0644	edit dl rm
builtins.rst.txt	1465	0644	edit dl rm
bz2.rst.txt	8825	0644	edit dl rm
calendar.rst.txt	10988	0644	edit dl rm
cgi.rst.txt	22650	0644	edit dl rm
cgitb.rst.txt	2918	0644	edit dl rm
chunk.rst.txt	5094	0644	edit dl rm
cmath.rst.txt	9326	0644	edit dl rm
cmd.rst.txt	13795	0644	edit dl rm
code.rst.txt	7817	0644	edit dl rm
codecs.rst.txt	75564	0644	edit dl rm
codeop.rst.txt	3021	0644	edit dl rm
collections.abc.rst.txt	12861	0644	edit dl rm
collections.rst.txt	46063	0644	edit dl rm
colorsys.rst.txt	1820	0644	edit dl rm
compileall.rst.txt	8975	0644	edit dl rm
concurrency.rst.txt	673	0644	edit dl rm
concurrent.futures.rst.txt	16910	0644	edit dl rm
concurrent.rst.txt	171	0644	edit dl rm
configparser.rst.txt	48756	0644	edit dl rm
constants.rst.txt	3331	0644	edit dl rm
contextlib.rst.txt	28175	0644	edit dl rm
copy.rst.txt	3378	0644	edit dl rm
copyreg.rst.txt	2182	0644	edit dl rm
crypt.rst.txt	5122	0644	edit dl rm
crypto.rst.txt	411	0644	edit dl rm
csv.rst.txt	19902	0644	edit dl rm
ctypes.rst.txt	88613	0644	edit dl rm
curses.ascii.rst.txt	8920	0644	edit dl rm
curses.panel.rst.txt	2764	0644	edit dl rm
curses.rst.txt	76397	0644	edit dl rm
custominterp.rst.txt	569	0644	edit dl rm
datatypes.rst.txt	751	0644	edit dl rm
datetime.rst.txt	90524	0644	edit dl rm
dbm.rst.txt	14293	0644	edit dl rm
debug.rst.txt	471	0644	edit dl rm
decimal.rst.txt	74869	0644	edit dl rm
development.rst.txt	704	0644	edit dl rm
difflib.rst.txt	29861	0644	edit dl rm
dis.rst.txt	32567	0644	edit dl rm
distribution.rst.txt	452	0644	edit dl rm
distutils.rst.txt	1974	0644	edit dl rm
doctest.rst.txt	71743	0644	edit dl rm
dummy_threading.rst.txt	784	0644	edit dl rm
email.charset.rst.txt	9293	0644	edit dl rm
email.compat32-message.rst.txt	33493	0644	edit dl rm
email.contentmanager.rst.txt	9112	0644	edit dl rm
email.encoders.rst.txt	2715	0644	edit dl rm
email.errors.rst.txt	4792	0644	edit dl rm
email.examples.rst.txt	1915	0644	edit dl rm
email.generator.rst.txt	13637	0644	edit dl rm
email.header.rst.txt	9188	0644	edit dl rm
email.headerregistry.rst.txt	17957	0644	edit dl rm
email.iterators.rst.txt	2795	0644	edit dl rm
email.message.rst.txt	33008	0644	edit dl rm
email.mime.rst.txt	11721	0644	edit dl rm
email.parser.rst.txt	14092	0644	edit dl rm
email.policy.rst.txt	27022	0644	edit dl rm
email.rst.txt	6785	0644	edit dl rm
email.util.rst.txt	9214	0644	edit dl rm
ensurepip.rst.txt	4987	0644	edit dl rm
enum.rst.txt	32751	0644	edit dl rm
errno.rst.txt	6811	0644	edit dl rm
exceptions.rst.txt	25570	0644	edit dl rm
faulthandler.rst.txt	6136	0644	edit dl rm
fcntl.rst.txt	7152	0644	edit dl rm
filecmp.rst.txt	5623	0644	edit dl rm
fileformats.rst.txt	287	0644	edit dl rm
fileinput.rst.txt	8051	0644	edit dl rm
filesys.rst.txt	961	0644	edit dl rm
fnmatch.rst.txt	3103	0644	edit dl rm
formatter.rst.txt	13242	0644	edit dl rm
fpectl.rst.txt	4180	0644	edit dl rm
fractions.rst.txt	6364	0644	edit dl rm
frameworks.rst.txt	391	0644	edit dl rm
ftplib.rst.txt	17552	0644	edit dl rm
functional.rst.txt	365	0644	edit dl rm
functions.rst.txt	71621	0644	edit dl rm
functools.rst.txt	18503	0644	edit dl rm
gc.rst.txt	9694	0644	edit dl rm
getopt.rst.txt	6557	0644	edit dl rm
getpass.rst.txt	1882	0644	edit dl rm
gettext.rst.txt	25588	0644	edit dl rm
glob.rst.txt	3508	0644	edit dl rm
grp.rst.txt	2417	0644	edit dl rm
gzip.rst.txt	8301	0644	edit dl rm
hashlib.rst.txt	26523	0644	edit dl rm
heapq.rst.txt	13402	0644	edit dl rm
hmac.rst.txt	4020	0644	edit dl rm
html.entities.rst.txt	1319	0644	edit dl rm
html.parser.rst.txt	11275	0644	edit dl rm
html.rst.txt	1304	0644	edit dl rm
http.client.rst.txt	18870	0644	edit dl rm
http.cookiejar.rst.txt	27832	0644	edit dl rm
http.cookies.rst.txt	8645	0644	edit dl rm
http.rst.txt	7096	0644	edit dl rm
http.server.rst.txt	17639	0644	edit dl rm
i18n.rst.txt	408	0644	edit dl rm
idle.rst.txt	25834	0644	edit dl rm
imaplib.rst.txt	20367	0644	edit dl rm
imghdr.rst.txt	2938	0644	edit dl rm
imp.rst.txt	15548	0644	edit dl rm
importlib.rst.txt	53563	0644	edit dl rm
index.rst.txt	2258	0644	edit dl rm
inspect.rst.txt	53928	0644	edit dl rm
internet.rst.txt	992	0644	edit dl rm
intro.rst.txt	2645	0644	edit dl rm
io.rst.txt	40328	0644	edit dl rm
ipaddress.rst.txt	32340	0644	edit dl rm
ipc.rst.txt	649	0644	edit dl rm
itertools.rst.txt	38459	0644	edit dl rm
json.rst.txt	27876	0644	edit dl rm
keyword.rst.txt	617	0644	edit dl rm
language.rst.txt	522	0644	edit dl rm
linecache.rst.txt	2408	0644	edit dl rm
locale.rst.txt	25470	0644	edit dl rm
logging.config.rst.txt	33886	0644	edit dl rm
logging.handlers.rst.txt	42497	0644	edit dl rm
logging.rst.txt	60479	0644	edit dl rm
lzma.rst.txt	17361	0644	edit dl rm
macpath.rst.txt	707	0644	edit dl rm
mailbox.rst.txt	63055	0644	edit dl rm
mailcap.rst.txt	3691	0644	edit dl rm
markup.rst.txt	679	0644	edit dl rm
marshal.rst.txt	4855	0644	edit dl rm
math.rst.txt	14375	0644	edit dl rm
mimetypes.rst.txt	9839	0644	edit dl rm
misc.rst.txt	247	0644	edit dl rm
mm.rst.txt	431	0644	edit dl rm
mmap.rst.txt	11232	0644	edit dl rm
modulefinder.rst.txt	3240	0644	edit dl rm
modules.rst.txt	355	0644	edit dl rm
msilib.rst.txt	18612	0644	edit dl rm
msvcrt.rst.txt	4392	0644	edit dl rm
multiprocessing.rst.txt	104494	0644	edit dl rm
netdata.rst.txt	339	0644	edit dl rm
netrc.rst.txt	3007	0644	edit dl rm
nis.rst.txt	1993	0644	edit dl rm
nntplib.rst.txt	21821	0644	edit dl rm
numbers.rst.txt	8089	0644	edit dl rm
numeric.rst.txt	696	0644	edit dl rm
operator.rst.txt	18989	0644	edit dl rm
optparse.rst.txt	76996	0644	edit dl rm
os.path.rst.txt	16419	0644	edit dl rm
os.rst.txt	137534	0644	edit dl rm
ossaudiodev.rst.txt	17845	0644	edit dl rm
othergui.rst.txt	2822	0644	edit dl rm
parser.rst.txt	15148	0644	edit dl rm
pathlib.rst.txt	30045	0644	edit dl rm
pdb.rst.txt	19454	0644	edit dl rm
persistence.rst.txt	591	0644	edit dl rm
pickle.rst.txt	37440	0644	edit dl rm
pickletools.rst.txt	3729	0644	edit dl rm
pipes.rst.txt	2557	0644	edit dl rm
pkgutil.rst.txt	8730	0644	edit dl rm
platform.rst.txt	9624	0644	edit dl rm
plistlib.rst.txt	7398	0644	edit dl rm
poplib.rst.txt	8197	0644	edit dl rm
posix.rst.txt	3694	0644	edit dl rm
pprint.rst.txt	14274	0644	edit dl rm
profile.rst.txt	27969	0644	edit dl rm
pty.rst.txt	3123	0644	edit dl rm
pwd.rst.txt	2739	0644	edit dl rm
pyclbr.rst.txt	3297	0644	edit dl rm
pydoc.rst.txt	4688	0644	edit dl rm
pyexpat.rst.txt	28620	0644	edit dl rm
python.rst.txt	475	0644	edit dl rm
py_compile.rst.txt	3851	0644	edit dl rm
queue.rst.txt	7268	0644	edit dl rm
quopri.rst.txt	2571	0644	edit dl rm
random.rst.txt	18503	0644	edit dl rm
re.rst.txt	64936	0644	edit dl rm
readline.rst.txt	11943	0644	edit dl rm
reprlib.rst.txt	5162	0644	edit dl rm
resource.rst.txt	12291	0644	edit dl rm
rlcompleter.rst.txt	2294	0644	edit dl rm
runpy.rst.txt	8285	0644	edit dl rm
sched.rst.txt	4842	0644	edit dl rm
secrets.rst.txt	5930	0644	edit dl rm
select.rst.txt	28175	0644	edit dl rm
selectors.rst.txt	8925	0644	edit dl rm
shelve.rst.txt	8390	0644	edit dl rm
shlex.rst.txt	16441	0644	edit dl rm
shutil.rst.txt	26014	0644	edit dl rm
signal.rst.txt	17218	0644	edit dl rm
site.rst.txt	9628	0644	edit dl rm
smtpd.rst.txt	10806	0644	edit dl rm
smtplib.rst.txt	23439	0644	edit dl rm
sndhdr.rst.txt	1994	0644	edit dl rm
socket.rst.txt	68202	0644	edit dl rm
socketserver.rst.txt	23712	0644	edit dl rm
spwd.rst.txt	2958	0644	edit dl rm
sqlite3.rst.txt	39215	0644	edit dl rm
ssl.rst.txt	96021	0644	edit dl rm
stat.rst.txt	9805	0644	edit dl rm
statistics.rst.txt	15301	0644	edit dl rm
stdtypes.rst.txt	179240	0644	edit dl rm
string.rst.txt	35374	0644	edit dl rm
stringprep.rst.txt	4279	0644	edit dl rm
struct.rst.txt	19581	0644	edit dl rm
subprocess.rst.txt	45793	0644	edit dl rm
sunau.rst.txt	7390	0644	edit dl rm
superseded.rst.txt	258	0644	edit dl rm
symbol.rst.txt	975	0644	edit dl rm
symtable.rst.txt	4964	0644	edit dl rm
sys.rst.txt	58273	0644	edit dl rm
sysconfig.rst.txt	8749	0644	edit dl rm
syslog.rst.txt	4302	0644	edit dl rm
tabnanny.rst.txt	2007	0644	edit dl rm
tarfile.rst.txt	31749	0644	edit dl rm
telnetlib.rst.txt	7899	0644	edit dl rm
tempfile.rst.txt	13857	0644	edit dl rm
termios.rst.txt	3751	0644	edit dl rm
test.rst.txt	25764	0644	edit dl rm
text.rst.txt	584	0644	edit dl rm
textwrap.rst.txt	10519	0644	edit dl rm
threading.rst.txt	39257	0644	edit dl rm
time.rst.txt	32967	0644	edit dl rm
timeit.rst.txt	13000	0644	edit dl rm
tk.rst.txt	1639	0644	edit dl rm
tkinter.rst.txt	33027	0644	edit dl rm
tkinter.scrolledtext.rst.txt	1255	0644	edit dl rm
tkinter.tix.rst.txt	22653	0644	edit dl rm
tkinter.ttk.rst.txt	58489	0644	edit dl rm
token.rst.txt	2607	0644	edit dl rm
tokenize.rst.txt	10002	0644	edit dl rm
trace.rst.txt	6914	0644	edit dl rm
traceback.rst.txt	17854	0644	edit dl rm
tracemalloc.rst.txt	22089	0644	edit dl rm
tty.rst.txt	1097	0644	edit dl rm
turtle.rst.txt	71221	0644	edit dl rm
types.rst.txt	9999	0644	edit dl rm
typing.rst.txt	34332	0644	edit dl rm
undoc.rst.txt	780	0644	edit dl rm
unicodedata.rst.txt	5762	0644	edit dl rm
unittest.mock-examples.rst.txt	46206	0644	edit dl rm
unittest.mock.rst.txt	85991	0644	edit dl rm
unittest.rst.txt	93304	0644	edit dl rm
unix.rst.txt	446	0644	edit dl rm
urllib.error.rst.txt	2199	0644	edit dl rm
urllib.parse.rst.txt	27332	0644	edit dl rm
urllib.request.rst.txt	59360	0644	edit dl rm
urllib.robotparser.rst.txt	2969	0644	edit dl rm
urllib.rst.txt	466	0644	edit dl rm
uu.rst.txt	2387	0644	edit dl rm
uuid.rst.txt	8760	0644	edit dl rm
venv.rst.txt	20621	0644	edit dl rm
warnings.rst.txt	20152	0644	edit dl rm
wave.rst.txt	6870	0644	edit dl rm
weakref.rst.txt	21328	0644	edit dl rm
webbrowser.rst.txt	9783	0644	edit dl rm
windows.rst.txt	272	0644	edit dl rm
winreg.rst.txt	24073	0644	edit dl rm
winsound.rst.txt	5134	0644	edit dl rm
wsgiref.rst.txt	33047	0644	edit dl rm
xdrlib.rst.txt	8078	0644	edit dl rm
xml.dom.minidom.rst.txt	10198	0644	edit dl rm
xml.dom.pulldom.rst.txt	5186	0644	edit dl rm
xml.dom.rst.txt	39507	0644	edit dl rm
xml.etree.elementtree.rst.txt	43871	0644	edit dl rm
xml.rst.txt	6071	0644	edit dl rm
xml.sax.handler.rst.txt	15399	0644	edit dl rm
xml.sax.reader.rst.txt	12133	0644	edit dl rm
xml.sax.rst.txt	7159	0644	edit dl rm
xml.sax.utils.rst.txt	3901	0644	edit dl rm
xmlrpc.client.rst.txt	23071	0644	edit dl rm
xmlrpc.rst.txt	475	0644	edit dl rm
xmlrpc.server.rst.txt	14990	0644	edit dl rm
zipapp.rst.txt	17392	0644	edit dl rm
zipfile.rst.txt	24005	0644	edit dl rm
zipimport.rst.txt	5805	0644	edit dl rm
zlib.rst.txt	13912	0644	edit dl rm
_dummy_thread.rst.txt	762	0644	edit dl rm
_thread.rst.txt	6886	0644	edit dl rm
__future__.rst.txt	5245	0644	edit dl rm
__main__.rst.txt	904	0644	edit dl rm

Edit: /usr/share/doc/python3-docs/html/_sources/library/xml.dom.rst.txt (39507B)

:mod:`xml.dom` --- The Document Object Model API
================================================

.. module:: xml.dom
   :synopsis: Document Object Model API for Python.

.. sectionauthor:: Paul Prescod <paul@prescod.net>
.. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>

**Source code:** :source:`Lib/xml/dom/__init__.py`

--------------

The Document Object Model, or "DOM," is a cross-language API from the World Wide
Web Consortium (W3C) for accessing and modifying XML documents.  A DOM
implementation presents an XML document as a tree structure, or allows client
code to build such a structure from scratch.  It then gives access to the
structure through a set of objects which provided well-known interfaces.

The DOM is extremely useful for random-access applications.  SAX only allows you
a view of one bit of the document at a time.  If you are looking at one SAX
element, you have no access to another.  If you are looking at a text node, you
have no access to a containing element. When you write a SAX application, you
need to keep track of your program's position in the document somewhere in your
own code.  SAX does not do it for you.  Also, if you need to look ahead in the
XML document, you are just out of luck.

Some applications are simply impossible in an event driven model with no access
to a tree.  Of course you could build some sort of tree yourself in SAX events,
but the DOM allows you to avoid writing that code.  The DOM is a standard tree
representation for XML data.

The Document Object Model is being defined by the W3C in stages, or "levels" in
their terminology.  The Python mapping of the API is substantially based on the
DOM Level 2 recommendation.

.. What if your needs are somewhere between SAX and the DOM?  Perhaps
   you cannot afford to load the entire tree in memory but you find the
   SAX model somewhat cumbersome and low-level.  There is also a module
   called xml.dom.pulldom that allows you to build trees of only the
   parts of a document that you need structured access to.  It also has
   features that allow you to find your way around the DOM.
   See http://www.prescod.net/python/pulldom

DOM applications typically start by parsing some XML into a DOM.  How this is
accomplished is not covered at all by DOM Level 1, and Level 2 provides only
limited improvements: There is a :class:`DOMImplementation` object class which
provides access to :class:`Document` creation methods, but no way to access an
XML reader/parser/Document builder in an implementation-independent way. There
is also no well-defined way to access these methods without an existing
:class:`Document` object.  In Python, each DOM implementation will provide a
function :func:`getDOMImplementation`. DOM Level 3 adds a Load/Store
specification, which defines an interface to the reader, but this is not yet
available in the Python standard library.

Once you have a DOM document object, you can access the parts of your XML
document through its properties and methods.  These properties are defined in
the DOM specification; this portion of the reference manual describes the
interpretation of the specification in Python.

The specification provided by the W3C defines the DOM API for Java, ECMAScript,
and OMG IDL.  The Python mapping defined here is based in large part on the IDL
version of the specification, but strict compliance is not required (though
implementations are free to support the strict mapping from IDL).  See section
:ref:`dom-conformance` for a detailed discussion of mapping requirements.

.. seealso::

`Document Object Model (DOM) Level 2 Specification <https://www.w3.org/TR/DOM-Level-2-Core/>`_
      The W3C recommendation upon which the Python DOM API is based.

`Document Object Model (DOM) Level 1 Specification <https://www.w3.org/TR/REC-DOM-Level-1/>`_
      The W3C recommendation for the DOM supported by :mod:`xml.dom.minidom`.

`Python Language Mapping Specification <http://www.omg.org/spec/PYTH/1.2/PDF>`_
      This specifies the mapping from OMG IDL to Python.

Module Contents
---------------

The :mod:`xml.dom` contains the following functions:

.. function:: registerDOMImplementation(name, factory)

Register the *factory* function with the name *name*.  The factory function
   should return an object which implements the :class:`DOMImplementation`
   interface.  The factory function can return the same object every time, or a new
   one for each call, as appropriate for the specific implementation (e.g. if that
   implementation supports some customization).

.. function:: getDOMImplementation(name=None, features=())

Return a suitable DOM implementation. The *name* is either well-known, the
   module name of a DOM implementation, or ``None``. If it is not ``None``, imports
   the corresponding module and returns a :class:`DOMImplementation` object if the
   import succeeds.  If no name is given, and if the environment variable
   :envvar:`PYTHON_DOM` is set, this variable is used to find the implementation.

If name is not given, this examines the available implementations to find one
   with the required feature set.  If no implementation can be found, raise an
   :exc:`ImportError`.  The features list must be a sequence of ``(feature,
   version)`` pairs which are passed to the :meth:`hasFeature` method on available
   :class:`DOMImplementation` objects.

Some convenience constants are also provided:

.. data:: EMPTY_NAMESPACE

The value used to indicate that no namespace is associated with a node in the
   DOM.  This is typically found as the :attr:`namespaceURI` of a node, or used as
   the *namespaceURI* parameter to a namespaces-specific method.

.. data:: XML_NAMESPACE

The namespace URI associated with the reserved prefix ``xml``, as defined by
   `Namespaces in XML <https://www.w3.org/TR/REC-xml-names/>`_ (section 4).

.. data:: XMLNS_NAMESPACE

The namespace URI for namespace declarations, as defined by `Document Object
   Model (DOM) Level 2 Core Specification
   <https://www.w3.org/TR/DOM-Level-2-Core/core.html>`_ (section 1.1.8).

.. data:: XHTML_NAMESPACE

The URI of the XHTML namespace as defined by `XHTML 1.0: The Extensible
   HyperText Markup Language <https://www.w3.org/TR/xhtml1/>`_ (section 3.1.1).

In addition, :mod:`xml.dom` contains a base :class:`Node` class and the DOM
exception classes.  The :class:`Node` class provided by this module does not
implement any of the methods or attributes defined by the DOM specification;
concrete DOM implementations must provide those.  The :class:`Node` class
provided as part of this module does provide the constants used for the
:attr:`nodeType` attribute on concrete :class:`Node` objects; they are located
within the class rather than at the module level to conform with the DOM
specifications.

.. Should the Node documentation go here?

.. _dom-objects:

Objects in the DOM
------------------

The definitive documentation for the DOM is the DOM specification from the W3C.

Note that DOM attributes may also be manipulated as nodes instead of as simple
strings.  It is fairly rare that you must do this, however, so this usage is not
yet documented.

An additional section describes the exceptions defined for working with the DOM
in Python.

.. _dom-implementation-objects:

DOMImplementation Objects
^^^^^^^^^^^^^^^^^^^^^^^^^

The :class:`DOMImplementation` interface provides a way for applications to
determine the availability of particular features in the DOM they are using.
DOM Level 2 added the ability to create new :class:`Document` and
:class:`DocumentType` objects using the :class:`DOMImplementation` as well.

.. method:: DOMImplementation.hasFeature(feature, version)

Return true if the feature identified by the pair of strings *feature* and
   *version* is implemented.

.. method:: DOMImplementation.createDocument(namespaceUri, qualifiedName, doctype)

Return a new :class:`Document` object (the root of the DOM), with a child
   :class:`Element` object having the given *namespaceUri* and *qualifiedName*. The
   *doctype* must be a :class:`DocumentType` object created by
   :meth:`createDocumentType`, or ``None``. In the Python DOM API, the first two
   arguments can also be ``None`` in order to indicate that no :class:`Element`
   child is to be created.

.. method:: DOMImplementation.createDocumentType(qualifiedName, publicId, systemId)

Return a new :class:`DocumentType` object that encapsulates the given
   *qualifiedName*, *publicId*, and *systemId* strings, representing the
   information contained in an XML document type declaration.

.. _dom-node-objects:

Node Objects
^^^^^^^^^^^^

All of the components of an XML document are subclasses of :class:`Node`.

.. attribute:: Node.nodeType

An integer representing the node type.  Symbolic constants for the types are on
   the :class:`Node` object: :const:`ELEMENT_NODE`, :const:`ATTRIBUTE_NODE`,
   :const:`TEXT_NODE`, :const:`CDATA_SECTION_NODE`, :const:`ENTITY_NODE`,
   :const:`PROCESSING_INSTRUCTION_NODE`, :const:`COMMENT_NODE`,
   :const:`DOCUMENT_NODE`, :const:`DOCUMENT_TYPE_NODE`, :const:`NOTATION_NODE`.
   This is a read-only attribute.

.. attribute:: Node.parentNode

The parent of the current node, or ``None`` for the document node. The value is
   always a :class:`Node` object or ``None``.  For :class:`Element` nodes, this
   will be the parent element, except for the root element, in which case it will
   be the :class:`Document` object. For :class:`Attr` nodes, this is always
   ``None``. This is a read-only attribute.

.. attribute:: Node.attributes

A :class:`NamedNodeMap` of attribute objects.  Only elements have actual values
   for this; others provide ``None`` for this attribute. This is a read-only
   attribute.

.. attribute:: Node.previousSibling

The node that immediately precedes this one with the same parent.  For
   instance the element with an end-tag that comes just before the *self*
   element's start-tag.  Of course, XML documents are made up of more than just
   elements so the previous sibling could be text, a comment, or something else.
   If this node is the first child of the parent, this attribute will be
   ``None``. This is a read-only attribute.

.. attribute:: Node.nextSibling

The node that immediately follows this one with the same parent.  See also
   :attr:`previousSibling`.  If this is the last child of the parent, this
   attribute will be ``None``. This is a read-only attribute.

.. attribute:: Node.childNodes

A list of nodes contained within this node. This is a read-only attribute.

.. attribute:: Node.firstChild

The first child of the node, if there are any, or ``None``. This is a read-only
   attribute.

.. attribute:: Node.lastChild

The last child of the node, if there are any, or ``None``. This is a read-only
   attribute.

.. attribute:: Node.localName

The part of the :attr:`tagName` following the colon if there is one, else the
   entire :attr:`tagName`.  The value is a string.

.. attribute:: Node.prefix

The part of the :attr:`tagName` preceding the colon if there is one, else the
   empty string.  The value is a string, or ``None``.

.. attribute:: Node.namespaceURI

The namespace associated with the element name.  This will be a string or
   ``None``.  This is a read-only attribute.

.. attribute:: Node.nodeName

This has a different meaning for each node type; see the DOM specification for
   details.  You can always get the information you would get here from another
   property such as the :attr:`tagName` property for elements or the :attr:`name`
   property for attributes. For all node types, the value of this attribute will be
   either a string or ``None``.  This is a read-only attribute.

.. attribute:: Node.nodeValue

This has a different meaning for each node type; see the DOM specification for
   details.  The situation is similar to that with :attr:`nodeName`.  The value is
   a string or ``None``.

.. method:: Node.hasAttributes()

Returns true if the node has any attributes.

.. method:: Node.hasChildNodes()

Returns true if the node has any child nodes.

.. method:: Node.isSameNode(other)

Returns true if *other* refers to the same node as this node. This is especially
   useful for DOM implementations which use any sort of proxy architecture (because
   more than one object can refer to the same node).

.. note::

This is based on a proposed DOM Level 3 API which is still in the "working
      draft" stage, but this particular interface appears uncontroversial.  Changes
      from the W3C will not necessarily affect this method in the Python DOM interface
      (though any new W3C API for this would also be supported).

.. method:: Node.appendChild(newChild)

Add a new child node to this node at the end of the list of
   children, returning *newChild*. If the node was already in
   the tree, it is removed first.

.. method:: Node.insertBefore(newChild, refChild)

Insert a new child node before an existing child.  It must be the case that
   *refChild* is a child of this node; if not, :exc:`ValueError` is raised.
   *newChild* is returned. If *refChild* is ``None``, it inserts *newChild* at the
   end of the children's list.

.. method:: Node.removeChild(oldChild)

Remove a child node.  *oldChild* must be a child of this node; if not,
   :exc:`ValueError` is raised.  *oldChild* is returned on success.  If *oldChild*
   will not be used further, its :meth:`unlink` method should be called.

.. method:: Node.replaceChild(newChild, oldChild)

Replace an existing node with a new node. It must be the case that  *oldChild*
   is a child of this node; if not, :exc:`ValueError` is raised.

.. method:: Node.normalize()

Join adjacent text nodes so that all stretches of text are stored as single
   :class:`Text` instances.  This simplifies processing text from a DOM tree for
   many applications.

.. method:: Node.cloneNode(deep)

Clone this node.  Setting *deep* means to clone all child nodes as well.  This
   returns the clone.

.. _dom-nodelist-objects:

NodeList Objects
^^^^^^^^^^^^^^^^

A :class:`NodeList` represents a sequence of nodes.  These objects are used in
two ways in the DOM Core recommendation:  an :class:`Element` object provides
one as its list of child nodes, and the :meth:`getElementsByTagName` and
:meth:`getElementsByTagNameNS` methods of :class:`Node` return objects with this
interface to represent query results.

The DOM Level 2 recommendation defines one method and one attribute for these
objects:

.. method:: NodeList.item(i)

Return the *i*'th item from the sequence, if there is one, or ``None``.  The
   index *i* is not allowed to be less than zero or greater than or equal to the
   length of the sequence.

.. attribute:: NodeList.length

The number of nodes in the sequence.

In addition, the Python DOM interface requires that some additional support is
provided to allow :class:`NodeList` objects to be used as Python sequences.  All
:class:`NodeList` implementations must include support for
:meth:`~object.__len__` and
:meth:`~object.__getitem__`; this allows iteration over the :class:`NodeList` in
:keyword:`for` statements and proper support for the :func:`len` built-in
function.

If a DOM implementation supports modification of the document, the
:class:`NodeList` implementation must also support the
:meth:`~object.__setitem__` and :meth:`~object.__delitem__` methods.

.. _dom-documenttype-objects:

DocumentType Objects
^^^^^^^^^^^^^^^^^^^^

Information about the notations and entities declared by a document (including
the external subset if the parser uses it and can provide the information) is
available from a :class:`DocumentType` object.  The :class:`DocumentType` for a
document is available from the :class:`Document` object's :attr:`doctype`
attribute; if there is no ``DOCTYPE`` declaration for the document, the
document's :attr:`doctype` attribute will be set to ``None`` instead of an
instance of this interface.

:class:`DocumentType` is a specialization of :class:`Node`, and adds the
following attributes:

.. attribute:: DocumentType.publicId

The public identifier for the external subset of the document type definition.
   This will be a string or ``None``.

.. attribute:: DocumentType.systemId

The system identifier for the external subset of the document type definition.
   This will be a URI as a string, or ``None``.

.. attribute:: DocumentType.internalSubset

A string giving the complete internal subset from the document. This does not
   include the brackets which enclose the subset.  If the document has no internal
   subset, this should be ``None``.

.. attribute:: DocumentType.name

The name of the root element as given in the ``DOCTYPE`` declaration, if
   present.

.. attribute:: DocumentType.entities

This is a :class:`NamedNodeMap` giving the definitions of external entities.
   For entity names defined more than once, only the first definition is provided
   (others are ignored as required by the XML recommendation).  This may be
   ``None`` if the information is not provided by the parser, or if no entities are
   defined.

.. attribute:: DocumentType.notations

This is a :class:`NamedNodeMap` giving the definitions of notations. For
   notation names defined more than once, only the first definition is provided
   (others are ignored as required by the XML recommendation).  This may be
   ``None`` if the information is not provided by the parser, or if no notations
   are defined.

.. _dom-document-objects:

Document Objects
^^^^^^^^^^^^^^^^

A :class:`Document` represents an entire XML document, including its constituent
elements, attributes, processing instructions, comments etc.  Remember that it
inherits properties from :class:`Node`.

.. attribute:: Document.documentElement

The one and only root element of the document.

.. method:: Document.createElement(tagName)

Create and return a new element node.  The element is not inserted into the
   document when it is created.  You need to explicitly insert it with one of the
   other methods such as :meth:`insertBefore` or :meth:`appendChild`.

.. method:: Document.createElementNS(namespaceURI, tagName)

Create and return a new element with a namespace.  The *tagName* may have a
   prefix.  The element is not inserted into the document when it is created.  You
   need to explicitly insert it with one of the other methods such as
   :meth:`insertBefore` or :meth:`appendChild`.

.. method:: Document.createTextNode(data)

Create and return a text node containing the data passed as a parameter.  As
   with the other creation methods, this one does not insert the node into the
   tree.

.. method:: Document.createComment(data)

Create and return a comment node containing the data passed as a parameter.  As
   with the other creation methods, this one does not insert the node into the
   tree.

.. method:: Document.createProcessingInstruction(target, data)

Create and return a processing instruction node containing the *target* and
   *data* passed as parameters.  As with the other creation methods, this one does
   not insert the node into the tree.

.. method:: Document.createAttribute(name)

Create and return an attribute node.  This method does not associate the
   attribute node with any particular element.  You must use
   :meth:`setAttributeNode` on the appropriate :class:`Element` object to use the
   newly created attribute instance.

.. method:: Document.createAttributeNS(namespaceURI, qualifiedName)

Create and return an attribute node with a namespace.  The *tagName* may have a
   prefix.  This method does not associate the attribute node with any particular
   element.  You must use :meth:`setAttributeNode` on the appropriate
   :class:`Element` object to use the newly created attribute instance.

.. method:: Document.getElementsByTagName(tagName)

Search for all descendants (direct children, children's children, etc.) with a
   particular element type name.

.. method:: Document.getElementsByTagNameNS(namespaceURI, localName)

Search for all descendants (direct children, children's children, etc.) with a
   particular namespace URI and localname.  The localname is the part of the
   namespace after the prefix.

.. _dom-element-objects:

Element Objects
^^^^^^^^^^^^^^^

:class:`Element` is a subclass of :class:`Node`, so inherits all the attributes
of that class.

.. attribute:: Element.tagName

The element type name.  In a namespace-using document it may have colons in it.
   The value is a string.

.. method:: Element.getElementsByTagName(tagName)

Same as equivalent method in the :class:`Document` class.

.. method:: Element.getElementsByTagNameNS(namespaceURI, localName)

Same as equivalent method in the :class:`Document` class.

.. method:: Element.hasAttribute(name)

Returns true if the element has an attribute named by *name*.

.. method:: Element.hasAttributeNS(namespaceURI, localName)

Returns true if the element has an attribute named by *namespaceURI* and
   *localName*.

.. method:: Element.getAttribute(name)

Return the value of the attribute named by *name* as a string. If no such
   attribute exists, an empty string is returned, as if the attribute had no value.

.. method:: Element.getAttributeNode(attrname)

Return the :class:`Attr` node for the attribute named by *attrname*.

.. method:: Element.getAttributeNS(namespaceURI, localName)

Return the value of the attribute named by *namespaceURI* and *localName* as a
   string. If no such attribute exists, an empty string is returned, as if the
   attribute had no value.

.. method:: Element.getAttributeNodeNS(namespaceURI, localName)

Return an attribute value as a node, given a *namespaceURI* and *localName*.

.. method:: Element.removeAttribute(name)

Remove an attribute by name.  If there is no matching attribute, a
   :exc:`NotFoundErr` is raised.

.. method:: Element.removeAttributeNode(oldAttr)

Remove and return *oldAttr* from the attribute list, if present. If *oldAttr* is
   not present, :exc:`NotFoundErr` is raised.

.. method:: Element.removeAttributeNS(namespaceURI, localName)

Remove an attribute by name.  Note that it uses a localName, not a qname.  No
   exception is raised if there is no matching attribute.

.. method:: Element.setAttribute(name, value)

Set an attribute value from a string.

.. method:: Element.setAttributeNode(newAttr)

Add a new attribute node to the element, replacing an existing attribute if
   necessary if the :attr:`name` attribute matches.  If a replacement occurs, the
   old attribute node will be returned.  If *newAttr* is already in use,
   :exc:`InuseAttributeErr` will be raised.

.. method:: Element.setAttributeNodeNS(newAttr)

Add a new attribute node to the element, replacing an existing attribute if
   necessary if the :attr:`namespaceURI` and :attr:`localName` attributes match.
   If a replacement occurs, the old attribute node will be returned.  If *newAttr*
   is already in use, :exc:`InuseAttributeErr` will be raised.

.. method:: Element.setAttributeNS(namespaceURI, qname, value)

Set an attribute value from a string, given a *namespaceURI* and a *qname*.
   Note that a qname is the whole attribute name.  This is different than above.

.. _dom-attr-objects:

Attr Objects
^^^^^^^^^^^^

:class:`Attr` inherits from :class:`Node`, so inherits all its attributes.

.. attribute:: Attr.name

The attribute name.
   In a namespace-using document it may include a colon.

.. attribute:: Attr.localName

The part of the name following the colon if there is one, else the
   entire name.
   This is a read-only attribute.

.. attribute:: Attr.prefix

The part of the name preceding the colon if there is one, else the
   empty string.

.. attribute:: Attr.value

The text value of the attribute.  This is a synonym for the
   :attr:`nodeValue` attribute.

.. _dom-attributelist-objects:

NamedNodeMap Objects
^^^^^^^^^^^^^^^^^^^^

:class:`NamedNodeMap` does *not* inherit from :class:`Node`.

.. attribute:: NamedNodeMap.length

The length of the attribute list.

.. method:: NamedNodeMap.item(index)

Return an attribute with a particular index.  The order you get the attributes
   in is arbitrary but will be consistent for the life of a DOM.  Each item is an
   attribute node.  Get its value with the :attr:`value` attribute.

There are also experimental methods that give this class more mapping behavior.
You can use them or you can use the standardized :meth:`getAttribute\*` family
of methods on the :class:`Element` objects.

.. _dom-comment-objects:

Comment Objects
^^^^^^^^^^^^^^^

:class:`Comment` represents a comment in the XML document.  It is a subclass of
:class:`Node`, but cannot have child nodes.

.. attribute:: Comment.data

The content of the comment as a string.  The attribute contains all characters
   between the leading ``<!-``\ ``-`` and trailing ``-``\ ``->``, but does not
   include them.

.. _dom-text-objects:

Text and CDATASection Objects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The :class:`Text` interface represents text in the XML document.  If the parser
and DOM implementation support the DOM's XML extension, portions of the text
enclosed in CDATA marked sections are stored in :class:`CDATASection` objects.
These two interfaces are identical, but provide different values for the
:attr:`nodeType` attribute.

These interfaces extend the :class:`Node` interface.  They cannot have child
nodes.

.. attribute:: Text.data

The content of the text node as a string.

.. note::

The use of a :class:`CDATASection` node does not indicate that the node
   represents a complete CDATA marked section, only that the content of the node
   was part of a CDATA section.  A single CDATA section may be represented by more
   than one node in the document tree.  There is no way to determine whether two
   adjacent :class:`CDATASection` nodes represent different CDATA marked sections.

.. _dom-pi-objects:

ProcessingInstruction Objects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Represents a processing instruction in the XML document; this inherits from the
:class:`Node` interface and cannot have child nodes.

.. attribute:: ProcessingInstruction.target

The content of the processing instruction up to the first whitespace character.
   This is a read-only attribute.

.. attribute:: ProcessingInstruction.data

The content of the processing instruction following the first whitespace
   character.

.. _dom-exceptions:

Exceptions
^^^^^^^^^^

The DOM Level 2 recommendation defines a single exception, :exc:`DOMException`,
and a number of constants that allow applications to determine what sort of
error occurred. :exc:`DOMException` instances carry a :attr:`code` attribute
that provides the appropriate value for the specific exception.

The Python DOM interface provides the constants, but also expands the set of
exceptions so that a specific exception exists for each of the exception codes
defined by the DOM.  The implementations must raise the appropriate specific
exception, each of which carries the appropriate value for the :attr:`code`
attribute.

.. exception:: DOMException

Base exception class used for all specific DOM exceptions.  This exception class
   cannot be directly instantiated.

.. exception:: DomstringSizeErr

Raised when a specified range of text does not fit into a string. This is not
   known to be used in the Python DOM implementations, but may be received from DOM
   implementations not written in Python.

.. exception:: HierarchyRequestErr

Raised when an attempt is made to insert a node where the node type is not
   allowed.

.. exception:: IndexSizeErr

Raised when an index or size parameter to a method is negative or exceeds the
   allowed values.

.. exception:: InuseAttributeErr

Raised when an attempt is made to insert an :class:`Attr` node that is already
   present elsewhere in the document.

.. exception:: InvalidAccessErr

Raised if a parameter or an operation is not supported on the underlying object.

.. exception:: InvalidCharacterErr

This exception is raised when a string parameter contains a character that is
   not permitted in the context it's being used in by the XML 1.0 recommendation.
   For example, attempting to create an :class:`Element` node with a space in the
   element type name will cause this error to be raised.

.. exception:: InvalidModificationErr

Raised when an attempt is made to modify the type of a node.

.. exception:: InvalidStateErr

Raised when an attempt is made to use an object that is not defined or is no
   longer usable.

.. exception:: NamespaceErr

If an attempt is made to change any object in a way that is not permitted with
   regard to the `Namespaces in XML <https://www.w3.org/TR/REC-xml-names/>`_
   recommendation, this exception is raised.

.. exception:: NotFoundErr

Exception when a node does not exist in the referenced context.  For example,
   :meth:`NamedNodeMap.removeNamedItem` will raise this if the node passed in does
   not exist in the map.

.. exception:: NotSupportedErr

Raised when the implementation does not support the requested type of object or
   operation.

.. exception:: NoDataAllowedErr

This is raised if data is specified for a node which does not support data.

.. XXX  a better explanation is needed!

.. exception:: NoModificationAllowedErr

Raised on attempts to modify an object where modifications are not allowed (such
   as for read-only nodes).

.. exception:: SyntaxErr

Raised when an invalid or illegal string is specified.

.. XXX  how is this different from InvalidCharacterErr?

.. exception:: WrongDocumentErr

Raised when a node is inserted in a different document than it currently belongs
   to, and the implementation does not support migrating the node from one document
   to the other.

The exception codes defined in the DOM recommendation map to the exceptions
described above according to this table:

+--------------------------------------+---------------------------------+
| Constant                             | Exception                       |
+======================================+=================================+
| :const:`DOMSTRING_SIZE_ERR`          | :exc:`DomstringSizeErr`         |
+--------------------------------------+---------------------------------+
| :const:`HIERARCHY_REQUEST_ERR`       | :exc:`HierarchyRequestErr`      |
+--------------------------------------+---------------------------------+
| :const:`INDEX_SIZE_ERR`              | :exc:`IndexSizeErr`             |
+--------------------------------------+---------------------------------+
| :const:`INUSE_ATTRIBUTE_ERR`         | :exc:`InuseAttributeErr`        |
+--------------------------------------+---------------------------------+
| :const:`INVALID_ACCESS_ERR`          | :exc:`InvalidAccessErr`         |
+--------------------------------------+---------------------------------+
| :const:`INVALID_CHARACTER_ERR`       | :exc:`InvalidCharacterErr`      |
+--------------------------------------+---------------------------------+
| :const:`INVALID_MODIFICATION_ERR`    | :exc:`InvalidModificationErr`   |
+--------------------------------------+---------------------------------+
| :const:`INVALID_STATE_ERR`           | :exc:`InvalidStateErr`          |
+--------------------------------------+---------------------------------+
| :const:`NAMESPACE_ERR`               | :exc:`NamespaceErr`             |
+--------------------------------------+---------------------------------+
| :const:`NOT_FOUND_ERR`               | :exc:`NotFoundErr`              |
+--------------------------------------+---------------------------------+
| :const:`NOT_SUPPORTED_ERR`           | :exc:`NotSupportedErr`          |
+--------------------------------------+---------------------------------+
| :const:`NO_DATA_ALLOWED_ERR`         | :exc:`NoDataAllowedErr`         |
+--------------------------------------+---------------------------------+
| :const:`NO_MODIFICATION_ALLOWED_ERR` | :exc:`NoModificationAllowedErr` |
+--------------------------------------+---------------------------------+
| :const:`SYNTAX_ERR`                  | :exc:`SyntaxErr`                |
+--------------------------------------+---------------------------------+
| :const:`WRONG_DOCUMENT_ERR`          | :exc:`WrongDocumentErr`         |
+--------------------------------------+---------------------------------+

.. _dom-conformance:

Conformance
-----------

This section describes the conformance requirements and relationships between
the Python DOM API, the W3C DOM recommendations, and the OMG IDL mapping for
Python.

.. _dom-type-mapping:

Type Mapping
^^^^^^^^^^^^

The IDL types used in the DOM specification are mapped to Python types
according to the following table.

+------------------+-------------------------------------------+
| IDL Type         | Python Type                               |
+==================+===========================================+
| ``boolean``      | ``bool`` or ``int``                       |
+------------------+-------------------------------------------+
| ``int``          | ``int``                                   |
+------------------+-------------------------------------------+
| ``long int``     | ``int``                                   |
+------------------+-------------------------------------------+
| ``unsigned int`` | ``int``                                   |
+------------------+-------------------------------------------+
| ``DOMString``    | ``str`` or ``bytes``                      |
+------------------+-------------------------------------------+
| ``null``         | ``None``                                  |
+------------------+-------------------------------------------+

.. _dom-accessor-methods:

Accessor Methods
^^^^^^^^^^^^^^^^

The mapping from OMG IDL to Python defines accessor functions for IDL
``attribute`` declarations in much the way the Java mapping does.
Mapping the IDL declarations ::

readonly attribute string someValue;
            attribute string anotherValue;

yields three accessor functions:  a "get" method for :attr:`someValue`
(:meth:`_get_someValue`), and "get" and "set" methods for :attr:`anotherValue`
(:meth:`_get_anotherValue` and :meth:`_set_anotherValue`).  The mapping, in
particular, does not require that the IDL attributes are accessible as normal
Python attributes:  ``object.someValue`` is *not* required to work, and may
raise an :exc:`AttributeError`.

The Python DOM API, however, *does* require that normal attribute access work.
This means that the typical surrogates generated by Python IDL compilers are not
likely to work, and wrapper objects may be needed on the client if the DOM
objects are accessed via CORBA. While this does require some additional
consideration for CORBA DOM clients, the implementers with experience using DOM
over CORBA from Python do not consider this a problem.  Attributes that are
declared ``readonly`` may not restrict write access in all DOM
implementations.

In the Python DOM API, accessor functions are not required.  If provided, they
should take the form defined by the Python IDL mapping, but these methods are
considered unnecessary since the attributes are accessible directly from Python.
"Set" accessors should never be provided for ``readonly`` attributes.

The IDL definitions do not fully embody the requirements of the W3C DOM API,
such as the notion of certain objects, such as the return value of
:meth:`getElementsByTagName`, being "live".  The Python DOM API does not require
implementations to enforce such requirements.

:mod:`xml.dom` --- The Document Object Model API ================================================ .. module:: xml.dom :synopsis: Document Object Model API for Python. .. sectionauthor:: Paul Prescod .. sectionauthor:: Martin v. Löwis **Source code:** :source:`Lib/xml/dom/__init__.py` -------------- The Document Object Model, or "DOM," is a cross-language API from the World Wide Web Consortium (W3C) for accessing and modifying XML documents. A DOM implementation presents an XML document as a tree structure, or allows client code to build such a structure from scratch. It then gives access to the structure through a set of objects which provided well-known interfaces. The DOM is extremely useful for random-access applications. SAX only allows you a view of one bit of the document at a time. If you are looking at one SAX element, you have no access to another. If you are looking at a text node, you have no access to a containing element. When you write a SAX application, you need to keep track of your program's position in the document somewhere in your own code. SAX does not do it for you. Also, if you need to look ahead in the XML document, you are just out of luck. Some applications are simply impossible in an event driven model with no access to a tree. Of course you could build some sort of tree yourself in SAX events, but the DOM allows you to avoid writing that code. The DOM is a standard tree representation for XML data. The Document Object Model is being defined by the W3C in stages, or "levels" in their terminology. The Python mapping of the API is substantially based on the DOM Level 2 recommendation. .. What if your needs are somewhere between SAX and the DOM? Perhaps you cannot afford to load the entire tree in memory but you find the SAX model somewhat cumbersome and low-level. There is also a module called xml.dom.pulldom that allows you to build trees of only the parts of a document that you need structured access to. It also has features that allow you to find your way around the DOM. See http://www.prescod.net/python/pulldom DOM applications typically start by parsing some XML into a DOM. How this is accomplished is not covered at all by DOM Level 1, and Level 2 provides only limited improvements: There is a :class:`DOMImplementation` object class which provides access to :class:`Document` creation methods, but no way to access an XML reader/parser/Document builder in an implementation-independent way. There is also no well-defined way to access these methods without an existing :class:`Document` object. In Python, each DOM implementation will provide a function :func:`getDOMImplementation`. DOM Level 3 adds a Load/Store specification, which defines an interface to the reader, but this is not yet available in the Python standard library. Once you have a DOM document object, you can access the parts of your XML document through its properties and methods. These properties are defined in the DOM specification; this portion of the reference manual describes the interpretation of the specification in Python. The specification provided by the W3C defines the DOM API for Java, ECMAScript, and OMG IDL. The Python mapping defined here is based in large part on the IDL version of the specification, but strict compliance is not required (though implementations are free to support the strict mapping from IDL). See section :ref:`dom-conformance` for a detailed discussion of mapping requirements. .. seealso:: `Document Object Model (DOM) Level 2 Specification `_ The W3C recommendation upon which the Python DOM API is based. `Document Object Model (DOM) Level 1 Specification `_ The W3C recommendation for the DOM supported by :mod:`xml.dom.minidom`. `Python Language Mapping Specification `_ This specifies the mapping from OMG IDL to Python. Module Contents --------------- The :mod:`xml.dom` contains the following functions: .. function:: registerDOMImplementation(name, factory) Register the *factory* function with the name *name*. The factory function should return an object which implements the :class:`DOMImplementation` interface. The factory function can return the same object every time, or a new one for each call, as appropriate for the specific implementation (e.g. if that implementation supports some customization). .. function:: getDOMImplementation(name=None, features=()) Return a suitable DOM implementation. The *name* is either well-known, the module name of a DOM implementation, or ``None``. If it is not ``None``, imports the corresponding module and returns a :class:`DOMImplementation` object if the import succeeds. If no name is given, and if the environment variable :envvar:`PYTHON_DOM` is set, this variable is used to find the implementation. If name is not given, this examines the available implementations to find one with the required feature set. If no implementation can be found, raise an :exc:`ImportError`. The features list must be a sequence of ``(feature, version)`` pairs which are passed to the :meth:`hasFeature` method on available :class:`DOMImplementation` objects. Some convenience constants are also provided: .. data:: EMPTY_NAMESPACE The value used to indicate that no namespace is associated with a node in the DOM. This is typically found as the :attr:`namespaceURI` of a node, or used as the *namespaceURI* parameter to a namespaces-specific method. .. data:: XML_NAMESPACE The namespace URI associated with the reserved prefix ``xml``, as defined by `Namespaces in XML `_ (section 4). .. data:: XMLNS_NAMESPACE The namespace URI for namespace declarations, as defined by `Document Object Model (DOM) Level 2 Core Specification `_ (section 1.1.8). .. data:: XHTML_NAMESPACE The URI of the XHTML namespace as defined by `XHTML 1.0: The Extensible HyperText Markup Language `_ (section 3.1.1). In addition, :mod:`xml.dom` contains a base :class:`Node` class and the DOM exception classes. The :class:`Node` class provided by this module does not implement any of the methods or attributes defined by the DOM specification; concrete DOM implementations must provide those. The :class:`Node` class provided as part of this module does provide the constants used for the :attr:`nodeType` attribute on concrete :class:`Node` objects; they are located within the class rather than at the module level to conform with the DOM specifications. .. Should the Node documentation go here? .. _dom-objects: Objects in the DOM ------------------ The definitive documentation for the DOM is the DOM specification from the W3C. Note that DOM attributes may also be manipulated as nodes instead of as simple strings. It is fairly rare that you must do this, however, so this usage is not yet documented. +--------------------------------+-----------------------------------+---------------------------------+ | Interface | Section | Purpose | +================================+===================================+=================================+ | :class:`DOMImplementation` | :ref:`dom-implementation-objects` | Interface to the underlying | | | | implementation. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`Node` | :ref:`dom-node-objects` | Base interface for most objects | | | | in a document. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`NodeList` | :ref:`dom-nodelist-objects` | Interface for a sequence of | | | | nodes. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`DocumentType` | :ref:`dom-documenttype-objects` | Information about the | | | | declarations needed to process | | | | a document. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`Document` | :ref:`dom-document-objects` | Object which represents an | | | | entire document. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`Element` | :ref:`dom-element-objects` | Element nodes in the document | | | | hierarchy. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`Attr` | :ref:`dom-attr-objects` | Attribute value nodes on | | | | element nodes. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`Comment` | :ref:`dom-comment-objects` | Representation of comments in | | | | the source document. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`Text` | :ref:`dom-text-objects` | Nodes containing textual | | | | content from the document. | +--------------------------------+-----------------------------------+---------------------------------+ | :class:`ProcessingInstruction` | :ref:`dom-pi-objects` | Processing instruction | | | | representation. | +--------------------------------+-----------------------------------+---------------------------------+ An additional section describes the exceptions defined for working with the DOM in Python. .. _dom-implementation-objects: DOMImplementation Objects ^^^^^^^^^^^^^^^^^^^^^^^^^ The :class:`DOMImplementation` interface provides a way for applications to determine the availability of particular features in the DOM they are using. DOM Level 2 added the ability to create new :class:`Document` and :class:`DocumentType` objects using the :class:`DOMImplementation` as well. .. method:: DOMImplementation.hasFeature(feature, version) Return true if the feature identified by the pair of strings *feature* and *version* is implemented. .. method:: DOMImplementation.createDocument(namespaceUri, qualifiedName, doctype) Return a new :class:`Document` object (the root of the DOM), with a child :class:`Element` object having the given *namespaceUri* and *qualifiedName*. The *doctype* must be a :class:`DocumentType` object created by :meth:`createDocumentType`, or ``None``. In the Python DOM API, the first two arguments can also be ``None`` in order to indicate that no :class:`Element` child is to be created. .. method:: DOMImplementation.createDocumentType(qualifiedName, publicId, systemId) Return a new :class:`DocumentType` object that encapsulates the given *qualifiedName*, *publicId*, and *systemId* strings, representing the information contained in an XML document type declaration. .. _dom-node-objects: Node Objects ^^^^^^^^^^^^ All of the components of an XML document are subclasses of :class:`Node`. .. attribute:: Node.nodeType An integer representing the node type. Symbolic constants for the types are on the :class:`Node` object: :const:`ELEMENT_NODE`, :const:`ATTRIBUTE_NODE`, :const:`TEXT_NODE`, :const:`CDATA_SECTION_NODE`, :const:`ENTITY_NODE`, :const:`PROCESSING_INSTRUCTION_NODE`, :const:`COMMENT_NODE`, :const:`DOCUMENT_NODE`, :const:`DOCUMENT_TYPE_NODE`, :const:`NOTATION_NODE`. This is a read-only attribute. .. attribute:: Node.parentNode The parent of the current node, or ``None`` for the document node. The value is always a :class:`Node` object or ``None``. For :class:`Element` nodes, this will be the parent element, except for the root element, in which case it will be the :class:`Document` object. For :class:`Attr` nodes, this is always ``None``. This is a read-only attribute. .. attribute:: Node.attributes A :class:`NamedNodeMap` of attribute objects. Only elements have actual values for this; others provide ``None`` for this attribute. This is a read-only attribute. .. attribute:: Node.previousSibling The node that immediately precedes this one with the same parent. For instance the element with an end-tag that comes just before the *self* element's start-tag. Of course, XML documents are made up of more than just elements so the previous sibling could be text, a comment, or something else. If this node is the first child of the parent, this attribute will be ``None``. This is a read-only attribute. .. attribute:: Node.nextSibling The node that immediately follows this one with the same parent. See also :attr:`previousSibling`. If this is the last child of the parent, this attribute will be ``None``. This is a read-only attribute. .. attribute:: Node.childNodes A list of nodes contained within this node. This is a read-only attribute. .. attribute:: Node.firstChild The first child of the node, if there are any, or ``None``. This is a read-only attribute. .. attribute:: Node.lastChild The last child of the node, if there are any, or ``None``. This is a read-only attribute. .. attribute:: Node.localName The part of the :attr:`tagName` following the colon if there is one, else the entire :attr:`tagName`. The value is a string. .. attribute:: Node.prefix The part of the :attr:`tagName` preceding the colon if there is one, else the empty string. The value is a string, or ``None``. .. attribute:: Node.namespaceURI The namespace associated with the element name. This will be a string or ``None``. This is a read-only attribute. .. attribute:: Node.nodeName This has a different meaning for each node type; see the DOM specification for details. You can always get the information you would get here from another property such as the :attr:`tagName` property for elements or the :attr:`name` property for attributes. For all node types, the value of this attribute will be either a string or ``None``. This is a read-only attribute. .. attribute:: Node.nodeValue This has a different meaning for each node type; see the DOM specification for details. The situation is similar to that with :attr:`nodeName`. The value is a string or ``None``. .. method:: Node.hasAttributes() Returns true if the node has any attributes. .. method:: Node.hasChildNodes() Returns true if the node has any child nodes. .. method:: Node.isSameNode(other) Returns true if *other* refers to the same node as this node. This is especially useful for DOM implementations which use any sort of proxy architecture (because more than one object can refer to the same node). .. note:: This is based on a proposed DOM Level 3 API which is still in the "working draft" stage, but this particular interface appears uncontroversial. Changes from the W3C will not necessarily affect this method in the Python DOM interface (though any new W3C API for this would also be supported). .. method:: Node.appendChild(newChild) Add a new child node to this node at the end of the list of children, returning *newChild*. If the node was already in the tree, it is removed first. .. method:: Node.insertBefore(newChild, refChild) Insert a new child node before an existing child. It must be the case that *refChild* is a child of this node; if not, :exc:`ValueError` is raised. *newChild* is returned. If *refChild* is ``None``, it inserts *newChild* at the end of the children's list. .. method:: Node.removeChild(oldChild) Remove a child node. *oldChild* must be a child of this node; if not, :exc:`ValueError` is raised. *oldChild* is returned on success. If *oldChild* will not be used further, its :meth:`unlink` method should be called. .. method:: Node.replaceChild(newChild, oldChild) Replace an existing node with a new node. It must be the case that *oldChild* is a child of this node; if not, :exc:`ValueError` is raised. .. method:: Node.normalize() Join adjacent text nodes so that all stretches of text are stored as single :class:`Text` instances. This simplifies processing text from a DOM tree for many applications. .. method:: Node.cloneNode(deep) Clone this node. Setting *deep* means to clone all child nodes as well. This returns the clone. .. _dom-nodelist-objects: NodeList Objects ^^^^^^^^^^^^^^^^ A :class:`NodeList` represents a sequence of nodes. These objects are used in two ways in the DOM Core recommendation: an :class:`Element` object provides one as its list of child nodes, and the :meth:`getElementsByTagName` and :meth:`getElementsByTagNameNS` methods of :class:`Node` return objects with this interface to represent query results. The DOM Level 2 recommendation defines one method and one attribute for these objects: .. method:: NodeList.item(i) Return the *i*'th item from the sequence, if there is one, or ``None``. The index *i* is not allowed to be less than zero or greater than or equal to the length of the sequence. .. attribute:: NodeList.length The number of nodes in the sequence. In addition, the Python DOM interface requires that some additional support is provided to allow :class:`NodeList` objects to be used as Python sequences. All :class:`NodeList` implementations must include support for :meth:`~object.__len__` and :meth:`~object.__getitem__`; this allows iteration over the :class:`NodeList` in :keyword:`for` statements and proper support for the :func:`len` built-in function. If a DOM implementation supports modification of the document, the :class:`NodeList` implementation must also support the :meth:`~object.__setitem__` and :meth:`~object.__delitem__` methods. .. _dom-documenttype-objects: DocumentType Objects ^^^^^^^^^^^^^^^^^^^^ Information about the notations and entities declared by a document (including the external subset if the parser uses it and can provide the information) is available from a :class:`DocumentType` object. The :class:`DocumentType` for a document is available from the :class:`Document` object's :attr:`doctype` attribute; if there is no ``DOCTYPE`` declaration for the document, the document's :attr:`doctype` attribute will be set to ``None`` instead of an instance of this interface. :class:`DocumentType` is a specialization of :class:`Node`, and adds the following attributes: .. attribute:: DocumentType.publicId The public identifier for the external subset of the document type definition. This will be a string or ``None``. .. attribute:: DocumentType.systemId The system identifier for the external subset of the document type definition. This will be a URI as a string, or ``None``. .. attribute:: DocumentType.internalSubset A string giving the complete internal subset from the document. This does not include the brackets which enclose the subset. If the document has no internal subset, this should be ``None``. .. attribute:: DocumentType.name The name of the root element as given in the ``DOCTYPE`` declaration, if present. .. attribute:: DocumentType.entities This is a :class:`NamedNodeMap` giving the definitions of external entities. For entity names defined more than once, only the first definition is provided (others are ignored as required by the XML recommendation). This may be ``None`` if the information is not provided by the parser, or if no entities are defined. .. attribute:: DocumentType.notations This is a :class:`NamedNodeMap` giving the definitions of notations. For notation names defined more than once, only the first definition is provided (others are ignored as required by the XML recommendation). This may be ``None`` if the information is not provided by the parser, or if no notations are defined. .. _dom-document-objects: Document Objects ^^^^^^^^^^^^^^^^ A :class:`Document` represents an entire XML document, including its constituent elements, attributes, processing instructions, comments etc. Remember that it inherits properties from :class:`Node`. .. attribute:: Document.documentElement The one and only root element of the document. .. method:: Document.createElement(tagName) Create and return a new element node. The element is not inserted into the document when it is created. You need to explicitly insert it with one of the other methods such as :meth:`insertBefore` or :meth:`appendChild`. .. method:: Document.createElementNS(namespaceURI, tagName) Create and return a new element with a namespace. The *tagName* may have a prefix. The element is not inserted into the document when it is created. You need to explicitly insert it with one of the other methods such as :meth:`insertBefore` or :meth:`appendChild`. .. method:: Document.createTextNode(data) Create and return a text node containing the data passed as a parameter. As with the other creation methods, this one does not insert the node into the tree. .. method:: Document.createComment(data) Create and return a comment node containing the data passed as a parameter. As with the other creation methods, this one does not insert the node into the tree. .. method:: Document.createProcessingInstruction(target, data) Create and return a processing instruction node containing the *target* and *data* passed as parameters. As with the other creation methods, this one does not insert the node into the tree. .. method:: Document.createAttribute(name) Create and return an attribute node. This method does not associate the attribute node with any particular element. You must use :meth:`setAttributeNode` on the appropriate :class:`Element` object to use the newly created attribute instance. .. method:: Document.createAttributeNS(namespaceURI, qualifiedName) Create and return an attribute node with a namespace. The *tagName* may have a prefix. This method does not associate the attribute node with any particular element. You must use :meth:`setAttributeNode` on the appropriate :class:`Element` object to use the newly created attribute instance. .. method:: Document.getElementsByTagName(tagName) Search for all descendants (direct children, children's children, etc.) with a particular element type name. .. method:: Document.getElementsByTagNameNS(namespaceURI, localName) Search for all descendants (direct children, children's children, etc.) with a particular namespace URI and localname. The localname is the part of the namespace after the prefix. .. _dom-element-objects: Element Objects ^^^^^^^^^^^^^^^ :class:`Element` is a subclass of :class:`Node`, so inherits all the attributes of that class. .. attribute:: Element.tagName The element type name. In a namespace-using document it may have colons in it. The value is a string. .. method:: Element.getElementsByTagName(tagName) Same as equivalent method in the :class:`Document` class. .. method:: Element.getElementsByTagNameNS(namespaceURI, localName) Same as equivalent method in the :class:`Document` class. .. method:: Element.hasAttribute(name) Returns true if the element has an attribute named by *name*. .. method:: Element.hasAttributeNS(namespaceURI, localName) Returns true if the element has an attribute named by *namespaceURI* and *localName*. .. method:: Element.getAttribute(name) Return the value of the attribute named by *name* as a string. If no such attribute exists, an empty string is returned, as if the attribute had no value. .. method:: Element.getAttributeNode(attrname) Return the :class:`Attr` node for the attribute named by *attrname*. .. method:: Element.getAttributeNS(namespaceURI, localName) Return the value of the attribute named by *namespaceURI* and *localName* as a string. If no such attribute exists, an empty string is returned, as if the attribute had no value. .. method:: Element.getAttributeNodeNS(namespaceURI, localName) Return an attribute value as a node, given a *namespaceURI* and *localName*. .. method:: Element.removeAttribute(name) Remove an attribute by name. If there is no matching attribute, a :exc:`NotFoundErr` is raised. .. method:: Element.removeAttributeNode(oldAttr) Remove and return *oldAttr* from the attribute list, if present. If *oldAttr* is not present, :exc:`NotFoundErr` is raised. .. method:: Element.removeAttributeNS(namespaceURI, localName) Remove an attribute by name. Note that it uses a localName, not a qname. No exception is raised if there is no matching attribute. .. method:: Element.setAttribute(name, value) Set an attribute value from a string. .. method:: Element.setAttributeNode(newAttr) Add a new attribute node to the element, replacing an existing attribute if necessary if the :attr:`name` attribute matches. If a replacement occurs, the old attribute node will be returned. If *newAttr* is already in use, :exc:`InuseAttributeErr` will be raised. .. method:: Element.setAttributeNodeNS(newAttr) Add a new attribute node to the element, replacing an existing attribute if necessary if the :attr:`namespaceURI` and :attr:`localName` attributes match. If a replacement occurs, the old attribute node will be returned. If *newAttr* is already in use, :exc:`InuseAttributeErr` will be raised. .. method:: Element.setAttributeNS(namespaceURI, qname, value) Set an attribute value from a string, given a *namespaceURI* and a *qname*. Note that a qname is the whole attribute name. This is different than above. .. _dom-attr-objects: Attr Objects ^^^^^^^^^^^^ :class:`Attr` inherits from :class:`Node`, so inherits all its attributes. .. attribute:: Attr.name The attribute name. In a namespace-using document it may include a colon. .. attribute:: Attr.localName The part of the name following the colon if there is one, else the entire name. This is a read-only attribute. .. attribute:: Attr.prefix The part of the name preceding the colon if there is one, else the empty string. .. attribute:: Attr.value The text value of the attribute. This is a synonym for the :attr:`nodeValue` attribute. .. _dom-attributelist-objects: NamedNodeMap Objects ^^^^^^^^^^^^^^^^^^^^ :class:`NamedNodeMap` does *not* inherit from :class:`Node`. .. attribute:: NamedNodeMap.length The length of the attribute list. .. method:: NamedNodeMap.item(index) Return an attribute with a particular index. The order you get the attributes in is arbitrary but will be consistent for the life of a DOM. Each item is an attribute node. Get its value with the :attr:`value` attribute. There are also experimental methods that give this class more mapping behavior. You can use them or you can use the standardized :meth:`getAttribute\*` family of methods on the :class:`Element` objects. .. _dom-comment-objects: Comment Objects ^^^^^^^^^^^^^^^ :class:`Comment` represents a comment in the XML document. It is a subclass of :class:`Node`, but cannot have child nodes. .. attribute:: Comment.data The content of the comment as a string. The attribute contains all characters between the leading ````, but does not include them. .. _dom-text-objects: Text and CDATASection Objects ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The :class:`Text` interface represents text in the XML document. If the parser and DOM implementation support the DOM's XML extension, portions of the text enclosed in CDATA marked sections are stored in :class:`CDATASection` objects. These two interfaces are identical, but provide different values for the :attr:`nodeType` attribute. These interfaces extend the :class:`Node` interface. They cannot have child nodes. .. attribute:: Text.data The content of the text node as a string. .. note:: The use of a :class:`CDATASection` node does not indicate that the node represents a complete CDATA marked section, only that the content of the node was part of a CDATA section. A single CDATA section may be represented by more than one node in the document tree. There is no way to determine whether two adjacent :class:`CDATASection` nodes represent different CDATA marked sections. .. _dom-pi-objects: ProcessingInstruction Objects ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Represents a processing instruction in the XML document; this inherits from the :class:`Node` interface and cannot have child nodes. .. attribute:: ProcessingInstruction.target The content of the processing instruction up to the first whitespace character. This is a read-only attribute. .. attribute:: ProcessingInstruction.data The content of the processing instruction following the first whitespace character. .. _dom-exceptions: Exceptions ^^^^^^^^^^ The DOM Level 2 recommendation defines a single exception, :exc:`DOMException`, and a number of constants that allow applications to determine what sort of error occurred. :exc:`DOMException` instances carry a :attr:`code` attribute that provides the appropriate value for the specific exception. The Python DOM interface provides the constants, but also expands the set of exceptions so that a specific exception exists for each of the exception codes defined by the DOM. The implementations must raise the appropriate specific exception, each of which carries the appropriate value for the :attr:`code` attribute. .. exception:: DOMException Base exception class used for all specific DOM exceptions. This exception class cannot be directly instantiated. .. exception:: DomstringSizeErr Raised when a specified range of text does not fit into a string. This is not known to be used in the Python DOM implementations, but may be received from DOM implementations not written in Python. .. exception:: HierarchyRequestErr Raised when an attempt is made to insert a node where the node type is not allowed. .. exception:: IndexSizeErr Raised when an index or size parameter to a method is negative or exceeds the allowed values. .. exception:: InuseAttributeErr Raised when an attempt is made to insert an :class:`Attr` node that is already present elsewhere in the document. .. exception:: InvalidAccessErr Raised if a parameter or an operation is not supported on the underlying object. .. exception:: InvalidCharacterErr This exception is raised when a string parameter contains a character that is not permitted in the context it's being used in by the XML 1.0 recommendation. For example, attempting to create an :class:`Element` node with a space in the element type name will cause this error to be raised. .. exception:: InvalidModificationErr Raised when an attempt is made to modify the type of a node. .. exception:: InvalidStateErr Raised when an attempt is made to use an object that is not defined or is no longer usable. .. exception:: NamespaceErr If an attempt is made to change any object in a way that is not permitted with regard to the `Namespaces in XML `_ recommendation, this exception is raised. .. exception:: NotFoundErr Exception when a node does not exist in the referenced context. For example, :meth:`NamedNodeMap.removeNamedItem` will raise this if the node passed in does not exist in the map. .. exception:: NotSupportedErr Raised when the implementation does not support the requested type of object or operation. .. exception:: NoDataAllowedErr This is raised if data is specified for a node which does not support data. .. XXX a better explanation is needed! .. exception:: NoModificationAllowedErr Raised on attempts to modify an object where modifications are not allowed (such as for read-only nodes). .. exception:: SyntaxErr Raised when an invalid or illegal string is specified. .. XXX how is this different from InvalidCharacterErr? .. exception:: WrongDocumentErr Raised when a node is inserted in a different document than it currently belongs to, and the implementation does not support migrating the node from one document to the other. The exception codes defined in the DOM recommendation map to the exceptions described above according to this table: +--------------------------------------+---------------------------------+ | Constant | Exception | +======================================+=================================+ | :const:`DOMSTRING_SIZE_ERR` | :exc:`DomstringSizeErr` | +--------------------------------------+---------------------------------+ | :const:`HIERARCHY_REQUEST_ERR` | :exc:`HierarchyRequestErr` | +--------------------------------------+---------------------------------+ | :const:`INDEX_SIZE_ERR` | :exc:`IndexSizeErr` | +--------------------------------------+---------------------------------+ | :const:`INUSE_ATTRIBUTE_ERR` | :exc:`InuseAttributeErr` | +--------------------------------------+---------------------------------+ | :const:`INVALID_ACCESS_ERR` | :exc:`InvalidAccessErr` | +--------------------------------------+---------------------------------+ | :const:`INVALID_CHARACTER_ERR` | :exc:`InvalidCharacterErr` | +--------------------------------------+---------------------------------+ | :const:`INVALID_MODIFICATION_ERR` | :exc:`InvalidModificationErr` | +--------------------------------------+---------------------------------+ | :const:`INVALID_STATE_ERR` | :exc:`InvalidStateErr` | +--------------------------------------+---------------------------------+ | :const:`NAMESPACE_ERR` | :exc:`NamespaceErr` | +--------------------------------------+---------------------------------+ | :const:`NOT_FOUND_ERR` | :exc:`NotFoundErr` | +--------------------------------------+---------------------------------+ | :const:`NOT_SUPPORTED_ERR` | :exc:`NotSupportedErr` | +--------------------------------------+---------------------------------+ | :const:`NO_DATA_ALLOWED_ERR` | :exc:`NoDataAllowedErr` | +--------------------------------------+---------------------------------+ | :const:`NO_MODIFICATION_ALLOWED_ERR` | :exc:`NoModificationAllowedErr` | +--------------------------------------+---------------------------------+ | :const:`SYNTAX_ERR` | :exc:`SyntaxErr` | +--------------------------------------+---------------------------------+ | :const:`WRONG_DOCUMENT_ERR` | :exc:`WrongDocumentErr` | +--------------------------------------+---------------------------------+ .. _dom-conformance: Conformance ----------- This section describes the conformance requirements and relationships between the Python DOM API, the W3C DOM recommendations, and the OMG IDL mapping for Python. .. _dom-type-mapping: Type Mapping ^^^^^^^^^^^^ The IDL types used in the DOM specification are mapped to Python types according to the following table. +------------------+-------------------------------------------+ | IDL Type | Python Type | +==================+===========================================+ | ``boolean`` | ``bool`` or ``int`` | +------------------+-------------------------------------------+ | ``int`` | ``int`` | +------------------+-------------------------------------------+ | ``long int`` | ``int`` | +------------------+-------------------------------------------+ | ``unsigned int`` | ``int`` | +------------------+-------------------------------------------+ | ``DOMString`` | ``str`` or ``bytes`` | +------------------+-------------------------------------------+ | ``null`` | ``None`` | +------------------+-------------------------------------------+ .. _dom-accessor-methods: Accessor Methods ^^^^^^^^^^^^^^^^ The mapping from OMG IDL to Python defines accessor functions for IDL ``attribute`` declarations in much the way the Java mapping does. Mapping the IDL declarations :: readonly attribute string someValue; attribute string anotherValue; yields three accessor functions: a "get" method for :attr:`someValue` (:meth:`_get_someValue`), and "get" and "set" methods for :attr:`anotherValue` (:meth:`_get_anotherValue` and :meth:`_set_anotherValue`). The mapping, in particular, does not require that the IDL attributes are accessible as normal Python attributes: ``object.someValue`` is *not* required to work, and may raise an :exc:`AttributeError`. The Python DOM API, however, *does* require that normal attribute access work. This means that the typical surrogates generated by Python IDL compilers are not likely to work, and wrapper objects may be needed on the client if the DOM objects are accessed via CORBA. While this does require some additional consideration for CORBA DOM clients, the implementers with experience using DOM over CORBA from Python do not consider this a problem. Attributes that are declared ``readonly`` may not restrict write access in all DOM implementations. In the Python DOM API, accessor functions are not required. If provided, they should take the form defined by the Python IDL mapping, but these methods are considered unnecessary since the attributes are accessible directly from Python. "Set" accessors should never be provided for ``readonly`` attributes. The IDL definitions do not fully embody the requirements of the W3C DOM API, such as the notion of certain objects, such as the return value of :meth:`getElementsByTagName`, being "live". The Python DOM API does not require implementations to enforce such requirements.