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

annotate Lib/xml/etree/ElementTree.py @ 78069:a8aa77458e12 3.2

Add c_size_t and c_ssize_t to the ctypes summary table.

author	Antoine Pitrou <solipsis@pitrou.net>
date	Thu, 12 Jul 2012 20:31:50 +0200
parents	23ffaf975267
children	17c528cff63f 65fc79fb4eb2

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",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	71 "XML",
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	72 "XMLParser", "XMLTreeBuilder",
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	73 ]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	74
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	75 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	76
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	77 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	78 # 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	79 # 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	80 # 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	81 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	82 # 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	83 # <ul>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	84 # <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	85 # 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	86 # <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	87 # <li>a <i>text</i> string.</li>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	88 # <li>an optional <i>tail</i> string.</li>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	89 # <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	90 # </ul>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	91 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	92 # 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	93 # or the {@link #SubElement} factory function.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	94 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	95 # 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	96 # structure, and convert it from and to XML.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	97 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	98
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	99 import sys
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	100 import re
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	101 import warnings
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	102
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	103
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	104 class _SimpleElementPath:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	105 # emulate pre-1.2 find/findtext/findall behaviour
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	106 def find(self, element, tag, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	107 for elem in element:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	108 if elem.tag == tag:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	109 return elem
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	110 return None
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	111 def findtext(self, element, tag, 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	112 elem = self.find(element, tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	113 if elem is None:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	114 return default
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	115 return elem.text or ""
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	116 def iterfind(self, element, tag, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	117 if tag[:3] == ".//":
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	118 for elem in element.iter(tag[3:]):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	119 yield elem
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	120 for elem in element:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	121 if elem.tag == tag:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	122 yield elem
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	123 def findall(self, element, tag, namespaces=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	124 return list(self.iterfind(element, tag, namespaces))
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	125
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	126 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	127 from . import ElementPath
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	128 except ImportError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	129 ElementPath = _SimpleElementPath()
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	130
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	131 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	132 # 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	133 # <p>
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	134 # 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	135 # 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	136 # 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	137
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	138 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	139 pass
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 # --------------------------------------------------------------------
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	142
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	143 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	144 # 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	145 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	146 # @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	147 # @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	148 # @defreturn flag
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	149
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	150 def iselement(element):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	151 # FIXME: not sure about this; might be a better idea to look
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	152 # for tag/attrib/text attributes
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	153 return isinstance(element, Element) or hasattr(element, "tag")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	154
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	155 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	156 # 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	157 # 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	158 # <p>
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	159 # 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	160 # 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	161 # 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	162 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	163 # @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	164 # @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	165 # @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	166 # @see Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	167 # @see SubElement
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	168 # @see Comment
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	169 # @see ProcessingInstruction
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	170
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	171 class Element:
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	172 # <tag attrib>text<child/>...</tag>tail
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	173
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 # (Attribute) Element tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	176
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	177 tag = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	178
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	179 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	180 # (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	181 # {@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	182 # {@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	183 # {@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	184 # {@link #Element.items} to access
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	185 # element attributes.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	186
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	187 attrib = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	188
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	189 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	190 # (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	191 # 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	192 # 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	193 # the parser.
39442 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 text = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	196
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 # (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	199 # 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	200 # 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	201 # 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	202
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	203 tail = None # text after end tag, if any
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	204
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	205 # constructor
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	206
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	207 def __init__(self, tag, attrib={}, **extra):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	208 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	209 attrib.update(extra)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	210 self.tag = tag
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	211 self.attrib = attrib
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	212 self._children = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	213
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	214 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	215 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	216
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	217 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	218 # 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	219 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	220 # @param tag Element tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	221 # @param attrib Element attributes, given as a dictionary.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	222 # @return A new element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	223
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	224 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	225 return self.__class__(tag, attrib)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	226
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	227 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	228 # (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	229 # 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	230 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	231 # @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	232
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	233 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	234 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	235 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	236 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	237 elem[:] = self
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	238 return elem
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	239
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	240 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	241 # 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	242 # 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	243 # 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	244 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	245 # @return The number of subelements.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	246
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	247 def __len__(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	248 return len(self._children)
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 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	251 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	252 "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	253 "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	254 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	255 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	256 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	257
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	258 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	259 # Returns the given subelement, by index.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	260 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	261 # @param index What subelement to return.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	262 # @return The given subelement.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	263 # @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	264
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	265 def __getitem__(self, index):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	266 return self._children[index]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	267
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	268 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	269 # Replaces the given subelement, by index.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	270 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	271 # @param index What subelement to replace.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	272 # @param element The new element value.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	273 # @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	274
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	275 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	276 # 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	277 # 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	278 # 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	279 # else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	280 # assert iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	281 self._children[index] = element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	282
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	283 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	284 # Deletes the given subelement, by index.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	285 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	286 # @param index What subelement to delete.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	287 # @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	288
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	289 def __delitem__(self, index):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	290 del self._children[index]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	291
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	292 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	293 # 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	294 # 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	295 # 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	296 # the end tag for this element.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	297 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	298 # @param element The element to add.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	299
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	300 def append(self, element):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	301 # assert iselement(element)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	302 self._children.append(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	303
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	304 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	305 # Appends subelements from a sequence.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	306 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	307 # @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	308 # @since 1.3
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	309
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	310 def extend(self, elements):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	311 # for element in elements:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	312 # assert iselement(element)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	313 self._children.extend(elements)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	314
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	315 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	316 # 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	317 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	318 # @param index Where to insert the new subelement.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	319
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	320 def insert(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	321 # assert iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	322 self._children.insert(index, element)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	323
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	324 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	325 # 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	326 # 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	327 # 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	328 # 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	329 # 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	330 # element.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	331 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	332 # @param element What element to remove.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	333 # @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	334
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	335 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	336 # assert iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	337 self._children.remove(element)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	338
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	339 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	340 # (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	341 # in document order.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	342 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	343 # @return A list of subelements.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	344 # @defreturn list of Element instances
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	345
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	346 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	347 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	348 "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	349 "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	350 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	351 )
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	352 return self._children
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	353
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 # 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	356 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	357 # @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	358 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	359 # @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	360 # @defreturn Element or None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	361
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	362 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	363 return ElementPath.find(self, path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	364
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	365 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	366 # 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	367 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	368 # @param path What element to look for.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	369 # @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	370 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	371 # @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	372 # 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	373 # 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	374 # empty string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	375 # @defreturn string
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	376
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	377 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	378 return ElementPath.findtext(self, path, default, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	379
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	380 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	381 # 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	382 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	383 # @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	384 # @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	385 # @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	386 # in document order.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	387 # @defreturn list of Element instances
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	388
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	389 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	390 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	391
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	392 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	393 # 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	394 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	395 # @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	396 # @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	397 # @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	398 # 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	399 # @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	400
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	401 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	402 return ElementPath.iterfind(self, path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	403
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 # 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	406 # 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	407 # to None.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	408
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	409 def clear(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	410 self.attrib.clear()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	411 self._children = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	412 self.text = self.tail = None
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 # 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	416 # 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 look for.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	419 # @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	420 # @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	421 # attribute was not found.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	422 # @defreturn string or None
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 def get(self, key, default=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	425 return self.attrib.get(key, default)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	426
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	427 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	428 # 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	429 # 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	430 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	431 # @param key What attribute to set.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	432 # @param value The attribute value.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	433
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	434 def set(self, key, value):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	435 self.attrib[key] = value
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	436
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	437 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	438 # 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	439 # 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	440 # Equivalent to <b>attrib.keys()</b>.
39442 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 # @return A list of element attribute names.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	443 # @defreturn list of strings
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 def keys(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	446 return self.attrib.keys()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	447
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	448 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	449 # 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	450 # 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	451 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	452 # @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	453 # @defreturn list of (string, string) tuples
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	454
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	455 def items(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	456 return self.attrib.items()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	457
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	458 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	459 # 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	460 # 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	461 # with a matching tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	462 # <p>
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	463 # 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	464 # 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	465 # 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	466 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	467 # @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	468 # @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	469 # @defreturn iterator
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	470
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	471 def iter(self, tag=None):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	472 if tag == "*":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	473 tag = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	474 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	475 yield self
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	476 for e in self._children:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	477 for e in e.iter(tag):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	478 yield e
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	479
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	480 # compatibility
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	481 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	482 # 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	483 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	484 "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	485 "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	486 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	487 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	488 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	489
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	490 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	491 # 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	492 # 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	493 # text.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	494 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	495 # @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	496 # @defreturn iterator
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	497
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	498 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	499 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	500 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	501 return
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	502 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	503 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	504 for e in self:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	505 for s in e.itertext():
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	506 yield s
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	507 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	508 yield e.tail
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	509
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	510 # compatibility
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	511 _Element = _ElementInterface = Element
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	512
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	513 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	514 # 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	515 # appends it to an existing element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	516 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	517 # 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	518 # either 8-bit ASCII strings or Unicode strings.
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 # @param parent The parent element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	521 # @param tag The subelement name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	522 # @param attrib An optional dictionary, containing element attributes.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	523 # @param **extra Additional attributes, given as keyword arguments.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	524 # @return An element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	525 # @defreturn Element
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 def SubElement(parent, tag, attrib={}, **extra):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	528 attrib = attrib.copy()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	529 attrib.update(extra)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	530 element = parent.makeelement(tag, attrib)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	531 parent.append(element)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	532 return element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	533
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	534 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	535 # 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	536 # 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	537 # serializer.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	538 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	539 # 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	540 # string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	541 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	542 # @param text A string containing the comment string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	543 # @return An element instance, representing a comment.
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 Comment(text=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	547 element = Element(Comment)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	548 element.text = text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	549 return element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	550
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	551 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	552 # 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	553 # 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	554 # serializer.
39442 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 # @param target A string containing the PI target.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	557 # @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	558 # @return An element instance, representing a PI.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	559 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	560
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	561 def ProcessingInstruction(target, text=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	562 element = Element(ProcessingInstruction)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	563 element.text = target
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	564 if text:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	565 element.text = element.text + " " + text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	566 return element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	567
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	568 PI = ProcessingInstruction
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	569
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	570 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	571 # 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	572 # order to get proper namespace handling on output.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	573 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	574 # @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	575 # 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	576 # @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	577 # 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	578 # @return An opaque object, representing the QName.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	579
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	580 class QName:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	581 def __init__(self, text_or_uri, tag=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	582 if tag:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	583 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	584 self.text = text_or_uri
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	585 def __str__(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	586 return self.text
66809 c537bd37f508 #10661: give QName a nicer repr. Georg Brandl <georg@python.org> parents: 66099 diff changeset	587 def __repr__(self):
66810 1b659a00570b Guard against rogue tuples. Georg Brandl <georg@python.org> parents: 66809 diff changeset	588 return '<QName %r>' % (self.text,)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	589 def __hash__(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	590 return hash(self.text)
51122 adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	591 def __le__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	592 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	593 return self.text <= other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	594 return self.text <= other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	595 def __lt__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	596 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	597 return self.text < other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	598 return self.text < other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	599 def __ge__(self, other):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	600 if isinstance(other, QName):
51122 adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	601 return self.text >= other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	602 return self.text >= other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	603 def __gt__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	604 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	605 return self.text > other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	606 return self.text > other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	607 def __eq__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	608 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	609 return self.text == other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	610 return self.text == other
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	611 def __ne__(self, other):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	612 if isinstance(other, QName):
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	613 return self.text != other.text
adbd77a90bde Merged revisions 69025 via svnmerge from Mark Dickinson <dickinsm@gmail.com> parents: 42501 diff changeset	614 return self.text != other
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	615
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	616 # --------------------------------------------------------------------
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	617
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	618 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	619 # 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	620 # 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	621 # standard XML.
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 # @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	624 # @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	625 # 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	626
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	627 class ElementTree:
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 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	630 # assert element is None or iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	631 self._root = element # first node
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	632 if file:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	633 self.parse(file)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	634
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 # Gets the root element for this tree.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	637 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	638 # @return An element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	639 # @defreturn Element
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 def getroot(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	642 return self._root
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	643
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	644 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	645 # 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	646 # 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	647 # element. Use with care.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	648 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	649 # @param element An element instance.
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 _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	652 # assert iselement(element)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	653 self._root = element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	654
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	655 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	656 # 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	657 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	658 # @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	659 # 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	660 # @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	661 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	662 # @return The document root element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	663 # @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	664 # @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	665
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	666 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	667 close_source = False
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	668 if not hasattr(source, "read"):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	669 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	670 close_source = True
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	671 try:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	672 if not parser:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	673 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	674 while 1:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	675 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	676 if not data:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	677 break
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	678 parser.feed(data)
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	679 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	680 return self._root
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	681 finally:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	682 if close_source:
cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	683 source.close()
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	684
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	685 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	686 # 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	687 # 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	688 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	689 # @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	690 # @return An iterator.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	691 # @defreturn iterator
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	692
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	693 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	694 # 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	695 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	696
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	697 # compatibility
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	698 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	699 # 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	700 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	701 "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	702 "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	703 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	704 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	705 return list(self.iter(tag))
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	706
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	707 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	708 # Finds the first toplevel element with given tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	709 # Same as getroot().find(path).
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	710 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	711 # @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	712 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	713 # @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	714 # @defreturn Element or None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	715
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	716 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	717 # assert self._root is not None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	718 if path[:1] == "/":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	719 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	720 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	721 "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	722 "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	723 "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	724 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	725 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	726 return self._root.find(path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	727
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	728 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	729 # 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	730 # tag. Same as getroot().findtext(path).
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	731 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	732 # @param path What toplevel element to look for.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	733 # @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	734 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	735 # @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	736 # 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	737 # 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	738 # empty string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	739 # @defreturn string
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	740
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	741 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	742 # assert self._root is not None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	743 if path[:1] == "/":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	744 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	745 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	746 "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	747 "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	748 "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	749 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	750 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	751 return self._root.findtext(path, default, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	752
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	753 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	754 # Finds all toplevel elements with the given tag.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	755 # Same as getroot().findall(path).
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	756 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	757 # @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	758 # @keyparam namespaces Optional namespace prefix map.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	759 # @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	760 # in document order.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	761 # @defreturn list of Element instances
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	762
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	763 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	764 # assert self._root is not None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	765 if path[:1] == "/":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	766 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	767 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	768 "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	769 "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	770 "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	771 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	772 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	773 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	774
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	775 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	776 # 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	777 # 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	778 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	779 # @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	780 # @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	781 # @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	782 # 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	783 # @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	784
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	785 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	786 # 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	787 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	788 path = "." + path
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	789 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	790 "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	791 "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	792 "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	793 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	794 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	795 return self._root.iterfind(path, namespaces)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	796
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	797 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	798 # 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	799 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	800 # @def write(file, **options)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	801 # @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	802 # @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	803 # @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	804 # 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	805 # @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	806 # "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	807 # @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	808 # 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	809 # 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	810
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	811 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	812 # keyword arguments
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	813 encoding=None,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	814 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	815 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	816 method=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	817 # 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	818 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	819 method = "xml"
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	820 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	821 # FIXME: raise an ImportError for c14n if ElementC14N is missing?
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	822 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	823 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	824 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	825 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	826 else:
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	827 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	828 elif encoding == str: # lxml.etree compatibility.
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	829 encoding = "unicode"
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	830 else:
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	831 encoding = encoding.lower()
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	832 if hasattr(file_or_filename, "write"):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	833 file = file_or_filename
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	834 else:
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	835 if encoding != "unicode":
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	836 file = open(file_or_filename, "wb")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	837 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	838 file = open(file_or_filename, "w")
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	839 if encoding != "unicode":
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	840 def write(text):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	841 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	842 return file.write(text.encode(encoding,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	843 "xmlcharrefreplace"))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	844 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	845 _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	846 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	847 write = file.write
63845 57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	848 if method == "xml" and (xml_declaration or
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	849 (xml_declaration is None and
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	850 encoding not in ("utf-8", "us-ascii", "unicode"))):
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	851 declared_encoding = encoding
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	852 if encoding == "unicode":
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	853 # Retrieve the default encoding for the xml declaration
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	854 import locale
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	855 declared_encoding = locale.getpreferredencoding()
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	856 write("<?xml version='1.0' encoding='%s'?>\n" % declared_encoding)
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	857 if method == "text":
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	858 _serialize_text(write, self._root)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	859 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	860 qnames, namespaces = _namespaces(self._root, default_namespace)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	861 serialize = _serialize[method]
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	862 serialize(write, self._root, qnames, namespaces)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	863 if file_or_filename is not file:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	864 file.close()
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	865
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	866 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	867 # 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	868 return self.write(file, method="c14n")
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	869
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	870 # --------------------------------------------------------------------
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	871 # serialization support
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	872
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	873 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	874 # 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	875
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	876 # 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	877 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	878
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	879 # 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	880 namespaces = {}
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	881 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	882 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	883
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	884 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	885 # 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	886 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	887 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	888 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	889 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	890 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	891 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	892 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	893 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	894 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	895 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	896 if prefix:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	897 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	898 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	899 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	900 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	901 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	902 # 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	903 raise ValueError(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	904 "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	905 "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	906 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	907 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	908 except TypeError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	909 _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	910
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	911 # populate qname and namespaces table
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	912 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	913 iterate = elem.iter
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	914 except AttributeError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	915 iterate = elem.getiterator # cET compatibility
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	916 for elem in iterate():
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	917 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	918 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	919 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	920 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	921 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	922 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	923 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	924 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	925 _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	926 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	927 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	928 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	929 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	930 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	931 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	932 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	933 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	934 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	935 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	936 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	937
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	938 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	939 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	940 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	941 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	942 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	943 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	944 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	945 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	946 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	947 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	948 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	949 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	950 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	951 _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	952 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	953 write("<" + tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	954 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	955 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	956 if namespaces:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	957 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	958 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	959 if k:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	960 k = ":" + k
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	961 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	962 k,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	963 _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	964 ))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	965 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	966 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	967 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	968 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	969 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	970 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	971 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	972 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	973 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	974 write(">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	975 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	976 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	977 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	978 _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	979 write("</" + tag + ">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	980 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	981 write(" />")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	982 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	983 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	984
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	985 HTML_EMPTY = ("area", "base", "basefont", "br", "col", "frame", "hr",
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	986 "img", "input", "isindex", "link", "meta" "param")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	987
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	988 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	989 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	990 except NameError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	991 pass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	992
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	993 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	994 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	995 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	996 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	997 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	998 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	999 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	1000 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1001 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	1002 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	1003 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1004 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	1005 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	1006 _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	1007 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1008 write("<" + tag)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1009 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	1010 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	1011 if namespaces:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1012 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	1013 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	1014 if k:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1015 k = ":" + k
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1016 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	1017 k,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1018 _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	1019 ))
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1020 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	1021 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	1022 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	1023 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	1024 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	1025 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1026 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	1027 # 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	1028 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	1029 write(">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1030 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	1031 if text:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1032 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	1033 write(text)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1034 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1035 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	1036 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	1037 _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	1038 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	1039 write("</" + tag + ">")
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1040 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	1041 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	1042
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1043 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	1044 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	1045 write(part)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1046 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	1047 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	1048
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1049 _serialize = {
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1050 "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	1051 "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	1052 "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	1053 # 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	1054 # "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	1055 }
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1056
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1057 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1058 # 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	1059 # 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	1060 # will be removed.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1061 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1062 # @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	1063 # @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	1064 # 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	1065 # @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	1066 # invalid.
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1067
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1068 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	1069 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	1070 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	1071 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	1072 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	1073 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	1074 _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	1075
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1076 _namespace_map = {
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1077 # "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	1078 "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	1079 "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	1080 "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	1081 "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	1082 # xml schema
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1083 "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	1084 "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	1085 # dublin core
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1086 "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	1087 }
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1088
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1089 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	1090 raise TypeError(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1091 "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	1092 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1093
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1094 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	1095 # 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	1096 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1097 # 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	1098 # 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	1099 # 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	1100 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	1101 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	1102 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	1103 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	1104 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	1105 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	1106 return text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1107 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	1108 _raise_serialization_error(text)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1109
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1110 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	1111 # 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	1112 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1113 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	1114 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	1115 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	1116 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	1117 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	1118 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	1119 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	1120 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	1121 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	1122 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	1123 return text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1124 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	1125 _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	1126
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1127 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	1128 # 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	1129 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1130 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	1131 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	1132 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	1133 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	1134 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	1135 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	1136 return text
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1137 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	1138 _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	1139
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
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1142 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1143 # 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	1144 # 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	1145 # 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	1146 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1147 # @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	1148 # @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	1149 # 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	1150 # @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	1151 # "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	1152 # @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	1153 # @defreturn string
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 def tostring(element, encoding=None, method=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1156 class dummy:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1157 pass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1158 data = []
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1159 file = dummy()
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1160 file.write = data.append
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1161 ElementTree(element).write(file, encoding, method=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	1162 if encoding in (str, "unicode"):
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1163 return "".join(data)
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1164 else:
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1165 return b"".join(data)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1166
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1167 ##
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1168 # 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	1169 # subelements. If encoding is False, the string is returned as a
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1170 # sequence of string fragments; otherwise it is a sequence of
57e631f088d7 Issue #8047: Fix the xml.etree serializer to return bytes by default. Florent Xicluna <florent.xicluna@gmail.com> parents: 59601 diff changeset	1171 # bytestrings.
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1172 #
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1173 # @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	1174 # @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	1175 # 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	1176 # @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	1177 # "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	1178 # @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	1179 # @defreturn sequence
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1180 # @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	1181
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1182 def tostringlist(element, encoding=None, method=None):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1183 class dummy:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1184 pass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1185 data = []
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1186 file = dummy()
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1187 file.write = data.append
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1188 ElementTree(element).write(file, encoding, method=method)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1189 # FIXME: merge small fragments into larger parts
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1190 return data
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1191
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1192 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1193 # 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	1194 # function should be used for debugging only.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1195 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1196 # 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	1197 # 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	1198 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1199 # @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	1200
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1201 def dump(elem):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1202 # debugging
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1203 if not isinstance(elem, ElementTree):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1204 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	1205 elem.write(sys.stdout, encoding="unicode")
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1206 tail = elem.getroot().tail
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1207 if not tail or tail[-1] != "\n":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1208 sys.stdout.write("\n")
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1209
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1210 # --------------------------------------------------------------------
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1211 # parsing
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1212
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1213 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1214 # Parses an XML document into an element tree.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1215 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1216 # @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	1217 # @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	1218 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1219 # @return An ElementTree instance
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1220
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1221 def parse(source, parser=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1222 tree = ElementTree()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1223 tree.parse(source, parser)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1224 return tree
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1225
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1226 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1227 # 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	1228 # what's going on to the user.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1229 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1230 # @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	1231 # @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	1232 # 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	1233 # @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	1234 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1235 # @return A (event, elem) iterator.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1236
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1237 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	1238 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	1239 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	1240 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	1241 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	1242 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	1243 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	1244 return _IterParseIterator(source, events, parser, close_source)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1245
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1246 class _IterParseIterator:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1247
65707 cff78ffb932a Issue #10093: ResourceWarnings are now issued when files and sockets are Antoine Pitrou <solipsis@pitrou.net> parents: 63845 diff changeset	1248 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	1249 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	1250 self._close_file = close_source
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1251 self._events = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1252 self._index = 0
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1253 self._error = None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1254 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	1255 self._parser = parser
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1256 # wire up the parser for event reporting
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1257 parser = self._parser._parser
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1258 append = self._events.append
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1259 if events is None:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1260 events = ["end"]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1261 for event in events:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1262 if event == "start":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1263 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1264 parser.ordered_attributes = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1265 parser.specified_attributes = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1266 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	1267 start=self._parser._start_list):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1268 append((event, start(tag, attrib_in)))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1269 parser.StartElementHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1270 except AttributeError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1271 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	1272 start=self._parser._start):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1273 append((event, start(tag, attrib_in)))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1274 parser.StartElementHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1275 elif event == "end":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1276 def handler(tag, event=event, append=append,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1277 end=self._parser._end):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1278 append((event, end(tag)))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1279 parser.EndElementHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1280 elif event == "start-ns":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1281 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	1282 append((event, (prefix or "", uri or "")))
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1283 parser.StartNamespaceDeclHandler = handler
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1284 elif event == "end-ns":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1285 def handler(prefix, event=event, append=append):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1286 append((event, None))
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1287 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	1288 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1289 raise ValueError("unknown event %r" % event)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1290
41501 0c5019afc55b PEP 3114: rename .next() to .__next__() and add next() builtin. Georg Brandl <georg@python.org> parents: 41480 diff changeset	1291 def __next__(self):
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1292 while 1:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1293 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1294 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	1295 self._index += 1
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1296 return item
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1297 except IndexError:
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1298 pass
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1299 if self._error:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1300 e = self._error
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1301 self._error = None
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1302 raise e
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1303 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	1304 self.root = self._root
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1305 if self._close_file:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1306 self._file.close()
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1307 raise StopIteration
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1308 # load event buffer
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1309 del self._events[:]
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1310 self._index = 0
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1311 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	1312 if data:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1313 try:
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1314 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	1315 except SyntaxError as exc:
23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1316 self._error = exc
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1317 else:
73291 23ffaf975267 Closes #2892: preserve iterparse events in case of SyntaxError. Florent Xicluna <florent.xicluna@gmail.com> parents: 67170 diff changeset	1318 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	1319 self._parser = None
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1320
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1321 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	1322 return self
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1323
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1324 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1325 # 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	1326 # 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	1327 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1328 # @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	1329 # @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	1330 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1331 # @return An Element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1332 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1333
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1334 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	1335 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	1336 parser = XMLParser(target=TreeBuilder())
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1337 parser.feed(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1338 return parser.close()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1339
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1340 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1341 # 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	1342 # 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	1343 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1344 # @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	1345 # @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	1346 # standard {@link XMLParser} parser is used.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1347 # @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	1348 # @defreturn (Element, dictionary)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1349
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1350 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	1351 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	1352 parser = XMLParser(target=TreeBuilder())
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1353 parser.feed(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1354 tree = parser.close()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1355 ids = {}
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1356 for elem in tree.iter():
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1357 id = elem.get("id")
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1358 if id:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1359 ids[id] = elem
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1360 return tree, ids
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1361
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 # 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	1364 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1365 # @def fromstring(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1366 # @param source A string containing XML data.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1367 # @return An Element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1368 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1369
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1370 fromstring = XML
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1371
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1372 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1373 # 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	1374 #
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1375 # @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	1376 # @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	1377 # 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	1378 # @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	1379 # @defreturn Element
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1380 # @since 1.3
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1381
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1382 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	1383 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	1384 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	1385 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	1386 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	1387 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	1388
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1389 # --------------------------------------------------------------------
39442 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 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1392 # 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	1393 # 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	1394 # #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	1395 # <p>
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1396 # 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	1397 # 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	1398 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1399 # @param element_factory Optional element factory. This factory
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1400 # 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	1401
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1402 class TreeBuilder:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1403
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1404 def __init__(self, element_factory=None):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1405 self._data = [] # data collector
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1406 self._elem = [] # element stack
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1407 self._last = None # last element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1408 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	1409 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	1410 element_factory = Element
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1411 self._factory = element_factory
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1412
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1413 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1414 # 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	1415 # element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1416 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1417 # @return An Element instance.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1418 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1419
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1420 def close(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1421 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	1422 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	1423 return self._last
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1424
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1425 def _flush(self):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1426 if self._data:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1427 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	1428 text = "".join(self._data)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1429 if self._tail:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1430 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	1431 self._last.tail = text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1432 else:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1433 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	1434 self._last.text = text
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1435 self._data = []
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1436
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1437 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1438 # Adds text to the current element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1439 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1440 # @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	1441 # containing ASCII text, or a Unicode string.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1442
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1443 def data(self, data):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1444 self._data.append(data)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1445
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1446 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1447 # Opens a new element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1448 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1449 # @param tag The element name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1450 # @param attrib A dictionary containing element attributes.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1451 # @return The opened element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1452 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1453
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1454 def start(self, tag, attrs):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1455 self._flush()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1456 self._last = elem = self._factory(tag, attrs)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1457 if self._elem:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1458 self._elem[-1].append(elem)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1459 self._elem.append(elem)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1460 self._tail = 0
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1461 return elem
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1462
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1463 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1464 # Closes the current element.
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 # @param tag The element name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1467 # @return The closed element.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1468 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1469
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1470 def end(self, tag):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1471 self._flush()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1472 self._last = self._elem.pop()
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1473 assert self._last.tag == tag,\
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1474 "end tag mismatch (expected %s, got %s)" % (
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1475 self._last.tag, tag)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1476 self._tail = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1477 return self._last
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1478
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1479 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1480 # 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	1481 # <b>expat</b> parser.
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 # @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	1484 # instance of the standard {@link #TreeBuilder} class.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1485 # @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	1486 # 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	1487 # @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	1488 # the encoding specified in the XML file.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1489 # @see #ElementTree
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1490 # @see #TreeBuilder
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1491
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1492 class XMLParser:
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1493
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1494 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	1495 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1496 from xml.parsers import expat
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1497 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	1498 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1499 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	1500 except ImportError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1501 raise ImportError(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1502 "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	1503 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1504 parser = expat.ParserCreate(encoding, "}")
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1505 if target is None:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1506 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	1507 # 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	1508 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	1509 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	1510 self._error = expat.error
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1511 self._names = {} # name memo cache
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1512 # callbacks
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1513 parser.DefaultHandlerExpand = self._default
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1514 parser.StartElementHandler = self._start
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1515 parser.EndElementHandler = self._end
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1516 parser.CharacterDataHandler = 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	1517 # optional callbacks
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1518 parser.CommentHandler = self._comment
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1519 parser.ProcessingInstructionHandler = self._pi
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1520 # let expat do the buffering, if supported
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1521 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1522 self._parser.buffer_text = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1523 except AttributeError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1524 pass
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1525 # use new-style attribute handling, if supported
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1526 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1527 self._parser.ordered_attributes = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1528 self._parser.specified_attributes = 1
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1529 parser.StartElementHandler = self._start_list
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1530 except AttributeError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1531 pass
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1532 self._doctype = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1533 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	1534 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1535 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	1536 except AttributeError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1537 pass # unknown
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1538
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1539 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	1540 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	1541 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	1542 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	1543 raise err
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1544
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1545 def _fixname(self, key):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1546 # 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	1547 try:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1548 name = self._names[key]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1549 except KeyError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1550 name = key
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1551 if "}" in name:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1552 name = "{" + name
42388 d3471ef6fe38 Patch #1762412: Fix test case for struni branch. Martin v. Löwis <martin@v.loewis.de> parents: 41501 diff changeset	1553 self._names[key] = name
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1554 return name
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1555
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1556 def _start(self, tag, attrib_in):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1557 fixname = self._fixname
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1558 tag = fixname(tag)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1559 attrib = {}
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1560 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	1561 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	1562 return self.target.start(tag, attrib)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1563
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1564 def _start_list(self, tag, attrib_in):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1565 fixname = self._fixname
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1566 tag = fixname(tag)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1567 attrib = {}
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1568 if attrib_in:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1569 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	1570 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	1571 return self.target.start(tag, attrib)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1572
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1573 def _data(self, text):
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1574 return self.target.data(text)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1575
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1576 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	1577 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	1578
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1579 def _comment(self, data):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1580 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1581 comment = self.target.comment
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1582 except AttributeError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1583 pass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1584 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1585 return comment(data)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1586
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1587 def _pi(self, target, data):
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1588 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1589 pi = self.target.pi
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1590 except AttributeError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1591 pass
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1592 else:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1593 return pi(target, data)
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1594
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1595 def _default(self, text):
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1596 prefix = text[:1]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1597 if prefix == "&":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1598 # deal with undefined entities
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1599 try:
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1600 self.target.data(self.entity[text[1:-1]])
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1601 except KeyError:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1602 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	1603 err = expat.error(
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1604 "undefined entity %s: line %d, column %d" %
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1605 (text, self._parser.ErrorLineNumber,
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1606 self._parser.ErrorColumnNumber)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1607 )
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1608 err.code = 11 # XML_ERROR_UNDEFINED_ENTITY
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1609 err.lineno = self._parser.ErrorLineNumber
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1610 err.offset = self._parser.ErrorColumnNumber
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1611 raise err
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1612 elif prefix == "<" and text[:9] == "<!DOCTYPE":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1613 self._doctype = [] # inside a doctype declaration
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1614 elif self._doctype is not None:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1615 # parse doctype contents
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1616 if prefix == ">":
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1617 self._doctype = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1618 return
41480 99027c2b3fd2 Remove functions in string module that are also string methods. Also remove: Neal Norwitz <nnorwitz@gmail.com> parents: 40809 diff changeset	1619 text = text.strip()
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1620 if not text:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1621 return
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1622 self._doctype.append(text)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1623 n = len(self._doctype)
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1624 if n > 2:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1625 type = self._doctype[1]
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1626 if type == "PUBLIC" and n == 4:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1627 name, type, pubid, system = self._doctype
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1628 elif type == "SYSTEM" and n == 3:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1629 name, type, system = self._doctype
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1630 pubid = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1631 else:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1632 return
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1633 if pubid:
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1634 pubid = pubid[1:-1]
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1635 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	1636 self.target.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	1637 elif self.doctype is not self._XMLParser__doctype:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1638 # 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	1639 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	1640 self.doctype(name, pubid, system[1:-1])
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1641 self._doctype = None
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1642
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1643 ##
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1644 # (Deprecated) Handles a doctype declaration.
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1645 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1646 # @param name Doctype name.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1647 # @param pubid Public identifier.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1648 # @param system System identifier.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1649
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1650 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	1651 """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	1652 warnings.warn(
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1653 "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	1654 "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	1655 DeprecationWarning,
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1656 )
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1657
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1658 # 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	1659 __doctype = doctype
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1660
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1661 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1662 # Feeds data to the parser.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1663 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1664 # @param data Encoded data.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1665
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1666 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	1667 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1668 self._parser.Parse(data, 0)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1669 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	1670 self._raiseerror(v)
39442 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 ##
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1673 # Finishes feeding data to the parser.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1674 #
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1675 # @return An element structure.
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1676 # @defreturn Element
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1677
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1678 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	1679 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1680 self._parser.Parse("", 1) # end of data
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1681 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	1682 self._raiseerror(v)
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1683 tree = self.target.close()
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1684 del self.target, self._parser # get rid of circular references
39442 654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1685 return tree
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1686
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from Thomas Wouters <thomas@python.org> parents: diff changeset	1687 # compatibility
59601 7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1688 XMLTreeBuilder = XMLParser
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1689
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1690 # 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	1691 try:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1692 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	1693 _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	1694 except ImportError:
7a18c2762886 Merged revisions 78838-78839,78917,78919,78934,78937 via svnmerge from Florent Xicluna <florent.xicluna@gmail.com> parents: 58849 diff changeset	1695 pass

Mercurial > cpython-lru_cache-weakref

annotate Lib/xml/etree/ElementTree.py @ 78069:a8aa77458e12 3.2