cpython-lru_cache-weakref: Lib/xml/etree/ElementTree.py annotate

annotate Lib/xml/etree/ElementTree.py @ 79691:05c8928362ee

Merge __next__ method link fixes with 3.3.

author	Ezio Melotti <ezio.melotti@gmail.com>
date	Fri, 12 Oct 2012 13:46:37 +0300
parents	a8c044188731
children	58168d69b496

rev	line source
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	2 # ElementTree
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	3 # $Id: ElementTree.py 3440 2008-07-18 14:45:01Z fredrik $
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	4 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	5 # light-weight XML support for Python 2.3 and later.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	6 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	7 # history (since 1.2.6):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	8 # 2005-11-12 fl added tostringlist/fromstringlist helpers
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	9 # 2006-07-05 fl merged in selected changes from the 1.3 sandbox
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	10 # 2006-07-05 fl removed support for 2.1 and earlier
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	11 # 2007-06-21 fl added deprecation/future warnings
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	12 # 2007-08-25 fl added doctype hook, added parser version attribute etc
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	13 # 2007-08-26 fl added new serializer code (better namespace handling, etc)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	14 # 2007-08-27 fl warn for broken /tag searches on tree level
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	15 # 2007-09-02 fl added html/text methods to serializer (experimental)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	16 # 2007-09-05 fl added method argument to tostring/tostringlist
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	17 # 2007-09-06 fl improved error handling
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	18 # 2007-09-13 fl added itertext, iterfind; assorted cleanups
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	19 # 2007-12-15 fl added C14N hooks, copy method (experimental)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	20 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	21 # Copyright (c) 1999-2008 by Fredrik Lundh. All rights reserved.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	22 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	23 # fredrik@pythonware.com
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	24 # http://www.pythonware.com
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	25 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	26 # --------------------------------------------------------------------
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	27 # The ElementTree toolkit is
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	28 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	29 # Copyright (c) 1999-2008 by Fredrik Lundh
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	30 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	31 # By obtaining, using, and/or copying this software and/or its
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	32 # associated documentation, you agree that you have read, understood,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	33 # and will comply with the following terms and conditions:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	34 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	35 # Permission to use, copy, modify, and distribute this software and
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	36 # its associated documentation for any purpose and without fee is
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	37 # hereby granted, provided that the above copyright notice appears in
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	38 # all copies, and that both that copyright notice and this permission
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	39 # notice appear in supporting documentation, and that the name of
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	40 # Secret Labs AB or the author not be used in advertising or publicity
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	41 # pertaining to distribution of the software without specific, written
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	42 # prior permission.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	43 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	44 # SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	45 # TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	46 # ABILITY AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	47 # BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	48 # DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	49 # WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	50 # ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	51 # OF THIS SOFTWARE.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	52 # --------------------------------------------------------------------
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	53
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	54 # Licensed to PSF under a Contributor Agreement.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	55 # See http://www.python.org/psf/license for licensing details.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	56
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	57 __all__ = [
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	58 # public symbols
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	59 "Comment",
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	60 "dump",
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	61 "Element", "ElementTree",
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	62 "fromstring", "fromstringlist",
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	63 "iselement", "iterparse",
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	64 "parse", "ParseError",
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	65 "PI", "ProcessingInstruction",
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	66 "QName",
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	67 "SubElement",
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	68 "tostring", "tostringlist",
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	69 "TreeBuilder",
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	70 "VERSION",
74903 65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	71 "XML", "XMLID",
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	72 "XMLParser", "XMLTreeBuilder",
74903 65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	73 "register_namespace",
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	74 ]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	75
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	76 VERSION = "1.3.0"
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	77
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	78 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	79 # The <b>Element</b> type is a flexible container object, designed to
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	80 # store hierarchical data structures in memory. The type can be
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	81 # described as a cross between a list and a dictionary.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	82 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	83 # Each element has a number of properties associated with it:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	84 # <ul>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	85 # <li>a <i>tag</i>. This is a string identifying what kind of data
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	86 # this element represents (the element type, in other words).</li>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	87 # <li>a number of <i>attributes</i>, stored in a Python dictionary.</li>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	88 # <li>a <i>text</i> string.</li>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	89 # <li>an optional <i>tail</i> string.</li>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	90 # <li>a number of <i>child elements</i>, stored in a Python sequence</li>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	91 # </ul>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	92 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	93 # To create an element instance, use the {@link #Element} constructor
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	94 # or the {@link #SubElement} factory function.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	95 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	96 # The {@link #ElementTree} class can be used to wrap an element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	97 # structure, and convert it from and to XML.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	98 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	99
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	100 import sys
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	101 import re
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	102 import warnings
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	103 import io
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	104 import contextlib
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	105
77434 ea0dc4338987 Removed _SimpleElementPath and its flaky test. The test monkey-patches the module, which causes other failures and fails itself depending on the order tests are run. Eli Bendersky <eliben@gmail.com> parents: 77431 diff changeset	106 from . import ElementPath
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	107
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	108
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	109 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	110 # Parser error. This is a subclass of <b>SyntaxError</b>.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	111 # <p>
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	112 # In addition to the exception value, an exception instance contains a
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	113 # specific exception code in the <b>code</b> attribute, and the line and
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	114 # column of the error in the <b>position</b> attribute.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	115
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	116 class ParseError(SyntaxError):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	117 pass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	118
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	119 # --------------------------------------------------------------------
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	120
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	121 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	122 # Checks if an object appears to be a valid element object.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	123 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	124 # @param An element instance.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	125 # @return A true value if this is an element object.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	126 # @defreturn flag
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	127
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	128 def iselement(element):
74903 65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	129 # FIXME: not sure about this;
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	130 # isinstance(element, Element) or look for tag/attrib/text attributes
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	131 return hasattr(element, 'tag')
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	132
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	133 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	134 # Element class. This class defines the Element interface, and
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	135 # provides a reference implementation of this interface.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	136 # <p>
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	137 # The element name, attribute names, and attribute values can be
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	138 # either ASCII strings (ordinary Python strings containing only 7-bit
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	139 # ASCII characters) or Unicode strings.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	140 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	141 # @param tag The element name.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	142 # @param attrib An optional dictionary, containing element attributes.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	143 # @param **extra Additional attributes, given as keyword arguments.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	144 # @see Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	145 # @see SubElement
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	146 # @see Comment
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	147 # @see ProcessingInstruction
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	148
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	149 class Element:
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	150 # <tag attrib>text<child/>...</tag>tail
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	151
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	152 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	153 # (Attribute) Element tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	154
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	155 tag = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	156
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	157 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	158 # (Attribute) Element attribute dictionary. Where possible, use
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	159 # {@link #Element.get},
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	160 # {@link #Element.set},
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	161 # {@link #Element.keys}, and
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	162 # {@link #Element.items} to access
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	163 # element attributes.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	164
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	165 attrib = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	166
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	167 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	168 # (Attribute) Text before first subelement. This is either a
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	169 # string or the value None. Note that if there was no text, this
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	170 # attribute may be either None or an empty string, depending on
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	171 # the parser.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	172
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	173 text = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	174
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	175 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	176 # (Attribute) Text after this element's end tag, but before the
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	177 # next sibling element's start tag. This is either a string or
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	178 # the value None. Note that if there was no text, this attribute
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	179 # may be either None or an empty string, depending on the parser.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	180
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	181 tail = None # text after end tag, if any
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	182
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	183 # constructor
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	184
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	185 def __init__(self, tag, attrib={}, **extra):
77217 7d252dbfbee3 Issue 14814: Add namespaces keyword arg to find() methods in _elementtree. Eli Bendersky <eliben@gmail.com>* parents: 75894 diff changeset	186 if not isinstance(attrib, dict):
7d252dbfbee3 Issue 14814: Add namespaces keyword arg to find() methods in _elementtree. Eli Bendersky <eliben@gmail.com>* parents: 75894 diff changeset	187 raise TypeError("attrib must be dict, not %s" % (
7d252dbfbee3 Issue 14814: Add namespaces keyword arg to find() methods in _elementtree. Eli Bendersky <eliben@gmail.com>* parents: 75894 diff changeset	188 attrib.__class__.__name__,))
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	189 attrib = attrib.copy()
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	190 attrib.update(extra)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	191 self.tag = tag
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	192 self.attrib = attrib
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	193 self._children = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	194
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	195 def __repr__(self):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	196 return "<Element %s at 0x%x>" % (repr(self.tag), id(self))
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	197
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	198 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	199 # Creates a new element object of the same type as this element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	200 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	201 # @param tag Element tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	202 # @param attrib Element attributes, given as a dictionary.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	203 # @return A new element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	204
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	205 def makeelement(self, tag, attrib):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	206 return self.__class__(tag, attrib)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	207
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	208 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	209 # (Experimental) Copies the current element. This creates a
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	210 # shallow copy; subelements will be shared with the original tree.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	211 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	212 # @return A new element instance.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	213
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	214 def copy(self):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	215 elem = self.makeelement(self.tag, self.attrib)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	216 elem.text = self.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	217 elem.tail = self.tail
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	218 elem[:] = self
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	219 return elem
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	220
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	221 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	222 # Returns the number of subelements. Note that this only counts
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	223 # full elements; to check if there's any content in an element, you
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	224 # have to check both the length and the <b>text</b> attribute.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	225 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	226 # @return The number of subelements.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	227
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	228 def __len__(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	229 return len(self._children)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	230
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	231 def __bool__(self):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	232 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	233 "The behavior of this method will change in future versions. "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	234 "Use specific 'len(elem)' or 'elem is not None' test instead.",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	235 FutureWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	236 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	237 return len(self._children) != 0 # emulate old behaviour, for now
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	238
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	239 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	240 # Returns the given subelement, by index.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	241 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	242 # @param index What subelement to return.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	243 # @return The given subelement.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	244 # @exception IndexError If the given element does not exist.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	245
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	246 def __getitem__(self, index):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	247 return self._children[index]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	248
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	249 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	250 # Replaces the given subelement, by index.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	251 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	252 # @param index What subelement to replace.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	253 # @param element The new element value.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	254 # @exception IndexError If the given element does not exist.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	255
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	256 def __setitem__(self, index, element):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	257 # if isinstance(index, slice):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	258 # for elt in element:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	259 # assert iselement(elt)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	260 # else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	261 # assert iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	262 self._children[index] = element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	263
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	264 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	265 # Deletes the given subelement, by index.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	266 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	267 # @param index What subelement to delete.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	268 # @exception IndexError If the given element does not exist.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	269
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	270 def __delitem__(self, index):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	271 del self._children[index]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	272
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	273 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	274 # Adds a subelement to the end of this element. In document order,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	275 # the new element will appear after the last existing subelement (or
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	276 # directly after the text, if it's the first subelement), but before
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	277 # the end tag for this element.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	278 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	279 # @param element The element to add.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	280
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	281 def append(self, element):
75894 75268a773455 Issue #13782: streamline argument type-checking in ET.Element Eli Bendersky <eliben@gmail.com> parents: 75416 diff changeset	282 self._assert_is_element(element)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	283 self._children.append(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	284
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	285 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	286 # Appends subelements from a sequence.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	287 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	288 # @param elements A sequence object with zero or more elements.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	289 # @since 1.3
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	290
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	291 def extend(self, elements):
75894 75268a773455 Issue #13782: streamline argument type-checking in ET.Element Eli Bendersky <eliben@gmail.com> parents: 75416 diff changeset	292 for element in elements:
75268a773455 Issue #13782: streamline argument type-checking in ET.Element Eli Bendersky <eliben@gmail.com> parents: 75416 diff changeset	293 self._assert_is_element(element)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	294 self._children.extend(elements)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	295
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	296 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	297 # Inserts a subelement at the given position in this element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	298 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	299 # @param index Where to insert the new subelement.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	300
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	301 def insert(self, index, element):
75894 75268a773455 Issue #13782: streamline argument type-checking in ET.Element Eli Bendersky <eliben@gmail.com> parents: 75416 diff changeset	302 self._assert_is_element(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	303 self._children.insert(index, element)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	304
75894 75268a773455 Issue #13782: streamline argument type-checking in ET.Element Eli Bendersky <eliben@gmail.com> parents: 75416 diff changeset	305 def _assert_is_element(self, e):
79460 7bd9626d8b4f Issue #16089: Allow ElementTree.TreeBuilder to work again with a non-Element element_factory (fixes a regression in SimpleTAL). Antoine Pitrou <solipsis@pitrou.net> parents: 79052 diff changeset	306 # Need to refer to the actual Python implementation, not the
7bd9626d8b4f Issue #16089: Allow ElementTree.TreeBuilder to work again with a non-Element element_factory (fixes a regression in SimpleTAL). Antoine Pitrou <solipsis@pitrou.net> parents: 79052 diff changeset	307 # shadowing C implementation.
7bd9626d8b4f Issue #16089: Allow ElementTree.TreeBuilder to work again with a non-Element element_factory (fixes a regression in SimpleTAL). Antoine Pitrou <solipsis@pitrou.net> parents: 79052 diff changeset	308 if not isinstance(e, _Element):
75894 75268a773455 Issue #13782: streamline argument type-checking in ET.Element Eli Bendersky <eliben@gmail.com> parents: 75416 diff changeset	309 raise TypeError('expected an Element, not %s' % type(e).__name__)
75268a773455 Issue #13782: streamline argument type-checking in ET.Element Eli Bendersky <eliben@gmail.com> parents: 75416 diff changeset	310
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	311 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	312 # Removes a matching subelement. Unlike the <b>find</b> methods,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	313 # this method compares elements based on identity, not on tag
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	314 # value or contents. To remove subelements by other means, the
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	315 # easiest way is often to use a list comprehension to select what
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	316 # elements to keep, and use slice assignment to update the parent
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	317 # element.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	318 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	319 # @param element What element to remove.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	320 # @exception ValueError If a matching element could not be found.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	321
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	322 def remove(self, element):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	323 # assert iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	324 self._children.remove(element)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	325
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	326 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	327 # (Deprecated) Returns all subelements. The elements are returned
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	328 # in document order.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	329 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	330 # @return A list of subelements.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	331 # @defreturn list of Element instances
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	332
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	333 def getchildren(self):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	334 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	335 "This method will be removed in future versions. "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	336 "Use 'list(elem)' or iteration over elem instead.",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	337 DeprecationWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	338 )
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	339 return self._children
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	340
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	341 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	342 # Finds the first matching subelement, by tag name or path.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	343 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	344 # @param path What element to look for.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	345 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	346 # @return The first matching element, or None if no element was found.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	347 # @defreturn Element or None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	348
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	349 def find(self, path, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	350 return ElementPath.find(self, path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	351
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	352 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	353 # Finds text for the first matching subelement, by tag name or path.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	354 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	355 # @param path What element to look for.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	356 # @param default What to return if the element was not found.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	357 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	358 # @return The text content of the first matching element, or the
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	359 # default value no element was found. Note that if the element
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	360 # is found, but has no text content, this method returns an
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	361 # empty string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	362 # @defreturn string
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	363
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	364 def findtext(self, path, default=None, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	365 return ElementPath.findtext(self, path, default, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	366
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	367 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	368 # Finds all matching subelements, by tag name or path.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	369 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	370 # @param path What element to look for.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	371 # @keyparam namespaces Optional namespace prefix map.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	372 # @return A list or other sequence containing all matching elements,
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	373 # in document order.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	374 # @defreturn list of Element instances
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	375
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	376 def findall(self, path, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	377 return ElementPath.findall(self, path, namespaces)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	378
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	379 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	380 # Finds all matching subelements, by tag name or path.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	381 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	382 # @param path What element to look for.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	383 # @keyparam namespaces Optional namespace prefix map.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	384 # @return An iterator or sequence containing all matching elements,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	385 # in document order.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	386 # @defreturn a generated sequence of Element instances
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	387
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	388 def iterfind(self, path, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	389 return ElementPath.iterfind(self, path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	390
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	391 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	392 # Resets an element. This function removes all subelements, clears
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	393 # all attributes, and sets the <b>text</b> and <b>tail</b> attributes
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	394 # to None.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	395
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	396 def clear(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	397 self.attrib.clear()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	398 self._children = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	399 self.text = self.tail = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	400
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	401 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	402 # Gets an element attribute. Equivalent to <b>attrib.get</b>, but
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	403 # some implementations may handle this a bit more efficiently.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	404 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	405 # @param key What attribute to look for.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	406 # @param default What to return if the attribute was not found.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	407 # @return The attribute value, or the default value, if the
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	408 # attribute was not found.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	409 # @defreturn string or None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	410
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	411 def get(self, key, default=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	412 return self.attrib.get(key, default)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	413
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	414 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	415 # Sets an element attribute. Equivalent to <b>attrib[key] = value</b>,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	416 # but some implementations may handle this a bit more efficiently.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	417 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	418 # @param key What attribute to set.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	419 # @param value The attribute value.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	420
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	421 def set(self, key, value):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	422 self.attrib[key] = value
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	423
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	424 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	425 # Gets a list of attribute names. The names are returned in an
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	426 # arbitrary order (just like for an ordinary Python dictionary).
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	427 # Equivalent to <b>attrib.keys()</b>.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	428 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	429 # @return A list of element attribute names.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	430 # @defreturn list of strings
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	431
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	432 def keys(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	433 return self.attrib.keys()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	434
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	435 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	436 # Gets element attributes, as a sequence. The attributes are
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	437 # returned in an arbitrary order. Equivalent to <b>attrib.items()</b>.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	438 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	439 # @return A list of (name, value) tuples for all attributes.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	440 # @defreturn list of (string, string) tuples
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	441
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	442 def items(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	443 return self.attrib.items()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	444
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	445 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	446 # Creates a tree iterator. The iterator loops over this element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	447 # and all subelements, in document order, and returns all elements
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	448 # with a matching tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	449 # <p>
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	450 # If the tree structure is modified during iteration, new or removed
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	451 # elements may or may not be included. To get a stable set, use the
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	452 # list() function on the iterator, and loop over the resulting list.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	453 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	454 # @param tag What tags to look for (default is to return all elements).
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	455 # @return An iterator containing all the matching elements.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	456 # @defreturn iterator
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	457
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	458 def iter(self, tag=None):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	459 if tag == "*":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	460 tag = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	461 if tag is None or self.tag == tag:
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	462 yield self
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	463 for e in self._children:
79389 33a221662f39 more yield from Philip Jenvey <pjenvey@underboss.org> parents: 79052 diff changeset	464 yield from e.iter(tag)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	465
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	466 # compatibility
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	467 def getiterator(self, tag=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	468 # Change for a DeprecationWarning in 1.4
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	469 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	470 "This method will be removed in future versions. "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	471 "Use 'elem.iter()' or 'list(elem.iter())' instead.",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	472 PendingDeprecationWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	473 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	474 return list(self.iter(tag))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	475
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	476 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	477 # Creates a text iterator. The iterator loops over this element
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	478 # and all subelements, in document order, and returns all inner
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	479 # text.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	480 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	481 # @return An iterator containing all inner text.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	482 # @defreturn iterator
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	483
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	484 def itertext(self):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	485 tag = self.tag
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	486 if not isinstance(tag, str) and tag is not None:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	487 return
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	488 if self.text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	489 yield self.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	490 for e in self:
79389 33a221662f39 more yield from Philip Jenvey <pjenvey@underboss.org> parents: 79052 diff changeset	491 yield from e.itertext()
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	492 if e.tail:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	493 yield e.tail
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	494
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	495 # compatibility
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	496 _Element = _ElementInterface = Element
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	497
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	498 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	499 # Subelement factory. This function creates an element instance, and
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	500 # appends it to an existing element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	501 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	502 # The element name, attribute names, and attribute values can be
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	503 # either 8-bit ASCII strings or Unicode strings.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	504 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	505 # @param parent The parent element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	506 # @param tag The subelement name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	507 # @param attrib An optional dictionary, containing element attributes.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	508 # @param **extra Additional attributes, given as keyword arguments.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	509 # @return An element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	510 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	511
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	512 def SubElement(parent, tag, attrib={}, **extra):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	513 attrib = attrib.copy()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	514 attrib.update(extra)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	515 element = parent.makeelement(tag, attrib)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	516 parent.append(element)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	517 return element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	518
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	519 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	520 # Comment element factory. This factory function creates a special
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	521 # element that will be serialized as an XML comment by the standard
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	522 # serializer.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	523 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	524 # The comment string can be either an 8-bit ASCII string or a Unicode
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	525 # string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	526 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	527 # @param text A string containing the comment string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	528 # @return An element instance, representing a comment.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	529 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	530
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	531 def Comment(text=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	532 element = Element(Comment)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	533 element.text = text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	534 return element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	535
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	536 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	537 # PI element factory. This factory function creates a special element
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	538 # that will be serialized as an XML processing instruction by the standard
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	539 # serializer.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	540 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	541 # @param target A string containing the PI target.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	542 # @param text A string containing the PI contents, if any.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	543 # @return An element instance, representing a PI.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	544 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	545
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	546 def ProcessingInstruction(target, text=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	547 element = Element(ProcessingInstruction)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	548 element.text = target
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	549 if text:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	550 element.text = element.text + " " + text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	551 return element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	552
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	553 PI = ProcessingInstruction
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	554
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	555 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	556 # QName wrapper. This can be used to wrap a QName attribute value, in
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	557 # order to get proper namespace handling on output.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	558 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	559 # @param text A string containing the QName value, in the form {uri}local,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	560 # or, if the tag argument is given, the URI part of a QName.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	561 # @param tag Optional tag. If given, the first argument is interpreted as
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	562 # an URI, and this argument is interpreted as a local name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	563 # @return An opaque object, representing the QName.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	564
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	565 class QName:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	566 def __init__(self, text_or_uri, tag=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	567 if tag:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	568 text_or_uri = "{%s}%s" % (text_or_uri, tag)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	569 self.text = text_or_uri
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	570 def __str__(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	571 return self.text
66809 c537bd37f508 #10661: give QName a nicer repr. Georg Brandl <georg@python.org> parents: 66099 diff changeset	572 def __repr__(self):
66810 1b659a00570b Guard against rogue tuples. Georg Brandl <georg@python.org> parents: 66809 diff changeset	573 return '<QName %r>' % (self.text,)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	574 def __hash__(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	575 return hash(self.text)
51122 adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	576 def __le__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	577 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	578 return self.text <= other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	579 return self.text <= other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	580 def __lt__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	581 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	582 return self.text < other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	583 return self.text < other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	584 def __ge__(self, other):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	585 if isinstance(other, QName):
51122 adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	586 return self.text >= other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	587 return self.text >= other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	588 def __gt__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	589 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	590 return self.text > other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	591 return self.text > other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	592 def __eq__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	593 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	594 return self.text == other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	595 return self.text == other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	596 def __ne__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	597 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	598 return self.text != other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	599 return self.text != other
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	600
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	601 # --------------------------------------------------------------------
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	602
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	603 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	604 # ElementTree wrapper class. This class represents an entire element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	605 # hierarchy, and adds some extra support for serialization to and from
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	606 # standard XML.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	607 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	608 # @param element Optional root element.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	609 # @keyparam file Optional file handle or file name. If given, the
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	610 # tree is initialized with the contents of this XML file.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	611
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	612 class ElementTree:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	613
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	614 def __init__(self, element=None, file=None):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	615 # assert element is None or iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	616 self._root = element # first node
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	617 if file:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	618 self.parse(file)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	619
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	620 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	621 # Gets the root element for this tree.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	622 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	623 # @return An element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	624 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	625
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	626 def getroot(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	627 return self._root
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	628
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	629 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	630 # Replaces the root element for this tree. This discards the
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	631 # current contents of the tree, and replaces it with the given
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	632 # element. Use with care.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	633 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	634 # @param element An element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	635
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	636 def _setroot(self, element):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	637 # assert iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	638 self._root = element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	639
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	640 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	641 # Loads an external XML document into this element tree.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	642 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	643 # @param source A file name or file object. If a file object is
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	644 # given, it only has to implement a <b>read(n)</b> method.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	645 # @keyparam parser An optional parser instance. If not given, the
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	646 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	647 # @return The document root element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	648 # @defreturn Element
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	649 # @exception ParseError If the parser fails to parse the document.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	650
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	651 def parse(self, source, parser=None):
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	652 close_source = False
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	653 if not hasattr(source, "read"):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	654 source = open(source, "rb")
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	655 close_source = True
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	656 try:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	657 if not parser:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	658 parser = XMLParser(target=TreeBuilder())
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	659 while 1:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	660 data = source.read(65536)
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	661 if not data:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	662 break
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	663 parser.feed(data)
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	664 self._root = parser.close()
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	665 return self._root
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	666 finally:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	667 if close_source:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	668 source.close()
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	669
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	670 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	671 # Creates a tree iterator for the root element. The iterator loops
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	672 # over all elements in this tree, in document order.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	673 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	674 # @param tag What tags to look for (default is to return all elements)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	675 # @return An iterator.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	676 # @defreturn iterator
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	677
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	678 def iter(self, tag=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	679 # assert self._root is not None
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	680 return self._root.iter(tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	681
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	682 # compatibility
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	683 def getiterator(self, tag=None):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	684 # Change for a DeprecationWarning in 1.4
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	685 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	686 "This method will be removed in future versions. "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	687 "Use 'tree.iter()' or 'list(tree.iter())' instead.",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	688 PendingDeprecationWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	689 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	690 return list(self.iter(tag))
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	691
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	692 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	693 # Finds the first toplevel element with given tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	694 # Same as getroot().find(path).
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	695 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	696 # @param path What element to look for.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	697 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	698 # @return The first matching element, or None if no element was found.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	699 # @defreturn Element or None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	700
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	701 def find(self, path, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	702 # assert self._root is not None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	703 if path[:1] == "/":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	704 path = "." + path
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	705 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	706 "This search is broken in 1.3 and earlier, and will be "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	707 "fixed in a future version. If you rely on the current "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	708 "behaviour, change it to %r" % path,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	709 FutureWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	710 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	711 return self._root.find(path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	712
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	713 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	714 # Finds the element text for the first toplevel element with given
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	715 # tag. Same as getroot().findtext(path).
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	716 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	717 # @param path What toplevel element to look for.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	718 # @param default What to return if the element was not found.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	719 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	720 # @return The text content of the first matching element, or the
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	721 # default value no element was found. Note that if the element
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	722 # is found, but has no text content, this method returns an
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	723 # empty string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	724 # @defreturn string
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	725
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	726 def findtext(self, path, default=None, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	727 # assert self._root is not None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	728 if path[:1] == "/":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	729 path = "." + path
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	730 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	731 "This search is broken in 1.3 and earlier, and will be "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	732 "fixed in a future version. If you rely on the current "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	733 "behaviour, change it to %r" % path,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	734 FutureWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	735 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	736 return self._root.findtext(path, default, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	737
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	738 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	739 # Finds all toplevel elements with the given tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	740 # Same as getroot().findall(path).
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	741 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	742 # @param path What element to look for.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	743 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	744 # @return A list or iterator containing all matching elements,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	745 # in document order.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	746 # @defreturn list of Element instances
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	747
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	748 def findall(self, path, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	749 # assert self._root is not None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	750 if path[:1] == "/":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	751 path = "." + path
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	752 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	753 "This search is broken in 1.3 and earlier, and will be "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	754 "fixed in a future version. If you rely on the current "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	755 "behaviour, change it to %r" % path,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	756 FutureWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	757 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	758 return self._root.findall(path, namespaces)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	759
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	760 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	761 # Finds all matching subelements, by tag name or path.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	762 # Same as getroot().iterfind(path).
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	763 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	764 # @param path What element to look for.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	765 # @keyparam namespaces Optional namespace prefix map.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	766 # @return An iterator or sequence containing all matching elements,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	767 # in document order.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	768 # @defreturn a generated sequence of Element instances
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	769
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	770 def iterfind(self, path, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	771 # assert self._root is not None
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	772 if path[:1] == "/":
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	773 path = "." + path
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	774 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	775 "This search is broken in 1.3 and earlier, and will be "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	776 "fixed in a future version. If you rely on the current "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	777 "behaviour, change it to %r" % path,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	778 FutureWarning, stacklevel=2
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	779 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	780 return self._root.iterfind(path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	781
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	782 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	783 # Writes the element tree to a file, as XML.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	784 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	785 # @def write(file, **options)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	786 # @param file A file name, or a file object opened for writing.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	787 # @param **options Options, given as keyword arguments.
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	788 # @keyparam encoding Optional output encoding (default is US-ASCII).
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	789 # Use "unicode" to return a Unicode string.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	790 # @keyparam method Optional output method ("xml", "html", "text" or
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	791 # "c14n"; default is "xml").
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	792 # @keyparam xml_declaration Controls if an XML declaration should
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	793 # be added to the file. Use False for never, True for always,
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	794 # None for only if not US-ASCII or UTF-8 or Unicode. None is default.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	795
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	796 def write(self, file_or_filename,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	797 encoding=None,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	798 xml_declaration=None,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	799 default_namespace=None,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	800 method=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	801 if not method:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	802 method = "xml"
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	803 elif method not in _serialize:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	804 raise ValueError("unknown method %r" % method)
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	805 if not encoding:
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	806 if method == "c14n":
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	807 encoding = "utf-8"
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	808 else:
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	809 encoding = "us-ascii"
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	810 else:
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	811 encoding = encoding.lower()
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	812 with _get_writer(file_or_filename, encoding) as write:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	813 if method == "xml" and (xml_declaration or
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	814 (xml_declaration is None and
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	815 encoding not in ("utf-8", "us-ascii", "unicode"))):
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	816 declared_encoding = encoding
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	817 if encoding == "unicode":
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	818 # Retrieve the default encoding for the xml declaration
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	819 import locale
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	820 declared_encoding = locale.getpreferredencoding()
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	821 write("<?xml version='1.0' encoding='%s'?>\n" % (
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	822 declared_encoding,))
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	823 if method == "text":
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	824 _serialize_text(write, self._root)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	825 else:
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	826 qnames, namespaces = _namespaces(self._root, default_namespace)
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	827 serialize = _serialize[method]
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	828 serialize(write, self._root, qnames, namespaces)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	829
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	830 def write_c14n(self, file):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	831 # lxml.etree compatibility. use output method instead
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	832 return self.write(file, method="c14n")
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	833
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	834 # --------------------------------------------------------------------
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	835 # serialization support
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	836
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	837 @contextlib.contextmanager
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	838 def _get_writer(file_or_filename, encoding):
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	839 # returns text write method and release all resourses after using
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	840 try:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	841 write = file_or_filename.write
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	842 except AttributeError:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	843 # file_or_filename is a file name
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	844 if encoding == "unicode":
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	845 file = open(file_or_filename, "w")
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	846 else:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	847 file = open(file_or_filename, "w", encoding=encoding,
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	848 errors="xmlcharrefreplace")
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	849 with file:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	850 yield file.write
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	851 else:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	852 # file_or_filename is a file-like object
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	853 # encoding determines if it is a text or binary writer
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	854 if encoding == "unicode":
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	855 # use a text writer as is
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	856 yield write
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	857 else:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	858 # wrap a binary writer with TextIOWrapper
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	859 with contextlib.ExitStack() as stack:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	860 if isinstance(file_or_filename, io.BufferedIOBase):
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	861 file = file_or_filename
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	862 elif isinstance(file_or_filename, io.RawIOBase):
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	863 file = io.BufferedWriter(file_or_filename)
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	864 # Keep the original file open when the BufferedWriter is
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	865 # destroyed
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	866 stack.callback(file.detach)
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	867 else:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	868 # This is to handle passed objects that aren't in the
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	869 # IOBase hierarchy, but just have a write method
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	870 file = io.BufferedIOBase()
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	871 file.writable = lambda: True
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	872 file.write = write
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	873 try:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	874 # TextIOWrapper uses this methods to determine
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	875 # if BOM (for UTF-16, etc) should be added
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	876 file.seekable = file_or_filename.seekable
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	877 file.tell = file_or_filename.tell
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	878 except AttributeError:
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	879 pass
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	880 file = io.TextIOWrapper(file,
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	881 encoding=encoding,
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	882 errors="xmlcharrefreplace",
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	883 newline="\n")
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	884 # Keep the original file open when the TextIOWrapper is
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	885 # destroyed
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	886 stack.callback(file.detach)
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	887 yield file.write
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	888
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	889 def _namespaces(elem, default_namespace=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	890 # identify namespaces used in this tree
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	891
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	892 # maps qnames to encoded prefix:local names
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	893 qnames = {None: None}
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	894
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	895 # maps uri:s to prefixes
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	896 namespaces = {}
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	897 if default_namespace:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	898 namespaces[default_namespace] = ""
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	899
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	900 def add_qname(qname):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	901 # calculate serialized qname representation
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	902 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	903 if qname[:1] == "{":
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	904 uri, tag = qname[1:].rsplit("}", 1)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	905 prefix = namespaces.get(uri)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	906 if prefix is None:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	907 prefix = _namespace_map.get(uri)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	908 if prefix is None:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	909 prefix = "ns%d" % len(namespaces)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	910 if prefix != "xml":
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	911 namespaces[uri] = prefix
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	912 if prefix:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	913 qnames[qname] = "%s:%s" % (prefix, tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	914 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	915 qnames[qname] = tag # default element
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	916 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	917 if default_namespace:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	918 # FIXME: can this be handled in XML 1.0?
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	919 raise ValueError(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	920 "cannot use non-qualified names with "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	921 "default_namespace option"
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	922 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	923 qnames[qname] = qname
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	924 except TypeError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	925 _raise_serialization_error(qname)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	926
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	927 # populate qname and namespaces table
77431 652d148bdc1d Replace the iter/itertext methods of Element in _elementtree with true C implementations, instead of the bootstrapped Python code. In addition to being cleaner (removing the last remains of the bootstrapping code in _elementtree), this gives a 10x performance boost for iter() on large documents. Eli Bendersky <eliben@gmail.com> parents: 77217 diff changeset	928 for elem in elem.iter():
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	929 tag = elem.tag
66099 9a66feb07a0a Fix Issue10205 - XML QName error when different tags have same QName. Senthil Kumaran <orsenthil@gmail.com> parents: 65707 diff changeset	930 if isinstance(tag, QName):
9a66feb07a0a Fix Issue10205 - XML QName error when different tags have same QName. Senthil Kumaran <orsenthil@gmail.com> parents: 65707 diff changeset	931 if tag.text not in qnames:
9a66feb07a0a Fix Issue10205 - XML QName error when different tags have same QName. Senthil Kumaran <orsenthil@gmail.com> parents: 65707 diff changeset	932 add_qname(tag.text)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	933 elif isinstance(tag, str):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	934 if tag not in qnames:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	935 add_qname(tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	936 elif tag is not None and tag is not Comment and tag is not PI:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	937 _raise_serialization_error(tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	938 for key, value in elem.items():
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	939 if isinstance(key, QName):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	940 key = key.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	941 if key not in qnames:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	942 add_qname(key)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	943 if isinstance(value, QName) and value.text not in qnames:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	944 add_qname(value.text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	945 text = elem.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	946 if isinstance(text, QName) and text.text not in qnames:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	947 add_qname(text.text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	948 return qnames, namespaces
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	949
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	950 def _serialize_xml(write, elem, qnames, namespaces):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	951 tag = elem.tag
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	952 text = elem.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	953 if tag is Comment:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	954 write("<!--%s-->" % text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	955 elif tag is ProcessingInstruction:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	956 write("<?%s?>" % text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	957 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	958 tag = qnames[tag]
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	959 if tag is None:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	960 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	961 write(_escape_cdata(text))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	962 for e in elem:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	963 _serialize_xml(write, e, qnames, None)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	964 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	965 write("<" + tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	966 items = list(elem.items())
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	967 if items or namespaces:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	968 if namespaces:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	969 for v, k in sorted(namespaces.items(),
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	970 key=lambda x: x[1]): # sort on prefix
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	971 if k:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	972 k = ":" + k
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	973 write(" xmlns%s=\"%s\"" % (
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	974 k,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	975 _escape_attrib(v)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	976 ))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	977 for k, v in sorted(items): # lexical order
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	978 if isinstance(k, QName):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	979 k = k.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	980 if isinstance(v, QName):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	981 v = qnames[v.text]
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	982 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	983 v = _escape_attrib(v)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	984 write(" %s=\"%s\"" % (qnames[k], v))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	985 if text or len(elem):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	986 write(">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	987 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	988 write(_escape_cdata(text))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	989 for e in elem:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	990 _serialize_xml(write, e, qnames, None)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	991 write("</" + tag + ">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	992 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	993 write(" />")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	994 if elem.tail:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	995 write(_escape_cdata(elem.tail))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	996
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	997 HTML_EMPTY = ("area", "base", "basefont", "br", "col", "frame", "hr",
79051 17c528cff63f #15970: xml.etree.ElementTree now serializes correctly the empty HTML elements "meta" and "param". Ezio Melotti <ezio.melotti@gmail.com> parents: 73291 diff changeset	998 "img", "input", "isindex", "link", "meta", "param")
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	999
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1000 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1001 HTML_EMPTY = set(HTML_EMPTY)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1002 except NameError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1003 pass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1004
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1005 def _serialize_html(write, elem, qnames, namespaces):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1006 tag = elem.tag
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1007 text = elem.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1008 if tag is Comment:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1009 write("<!--%s-->" % _escape_cdata(text))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1010 elif tag is ProcessingInstruction:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1011 write("<?%s?>" % _escape_cdata(text))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1012 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1013 tag = qnames[tag]
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1014 if tag is None:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1015 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1016 write(_escape_cdata(text))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1017 for e in elem:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1018 _serialize_html(write, e, qnames, None)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1019 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1020 write("<" + tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1021 items = list(elem.items())
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1022 if items or namespaces:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1023 if namespaces:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1024 for v, k in sorted(namespaces.items(),
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1025 key=lambda x: x[1]): # sort on prefix
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1026 if k:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1027 k = ":" + k
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1028 write(" xmlns%s=\"%s\"" % (
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1029 k,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1030 _escape_attrib(v)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1031 ))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1032 for k, v in sorted(items): # lexical order
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1033 if isinstance(k, QName):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1034 k = k.text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1035 if isinstance(v, QName):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1036 v = qnames[v.text]
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1037 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1038 v = _escape_attrib_html(v)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1039 # FIXME: handle boolean attributes
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1040 write(" %s=\"%s\"" % (qnames[k], v))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1041 write(">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1042 tag = tag.lower()
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1043 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1044 if tag == "script" or tag == "style":
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1045 write(text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1046 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1047 write(_escape_cdata(text))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1048 for e in elem:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1049 _serialize_html(write, e, qnames, None)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1050 if tag not in HTML_EMPTY:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1051 write("</" + tag + ">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1052 if elem.tail:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1053 write(_escape_cdata(elem.tail))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1054
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1055 def _serialize_text(write, elem):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1056 for part in elem.itertext():
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1057 write(part)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1058 if elem.tail:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1059 write(elem.tail)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1060
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1061 _serialize = {
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1062 "xml": _serialize_xml,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1063 "html": _serialize_html,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1064 "text": _serialize_text,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1065 # this optional method is imported at the end of the module
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1066 # "c14n": _serialize_c14n,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1067 }
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1068
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1069 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1070 # Registers a namespace prefix. The registry is global, and any
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1071 # existing mapping for either the given prefix or the namespace URI
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1072 # will be removed.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1073 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1074 # @param prefix Namespace prefix.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1075 # @param uri Namespace uri. Tags and attributes in this namespace
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1076 # will be serialized with the given prefix, if at all possible.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1077 # @exception ValueError If the prefix is reserved, or is otherwise
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1078 # invalid.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1079
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1080 def register_namespace(prefix, uri):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1081 if re.match("ns\d+$", prefix):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1082 raise ValueError("Prefix format reserved for internal use")
67170 7d551d5ef4fc #10777: fix iteration over dict keys while mutating the dict. Georg Brandl <georg@python.org> parents: 66810 diff changeset	1083 for k, v in list(_namespace_map.items()):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1084 if k == uri or v == prefix:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1085 del _namespace_map[k]
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1086 _namespace_map[uri] = prefix
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1087
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1088 _namespace_map = {
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1089 # "well-known" namespace prefixes
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1090 "http://www.w3.org/XML/1998/namespace": "xml",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1091 "http://www.w3.org/1999/xhtml": "html",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1092 "http://www.w3.org/1999/02/22-rdf-syntax-ns#": "rdf",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1093 "http://schemas.xmlsoap.org/wsdl/": "wsdl",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1094 # xml schema
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1095 "http://www.w3.org/2001/XMLSchema": "xs",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1096 "http://www.w3.org/2001/XMLSchema-instance": "xsi",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1097 # dublin core
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1098 "http://purl.org/dc/elements/1.1/": "dc",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1099 }
74991 cdc9e0238b1d fix the _namespace_map cleanup for cElementTree tests. Florent Xicluna <florent.xicluna@gmail.com> parents: 74903 diff changeset	1100 # For tests and troubleshooting
cdc9e0238b1d fix the _namespace_map cleanup for cElementTree tests. Florent Xicluna <florent.xicluna@gmail.com> parents: 74903 diff changeset	1101 register_namespace._namespace_map = _namespace_map
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1102
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1103 def _raise_serialization_error(text):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1104 raise TypeError(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1105 "cannot serialize %r (type %s)" % (text, type(text).__name__)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1106 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1107
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1108 def _escape_cdata(text):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1109 # escape character data
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1110 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1111 # it's worth avoiding do-nothing calls for strings that are
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1112 # shorter than 500 character, or so. assume that's, by far,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1113 # the most common case in most applications.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1114 if "&" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1115 text = text.replace("&", "&")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1116 if "<" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1117 text = text.replace("<", "<")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1118 if ">" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1119 text = text.replace(">", ">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1120 return text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1121 except (TypeError, AttributeError):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1122 _raise_serialization_error(text)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1123
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1124 def _escape_attrib(text):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1125 # escape attribute value
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1126 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1127 if "&" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1128 text = text.replace("&", "&")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1129 if "<" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1130 text = text.replace("<", "<")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1131 if ">" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1132 text = text.replace(">", ">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1133 if "\"" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1134 text = text.replace("\"", """)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1135 if "\n" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1136 text = text.replace("\n", " ")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1137 return text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1138 except (TypeError, AttributeError):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1139 _raise_serialization_error(text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1140
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1141 def _escape_attrib_html(text):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1142 # escape attribute value
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1143 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1144 if "&" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1145 text = text.replace("&", "&")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1146 if ">" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1147 text = text.replace(">", ">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1148 if "\"" in text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1149 text = text.replace("\"", """)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1150 return text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1151 except (TypeError, AttributeError):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1152 _raise_serialization_error(text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1153
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1154 # --------------------------------------------------------------------
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1155
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1156 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1157 # Generates a string representation of an XML element, including all
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1158 # subelements. If encoding is "unicode", the return type is a string;
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1159 # otherwise it is a bytes array.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1160 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1161 # @param element An Element instance.
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1162 # @keyparam encoding Optional output encoding (default is US-ASCII).
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1163 # Use "unicode" to return a Unicode string.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1164 # @keyparam method Optional output method ("xml", "html", "text" or
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1165 # "c14n"; default is "xml").
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1166 # @return An (optionally) encoded string containing the XML data.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1167 # @defreturn string
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1168
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1169 def tostring(element, encoding=None, method=None):
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	1170 stream = io.StringIO() if encoding == 'unicode' else io.BytesIO()
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	1171 ElementTree(element).write(stream, encoding, method=method)
6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	1172 return stream.getvalue()
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1173
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1174 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1175 # Generates a string representation of an XML element, including all
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	1176 # subelements.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1177 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1178 # @param element An Element instance.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1179 # @keyparam encoding Optional output encoding (default is US-ASCII).
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1180 # Use "unicode" to return a Unicode string.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1181 # @keyparam method Optional output method ("xml", "html", "text" or
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1182 # "c14n"; default is "xml").
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1183 # @return A sequence object containing the XML data.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1184 # @defreturn sequence
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1185 # @since 1.3
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1186
78156 51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1187 class _ListDataStream(io.BufferedIOBase):
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1188 """ An auxiliary stream accumulating into a list reference
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1189 """
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1190 def __init__(self, lst):
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1191 self.lst = lst
78157 63ba0c32b81a fix whitespace woes Eli Bendersky <eliben@gmail.com> parents: 78156 diff changeset	1192
78156 51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1193 def writable(self):
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1194 return True
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	1195
78156 51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1196 def seekable(self):
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1197 return True
78145 64ff90e07d71 Preserve the invariant tostring(elem) == b''.join(tostringlist(elem)) and add a test to make sure it keeps working Eli Bendersky <eliben@gmail.com> parents: 78105 diff changeset	1198
78156 51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1199 def write(self, b):
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1200 self.lst.append(b)
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1201
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1202 def tell(self):
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1203 return len(self.lst)
78105 6120cf695574 Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me Eli Bendersky <eliben@gmail.com> parents: 77963 diff changeset	1204
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1205 def tostringlist(element, encoding=None, method=None):
78156 51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1206 lst = []
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1207 stream = _ListDataStream(lst)
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1208 ElementTree(element).write(stream, encoding, method=method)
51978f89e5ed Optimize tostringlist by taking the stream class outside the function. It's now 2x faster on short calls. Related to #1767933 Eli Bendersky <eliben@gmail.com> parents: 78145 diff changeset	1209 return lst
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1210
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1211 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1212 # Writes an element tree or element structure to sys.stdout. This
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1213 # function should be used for debugging only.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1214 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1215 # The exact output format is implementation dependent. In this
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1216 # version, it's written as an ordinary XML file.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1217 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1218 # @param elem An element tree or an individual element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1219
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1220 def dump(elem):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1221 # debugging
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1222 if not isinstance(elem, ElementTree):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1223 elem = ElementTree(elem)
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1224 elem.write(sys.stdout, encoding="unicode")
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1225 tail = elem.getroot().tail
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1226 if not tail or tail[-1] != "\n":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1227 sys.stdout.write("\n")
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1228
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1229 # --------------------------------------------------------------------
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1230 # parsing
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1231
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1232 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1233 # Parses an XML document into an element tree.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1234 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1235 # @param source A filename or file object containing XML data.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1236 # @param parser An optional parser instance. If not given, the
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1237 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1238 # @return An ElementTree instance
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1239
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1240 def parse(source, parser=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1241 tree = ElementTree()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1242 tree.parse(source, parser)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1243 return tree
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1244
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1245 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1246 # Parses an XML document into an element tree incrementally, and reports
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1247 # what's going on to the user.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1248 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1249 # @param source A filename or file object containing XML data.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1250 # @param events A list of events to report back. If omitted, only "end"
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1251 # events are reported.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1252 # @param parser An optional parser instance. If not given, the
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1253 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1254 # @return A (event, elem) iterator.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1255
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1256 def iterparse(source, events=None, parser=None):
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	1257 close_source = False
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1258 if not hasattr(source, "read"):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1259 source = open(source, "rb")
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	1260 close_source = True
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1261 if not parser:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1262 parser = XMLParser(target=TreeBuilder())
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	1263 return _IterParseIterator(source, events, parser, close_source)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1264
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1265 class _IterParseIterator:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1266
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	1267 def __init__(self, source, events, parser, close_source=False):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1268 self._file = source
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	1269 self._close_file = close_source
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1270 self._events = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1271 self._index = 0
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1272 self._error = None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1273 self.root = self._root = None
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1274 self._parser = parser
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1275 # wire up the parser for event reporting
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1276 parser = self._parser._parser
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1277 append = self._events.append
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1278 if events is None:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1279 events = ["end"]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1280 for event in events:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1281 if event == "start":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1282 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1283 parser.ordered_attributes = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1284 parser.specified_attributes = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1285 def handler(tag, attrib_in, event=event, append=append,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1286 start=self._parser._start_list):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1287 append((event, start(tag, attrib_in)))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1288 parser.StartElementHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1289 except AttributeError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1290 def handler(tag, attrib_in, event=event, append=append,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1291 start=self._parser._start):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1292 append((event, start(tag, attrib_in)))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1293 parser.StartElementHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1294 elif event == "end":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1295 def handler(tag, event=event, append=append,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1296 end=self._parser._end):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1297 append((event, end(tag)))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1298 parser.EndElementHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1299 elif event == "start-ns":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1300 def handler(prefix, uri, event=event, append=append):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1301 append((event, (prefix or "", uri or "")))
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1302 parser.StartNamespaceDeclHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1303 elif event == "end-ns":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1304 def handler(prefix, event=event, append=append):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1305 append((event, None))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1306 parser.EndNamespaceDeclHandler = handler
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1307 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1308 raise ValueError("unknown event %r" % event)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1309
41501 0c5019afc55b PEP 3114: rename .next() to .__next__() and add next() builtin. Georg Brandl <georg@python.org> parents: 41480 diff changeset	1310 def __next__(self):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1311 while 1:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1312 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1313 item = self._events[self._index]
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1314 self._index += 1
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1315 return item
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1316 except IndexError:
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1317 pass
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1318 if self._error:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1319 e = self._error
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1320 self._error = None
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1321 raise e
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1322 if self._parser is None:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1323 self.root = self._root
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1324 if self._close_file:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1325 self._file.close()
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1326 raise StopIteration
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1327 # load event buffer
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1328 del self._events[:]
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1329 self._index = 0
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1330 data = self._file.read(16384)
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1331 if data:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1332 try:
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1333 self._parser.feed(data)
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1334 except SyntaxError as exc:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1335 self._error = exc
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1336 else:
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1337 self._root = self._parser.close()
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1338 self._parser = None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1339
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1340 def __iter__(self):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1341 return self
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1342
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1343 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1344 # Parses an XML document from a string constant. This function can
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1345 # be used to embed "XML literals" in Python code.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1346 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1347 # @param source A string containing XML data.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1348 # @param parser An optional parser instance. If not given, the
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1349 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1350 # @return An Element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1351 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1352
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1353 def XML(text, parser=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1354 if not parser:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1355 parser = XMLParser(target=TreeBuilder())
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1356 parser.feed(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1357 return parser.close()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1358
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1359 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1360 # Parses an XML document from a string constant, and also returns
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1361 # a dictionary which maps from element id:s to elements.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1362 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1363 # @param source A string containing XML data.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1364 # @param parser An optional parser instance. If not given, the
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1365 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1366 # @return A tuple containing an Element instance and a dictionary.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1367 # @defreturn (Element, dictionary)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1368
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1369 def XMLID(text, parser=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1370 if not parser:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1371 parser = XMLParser(target=TreeBuilder())
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1372 parser.feed(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1373 tree = parser.close()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1374 ids = {}
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1375 for elem in tree.iter():
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1376 id = elem.get("id")
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1377 if id:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1378 ids[id] = elem
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1379 return tree, ids
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1380
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1381 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1382 # Parses an XML document from a string constant. Same as {@link #XML}.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1383 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1384 # @def fromstring(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1385 # @param source A string containing XML data.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1386 # @return An Element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1387 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1388
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1389 fromstring = XML
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1390
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1391 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1392 # Parses an XML document from a sequence of string fragments.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1393 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1394 # @param sequence A list or other sequence containing XML data fragments.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1395 # @param parser An optional parser instance. If not given, the
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1396 # standard {@link XMLParser} parser is used.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1397 # @return An Element instance.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1398 # @defreturn Element
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1399 # @since 1.3
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1400
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1401 def fromstringlist(sequence, parser=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1402 if not parser:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1403 parser = XMLParser(target=TreeBuilder())
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1404 for text in sequence:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1405 parser.feed(text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1406 return parser.close()
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1407
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1408 # --------------------------------------------------------------------
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1409
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1410 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1411 # Generic element structure builder. This builder converts a sequence
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1412 # of {@link #TreeBuilder.start}, {@link #TreeBuilder.data}, and {@link
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1413 # #TreeBuilder.end} method calls to a well-formed element structure.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1414 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1415 # You can use this class to build an element structure using a custom XML
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1416 # parser, or a parser for some other XML-like format.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1417 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1418 # @param element_factory Optional element factory. This factory
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1419 # is called to create new Element instances, as necessary.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1420
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1421 class TreeBuilder:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1422
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1423 def __init__(self, element_factory=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1424 self._data = [] # data collector
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1425 self._elem = [] # element stack
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1426 self._last = None # last element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1427 self._tail = None # true if we're after an end tag
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1428 if element_factory is None:
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1429 element_factory = Element
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1430 self._factory = element_factory
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1431
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1432 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1433 # Flushes the builder buffers, and returns the toplevel document
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1434 # element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1435 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1436 # @return An Element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1437 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1438
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1439 def close(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1440 assert len(self._elem) == 0, "missing end tags"
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1441 assert self._last is not None, "missing toplevel element"
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1442 return self._last
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1443
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1444 def _flush(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1445 if self._data:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1446 if self._last is not None:
41480 99027c2b3fd2 Remove functions in string module that are also string methods. Also remove: Neal Norwitz <nnorwitz@gmail.com> parents: 40809 diff changeset	1447 text = "".join(self._data)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1448 if self._tail:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1449 assert self._last.tail is None, "internal error (tail)"
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1450 self._last.tail = text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1451 else:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1452 assert self._last.text is None, "internal error (text)"
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1453 self._last.text = text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1454 self._data = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1455
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1456 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1457 # Adds text to the current element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1458 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1459 # @param data A string. This should be either an 8-bit string
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1460 # containing ASCII text, or a Unicode string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1461
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1462 def data(self, data):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1463 self._data.append(data)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1464
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1465 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1466 # Opens a new element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1467 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1468 # @param tag The element name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1469 # @param attrib A dictionary containing element attributes.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1470 # @return The opened element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1471 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1472
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1473 def start(self, tag, attrs):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1474 self._flush()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1475 self._last = elem = self._factory(tag, attrs)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1476 if self._elem:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1477 self._elem[-1].append(elem)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1478 self._elem.append(elem)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1479 self._tail = 0
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1480 return elem
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1481
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1482 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1483 # Closes the current element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1484 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1485 # @param tag The element name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1486 # @return The closed element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1487 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1488
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1489 def end(self, tag):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1490 self._flush()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1491 self._last = self._elem.pop()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1492 assert self._last.tag == tag,\
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1493 "end tag mismatch (expected %s, got %s)" % (
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1494 self._last.tag, tag)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1495 self._tail = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1496 return self._last
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1497
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1498 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1499 # Element structure builder for XML source data, based on the
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1500 # <b>expat</b> parser.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1501 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1502 # @keyparam target Target object. If omitted, the builder uses an
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1503 # instance of the standard {@link #TreeBuilder} class.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1504 # @keyparam html Predefine HTML entities. This flag is not supported
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1505 # by the current implementation.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1506 # @keyparam encoding Optional encoding. If given, the value overrides
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1507 # the encoding specified in the XML file.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1508 # @see #ElementTree
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1509 # @see #TreeBuilder
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1510
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1511 class XMLParser:
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1512
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1513 def __init__(self, html=0, target=None, encoding=None):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1514 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1515 from xml.parsers import expat
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1516 except ImportError:
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1517 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1518 import pyexpat as expat
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1519 except ImportError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1520 raise ImportError(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1521 "No module named expat; use SimpleXMLTreeBuilder instead"
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1522 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1523 parser = expat.ParserCreate(encoding, "}")
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1524 if target is None:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1525 target = TreeBuilder()
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1526 # underscored names are provided for compatibility only
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1527 self.parser = self._parser = parser
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1528 self.target = self._target = target
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1529 self._error = expat.error
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1530 self._names = {} # name memo cache
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1531 # main callbacks
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1532 parser.DefaultHandlerExpand = self._default
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1533 if hasattr(target, 'start'):
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1534 parser.StartElementHandler = self._start
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1535 if hasattr(target, 'end'):
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1536 parser.EndElementHandler = self._end
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1537 if hasattr(target, 'data'):
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1538 parser.CharacterDataHandler = target.data
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1539 # miscellaneous callbacks
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1540 if hasattr(target, 'comment'):
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1541 parser.CommentHandler = target.comment
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1542 if hasattr(target, 'pi'):
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1543 parser.ProcessingInstructionHandler = target.pi
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1544 # let expat do the buffering, if supported
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1545 try:
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1546 parser.buffer_text = 1
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1547 except AttributeError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1548 pass
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1549 # use new-style attribute handling, if supported
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1550 try:
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1551 parser.ordered_attributes = 1
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1552 parser.specified_attributes = 1
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1553 if hasattr(target, 'start'):
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1554 parser.StartElementHandler = self._start_list
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1555 except AttributeError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1556 pass
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1557 self._doctype = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1558 self.entity = {}
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1559 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1560 self.version = "Expat %d.%d.%d" % expat.version_info
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1561 except AttributeError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1562 pass # unknown
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1563
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1564 def _raiseerror(self, value):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1565 err = ParseError(value)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1566 err.code = value.code
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1567 err.position = value.lineno, value.offset
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1568 raise err
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1569
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1570 def _fixname(self, key):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1571 # expand qname, and convert name string to ascii, if possible
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1572 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1573 name = self._names[key]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1574 except KeyError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1575 name = key
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1576 if "}" in name:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1577 name = "{" + name
42388 d3471ef6fe38 Patch #1762412: Fix test case for struni branch. Martin v. Löwis <martin@v.loewis.de> parents: 41501 diff changeset	1578 self._names[key] = name
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1579 return name
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1580
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1581 def _start(self, tag, attrib_in):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1582 fixname = self._fixname
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1583 tag = fixname(tag)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1584 attrib = {}
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1585 for key, value in attrib_in.items():
42388 d3471ef6fe38 Patch #1762412: Fix test case for struni branch. Martin v. Löwis <martin@v.loewis.de> parents: 41501 diff changeset	1586 attrib[fixname(key)] = value
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1587 return self.target.start(tag, attrib)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1588
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1589 def _start_list(self, tag, attrib_in):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1590 fixname = self._fixname
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1591 tag = fixname(tag)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1592 attrib = {}
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1593 if attrib_in:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1594 for i in range(0, len(attrib_in), 2):
42388 d3471ef6fe38 Patch #1762412: Fix test case for struni branch. Martin v. Löwis <martin@v.loewis.de> parents: 41501 diff changeset	1595 attrib[fixname(attrib_in[i])] = attrib_in[i+1]
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1596 return self.target.start(tag, attrib)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1597
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1598 def _end(self, tag):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1599 return self.target.end(self._fixname(tag))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1600
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1601 def _default(self, text):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1602 prefix = text[:1]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1603 if prefix == "&":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1604 # deal with undefined entities
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1605 try:
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1606 data_handler = self.target.data
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1607 except AttributeError:
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1608 return
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1609 try:
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1610 data_handler(self.entity[text[1:-1]])
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1611 except KeyError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1612 from xml.parsers import expat
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1613 err = expat.error(
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1614 "undefined entity %s: line %d, column %d" %
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1615 (text, self.parser.ErrorLineNumber,
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1616 self.parser.ErrorColumnNumber)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1617 )
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1618 err.code = 11 # XML_ERROR_UNDEFINED_ENTITY
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1619 err.lineno = self.parser.ErrorLineNumber
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1620 err.offset = self.parser.ErrorColumnNumber
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1621 raise err
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1622 elif prefix == "<" and text[:9] == "<!DOCTYPE":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1623 self._doctype = [] # inside a doctype declaration
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1624 elif self._doctype is not None:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1625 # parse doctype contents
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1626 if prefix == ">":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1627 self._doctype = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1628 return
41480 99027c2b3fd2 Remove functions in string module that are also string methods. Also remove: Neal Norwitz <nnorwitz@gmail.com> parents: 40809 diff changeset	1629 text = text.strip()
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1630 if not text:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1631 return
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1632 self._doctype.append(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1633 n = len(self._doctype)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1634 if n > 2:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1635 type = self._doctype[1]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1636 if type == "PUBLIC" and n == 4:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1637 name, type, pubid, system = self._doctype
77963 5c1efcd53b8b Minor refactoring in xml.etree.ElementTree doctype parser. Florent Xicluna <florent.xicluna@gmail.com> parents: 77434 diff changeset	1638 if pubid:
5c1efcd53b8b Minor refactoring in xml.etree.ElementTree doctype parser. Florent Xicluna <florent.xicluna@gmail.com> parents: 77434 diff changeset	1639 pubid = pubid[1:-1]
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1640 elif type == "SYSTEM" and n == 3:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1641 name, type, system = self._doctype
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1642 pubid = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1643 else:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1644 return
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1645 if hasattr(self.target, "doctype"):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1646 self.target.doctype(name, pubid, system[1:-1])
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1647 elif self.doctype != self._XMLParser__doctype:
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1648 # warn about deprecated call
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1649 self._XMLParser__doctype(name, pubid, system[1:-1])
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1650 self.doctype(name, pubid, system[1:-1])
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1651 self._doctype = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1652
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1653 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1654 # (Deprecated) Handles a doctype declaration.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1655 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1656 # @param name Doctype name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1657 # @param pubid Public identifier.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1658 # @param system System identifier.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1659
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1660 def doctype(self, name, pubid, system):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1661 """This method of XMLParser is deprecated."""
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1662 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1663 "This method of XMLParser is deprecated. Define doctype() "
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1664 "method on the TreeBuilder target.",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1665 DeprecationWarning,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1666 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1667
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1668 # sentinel, if doctype is redefined in a subclass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1669 __doctype = doctype
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1670
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1671 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1672 # Feeds data to the parser.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1673 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1674 # @param data Encoded data.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1675
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1676 def feed(self, data):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1677 try:
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1678 self.parser.Parse(data, 0)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1679 except self._error as v:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1680 self._raiseerror(v)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1681
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1682 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1683 # Finishes feeding data to the parser.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1684 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1685 # @return An element structure.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1686 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1687
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1688 def close(self):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1689 try:
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1690 self.parser.Parse("", 1) # end of data
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1691 except self._error as v:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1692 self._raiseerror(v)
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1693 try:
75416 09b19d06590e Flatten nested try ... finally, try ... except. Florent Xicluna <florent.xicluna@gmail.com> parents: 75411 diff changeset	1694 close_handler = self.target.close
09b19d06590e Flatten nested try ... finally, try ... except. Florent Xicluna <florent.xicluna@gmail.com> parents: 75411 diff changeset	1695 except AttributeError:
09b19d06590e Flatten nested try ... finally, try ... except. Florent Xicluna <florent.xicluna@gmail.com> parents: 75411 diff changeset	1696 pass
09b19d06590e Flatten nested try ... finally, try ... except. Florent Xicluna <florent.xicluna@gmail.com> parents: 75411 diff changeset	1697 else:
09b19d06590e Flatten nested try ... finally, try ... except. Florent Xicluna <florent.xicluna@gmail.com> parents: 75411 diff changeset	1698 return close_handler()
75411 47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1699 finally:
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1700 # get rid of circular references
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1701 del self.parser, self._parser
47016103185f Issue #14007: accept incomplete TreeBuilder objects (missing start/end/data/close) for the Python implementation as well. Add disabled tests for the doctype() method. Florent Xicluna <florent.xicluna@gmail.com> parents: 75379 diff changeset	1702 del self.target, self._target
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1703
74903 65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1704
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1705 # Import the C accelerators
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1706 try:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1707 # Element, SubElement, ParseError, TreeBuilder, XMLParser
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1708 from _elementtree import *
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1709 except ImportError:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1710 pass
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1711 else:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1712 # Overwrite 'ElementTree.parse' and 'iterparse' to use the C XMLParser
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1713
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1714 class ElementTree(ElementTree):
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1715 def parse(self, source, parser=None):
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1716 close_source = False
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1717 if not hasattr(source, 'read'):
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1718 source = open(source, 'rb')
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1719 close_source = True
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1720 try:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1721 if parser is not None:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1722 while True:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1723 data = source.read(65536)
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1724 if not data:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1725 break
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1726 parser.feed(data)
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1727 self._root = parser.close()
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1728 else:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1729 parser = XMLParser()
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1730 self._root = parser._parse(source)
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1731 return self._root
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1732 finally:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1733 if close_source:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1734 source.close()
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1735
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1736 class iterparse:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1737 root = None
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1738 def __init__(self, file, events=None):
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1739 self._close_file = False
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1740 if not hasattr(file, 'read'):
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1741 file = open(file, 'rb')
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1742 self._close_file = True
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1743 self._file = file
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1744 self._events = []
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1745 self._index = 0
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1746 self._error = None
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1747 self.root = self._root = None
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1748 b = TreeBuilder()
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1749 self._parser = XMLParser(b)
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1750 self._parser._setevents(self._events, events)
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1751
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1752 def __next__(self):
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1753 while True:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1754 try:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1755 item = self._events[self._index]
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1756 self._index += 1
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1757 return item
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1758 except IndexError:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1759 pass
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1760 if self._error:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1761 e = self._error
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1762 self._error = None
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1763 raise e
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1764 if self._parser is None:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1765 self.root = self._root
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1766 if self._close_file:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1767 self._file.close()
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1768 raise StopIteration
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1769 # load event buffer
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1770 del self._events[:]
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1771 self._index = 0
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1772 data = self._file.read(16384)
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1773 if data:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1774 try:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1775 self._parser.feed(data)
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1776 except SyntaxError as exc:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1777 self._error = exc
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1778 else:
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1779 self._root = self._parser.close()
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1780 self._parser = None
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1781
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1782 def __iter__(self):
65fc79fb4eb2 Issue #13988: cElementTree is deprecated and the _elementtree accelerator is automatically used whenever available. Florent Xicluna <florent.xicluna@gmail.com> parents: 73291 diff changeset	1783 return self
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1784
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1785 # compatibility
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1786 XMLTreeBuilder = XMLParser
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1787
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1788 # workaround circular import.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1789 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1790 from ElementC14N import _serialize_c14n
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1791 _serialize["c14n"] = _serialize_c14n
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1792 except ImportError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1793 pass

Mercurial > cpython-lru_cache-weakref

annotate Lib/xml/etree/ElementTree.py @ 79691:05c8928362ee