xml.etree.elementtree.rst 21.5 KB
Newer Older
1 2 3 4 5 6 7
:mod:`xml.etree.ElementTree` --- The ElementTree XML API
========================================================

.. module:: xml.etree.ElementTree
   :synopsis: Implementation of the ElementTree API.
.. moduleauthor:: Fredrik Lundh <fredrik@pythonware.com>

8 9 10
**Source code:** :source:`Lib/xml/etree/ElementTree.py`

--------------
11

12 13 14
The :class:`Element` type is a flexible container object, designed to store
hierarchical data structures in memory.  The type can be described as a cross
between a list and a dictionary.
15 16 17 18 19 20 21 22 23 24 25 26 27 28

Each element has a number of properties associated with it:

* a tag which is a string identifying what kind of data this element represents
  (the element type, in other words).

* a number of attributes, stored in a Python dictionary.

* a text string.

* an optional tail string.

* a number of child elements, stored in a Python sequence

29 30
To create an element instance, use the :class:`Element` constructor or the
:func:`SubElement` factory function.
31 32 33 34 35 36

The :class:`ElementTree` class can be used to wrap an element structure, and
convert it from and to XML.

A C implementation of this API is available as :mod:`xml.etree.cElementTree`.

37
See http://effbot.org/zone/element-index.htm for tutorials and links to other
38 39 40
docs.  Fredrik Lundh's page is also the location of the development version of
the xml.etree.ElementTree.

41
.. versionchanged:: 3.2
42 43 44 45
   The ElementTree API is updated to 1.3.  For more information, see
   `Introducing ElementTree 1.3
   <http://effbot.org/zone/elementtree-13-intro.htm>`_.

46 47 48 49 50 51 52

.. _elementtree-functions:

Functions
---------


53
.. function:: Comment(text=None)
54

55
   Comment element factory.  This factory function creates a special element
56 57 58
   that will be serialized as an XML comment by the standard serializer.  The
   comment string can be either a bytestring or a Unicode string.  *text* is a
   string containing the comment string.  Returns an element instance
59
   representing a comment.
60 61 62 63


.. function:: dump(elem)

64 65
   Writes an element tree or element structure to sys.stdout.  This function
   should be used for debugging only.
66 67 68 69 70 71 72

   The exact output format is implementation dependent.  In this version, it's
   written as an ordinary XML file.

   *elem* is an element tree or an individual element.


73
.. function:: fromstring(text)
74

75 76
   Parses an XML section from a string constant.  Same as :func:`XML`.  *text*
   is a string containing XML data.  Returns an :class:`Element` instance.
77 78


79
.. function:: fromstringlist(sequence, parser=None)
80

81 82 83 84
   Parses an XML document from a sequence of string fragments.  *sequence* is a
   list or other sequence containing XML data fragments.  *parser* is an
   optional parser instance.  If not given, the standard :class:`XMLParser`
   parser is used.  Returns an :class:`Element` instance.
85

86
   .. versionadded:: 3.2
87 88 89 90


.. function:: iselement(element)

91 92
   Checks if an object appears to be a valid element object.  *element* is an
   element instance.  Returns a true value if this is an element object.
93 94


95
.. function:: iterparse(source, events=None, parser=None)
96 97

   Parses an XML section into an element tree incrementally, and reports what's
98 99
   going on to the user.  *source* is a filename or :term:`file object` containing
   XML data.  *events* is a list of events to report back.  If omitted, only "end"
100 101 102
   events are reported.  *parser* is an optional parser instance.  If not
   given, the standard :class:`XMLParser` parser is used.  Returns an
   :term:`iterator` providing ``(event, elem)`` pairs.
103

104 105 106 107 108 109 110 111 112 113
   .. note::

      :func:`iterparse` only guarantees that it has seen the ">"
      character of a starting tag when it emits a "start" event, so the
      attributes are defined, but the contents of the text and tail attributes
      are undefined at that point.  The same applies to the element children;
      they may or may not be present.

      If you need a fully populated element, look for "end" events instead.

114

115
.. function:: parse(source, parser=None)
116

117 118 119 120
   Parses an XML section into an element tree.  *source* is a filename or file
   object containing XML data.  *parser* is an optional parser instance.  If
   not given, the standard :class:`XMLParser` parser is used.  Returns an
   :class:`ElementTree` instance.
121 122


123
.. function:: ProcessingInstruction(target, text=None)
124

125 126 127 128 129 130 131 132 133 134 135 136 137 138
   PI element factory.  This factory function creates a special element that
   will be serialized as an XML processing instruction.  *target* is a string
   containing the PI target.  *text* is a string containing the PI contents, if
   given.  Returns an element instance, representing a processing instruction.


.. function:: register_namespace(prefix, uri)

   Registers a namespace prefix.  The registry is global, and any existing
   mapping for either the given prefix or the namespace URI will be removed.
   *prefix* is a namespace prefix.  *uri* is a namespace uri.  Tags and
   attributes in this namespace will be serialized with the given prefix, if at
   all possible.

139
   .. versionadded:: 3.2
140 141


142
.. function:: SubElement(parent, tag, attrib={}, **extra)
143

144 145 146 147 148 149 150 151 152 153
   Subelement factory.  This function creates an element instance, and appends
   it to an existing element.

   The element name, attribute names, and attribute values can be either
   bytestrings or Unicode strings.  *parent* is the parent element.  *tag* is
   the subelement name.  *attrib* is an optional dictionary, containing element
   attributes.  *extra* contains additional attributes, given as keyword
   arguments.  Returns an element instance.


154
.. function:: tostring(element, encoding="us-ascii", method="xml")
155 156

   Generates a string representation of an XML element, including all
157
   subelements.  *element* is an :class:`Element` instance.  *encoding* [1]_ is
158 159
   the output encoding (default is US-ASCII).  Use ``encoding="unicode"`` to
   generate a Unicode string.  *method* is either ``"xml"``,
160 161
   ``"html"`` or ``"text"`` (default is ``"xml"``).  Returns an (optionally)
   encoded string containing the XML data.
162 163


164
.. function:: tostringlist(element, encoding="us-ascii", method="xml")
165

166
   Generates a string representation of an XML element, including all
167
   subelements.  *element* is an :class:`Element` instance.  *encoding* [1]_ is
168 169
   the output encoding (default is US-ASCII).  Use ``encoding="unicode"`` to
   generate a Unicode string.  *method* is either ``"xml"``,
170 171 172 173
   ``"html"`` or ``"text"`` (default is ``"xml"``).  Returns a list of
   (optionally) encoded strings containing the XML data.  It does not guarantee
   any specific sequence, except that ``"".join(tostringlist(element)) ==
   tostring(element)``.
174

175
   .. versionadded:: 3.2
176 177


178
.. function:: XML(text, parser=None)
179 180

   Parses an XML section from a string constant.  This function can be used to
181 182 183
   embed "XML literals" in Python code.  *text* is a string containing XML
   data.  *parser* is an optional parser instance.  If not given, the standard
   :class:`XMLParser` parser is used.  Returns an :class:`Element` instance.
184 185


186
.. function:: XMLID(text, parser=None)
187 188

   Parses an XML section from a string constant, and also returns a dictionary
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
   which maps from element id:s to elements.  *text* is a string containing XML
   data.  *parser* is an optional parser instance.  If not given, the standard
   :class:`XMLParser` parser is used.  Returns a tuple containing an
   :class:`Element` instance and a dictionary.


.. _elementtree-element-objects:

Element Objects
---------------


.. class:: Element(tag, attrib={}, **extra)

   Element class.  This class defines the Element interface, and provides a
   reference implementation of this interface.

   The element name, attribute names, and attribute values can be either
   bytestrings or Unicode strings.  *tag* is the element name.  *attrib* is
   an optional dictionary, containing element attributes.  *extra* contains
   additional attributes, given as keyword arguments.


   .. attribute:: tag

      A string identifying what kind of data this element represents (the
      element type, in other words).


   .. attribute:: text
219

220 221 222 223 224
      The *text* attribute can be used to hold additional data associated with
      the element.  As the name implies this attribute is usually a string but
      may be any application-specific object.  If the element is created from
      an XML file the attribute will contain any text found between the element
      tags.
225 226


227
   .. attribute:: tail
228

229 230 231 232 233
      The *tail* attribute can be used to hold additional data associated with
      the element.  This attribute is usually a string but may be any
      application-specific object.  If the element is created from an XML file
      the attribute will contain any text found after the element's end tag and
      before the next tag.
234 235


236
   .. attribute:: attrib
237

238 239 240 241 242
      A dictionary containing the element's attributes.  Note that while the
      *attrib* value is always a real mutable Python dictionary, an ElementTree
      implementation may choose to use another internal representation, and
      create the dictionary only if someone asks for it.  To take advantage of
      such implementations, use the dictionary methods below whenever possible.
243

244
   The following dictionary-like methods work on the element attributes.
245 246


247
   .. method:: clear()
248

249 250
      Resets an element.  This function removes all subelements, clears all
      attributes, and sets the text and tail attributes to None.
251 252


253
   .. method:: get(key, default=None)
254

255
      Gets the element attribute named *key*.
256

257
      Returns the attribute value, or *default* if the attribute was not found.
258 259


260
   .. method:: items()
261

262 263
      Returns the element attributes as a sequence of (name, value) pairs.  The
      attributes are returned in an arbitrary order.
264 265


266
   .. method:: keys()
267

268 269
      Returns the elements attribute names as a list.  The names are returned
      in an arbitrary order.
270 271


272
   .. method:: set(key, value)
273

274
      Set the attribute *key* on the element to *value*.
275

276
   The following methods work on the element's children (subelements).
277 278


279
   .. method:: append(subelement)
280

281 282
      Adds the element *subelement* to the end of this elements internal list
      of subelements.
283 284


285
   .. method:: extend(subelements)
286

287 288
      Appends *subelements* from a sequence object with zero or more elements.
      Raises :exc:`AssertionError` if a subelement is not a valid object.
289

290
      .. versionadded:: 3.2
291 292


293
   .. method:: find(match)
294

295 296
      Finds the first subelement matching *match*.  *match* may be a tag name
      or path.  Returns an element instance or ``None``.
297 298


299
   .. method:: findall(match)
300

301 302
      Finds all matching subelements, by tag name or path.  Returns a list
      containing all matching elements in document order.
303 304


305
   .. method:: findtext(match, default=None)
306

307 308 309 310
      Finds text for the first subelement matching *match*.  *match* may be
      a tag name or path.  Returns the text content of the first matching
      element, or *default* if no element was found.  Note that if the matching
      element has no text content an empty string is returned.
311 312


313
   .. method:: getchildren()
314

315
      .. deprecated:: 3.2
316
         Use ``list(elem)`` or iteration.
317 318


319 320
   .. method:: getiterator(tag=None)

321
      .. deprecated:: 3.2
322 323 324 325 326 327 328
         Use method :meth:`Element.iter` instead.


   .. method:: insert(index, element)

      Inserts a subelement at the given position in this element.

329

330
   .. method:: iter(tag=None)
331

332 333 334 335 336
      Creates a tree :term:`iterator` with the current element as the root.
      The iterator iterates over this element and all elements below it, in
      document (depth first) order.  If *tag* is not ``None`` or ``'*'``, only
      elements whose tag equals *tag* are returned from the iterator.  If the
      tree structure is modified during iteration, the result is undefined.
337 338


339
   .. method:: iterfind(match)
340

341 342
      Finds all matching subelements, by tag name or path.  Returns an iterable
      yielding all matching elements in document order.
343

344
      .. versionadded:: 3.2
345 346


347
   .. method:: itertext()
348

349 350
      Creates a text iterator.  The iterator loops over this element and all
      subelements, in document order, and returns all inner text.
351

352
      .. versionadded:: 3.2
353 354


355
   .. method:: makeelement(tag, attrib)
356

357 358
      Creates a new element object of the same type as this element.  Do not
      call this method, use the :func:`SubElement` factory function instead.
359 360


361
   .. method:: remove(subelement)
362

363 364 365
      Removes *subelement* from the element.  Unlike the find\* methods this
      method compares elements based on the instance identity, not on tag value
      or contents.
366

367 368 369
   :class:`Element` objects also support the following sequence type methods
   for working with subelements: :meth:`__delitem__`, :meth:`__getitem__`,
   :meth:`__setitem__`, :meth:`__len__`.
370

371 372 373
   Caution: Elements with no subelements will test as ``False``.  This behavior
   will change in future versions.  Use specific ``len(elem)`` or ``elem is
   None`` test instead. ::
374

375
     element = root.find('foo')
376

377 378 379 380 381
     if not element:  # careful!
         print("element not found, or element has no subelements")

     if element is None:
         print("element not found")
382 383 384 385 386 387 388 389


.. _elementtree-elementtree-objects:

ElementTree Objects
-------------------


390
.. class:: ElementTree(element=None, file=None)
391

392 393 394
   ElementTree wrapper class.  This class represents an entire element
   hierarchy, and adds some extra support for serialization to and from
   standard XML.
395

396 397
   *element* is the root element.  The tree is initialized with the contents
   of the XML *file* if given.
398 399


400
   .. method:: _setroot(element)
401

402 403
      Replaces the root element for this tree.  This discards the current
      contents of the tree, and replaces it with the given element.  Use with
404
      care.  *element* is an element instance.
405 406


407
   .. method:: find(match)
408

409 410 411
      Finds the first toplevel element matching *match*.  *match* may be a tag
      name or path.  Same as getroot().find(match).  Returns the first matching
      element, or ``None`` if no element was found.
412 413


414
   .. method:: findall(match)
415

416 417 418
      Finds all matching subelements, by tag name or path.  Same as
      getroot().findall(match).  *match* may be a tag name or path.  Returns a
      list containing all matching elements, in document order.
419 420


421
   .. method:: findtext(match, default=None)
422

423
      Finds the element text for the first toplevel element with given tag.
424 425 426 427 428
      Same as getroot().findtext(match).  *match* may be a tag name or path.
      *default* is the value to return if the element was not found.  Returns
      the text content of the first matching element, or the default value no
      element was found.  Note that if the element is found, but has no text
      content, this method returns an empty string.
429 430


431
   .. method:: getiterator(tag=None)
432

433
      .. deprecated:: 3.2
434 435 436 437
         Use method :meth:`ElementTree.iter` instead.


   .. method:: getroot()
438

439 440 441 442 443
      Returns the root element for this tree.


   .. method:: iter(tag=None)

444
      Creates and returns a tree iterator for the root element.  The iterator
445
      loops over all elements in this tree, in section order.  *tag* is the tag
446
      to look for (default is to return all elements)
447 448


449
   .. method:: iterfind(match)
450

451 452 453 454
      Finds all matching subelements, by tag name or path.  Same as
      getroot().iterfind(match). Returns an iterable yielding all matching
      elements in document order.

455
      .. versionadded:: 3.2
456 457


458
   .. method:: parse(source, parser=None)
459

460
      Loads an external XML section into this element tree.  *source* is a file
461 462
      name or :term:`file object`.  *parser* is an optional parser instance.
      If not given, the standard XMLParser parser is used.  Returns the section
463
      root element.
464 465


466
   .. method:: write(file, encoding="us-ascii", xml_declaration=None, method="xml")
467

468
      Writes the element tree to a file, as XML.  *file* is a file name, or a
469
      :term:`file object` opened for writing.  *encoding* [1]_ is the output encoding
470 471
      (default is US-ASCII).  Use ``encoding="unicode"`` to write a Unicode string.
      *xml_declaration* controls if an XML declaration
472
      should be added to the file.  Use False for never, True for always, None
473 474 475
      for only if not US-ASCII or UTF-8 or Unicode (default is None).  *method* is
      either ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``).
      Returns an (optionally) encoded string.
476

477 478 479 480 481 482 483
This is the XML file that is going to be manipulated::

    <html>
        <head>
            <title>Example page</title>
        </head>
        <body>
484
            <p>Moved to <a href="http://example.org/">example.org</a>
485 486 487 488 489 490 491 492 493
            or <a href="http://example.com/">example.com</a>.</p>
        </body>
    </html>

Example of changing the attribute "target" of every link in first paragraph::

    >>> from xml.etree.ElementTree import ElementTree
    >>> tree = ElementTree()
    >>> tree.parse("index.xhtml")
494
    <Element 'html' at 0xb77e6fac>
495 496
    >>> p = tree.find("body/p")     # Finds first occurrence of tag p in body
    >>> p
497 498
    <Element 'p' at 0xb77ec26c>
    >>> links = list(p.iter("a"))   # Returns list of all links
499
    >>> links
500
    [<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
501 502 503
    >>> for i in links:             # Iterates through all found links
    ...     i.attrib["target"] = "blank"
    >>> tree.write("output.xhtml")
504 505 506 507 508 509 510

.. _elementtree-qname-objects:

QName Objects
-------------


511
.. class:: QName(text_or_uri, tag=None)
512

513 514 515 516 517 518
   QName wrapper.  This can be used to wrap a QName attribute value, in order
   to get proper namespace handling on output.  *text_or_uri* is a string
   containing the QName value, in the form {uri}local, or, if the tag argument
   is given, the URI part of a QName.  If *tag* is given, the first argument is
   interpreted as an URI, and this argument is interpreted as a local name.
   :class:`QName` instances are opaque.
519 520 521 522 523 524 525 526


.. _elementtree-treebuilder-objects:

TreeBuilder Objects
-------------------


527
.. class:: TreeBuilder(element_factory=None)
528

529 530 531 532 533
   Generic element structure builder.  This builder converts a sequence of
   start, data, and end method calls to a well-formed element structure.  You
   can use this class to build an element structure using a custom XML parser,
   or a parser for some other XML-like format.  The *element_factory* is called
   to create new :class:`Element` instances when given.
534 535


536
   .. method:: close()
537

538 539
      Flushes the builder buffers, and returns the toplevel document
      element.  Returns an :class:`Element` instance.
540 541


542
   .. method:: data(data)
543

544 545
      Adds text to the current element.  *data* is a string.  This should be
      either a bytestring, or a Unicode string.
546 547


548
   .. method:: end(tag)
549

550 551
      Closes the current element.  *tag* is the element name.  Returns the
      closed element.
552 553


554
   .. method:: start(tag, attrs)
555

556 557 558
      Opens a new element.  *tag* is the element name.  *attrs* is a dictionary
      containing element attributes.  Returns the opened element.

559

560 561
   In addition, a custom :class:`TreeBuilder` object can provide the
   following method:
562

563 564 565 566 567 568
   .. method:: doctype(name, pubid, system)

      Handles a doctype declaration.  *name* is the doctype name.  *pubid* is
      the public identifier.  *system* is the system identifier.  This method
      does not exist on the default :class:`TreeBuilder` class.

569
      .. versionadded:: 3.2
570 571


572
.. _elementtree-xmlparser-objects:
573

574 575
XMLParser Objects
-----------------
576

577 578 579 580 581 582 583 584 585

.. class:: XMLParser(html=0, target=None, encoding=None)

   :class:`Element` structure builder for XML source data, based on the expat
   parser.  *html* are predefined HTML entities.  This flag is not supported by
   the current implementation.  *target* is the target object.  If omitted, the
   builder uses an instance of the standard TreeBuilder class.  *encoding* [1]_
   is optional.  If given, the value overrides the encoding specified in the
   XML file.
586 587


588
   .. method:: close()
589

590
      Finishes feeding data to the parser.  Returns an element structure.
591 592


593
   .. method:: doctype(name, pubid, system)
594

595
      .. deprecated:: 3.2
596 597
         Define the :meth:`TreeBuilder.doctype` method on a custom TreeBuilder
         target.
598 599


600
   .. method:: feed(data)
601

602
      Feeds data to the parser.  *data* is encoded data.
603

604
:meth:`XMLParser.feed` calls *target*\'s :meth:`start` method
605
for each opening tag, its :meth:`end` method for each closing tag,
606
and data is processed by method :meth:`data`.  :meth:`XMLParser.close`
607
calls *target*\'s method :meth:`close`.
608
:class:`XMLParser` can be used not only for building a tree structure.
609 610
This is an example of counting the maximum depth of an XML file::

611
    >>> from xml.etree.ElementTree import XMLParser
612 613 614 615
    >>> class MaxDepth:                     # The target object of the parser
    ...     maxDepth = 0
    ...     depth = 0
    ...     def start(self, tag, attrib):   # Called for each opening tag.
616
    ...         self.depth += 1
617 618 619 620
    ...         if self.depth > self.maxDepth:
    ...             self.maxDepth = self.depth
    ...     def end(self, tag):             # Called for each closing tag.
    ...         self.depth -= 1
621
    ...     def data(self, data):
622 623 624
    ...         pass            # We do not need to do anything with data.
    ...     def close(self):    # Called when all data has been parsed.
    ...         return self.maxDepth
625
    ...
626
    >>> target = MaxDepth()
627
    >>> parser = XMLParser(target=target)
628 629 630 631 632 633 634 635 636 637 638 639 640 641
    >>> exampleXml = """
    ... <a>
    ...   <b>
    ...   </b>
    ...   <b>
    ...     <c>
    ...       <d>
    ...       </d>
    ...     </c>
    ...   </b>
    ... </a>"""
    >>> parser.feed(exampleXml)
    >>> parser.close()
    4
Christian Heimes's avatar
Christian Heimes committed
642 643 644 645 646


.. rubric:: Footnotes

.. [#] The encoding string included in XML output should conform to the
647 648
   appropriate standards.  For example, "UTF-8" is valid, but "UTF8" is
   not.  See http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
649
   and http://www.iana.org/assignments/character-sets.