Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`xml.etree.ElementTree` --- The ElementTree XML API |
| 2 | ======================================================== |
| 3 | |
| 4 | .. module:: xml.etree.ElementTree |
| 5 | :synopsis: Implementation of the ElementTree API. |
| 6 | .. moduleauthor:: Fredrik Lundh <fredrik@pythonware.com> |
| 7 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 8 | The :mod:`xml.etree.ElementTree` module implements a simple and efficient API |
| 9 | for parsing and creating XML data. |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 10 | |
Florent Xicluna | a72a98f | 2012-02-13 11:03:30 +0100 | [diff] [blame] | 11 | .. versionchanged:: 3.3 |
| 12 | This module will use a fast implementation whenever available. |
| 13 | The :mod:`xml.etree.cElementTree` module is deprecated. |
| 14 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 15 | Tutorial |
| 16 | -------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 17 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 18 | This is a short tutorial for using :mod:`xml.etree.ElementTree` (``ET`` in |
| 19 | short). The goal is to demonstrate some of the building blocks and basic |
| 20 | concepts of the module. |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 21 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 22 | XML tree and elements |
| 23 | ^^^^^^^^^^^^^^^^^^^^^ |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 24 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 25 | XML is an inherently hierarchical data format, and the most natural way to |
| 26 | represent it is with a tree. ``ET`` has two classes for this purpose - |
| 27 | :class:`ElementTree` represents the whole XML document as a tree, and |
| 28 | :class:`Element` represents a single node in this tree. Interactions with |
| 29 | the whole document (reading and writing to/from files) are usually done |
| 30 | on the :class:`ElementTree` level. Interactions with a single XML element |
| 31 | and its sub-elements are done on the :class:`Element` level. |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 32 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 33 | .. _elementtree-parsing-xml: |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 34 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 35 | Parsing XML |
| 36 | ^^^^^^^^^^^ |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 37 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 38 | We'll be using the following XML document as the sample data for this section: |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 39 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 40 | .. code-block:: xml |
| 41 | |
| 42 | <?xml version="1.0"?> |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 43 | <data> |
Eli Bendersky | 3115f0d | 2012-08-15 14:26:30 +0300 | [diff] [blame] | 44 | <country name="Liechtenstein"> |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 45 | <rank>1</rank> |
| 46 | <year>2008</year> |
| 47 | <gdppc>141100</gdppc> |
| 48 | <neighbor name="Austria" direction="E"/> |
| 49 | <neighbor name="Switzerland" direction="W"/> |
| 50 | </country> |
| 51 | <country name="Singapore"> |
| 52 | <rank>4</rank> |
| 53 | <year>2011</year> |
| 54 | <gdppc>59900</gdppc> |
| 55 | <neighbor name="Malaysia" direction="N"/> |
| 56 | </country> |
| 57 | <country name="Panama"> |
| 58 | <rank>68</rank> |
| 59 | <year>2011</year> |
| 60 | <gdppc>13600</gdppc> |
| 61 | <neighbor name="Costa Rica" direction="W"/> |
| 62 | <neighbor name="Colombia" direction="E"/> |
| 63 | </country> |
| 64 | </data> |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 65 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 66 | We can import this data by reading from a file:: |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 67 | |
| 68 | import xml.etree.ElementTree as ET |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 69 | tree = ET.parse('country_data.xml') |
| 70 | root = tree.getroot() |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 71 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 72 | Or directly from a string:: |
| 73 | |
| 74 | root = ET.fromstring(country_data_as_string) |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 75 | |
| 76 | :func:`fromstring` parses XML from a string directly into an :class:`Element`, |
| 77 | which is the root element of the parsed tree. Other parsing functions may |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 78 | create an :class:`ElementTree`. Check the documentation to be sure. |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 79 | |
| 80 | As an :class:`Element`, ``root`` has a tag and a dictionary of attributes:: |
| 81 | |
| 82 | >>> root.tag |
| 83 | 'data' |
| 84 | >>> root.attrib |
| 85 | {} |
| 86 | |
| 87 | It also has children nodes over which we can iterate:: |
| 88 | |
| 89 | >>> for child in root: |
| 90 | ... print(child.tag, child.attrib) |
| 91 | ... |
Eli Bendersky | 3115f0d | 2012-08-15 14:26:30 +0300 | [diff] [blame] | 92 | country {'name': 'Liechtenstein'} |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 93 | country {'name': 'Singapore'} |
| 94 | country {'name': 'Panama'} |
| 95 | |
| 96 | Children are nested, and we can access specific child nodes by index:: |
| 97 | |
| 98 | >>> root[0][1].text |
| 99 | '2008' |
| 100 | |
| 101 | Finding interesting elements |
| 102 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 103 | |
| 104 | :class:`Element` has some useful methods that help iterate recursively over all |
| 105 | the sub-tree below it (its children, their children, and so on). For example, |
| 106 | :meth:`Element.iter`:: |
| 107 | |
| 108 | >>> for neighbor in root.iter('neighbor'): |
| 109 | ... print(neighbor.attrib) |
| 110 | ... |
| 111 | {'name': 'Austria', 'direction': 'E'} |
| 112 | {'name': 'Switzerland', 'direction': 'W'} |
| 113 | {'name': 'Malaysia', 'direction': 'N'} |
| 114 | {'name': 'Costa Rica', 'direction': 'W'} |
| 115 | {'name': 'Colombia', 'direction': 'E'} |
| 116 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 117 | :meth:`Element.findall` finds only elements with a tag which are direct |
| 118 | children of the current element. :meth:`Element.find` finds the *first* child |
| 119 | with a particular tag, and :meth:`Element.text` accesses the element's text |
| 120 | content. :meth:`Element.get` accesses the element's attributes:: |
| 121 | |
| 122 | >>> for country in root.findall('country'): |
| 123 | ... rank = country.find('rank').text |
| 124 | ... name = country.get('name') |
| 125 | ... print(name, rank) |
| 126 | ... |
Eli Bendersky | 3115f0d | 2012-08-15 14:26:30 +0300 | [diff] [blame] | 127 | Liechtenstein 1 |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 128 | Singapore 4 |
| 129 | Panama 68 |
| 130 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 131 | More sophisticated specification of which elements to look for is possible by |
| 132 | using :ref:`XPath <elementtree-xpath>`. |
| 133 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 134 | Modifying an XML File |
| 135 | ^^^^^^^^^^^^^^^^^^^^^ |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 136 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 137 | :class:`ElementTree` provides a simple way to build XML documents and write them to files. |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 138 | The :meth:`ElementTree.write` method serves this purpose. |
| 139 | |
| 140 | Once created, an :class:`Element` object may be manipulated by directly changing |
| 141 | its fields (such as :attr:`Element.text`), adding and modifying attributes |
| 142 | (:meth:`Element.set` method), as well as adding new children (for example |
| 143 | with :meth:`Element.append`). |
| 144 | |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 145 | Let's say we want to add one to each country's rank, and add an ``updated`` |
| 146 | attribute to the rank element:: |
| 147 | |
| 148 | >>> for rank in root.iter('rank'): |
| 149 | ... new_rank = int(rank.text) + 1 |
| 150 | ... rank.text = str(new_rank) |
| 151 | ... rank.set('updated', 'yes') |
| 152 | ... |
Eli Bendersky | a1b0f6d | 2012-08-18 05:42:22 +0300 | [diff] [blame] | 153 | >>> tree.write('output.xml') |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 154 | |
| 155 | Our XML now looks like this: |
| 156 | |
| 157 | .. code-block:: xml |
| 158 | |
| 159 | <?xml version="1.0"?> |
| 160 | <data> |
Eli Bendersky | 3115f0d | 2012-08-15 14:26:30 +0300 | [diff] [blame] | 161 | <country name="Liechtenstein"> |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 162 | <rank updated="yes">2</rank> |
| 163 | <year>2008</year> |
| 164 | <gdppc>141100</gdppc> |
| 165 | <neighbor name="Austria" direction="E"/> |
| 166 | <neighbor name="Switzerland" direction="W"/> |
| 167 | </country> |
| 168 | <country name="Singapore"> |
| 169 | <rank updated="yes">5</rank> |
| 170 | <year>2011</year> |
| 171 | <gdppc>59900</gdppc> |
| 172 | <neighbor name="Malaysia" direction="N"/> |
| 173 | </country> |
| 174 | <country name="Panama"> |
| 175 | <rank updated="yes">69</rank> |
| 176 | <year>2011</year> |
| 177 | <gdppc>13600</gdppc> |
| 178 | <neighbor name="Costa Rica" direction="W"/> |
| 179 | <neighbor name="Colombia" direction="E"/> |
| 180 | </country> |
| 181 | </data> |
| 182 | |
| 183 | We can remove elements using :meth:`Element.remove`. Let's say we want to |
| 184 | remove all countries with a rank higher than 50:: |
| 185 | |
| 186 | >>> for country in root.findall('country'): |
| 187 | ... rank = int(country.find('rank').text) |
| 188 | ... if rank > 50: |
| 189 | ... root.remove(country) |
| 190 | ... |
Eli Bendersky | a1b0f6d | 2012-08-18 05:42:22 +0300 | [diff] [blame] | 191 | >>> tree.write('output.xml') |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 192 | |
| 193 | Our XML now looks like this: |
| 194 | |
| 195 | .. code-block:: xml |
| 196 | |
| 197 | <?xml version="1.0"?> |
| 198 | <data> |
Eli Bendersky | 3115f0d | 2012-08-15 14:26:30 +0300 | [diff] [blame] | 199 | <country name="Liechtenstein"> |
Eli Bendersky | 0f4e934 | 2012-08-14 07:19:33 +0300 | [diff] [blame] | 200 | <rank updated="yes">2</rank> |
| 201 | <year>2008</year> |
| 202 | <gdppc>141100</gdppc> |
| 203 | <neighbor name="Austria" direction="E"/> |
| 204 | <neighbor name="Switzerland" direction="W"/> |
| 205 | </country> |
| 206 | <country name="Singapore"> |
| 207 | <rank updated="yes">5</rank> |
| 208 | <year>2011</year> |
| 209 | <gdppc>59900</gdppc> |
| 210 | <neighbor name="Malaysia" direction="N"/> |
| 211 | </country> |
| 212 | </data> |
| 213 | |
| 214 | Building XML documents |
| 215 | ^^^^^^^^^^^^^^^^^^^^^^ |
| 216 | |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 217 | The :func:`SubElement` function also provides a convenient way to create new |
| 218 | sub-elements for a given element:: |
| 219 | |
| 220 | >>> a = ET.Element('a') |
| 221 | >>> b = ET.SubElement(a, 'b') |
| 222 | >>> c = ET.SubElement(a, 'c') |
| 223 | >>> d = ET.SubElement(c, 'd') |
| 224 | >>> ET.dump(a) |
| 225 | <a><b /><c><d /></c></a> |
| 226 | |
| 227 | Additional resources |
| 228 | ^^^^^^^^^^^^^^^^^^^^ |
| 229 | |
| 230 | See http://effbot.org/zone/element-index.htm for tutorials and links to other |
| 231 | docs. |
| 232 | |
| 233 | |
| 234 | .. _elementtree-xpath: |
| 235 | |
| 236 | XPath support |
| 237 | ------------- |
| 238 | |
| 239 | This module provides limited support for |
| 240 | `XPath expressions <http://www.w3.org/TR/xpath>`_ for locating elements in a |
| 241 | tree. The goal is to support a small subset of the abbreviated syntax; a full |
| 242 | XPath engine is outside the scope of the module. |
| 243 | |
| 244 | Example |
| 245 | ^^^^^^^ |
| 246 | |
| 247 | Here's an example that demonstrates some of the XPath capabilities of the |
| 248 | module. We'll be using the ``countrydata`` XML document from the |
| 249 | :ref:`Parsing XML <elementtree-parsing-xml>` section:: |
| 250 | |
| 251 | import xml.etree.ElementTree as ET |
| 252 | |
| 253 | root = ET.fromstring(countrydata) |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 254 | |
| 255 | # Top-level elements |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 256 | root.findall(".") |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 257 | |
| 258 | # All 'neighbor' grand-children of 'country' children of the top-level |
| 259 | # elements |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 260 | root.findall("./country/neighbor") |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 261 | |
| 262 | # Nodes with name='Singapore' that have a 'year' child |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 263 | root.findall(".//year/..[@name='Singapore']") |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 264 | |
| 265 | # 'year' nodes that are children of nodes with name='Singapore' |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 266 | root.findall(".//*[@name='Singapore']/year") |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 267 | |
| 268 | # All 'neighbor' nodes that are the second child of their parent |
Eli Bendersky | c1d9869 | 2012-03-30 11:44:15 +0300 | [diff] [blame] | 269 | root.findall(".//neighbor[2]") |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 270 | |
| 271 | Supported XPath syntax |
| 272 | ^^^^^^^^^^^^^^^^^^^^^^ |
| 273 | |
| 274 | +-----------------------+------------------------------------------------------+ |
| 275 | | Syntax | Meaning | |
| 276 | +=======================+======================================================+ |
| 277 | | ``tag`` | Selects all child elements with the given tag. | |
| 278 | | | For example, ``spam`` selects all child elements | |
| 279 | | | named ``spam``, ``spam/egg`` selects all | |
| 280 | | | grandchildren named ``egg`` in all children named | |
| 281 | | | ``spam``. | |
| 282 | +-----------------------+------------------------------------------------------+ |
| 283 | | ``*`` | Selects all child elements. For example, ``*/egg`` | |
| 284 | | | selects all grandchildren named ``egg``. | |
| 285 | +-----------------------+------------------------------------------------------+ |
| 286 | | ``.`` | Selects the current node. This is mostly useful | |
| 287 | | | at the beginning of the path, to indicate that it's | |
| 288 | | | a relative path. | |
| 289 | +-----------------------+------------------------------------------------------+ |
| 290 | | ``//`` | Selects all subelements, on all levels beneath the | |
Eli Bendersky | ede001a | 2012-03-27 04:57:23 +0200 | [diff] [blame] | 291 | | | current element. For example, ``.//egg`` selects | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 292 | | | all ``egg`` elements in the entire tree. | |
| 293 | +-----------------------+------------------------------------------------------+ |
Eli Bendersky | 323a43a | 2012-10-09 06:46:33 -0700 | [diff] [blame] | 294 | | ``..`` | Selects the parent element. Returns ``None`` if the | |
| 295 | | | path attempts to reach the ancestors of the start | |
| 296 | | | element (the element ``find`` was called on). | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 297 | +-----------------------+------------------------------------------------------+ |
| 298 | | ``[@attrib]`` | Selects all elements that have the given attribute. | |
| 299 | +-----------------------+------------------------------------------------------+ |
| 300 | | ``[@attrib='value']`` | Selects all elements for which the given attribute | |
| 301 | | | has the given value. The value cannot contain | |
| 302 | | | quotes. | |
| 303 | +-----------------------+------------------------------------------------------+ |
| 304 | | ``[tag]`` | Selects all elements that have a child named | |
| 305 | | | ``tag``. Only immediate children are supported. | |
| 306 | +-----------------------+------------------------------------------------------+ |
| 307 | | ``[position]`` | Selects all elements that are located at the given | |
| 308 | | | position. The position can be either an integer | |
| 309 | | | (1 is the first position), the expression ``last()`` | |
| 310 | | | (for the last position), or a position relative to | |
| 311 | | | the last position (e.g. ``last()-1``). | |
| 312 | +-----------------------+------------------------------------------------------+ |
| 313 | |
| 314 | Predicates (expressions within square brackets) must be preceded by a tag |
| 315 | name, an asterisk, or another predicate. ``position`` predicates must be |
| 316 | preceded by a tag name. |
| 317 | |
| 318 | Reference |
| 319 | --------- |
| 320 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 321 | .. _elementtree-functions: |
| 322 | |
| 323 | Functions |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 324 | ^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 325 | |
| 326 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 327 | .. function:: Comment(text=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 328 | |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 329 | Comment element factory. This factory function creates a special element |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 330 | that will be serialized as an XML comment by the standard serializer. The |
| 331 | comment string can be either a bytestring or a Unicode string. *text* is a |
| 332 | string containing the comment string. Returns an element instance |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 333 | representing a comment. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 334 | |
| 335 | |
| 336 | .. function:: dump(elem) |
| 337 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 338 | Writes an element tree or element structure to sys.stdout. This function |
| 339 | should be used for debugging only. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 340 | |
| 341 | The exact output format is implementation dependent. In this version, it's |
| 342 | written as an ordinary XML file. |
| 343 | |
| 344 | *elem* is an element tree or an individual element. |
| 345 | |
| 346 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 347 | .. function:: fromstring(text) |
| 348 | |
Florent Xicluna | dddd5e9 | 2010-03-14 01:28:07 +0000 | [diff] [blame] | 349 | Parses an XML section from a string constant. Same as :func:`XML`. *text* |
| 350 | is a string containing XML data. Returns an :class:`Element` instance. |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 351 | |
| 352 | |
| 353 | .. function:: fromstringlist(sequence, parser=None) |
| 354 | |
| 355 | Parses an XML document from a sequence of string fragments. *sequence* is a |
| 356 | list or other sequence containing XML data fragments. *parser* is an |
| 357 | optional parser instance. If not given, the standard :class:`XMLParser` |
| 358 | parser is used. Returns an :class:`Element` instance. |
| 359 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 360 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 361 | |
| 362 | |
| 363 | .. function:: iselement(element) |
| 364 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 365 | Checks if an object appears to be a valid element object. *element* is an |
| 366 | element instance. Returns a true value if this is an element object. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 367 | |
| 368 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 369 | .. function:: iterparse(source, events=None, parser=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 370 | |
| 371 | Parses an XML section into an element tree incrementally, and reports what's |
Eli Bendersky | 604c4ff | 2012-03-16 08:41:30 +0200 | [diff] [blame] | 372 | going on to the user. *source* is a filename or :term:`file object` |
| 373 | containing XML data. *events* is a list of events to report back. The |
| 374 | supported events are the strings ``"start"``, ``"end"``, ``"start-ns"`` |
| 375 | and ``"end-ns"`` (the "ns" events are used to get detailed namespace |
| 376 | information). If *events* is omitted, only ``"end"`` events are reported. |
| 377 | *parser* is an optional parser instance. If not given, the standard |
| 378 | :class:`XMLParser` parser is used. Returns an :term:`iterator` providing |
| 379 | ``(event, elem)`` pairs. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 380 | |
Benjamin Peterson | 75edad0 | 2009-01-01 15:05:06 +0000 | [diff] [blame] | 381 | .. note:: |
| 382 | |
| 383 | :func:`iterparse` only guarantees that it has seen the ">" |
| 384 | character of a starting tag when it emits a "start" event, so the |
| 385 | attributes are defined, but the contents of the text and tail attributes |
| 386 | are undefined at that point. The same applies to the element children; |
| 387 | they may or may not be present. |
| 388 | |
| 389 | If you need a fully populated element, look for "end" events instead. |
| 390 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 391 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 392 | .. function:: parse(source, parser=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 393 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 394 | Parses an XML section into an element tree. *source* is a filename or file |
| 395 | object containing XML data. *parser* is an optional parser instance. If |
| 396 | not given, the standard :class:`XMLParser` parser is used. Returns an |
| 397 | :class:`ElementTree` instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 398 | |
| 399 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 400 | .. function:: ProcessingInstruction(target, text=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 401 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 402 | PI element factory. This factory function creates a special element that |
| 403 | will be serialized as an XML processing instruction. *target* is a string |
| 404 | containing the PI target. *text* is a string containing the PI contents, if |
| 405 | given. Returns an element instance, representing a processing instruction. |
| 406 | |
| 407 | |
| 408 | .. function:: register_namespace(prefix, uri) |
| 409 | |
| 410 | Registers a namespace prefix. The registry is global, and any existing |
| 411 | mapping for either the given prefix or the namespace URI will be removed. |
| 412 | *prefix* is a namespace prefix. *uri* is a namespace uri. Tags and |
| 413 | attributes in this namespace will be serialized with the given prefix, if at |
| 414 | all possible. |
| 415 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 416 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 417 | |
| 418 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 419 | .. function:: SubElement(parent, tag, attrib={}, **extra) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 420 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 421 | Subelement factory. This function creates an element instance, and appends |
| 422 | it to an existing element. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 423 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 424 | The element name, attribute names, and attribute values can be either |
| 425 | bytestrings or Unicode strings. *parent* is the parent element. *tag* is |
| 426 | the subelement name. *attrib* is an optional dictionary, containing element |
| 427 | attributes. *extra* contains additional attributes, given as keyword |
| 428 | arguments. Returns an element instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 429 | |
| 430 | |
Eli Bendersky | e9af827 | 2013-01-13 06:27:51 -0800 | [diff] [blame^] | 431 | .. function:: tostring(element, encoding="us-ascii", method="xml", *,\ |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 432 | short_empty_elements=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 433 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 434 | Generates a string representation of an XML element, including all |
Florent Xicluna | dddd5e9 | 2010-03-14 01:28:07 +0000 | [diff] [blame] | 435 | subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is |
Florent Xicluna | c17f172 | 2010-08-08 19:48:29 +0000 | [diff] [blame] | 436 | the output encoding (default is US-ASCII). Use ``encoding="unicode"`` to |
Eli Bendersky | 831893a | 2012-10-09 07:18:16 -0700 | [diff] [blame] | 437 | generate a Unicode string (otherwise, a bytestring is generated). *method* |
| 438 | is either ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 439 | *short_empty_elements* has the same meaning as in :meth:`ElementTree.write`. |
Eli Bendersky | 831893a | 2012-10-09 07:18:16 -0700 | [diff] [blame] | 440 | Returns an (optionally) encoded string containing the XML data. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 441 | |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 442 | .. versionadded:: 3.4 |
| 443 | The *short_empty_elements* parameter. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 444 | |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 445 | |
Eli Bendersky | e9af827 | 2013-01-13 06:27:51 -0800 | [diff] [blame^] | 446 | .. function:: tostringlist(element, encoding="us-ascii", method="xml", *,\ |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 447 | short_empty_elements=True) |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 448 | |
| 449 | Generates a string representation of an XML element, including all |
Florent Xicluna | dddd5e9 | 2010-03-14 01:28:07 +0000 | [diff] [blame] | 450 | subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is |
Florent Xicluna | c17f172 | 2010-08-08 19:48:29 +0000 | [diff] [blame] | 451 | the output encoding (default is US-ASCII). Use ``encoding="unicode"`` to |
Eli Bendersky | 831893a | 2012-10-09 07:18:16 -0700 | [diff] [blame] | 452 | generate a Unicode string (otherwise, a bytestring is generated). *method* |
| 453 | is either ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 454 | *short_empty_elements* has the same meaning as in :meth:`ElementTree.write`. |
Eli Bendersky | 831893a | 2012-10-09 07:18:16 -0700 | [diff] [blame] | 455 | Returns a list of (optionally) encoded strings containing the XML data. |
| 456 | It does not guarantee any specific sequence, except that |
| 457 | ``"".join(tostringlist(element)) == tostring(element)``. |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 458 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 459 | .. versionadded:: 3.2 |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 460 | |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 461 | .. versionadded:: 3.4 |
| 462 | The *short_empty_elements* parameter. |
| 463 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 464 | |
| 465 | .. function:: XML(text, parser=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 466 | |
| 467 | Parses an XML section from a string constant. This function can be used to |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 468 | embed "XML literals" in Python code. *text* is a string containing XML |
| 469 | data. *parser* is an optional parser instance. If not given, the standard |
| 470 | :class:`XMLParser` parser is used. Returns an :class:`Element` instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 471 | |
| 472 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 473 | .. function:: XMLID(text, parser=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 474 | |
| 475 | Parses an XML section from a string constant, and also returns a dictionary |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 476 | which maps from element id:s to elements. *text* is a string containing XML |
| 477 | data. *parser* is an optional parser instance. If not given, the standard |
| 478 | :class:`XMLParser` parser is used. Returns a tuple containing an |
| 479 | :class:`Element` instance and a dictionary. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 480 | |
| 481 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 482 | .. _elementtree-element-objects: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 483 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 484 | Element Objects |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 485 | ^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 486 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 487 | .. class:: Element(tag, attrib={}, **extra) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 488 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 489 | Element class. This class defines the Element interface, and provides a |
| 490 | reference implementation of this interface. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 491 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 492 | The element name, attribute names, and attribute values can be either |
| 493 | bytestrings or Unicode strings. *tag* is the element name. *attrib* is |
| 494 | an optional dictionary, containing element attributes. *extra* contains |
| 495 | additional attributes, given as keyword arguments. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 496 | |
| 497 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 498 | .. attribute:: tag |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 499 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 500 | A string identifying what kind of data this element represents (the |
| 501 | element type, in other words). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 502 | |
| 503 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 504 | .. attribute:: text |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 505 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 506 | The *text* attribute can be used to hold additional data associated with |
| 507 | the element. As the name implies this attribute is usually a string but |
| 508 | may be any application-specific object. If the element is created from |
| 509 | an XML file the attribute will contain any text found between the element |
| 510 | tags. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 511 | |
| 512 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 513 | .. attribute:: tail |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 514 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 515 | The *tail* attribute can be used to hold additional data associated with |
| 516 | the element. This attribute is usually a string but may be any |
| 517 | application-specific object. If the element is created from an XML file |
| 518 | the attribute will contain any text found after the element's end tag and |
| 519 | before the next tag. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 520 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 521 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 522 | .. attribute:: attrib |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 523 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 524 | A dictionary containing the element's attributes. Note that while the |
| 525 | *attrib* value is always a real mutable Python dictionary, an ElementTree |
| 526 | implementation may choose to use another internal representation, and |
| 527 | create the dictionary only if someone asks for it. To take advantage of |
| 528 | such implementations, use the dictionary methods below whenever possible. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 529 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 530 | The following dictionary-like methods work on the element attributes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 531 | |
| 532 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 533 | .. method:: clear() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 534 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 535 | Resets an element. This function removes all subelements, clears all |
Eli Bendersky | 323a43a | 2012-10-09 06:46:33 -0700 | [diff] [blame] | 536 | attributes, and sets the text and tail attributes to ``None``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 537 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 538 | |
| 539 | .. method:: get(key, default=None) |
| 540 | |
| 541 | Gets the element attribute named *key*. |
| 542 | |
| 543 | Returns the attribute value, or *default* if the attribute was not found. |
| 544 | |
| 545 | |
| 546 | .. method:: items() |
| 547 | |
| 548 | Returns the element attributes as a sequence of (name, value) pairs. The |
| 549 | attributes are returned in an arbitrary order. |
| 550 | |
| 551 | |
| 552 | .. method:: keys() |
| 553 | |
| 554 | Returns the elements attribute names as a list. The names are returned |
| 555 | in an arbitrary order. |
| 556 | |
| 557 | |
| 558 | .. method:: set(key, value) |
| 559 | |
| 560 | Set the attribute *key* on the element to *value*. |
| 561 | |
| 562 | The following methods work on the element's children (subelements). |
| 563 | |
| 564 | |
| 565 | .. method:: append(subelement) |
| 566 | |
Eli Bendersky | 396e8fc | 2012-03-23 14:24:20 +0200 | [diff] [blame] | 567 | Adds the element *subelement* to the end of this element's internal list |
| 568 | of subelements. Raises :exc:`TypeError` if *subelement* is not an |
| 569 | :class:`Element`. |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 570 | |
| 571 | |
| 572 | .. method:: extend(subelements) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 573 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 574 | Appends *subelements* from a sequence object with zero or more elements. |
Eli Bendersky | 396e8fc | 2012-03-23 14:24:20 +0200 | [diff] [blame] | 575 | Raises :exc:`TypeError` if a subelement is not an :class:`Element`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 576 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 577 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 578 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 579 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 580 | .. method:: find(match, namespaces=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 581 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 582 | Finds the first subelement matching *match*. *match* may be a tag name |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 583 | or a :ref:`path <elementtree-xpath>`. Returns an element instance |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 584 | or ``None``. *namespaces* is an optional mapping from namespace prefix |
| 585 | to full name. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 586 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 587 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 588 | .. method:: findall(match, namespaces=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 589 | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 590 | Finds all matching subelements, by tag name or |
| 591 | :ref:`path <elementtree-xpath>`. Returns a list containing all matching |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 592 | elements in document order. *namespaces* is an optional mapping from |
| 593 | namespace prefix to full name. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 594 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 595 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 596 | .. method:: findtext(match, default=None, namespaces=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 597 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 598 | Finds text for the first subelement matching *match*. *match* may be |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 599 | a tag name or a :ref:`path <elementtree-xpath>`. Returns the text content |
| 600 | of the first matching element, or *default* if no element was found. |
| 601 | Note that if the matching element has no text content an empty string |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 602 | is returned. *namespaces* is an optional mapping from namespace prefix |
| 603 | to full name. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 604 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 605 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 606 | .. method:: getchildren() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 607 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 608 | .. deprecated:: 3.2 |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 609 | Use ``list(elem)`` or iteration. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 610 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 611 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 612 | .. method:: getiterator(tag=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 613 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 614 | .. deprecated:: 3.2 |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 615 | Use method :meth:`Element.iter` instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 616 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 617 | |
Eli Bendersky | 396e8fc | 2012-03-23 14:24:20 +0200 | [diff] [blame] | 618 | .. method:: insert(index, subelement) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 619 | |
Eli Bendersky | 396e8fc | 2012-03-23 14:24:20 +0200 | [diff] [blame] | 620 | Inserts *subelement* at the given position in this element. Raises |
| 621 | :exc:`TypeError` if *subelement* is not an :class:`Element`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 622 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 623 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 624 | .. method:: iter(tag=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 625 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 626 | Creates a tree :term:`iterator` with the current element as the root. |
| 627 | The iterator iterates over this element and all elements below it, in |
| 628 | document (depth first) order. If *tag* is not ``None`` or ``'*'``, only |
| 629 | elements whose tag equals *tag* are returned from the iterator. If the |
| 630 | tree structure is modified during iteration, the result is undefined. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 631 | |
Ezio Melotti | 138fc89 | 2011-10-10 00:02:03 +0300 | [diff] [blame] | 632 | .. versionadded:: 3.2 |
| 633 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 634 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 635 | .. method:: iterfind(match, namespaces=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 636 | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 637 | Finds all matching subelements, by tag name or |
| 638 | :ref:`path <elementtree-xpath>`. Returns an iterable yielding all |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 639 | matching elements in document order. *namespaces* is an optional mapping |
| 640 | from namespace prefix to full name. |
| 641 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 642 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 643 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 644 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 645 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 646 | .. method:: itertext() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 647 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 648 | Creates a text iterator. The iterator loops over this element and all |
| 649 | subelements, in document order, and returns all inner text. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 650 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 651 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 652 | |
| 653 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 654 | .. method:: makeelement(tag, attrib) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 655 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 656 | Creates a new element object of the same type as this element. Do not |
| 657 | call this method, use the :func:`SubElement` factory function instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 658 | |
| 659 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 660 | .. method:: remove(subelement) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 661 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 662 | Removes *subelement* from the element. Unlike the find\* methods this |
| 663 | method compares elements based on the instance identity, not on tag value |
| 664 | or contents. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 665 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 666 | :class:`Element` objects also support the following sequence type methods |
| 667 | for working with subelements: :meth:`__delitem__`, :meth:`__getitem__`, |
| 668 | :meth:`__setitem__`, :meth:`__len__`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 669 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 670 | Caution: Elements with no subelements will test as ``False``. This behavior |
| 671 | will change in future versions. Use specific ``len(elem)`` or ``elem is |
| 672 | None`` test instead. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 673 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 674 | element = root.find('foo') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 675 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 676 | if not element: # careful! |
| 677 | print("element not found, or element has no subelements") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 678 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 679 | if element is None: |
| 680 | print("element not found") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 681 | |
| 682 | |
| 683 | .. _elementtree-elementtree-objects: |
| 684 | |
| 685 | ElementTree Objects |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 686 | ^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 687 | |
| 688 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 689 | .. class:: ElementTree(element=None, file=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 690 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 691 | ElementTree wrapper class. This class represents an entire element |
| 692 | hierarchy, and adds some extra support for serialization to and from |
| 693 | standard XML. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 694 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 695 | *element* is the root element. The tree is initialized with the contents |
| 696 | of the XML *file* if given. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 697 | |
| 698 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 699 | .. method:: _setroot(element) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 700 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 701 | Replaces the root element for this tree. This discards the current |
| 702 | contents of the tree, and replaces it with the given element. Use with |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 703 | care. *element* is an element instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 704 | |
| 705 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 706 | .. method:: find(match, namespaces=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 707 | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 708 | Same as :meth:`Element.find`, starting at the root of the tree. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 709 | |
| 710 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 711 | .. method:: findall(match, namespaces=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 712 | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 713 | Same as :meth:`Element.findall`, starting at the root of the tree. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 714 | |
| 715 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 716 | .. method:: findtext(match, default=None, namespaces=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 717 | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 718 | Same as :meth:`Element.findtext`, starting at the root of the tree. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 719 | |
| 720 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 721 | .. method:: getiterator(tag=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 722 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 723 | .. deprecated:: 3.2 |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 724 | Use method :meth:`ElementTree.iter` instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 725 | |
| 726 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 727 | .. method:: getroot() |
Florent Xicluna | c17f172 | 2010-08-08 19:48:29 +0000 | [diff] [blame] | 728 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 729 | Returns the root element for this tree. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 730 | |
| 731 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 732 | .. method:: iter(tag=None) |
| 733 | |
| 734 | Creates and returns a tree iterator for the root element. The iterator |
| 735 | loops over all elements in this tree, in section order. *tag* is the tag |
| 736 | to look for (default is to return all elements) |
| 737 | |
| 738 | |
Eli Bendersky | 737b173 | 2012-05-29 06:02:56 +0300 | [diff] [blame] | 739 | .. method:: iterfind(match, namespaces=None) |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 740 | |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 741 | Same as :meth:`Element.iterfind`, starting at the root of the tree. |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 742 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 743 | .. versionadded:: 3.2 |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 744 | |
| 745 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 746 | .. method:: parse(source, parser=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 747 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 748 | Loads an external XML section into this element tree. *source* is a file |
Antoine Pitrou | 11cb961 | 2010-09-15 11:11:28 +0000 | [diff] [blame] | 749 | name or :term:`file object`. *parser* is an optional parser instance. |
Eli Bendersky | 52467b1 | 2012-06-01 07:13:08 +0300 | [diff] [blame] | 750 | If not given, the standard :class:`XMLParser` parser is used. Returns the |
| 751 | section root element. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 752 | |
| 753 | |
Eli Bendersky | e9af827 | 2013-01-13 06:27:51 -0800 | [diff] [blame^] | 754 | .. method:: write(file, encoding="us-ascii", xml_declaration=None,\ |
| 755 | default_namespace=None, method="xml", *,\ |
| 756 | short_empty_elements=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 757 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 758 | Writes the element tree to a file, as XML. *file* is a file name, or a |
Eli Bendersky | f96cf91 | 2012-07-15 06:19:44 +0300 | [diff] [blame] | 759 | :term:`file object` opened for writing. *encoding* [1]_ is the output |
| 760 | encoding (default is US-ASCII). |
| 761 | *xml_declaration* controls if an XML declaration should be added to the |
| 762 | file. Use ``False`` for never, ``True`` for always, ``None`` |
| 763 | for only if not US-ASCII or UTF-8 or Unicode (default is ``None``). |
| 764 | *method* is either ``"xml"``, ``"html"`` or ``"text"`` (default is |
Eli Bendersky | e9af827 | 2013-01-13 06:27:51 -0800 | [diff] [blame^] | 765 | ``"xml"``). *default_namespace* sets the default XML namespace (for |
| 766 | "xmlns"). |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 767 | The keyword-only *short_empty_elements* parameter controls the formatting |
| 768 | of elements that contain no content. If *True* (the default), they are |
| 769 | emitted as a single self-closed tag, otherwise they are emitted as a pair |
| 770 | of start/end tags. |
Eli Bendersky | f96cf91 | 2012-07-15 06:19:44 +0300 | [diff] [blame] | 771 | |
| 772 | The output is either a string (:class:`str`) or binary (:class:`bytes`). |
| 773 | This is controlled by the *encoding* argument. If *encoding* is |
| 774 | ``"unicode"``, the output is a string; otherwise, it's binary. Note that |
| 775 | this may conflict with the type of *file* if it's an open |
| 776 | :term:`file object`; make sure you do not try to write a string to a |
| 777 | binary stream and vice versa. |
| 778 | |
Eli Bendersky | a9a2ef5 | 2013-01-13 06:04:43 -0800 | [diff] [blame] | 779 | .. versionadded:: 3.4 |
| 780 | The *short_empty_elements* parameter. |
| 781 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 782 | |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 783 | This is the XML file that is going to be manipulated:: |
| 784 | |
| 785 | <html> |
| 786 | <head> |
| 787 | <title>Example page</title> |
| 788 | </head> |
| 789 | <body> |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 790 | <p>Moved to <a href="http://example.org/">example.org</a> |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 791 | or <a href="http://example.com/">example.com</a>.</p> |
| 792 | </body> |
| 793 | </html> |
| 794 | |
| 795 | Example of changing the attribute "target" of every link in first paragraph:: |
| 796 | |
| 797 | >>> from xml.etree.ElementTree import ElementTree |
| 798 | >>> tree = ElementTree() |
| 799 | >>> tree.parse("index.xhtml") |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 800 | <Element 'html' at 0xb77e6fac> |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 801 | >>> p = tree.find("body/p") # Finds first occurrence of tag p in body |
| 802 | >>> p |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 803 | <Element 'p' at 0xb77ec26c> |
| 804 | >>> links = list(p.iter("a")) # Returns list of all links |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 805 | >>> links |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 806 | [<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>] |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 807 | >>> for i in links: # Iterates through all found links |
| 808 | ... i.attrib["target"] = "blank" |
| 809 | >>> tree.write("output.xhtml") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 810 | |
| 811 | .. _elementtree-qname-objects: |
| 812 | |
| 813 | QName Objects |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 814 | ^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 815 | |
| 816 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 817 | .. class:: QName(text_or_uri, tag=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 818 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 819 | QName wrapper. This can be used to wrap a QName attribute value, in order |
| 820 | to get proper namespace handling on output. *text_or_uri* is a string |
| 821 | containing the QName value, in the form {uri}local, or, if the tag argument |
| 822 | is given, the URI part of a QName. If *tag* is given, the first argument is |
| 823 | interpreted as an URI, and this argument is interpreted as a local name. |
| 824 | :class:`QName` instances are opaque. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 825 | |
| 826 | |
| 827 | .. _elementtree-treebuilder-objects: |
| 828 | |
| 829 | TreeBuilder Objects |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 830 | ^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 831 | |
| 832 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 833 | .. class:: TreeBuilder(element_factory=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 834 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 835 | Generic element structure builder. This builder converts a sequence of |
| 836 | start, data, and end method calls to a well-formed element structure. You |
| 837 | can use this class to build an element structure using a custom XML parser, |
Eli Bendersky | 48d358b | 2012-05-30 17:57:50 +0300 | [diff] [blame] | 838 | or a parser for some other XML-like format. *element_factory*, when given, |
| 839 | must be a callable accepting two positional arguments: a tag and |
| 840 | a dict of attributes. It is expected to return a new element instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 841 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 842 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 843 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 844 | Flushes the builder buffers, and returns the toplevel document |
| 845 | element. Returns an :class:`Element` instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 846 | |
| 847 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 848 | .. method:: data(data) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 849 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 850 | Adds text to the current element. *data* is a string. This should be |
| 851 | either a bytestring, or a Unicode string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 852 | |
| 853 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 854 | .. method:: end(tag) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 855 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 856 | Closes the current element. *tag* is the element name. Returns the |
| 857 | closed element. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 858 | |
| 859 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 860 | .. method:: start(tag, attrs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 861 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 862 | Opens a new element. *tag* is the element name. *attrs* is a dictionary |
| 863 | containing element attributes. Returns the opened element. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 864 | |
| 865 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 866 | In addition, a custom :class:`TreeBuilder` object can provide the |
| 867 | following method: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 868 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 869 | .. method:: doctype(name, pubid, system) |
| 870 | |
| 871 | Handles a doctype declaration. *name* is the doctype name. *pubid* is |
| 872 | the public identifier. *system* is the system identifier. This method |
| 873 | does not exist on the default :class:`TreeBuilder` class. |
| 874 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 875 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 876 | |
| 877 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 878 | .. _elementtree-xmlparser-objects: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 879 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 880 | XMLParser Objects |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 881 | ^^^^^^^^^^^^^^^^^ |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 882 | |
| 883 | |
| 884 | .. class:: XMLParser(html=0, target=None, encoding=None) |
| 885 | |
| 886 | :class:`Element` structure builder for XML source data, based on the expat |
| 887 | parser. *html* are predefined HTML entities. This flag is not supported by |
| 888 | the current implementation. *target* is the target object. If omitted, the |
Eli Bendersky | 1bf2394 | 2012-06-01 07:15:00 +0300 | [diff] [blame] | 889 | builder uses an instance of the standard :class:`TreeBuilder` class. |
Eli Bendersky | 52467b1 | 2012-06-01 07:13:08 +0300 | [diff] [blame] | 890 | *encoding* [1]_ is optional. If given, the value overrides the encoding |
| 891 | specified in the XML file. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 892 | |
| 893 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 894 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 895 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 896 | Finishes feeding data to the parser. Returns an element structure. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 897 | |
| 898 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 899 | .. method:: doctype(name, pubid, system) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 900 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 901 | .. deprecated:: 3.2 |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 902 | Define the :meth:`TreeBuilder.doctype` method on a custom TreeBuilder |
| 903 | target. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 904 | |
| 905 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 906 | .. method:: feed(data) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 907 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 908 | Feeds data to the parser. *data* is encoded data. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 909 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 910 | :meth:`XMLParser.feed` calls *target*\'s :meth:`start` method |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 911 | for each opening tag, its :meth:`end` method for each closing tag, |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 912 | and data is processed by method :meth:`data`. :meth:`XMLParser.close` |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 913 | calls *target*\'s method :meth:`close`. |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 914 | :class:`XMLParser` can be used not only for building a tree structure. |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 915 | This is an example of counting the maximum depth of an XML file:: |
| 916 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 917 | >>> from xml.etree.ElementTree import XMLParser |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 918 | >>> class MaxDepth: # The target object of the parser |
| 919 | ... maxDepth = 0 |
| 920 | ... depth = 0 |
| 921 | ... def start(self, tag, attrib): # Called for each opening tag. |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 922 | ... self.depth += 1 |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 923 | ... if self.depth > self.maxDepth: |
| 924 | ... self.maxDepth = self.depth |
| 925 | ... def end(self, tag): # Called for each closing tag. |
| 926 | ... self.depth -= 1 |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 927 | ... def data(self, data): |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 928 | ... pass # We do not need to do anything with data. |
| 929 | ... def close(self): # Called when all data has been parsed. |
| 930 | ... return self.maxDepth |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 931 | ... |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 932 | >>> target = MaxDepth() |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 933 | >>> parser = XMLParser(target=target) |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 934 | >>> exampleXml = """ |
| 935 | ... <a> |
| 936 | ... <b> |
| 937 | ... </b> |
| 938 | ... <b> |
| 939 | ... <c> |
| 940 | ... <d> |
| 941 | ... </d> |
| 942 | ... </c> |
| 943 | ... </b> |
| 944 | ... </a>""" |
| 945 | >>> parser.feed(exampleXml) |
| 946 | >>> parser.close() |
| 947 | 4 |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 948 | |
Eli Bendersky | 5b77d81 | 2012-03-16 08:20:05 +0200 | [diff] [blame] | 949 | Exceptions |
Eli Bendersky | 3a4875e | 2012-03-26 20:43:32 +0200 | [diff] [blame] | 950 | ^^^^^^^^^^ |
Eli Bendersky | 5b77d81 | 2012-03-16 08:20:05 +0200 | [diff] [blame] | 951 | |
| 952 | .. class:: ParseError |
| 953 | |
| 954 | XML parse error, raised by the various parsing methods in this module when |
| 955 | parsing fails. The string representation of an instance of this exception |
| 956 | will contain a user-friendly error message. In addition, it will have |
| 957 | the following attributes available: |
| 958 | |
| 959 | .. attribute:: code |
| 960 | |
| 961 | A numeric error code from the expat parser. See the documentation of |
| 962 | :mod:`xml.parsers.expat` for the list of error codes and their meanings. |
| 963 | |
| 964 | .. attribute:: position |
| 965 | |
| 966 | A tuple of *line*, *column* numbers, specifying where the error occurred. |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 967 | |
| 968 | .. rubric:: Footnotes |
| 969 | |
| 970 | .. [#] The encoding string included in XML output should conform to the |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 971 | appropriate standards. For example, "UTF-8" is valid, but "UTF8" is |
| 972 | not. See http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl |
Benjamin Peterson | ad3d5c2 | 2009-02-26 03:38:59 +0000 | [diff] [blame] | 973 | and http://www.iana.org/assignments/character-sets. |