mirror of https://github.com/python/cpython
4410 lines
164 KiB
Python
4410 lines
164 KiB
Python
# IMPORTANT: the same tests are run from "test_xml_etree_c" in order
|
|
# to ensure consistency between the C implementation and the Python
|
|
# implementation.
|
|
#
|
|
# For this purpose, the module-level "ET" symbol is temporarily
|
|
# monkey-patched when running the "test_xml_etree_c" test suite.
|
|
|
|
import copy
|
|
import functools
|
|
import html
|
|
import io
|
|
import itertools
|
|
import operator
|
|
import os
|
|
import pickle
|
|
import pyexpat
|
|
import sys
|
|
import textwrap
|
|
import types
|
|
import unittest
|
|
import warnings
|
|
import weakref
|
|
|
|
from functools import partial
|
|
from itertools import product, islice
|
|
from test import support
|
|
from test.support import os_helper
|
|
from test.support import warnings_helper
|
|
from test.support import findfile, gc_collect, swap_attr, swap_item
|
|
from test.support.import_helper import import_fresh_module
|
|
from test.support.os_helper import TESTFN
|
|
|
|
|
|
# pyET is the pure-Python implementation.
|
|
#
|
|
# ET is pyET in test_xml_etree and is the C accelerated version in
|
|
# test_xml_etree_c.
|
|
pyET = None
|
|
ET = None
|
|
|
|
SIMPLE_XMLFILE = findfile("simple.xml", subdir="xmltestdata")
|
|
try:
|
|
SIMPLE_XMLFILE.encode("utf-8")
|
|
except UnicodeEncodeError:
|
|
raise unittest.SkipTest("filename is not encodable to utf8")
|
|
SIMPLE_NS_XMLFILE = findfile("simple-ns.xml", subdir="xmltestdata")
|
|
UTF8_BUG_XMLFILE = findfile("expat224_utf8_bug.xml", subdir="xmltestdata")
|
|
|
|
SAMPLE_XML = """\
|
|
<body>
|
|
<tag class='a'>text</tag>
|
|
<tag class='b' />
|
|
<section>
|
|
<tag class='b' id='inner'>subtext</tag>
|
|
</section>
|
|
</body>
|
|
"""
|
|
|
|
SAMPLE_SECTION = """\
|
|
<section>
|
|
<tag class='b' id='inner'>subtext</tag>
|
|
<nexttag />
|
|
<nextsection>
|
|
<tag />
|
|
</nextsection>
|
|
</section>
|
|
"""
|
|
|
|
SAMPLE_XML_NS = """
|
|
<body xmlns="http://effbot.org/ns">
|
|
<tag>text</tag>
|
|
<tag />
|
|
<section>
|
|
<tag>subtext</tag>
|
|
</section>
|
|
</body>
|
|
"""
|
|
|
|
SAMPLE_XML_NS_ELEMS = """
|
|
<root>
|
|
<h:table xmlns:h="hello">
|
|
<h:tr>
|
|
<h:td>Apples</h:td>
|
|
<h:td>Bananas</h:td>
|
|
</h:tr>
|
|
</h:table>
|
|
|
|
<f:table xmlns:f="foo">
|
|
<f:name>African Coffee Table</f:name>
|
|
<f:width>80</f:width>
|
|
<f:length>120</f:length>
|
|
</f:table>
|
|
</root>
|
|
"""
|
|
|
|
ENTITY_XML = """\
|
|
<!DOCTYPE points [
|
|
<!ENTITY % user-entities SYSTEM 'user-entities.xml'>
|
|
%user-entities;
|
|
]>
|
|
<document>&entity;</document>
|
|
"""
|
|
|
|
EXTERNAL_ENTITY_XML = """\
|
|
<!DOCTYPE points [
|
|
<!ENTITY entity SYSTEM "file:///non-existing-file.xml">
|
|
]>
|
|
<document>&entity;</document>
|
|
"""
|
|
|
|
ATTLIST_XML = """\
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE Foo [
|
|
<!ELEMENT foo (bar*)>
|
|
<!ELEMENT bar (#PCDATA)*>
|
|
<!ATTLIST bar xml:lang CDATA "eng">
|
|
<!ENTITY qux "quux">
|
|
]>
|
|
<foo>
|
|
<bar>&qux;</bar>
|
|
</foo>
|
|
"""
|
|
|
|
def checkwarnings(*filters, quiet=False):
|
|
def decorator(test):
|
|
def newtest(*args, **kwargs):
|
|
with warnings_helper.check_warnings(*filters, quiet=quiet):
|
|
test(*args, **kwargs)
|
|
functools.update_wrapper(newtest, test)
|
|
return newtest
|
|
return decorator
|
|
|
|
def convlinesep(data):
|
|
return data.replace(b'\n', os.linesep.encode())
|
|
|
|
|
|
class ModuleTest(unittest.TestCase):
|
|
def test_sanity(self):
|
|
# Import sanity.
|
|
|
|
from xml.etree import ElementTree
|
|
from xml.etree import ElementInclude
|
|
from xml.etree import ElementPath
|
|
|
|
def test_all(self):
|
|
names = ("xml.etree.ElementTree", "_elementtree")
|
|
support.check__all__(self, ET, names, not_exported=("HTML_EMPTY",))
|
|
|
|
|
|
def serialize(elem, to_string=True, encoding='unicode', **options):
|
|
if encoding != 'unicode':
|
|
file = io.BytesIO()
|
|
else:
|
|
file = io.StringIO()
|
|
tree = ET.ElementTree(elem)
|
|
tree.write(file, encoding=encoding, **options)
|
|
if to_string:
|
|
return file.getvalue()
|
|
else:
|
|
file.seek(0)
|
|
return file
|
|
|
|
def summarize_list(seq):
|
|
return [elem.tag for elem in seq]
|
|
|
|
|
|
class ElementTestCase:
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
cls.modules = {pyET, ET}
|
|
|
|
def pickleRoundTrip(self, obj, name, dumper, loader, proto):
|
|
try:
|
|
with swap_item(sys.modules, name, dumper):
|
|
temp = pickle.dumps(obj, proto)
|
|
with swap_item(sys.modules, name, loader):
|
|
result = pickle.loads(temp)
|
|
except pickle.PicklingError as pe:
|
|
# pyET must be second, because pyET may be (equal to) ET.
|
|
human = dict([(ET, "cET"), (pyET, "pyET")])
|
|
raise support.TestFailed("Failed to round-trip %r from %r to %r"
|
|
% (obj,
|
|
human.get(dumper, dumper),
|
|
human.get(loader, loader))) from pe
|
|
return result
|
|
|
|
def assertEqualElements(self, alice, bob):
|
|
self.assertIsInstance(alice, (ET.Element, pyET.Element))
|
|
self.assertIsInstance(bob, (ET.Element, pyET.Element))
|
|
self.assertEqual(len(list(alice)), len(list(bob)))
|
|
for x, y in zip(alice, bob):
|
|
self.assertEqualElements(x, y)
|
|
properties = operator.attrgetter('tag', 'tail', 'text', 'attrib')
|
|
self.assertEqual(properties(alice), properties(bob))
|
|
|
|
# --------------------------------------------------------------------
|
|
# element tree tests
|
|
|
|
class ElementTreeTest(unittest.TestCase):
|
|
|
|
def serialize_check(self, elem, expected):
|
|
self.assertEqual(serialize(elem), expected)
|
|
|
|
def test_interface(self):
|
|
# Test element tree interface.
|
|
|
|
def check_element(element):
|
|
self.assertTrue(ET.iselement(element), msg="not an element")
|
|
direlem = dir(element)
|
|
for attr in 'tag', 'attrib', 'text', 'tail':
|
|
self.assertTrue(hasattr(element, attr),
|
|
msg='no %s member' % attr)
|
|
self.assertIn(attr, direlem,
|
|
msg='no %s visible by dir' % attr)
|
|
|
|
self.assertIsInstance(element.tag, str)
|
|
self.assertIsInstance(element.attrib, dict)
|
|
if element.text is not None:
|
|
self.assertIsInstance(element.text, str)
|
|
if element.tail is not None:
|
|
self.assertIsInstance(element.tail, str)
|
|
for elem in element:
|
|
check_element(elem)
|
|
|
|
element = ET.Element("tag")
|
|
check_element(element)
|
|
tree = ET.ElementTree(element)
|
|
check_element(tree.getroot())
|
|
element = ET.Element("t\xe4g", key="value")
|
|
tree = ET.ElementTree(element)
|
|
self.assertRegex(repr(element), r"^<Element 't\xe4g' at 0x.*>$")
|
|
element = ET.Element("tag", key="value")
|
|
|
|
# Make sure all standard element methods exist.
|
|
|
|
def check_method(method):
|
|
self.assertTrue(hasattr(method, '__call__'),
|
|
msg="%s not callable" % method)
|
|
|
|
check_method(element.append)
|
|
check_method(element.extend)
|
|
check_method(element.insert)
|
|
check_method(element.remove)
|
|
check_method(element.find)
|
|
check_method(element.iterfind)
|
|
check_method(element.findall)
|
|
check_method(element.findtext)
|
|
check_method(element.clear)
|
|
check_method(element.get)
|
|
check_method(element.set)
|
|
check_method(element.keys)
|
|
check_method(element.items)
|
|
check_method(element.iter)
|
|
check_method(element.itertext)
|
|
|
|
# These methods return an iterable. See bug 6472.
|
|
|
|
def check_iter(it):
|
|
check_method(it.__next__)
|
|
|
|
check_iter(element.iterfind("tag"))
|
|
check_iter(element.iterfind("*"))
|
|
check_iter(tree.iterfind("tag"))
|
|
check_iter(tree.iterfind("*"))
|
|
|
|
# These aliases are provided:
|
|
|
|
self.assertEqual(ET.XML, ET.fromstring)
|
|
self.assertEqual(ET.PI, ET.ProcessingInstruction)
|
|
|
|
def test_set_attribute(self):
|
|
element = ET.Element('tag')
|
|
|
|
self.assertEqual(element.tag, 'tag')
|
|
element.tag = 'Tag'
|
|
self.assertEqual(element.tag, 'Tag')
|
|
element.tag = 'TAG'
|
|
self.assertEqual(element.tag, 'TAG')
|
|
|
|
self.assertIsNone(element.text)
|
|
element.text = 'Text'
|
|
self.assertEqual(element.text, 'Text')
|
|
element.text = 'TEXT'
|
|
self.assertEqual(element.text, 'TEXT')
|
|
|
|
self.assertIsNone(element.tail)
|
|
element.tail = 'Tail'
|
|
self.assertEqual(element.tail, 'Tail')
|
|
element.tail = 'TAIL'
|
|
self.assertEqual(element.tail, 'TAIL')
|
|
|
|
self.assertEqual(element.attrib, {})
|
|
element.attrib = {'a': 'b', 'c': 'd'}
|
|
self.assertEqual(element.attrib, {'a': 'b', 'c': 'd'})
|
|
element.attrib = {'A': 'B', 'C': 'D'}
|
|
self.assertEqual(element.attrib, {'A': 'B', 'C': 'D'})
|
|
|
|
def test_simpleops(self):
|
|
# Basic method sanity checks.
|
|
|
|
elem = ET.XML("<body><tag/></body>")
|
|
self.serialize_check(elem, '<body><tag /></body>')
|
|
e = ET.Element("tag2")
|
|
elem.append(e)
|
|
self.serialize_check(elem, '<body><tag /><tag2 /></body>')
|
|
elem.remove(e)
|
|
self.serialize_check(elem, '<body><tag /></body>')
|
|
elem.insert(0, e)
|
|
self.serialize_check(elem, '<body><tag2 /><tag /></body>')
|
|
elem.remove(e)
|
|
elem.extend([e])
|
|
self.serialize_check(elem, '<body><tag /><tag2 /></body>')
|
|
elem.remove(e)
|
|
elem.extend(iter([e]))
|
|
self.serialize_check(elem, '<body><tag /><tag2 /></body>')
|
|
elem.remove(e)
|
|
|
|
element = ET.Element("tag", key="value")
|
|
self.serialize_check(element, '<tag key="value" />') # 1
|
|
subelement = ET.Element("subtag")
|
|
element.append(subelement)
|
|
self.serialize_check(element, '<tag key="value"><subtag /></tag>') # 2
|
|
element.insert(0, subelement)
|
|
self.serialize_check(element,
|
|
'<tag key="value"><subtag /><subtag /></tag>') # 3
|
|
element.remove(subelement)
|
|
self.serialize_check(element, '<tag key="value"><subtag /></tag>') # 4
|
|
element.remove(subelement)
|
|
self.serialize_check(element, '<tag key="value" />') # 5
|
|
with self.assertRaises(ValueError) as cm:
|
|
element.remove(subelement)
|
|
self.assertEqual(str(cm.exception), 'list.remove(x): x not in list')
|
|
self.serialize_check(element, '<tag key="value" />') # 6
|
|
element[0:0] = [subelement, subelement, subelement]
|
|
self.serialize_check(element[1], '<subtag />')
|
|
self.assertEqual(element[1:9], [element[1], element[2]])
|
|
self.assertEqual(element[:9:2], [element[0], element[2]])
|
|
del element[1:2]
|
|
self.serialize_check(element,
|
|
'<tag key="value"><subtag /><subtag /></tag>')
|
|
|
|
def test_cdata(self):
|
|
# Test CDATA handling (etc).
|
|
|
|
self.serialize_check(ET.XML("<tag>hello</tag>"),
|
|
'<tag>hello</tag>')
|
|
self.serialize_check(ET.XML("<tag>hello</tag>"),
|
|
'<tag>hello</tag>')
|
|
self.serialize_check(ET.XML("<tag><![CDATA[hello]]></tag>"),
|
|
'<tag>hello</tag>')
|
|
|
|
def test_file_init(self):
|
|
stringfile = io.BytesIO(SAMPLE_XML.encode("utf-8"))
|
|
tree = ET.ElementTree(file=stringfile)
|
|
self.assertEqual(tree.find("tag").tag, 'tag')
|
|
self.assertEqual(tree.find("section/tag").tag, 'tag')
|
|
|
|
tree = ET.ElementTree(file=SIMPLE_XMLFILE)
|
|
self.assertEqual(tree.find("element").tag, 'element')
|
|
self.assertEqual(tree.find("element/../empty-element").tag,
|
|
'empty-element')
|
|
|
|
def test_path_cache(self):
|
|
# Check that the path cache behaves sanely.
|
|
|
|
from xml.etree import ElementPath
|
|
|
|
elem = ET.XML(SAMPLE_XML)
|
|
ElementPath._cache.clear()
|
|
for i in range(10): ET.ElementTree(elem).find('./'+str(i))
|
|
cache_len_10 = len(ElementPath._cache)
|
|
for i in range(10): ET.ElementTree(elem).find('./'+str(i))
|
|
self.assertEqual(len(ElementPath._cache), cache_len_10)
|
|
for i in range(20): ET.ElementTree(elem).find('./'+str(i))
|
|
self.assertGreater(len(ElementPath._cache), cache_len_10)
|
|
for i in range(600): ET.ElementTree(elem).find('./'+str(i))
|
|
self.assertLess(len(ElementPath._cache), 500)
|
|
|
|
def test_copy(self):
|
|
# Test copy handling (etc).
|
|
|
|
import copy
|
|
e1 = ET.XML("<tag>hello<foo/></tag>")
|
|
e2 = copy.copy(e1)
|
|
e3 = copy.deepcopy(e1)
|
|
e1.find("foo").tag = "bar"
|
|
self.serialize_check(e1, '<tag>hello<bar /></tag>')
|
|
self.serialize_check(e2, '<tag>hello<bar /></tag>')
|
|
self.serialize_check(e3, '<tag>hello<foo /></tag>')
|
|
|
|
def test_attrib(self):
|
|
# Test attribute handling.
|
|
|
|
elem = ET.Element("tag")
|
|
elem.get("key") # 1.1
|
|
self.assertEqual(elem.get("key", "default"), 'default') # 1.2
|
|
|
|
elem.set("key", "value")
|
|
self.assertEqual(elem.get("key"), 'value') # 1.3
|
|
|
|
elem = ET.Element("tag", key="value")
|
|
self.assertEqual(elem.get("key"), 'value') # 2.1
|
|
self.assertEqual(elem.attrib, {'key': 'value'}) # 2.2
|
|
|
|
attrib = {"key": "value"}
|
|
elem = ET.Element("tag", attrib)
|
|
attrib.clear() # check for aliasing issues
|
|
self.assertEqual(elem.get("key"), 'value') # 3.1
|
|
self.assertEqual(elem.attrib, {'key': 'value'}) # 3.2
|
|
|
|
attrib = {"key": "value"}
|
|
elem = ET.Element("tag", **attrib)
|
|
attrib.clear() # check for aliasing issues
|
|
self.assertEqual(elem.get("key"), 'value') # 4.1
|
|
self.assertEqual(elem.attrib, {'key': 'value'}) # 4.2
|
|
|
|
elem = ET.Element("tag", {"key": "other"}, key="value")
|
|
self.assertEqual(elem.get("key"), 'value') # 5.1
|
|
self.assertEqual(elem.attrib, {'key': 'value'}) # 5.2
|
|
|
|
elem = ET.Element('test')
|
|
elem.text = "aa"
|
|
elem.set('testa', 'testval')
|
|
elem.set('testb', 'test2')
|
|
self.assertEqual(ET.tostring(elem),
|
|
b'<test testa="testval" testb="test2">aa</test>')
|
|
self.assertEqual(sorted(elem.keys()), ['testa', 'testb'])
|
|
self.assertEqual(sorted(elem.items()),
|
|
[('testa', 'testval'), ('testb', 'test2')])
|
|
self.assertEqual(elem.attrib['testb'], 'test2')
|
|
elem.attrib['testb'] = 'test1'
|
|
elem.attrib['testc'] = 'test2'
|
|
self.assertEqual(ET.tostring(elem),
|
|
b'<test testa="testval" testb="test1" testc="test2">aa</test>')
|
|
|
|
# Test preserving white space chars in attributes
|
|
elem = ET.Element('test')
|
|
elem.set('a', '\r')
|
|
elem.set('b', '\r\n')
|
|
elem.set('c', '\t\n\r ')
|
|
elem.set('d', '\n\n\r\r\t\t ')
|
|
self.assertEqual(ET.tostring(elem),
|
|
b'<test a=" " b=" " c="	 " d=" 		 " />')
|
|
|
|
def test_makeelement(self):
|
|
# Test makeelement handling.
|
|
|
|
elem = ET.Element("tag")
|
|
attrib = {"key": "value"}
|
|
subelem = elem.makeelement("subtag", attrib)
|
|
self.assertIsNot(subelem.attrib, attrib, msg="attrib aliasing")
|
|
elem.append(subelem)
|
|
self.serialize_check(elem, '<tag><subtag key="value" /></tag>')
|
|
|
|
elem.clear()
|
|
self.serialize_check(elem, '<tag />')
|
|
elem.append(subelem)
|
|
self.serialize_check(elem, '<tag><subtag key="value" /></tag>')
|
|
elem.extend([subelem, subelem])
|
|
self.serialize_check(elem,
|
|
'<tag><subtag key="value" /><subtag key="value" /><subtag key="value" /></tag>')
|
|
elem[:] = [subelem]
|
|
self.serialize_check(elem, '<tag><subtag key="value" /></tag>')
|
|
elem[:] = tuple([subelem])
|
|
self.serialize_check(elem, '<tag><subtag key="value" /></tag>')
|
|
|
|
def test_parsefile(self):
|
|
# Test parsing from file.
|
|
|
|
tree = ET.parse(SIMPLE_XMLFILE)
|
|
stream = io.StringIO()
|
|
tree.write(stream, encoding='unicode')
|
|
self.assertEqual(stream.getvalue(),
|
|
'<root>\n'
|
|
' <element key="value">text</element>\n'
|
|
' <element>text</element>tail\n'
|
|
' <empty-element />\n'
|
|
'</root>')
|
|
tree = ET.parse(SIMPLE_NS_XMLFILE)
|
|
stream = io.StringIO()
|
|
tree.write(stream, encoding='unicode')
|
|
self.assertEqual(stream.getvalue(),
|
|
'<ns0:root xmlns:ns0="namespace">\n'
|
|
' <ns0:element key="value">text</ns0:element>\n'
|
|
' <ns0:element>text</ns0:element>tail\n'
|
|
' <ns0:empty-element />\n'
|
|
'</ns0:root>')
|
|
|
|
with open(SIMPLE_XMLFILE) as f:
|
|
data = f.read()
|
|
|
|
parser = ET.XMLParser()
|
|
self.assertRegex(parser.version, r'^Expat ')
|
|
parser.feed(data)
|
|
self.serialize_check(parser.close(),
|
|
'<root>\n'
|
|
' <element key="value">text</element>\n'
|
|
' <element>text</element>tail\n'
|
|
' <empty-element />\n'
|
|
'</root>')
|
|
|
|
target = ET.TreeBuilder()
|
|
parser = ET.XMLParser(target=target)
|
|
parser.feed(data)
|
|
self.serialize_check(parser.close(),
|
|
'<root>\n'
|
|
' <element key="value">text</element>\n'
|
|
' <element>text</element>tail\n'
|
|
' <empty-element />\n'
|
|
'</root>')
|
|
|
|
def test_parseliteral(self):
|
|
element = ET.XML("<html><body>text</body></html>")
|
|
self.assertEqual(ET.tostring(element, encoding='unicode'),
|
|
'<html><body>text</body></html>')
|
|
element = ET.fromstring("<html><body>text</body></html>")
|
|
self.assertEqual(ET.tostring(element, encoding='unicode'),
|
|
'<html><body>text</body></html>')
|
|
sequence = ["<html><body>", "text</bo", "dy></html>"]
|
|
element = ET.fromstringlist(sequence)
|
|
self.assertEqual(ET.tostring(element),
|
|
b'<html><body>text</body></html>')
|
|
self.assertEqual(b"".join(ET.tostringlist(element)),
|
|
b'<html><body>text</body></html>')
|
|
self.assertEqual(ET.tostring(element, "ascii"),
|
|
b"<?xml version='1.0' encoding='ascii'?>\n"
|
|
b"<html><body>text</body></html>")
|
|
_, ids = ET.XMLID("<html><body>text</body></html>")
|
|
self.assertEqual(len(ids), 0)
|
|
_, ids = ET.XMLID("<html><body id='body'>text</body></html>")
|
|
self.assertEqual(len(ids), 1)
|
|
self.assertEqual(ids["body"].tag, 'body')
|
|
|
|
def test_iterparse(self):
|
|
# Test iterparse interface.
|
|
|
|
iterparse = ET.iterparse
|
|
|
|
context = iterparse(SIMPLE_XMLFILE)
|
|
self.assertIsNone(context.root)
|
|
action, elem = next(context)
|
|
self.assertIsNone(context.root)
|
|
self.assertEqual((action, elem.tag), ('end', 'element'))
|
|
self.assertEqual([(action, elem.tag) for action, elem in context], [
|
|
('end', 'element'),
|
|
('end', 'empty-element'),
|
|
('end', 'root'),
|
|
])
|
|
self.assertEqual(context.root.tag, 'root')
|
|
|
|
context = iterparse(SIMPLE_NS_XMLFILE)
|
|
self.assertEqual([(action, elem.tag) for action, elem in context], [
|
|
('end', '{namespace}element'),
|
|
('end', '{namespace}element'),
|
|
('end', '{namespace}empty-element'),
|
|
('end', '{namespace}root'),
|
|
])
|
|
|
|
with open(SIMPLE_XMLFILE, 'rb') as source:
|
|
context = iterparse(source)
|
|
action, elem = next(context)
|
|
self.assertEqual((action, elem.tag), ('end', 'element'))
|
|
self.assertEqual([(action, elem.tag) for action, elem in context], [
|
|
('end', 'element'),
|
|
('end', 'empty-element'),
|
|
('end', 'root'),
|
|
])
|
|
self.assertEqual(context.root.tag, 'root')
|
|
|
|
events = ()
|
|
context = iterparse(SIMPLE_XMLFILE, events)
|
|
self.assertEqual([(action, elem.tag) for action, elem in context], [])
|
|
|
|
events = ()
|
|
context = iterparse(SIMPLE_XMLFILE, events=events)
|
|
self.assertEqual([(action, elem.tag) for action, elem in context], [])
|
|
|
|
events = ("start", "end")
|
|
context = iterparse(SIMPLE_XMLFILE, events)
|
|
self.assertEqual([(action, elem.tag) for action, elem in context], [
|
|
('start', 'root'),
|
|
('start', 'element'),
|
|
('end', 'element'),
|
|
('start', 'element'),
|
|
('end', 'element'),
|
|
('start', 'empty-element'),
|
|
('end', 'empty-element'),
|
|
('end', 'root'),
|
|
])
|
|
|
|
events = ("start", "end", "start-ns", "end-ns")
|
|
context = iterparse(SIMPLE_NS_XMLFILE, events)
|
|
self.assertEqual([(action, elem.tag) if action in ("start", "end")
|
|
else (action, elem)
|
|
for action, elem in context], [
|
|
('start-ns', ('', 'namespace')),
|
|
('start', '{namespace}root'),
|
|
('start', '{namespace}element'),
|
|
('end', '{namespace}element'),
|
|
('start', '{namespace}element'),
|
|
('end', '{namespace}element'),
|
|
('start', '{namespace}empty-element'),
|
|
('end', '{namespace}empty-element'),
|
|
('end', '{namespace}root'),
|
|
('end-ns', None),
|
|
])
|
|
|
|
events = ('start-ns', 'end-ns')
|
|
context = iterparse(io.StringIO(r"<root xmlns=''/>"), events)
|
|
res = [action for action, elem in context]
|
|
self.assertEqual(res, ['start-ns', 'end-ns'])
|
|
|
|
events = ("start", "end", "bogus")
|
|
with open(SIMPLE_XMLFILE, "rb") as f:
|
|
with self.assertRaises(ValueError) as cm:
|
|
iterparse(f, events)
|
|
self.assertFalse(f.closed)
|
|
self.assertEqual(str(cm.exception), "unknown event 'bogus'")
|
|
|
|
with warnings_helper.check_no_resource_warning(self):
|
|
with self.assertRaises(ValueError) as cm:
|
|
iterparse(SIMPLE_XMLFILE, events)
|
|
self.assertEqual(str(cm.exception), "unknown event 'bogus'")
|
|
del cm
|
|
|
|
source = io.BytesIO(
|
|
b"<?xml version='1.0' encoding='iso-8859-1'?>\n"
|
|
b"<body xmlns='http://éffbot.org/ns'\n"
|
|
b" xmlns:cl\xe9='http://effbot.org/ns'>text</body>\n")
|
|
events = ("start-ns",)
|
|
context = iterparse(source, events)
|
|
self.assertEqual([(action, elem) for action, elem in context], [
|
|
('start-ns', ('', 'http://\xe9ffbot.org/ns')),
|
|
('start-ns', ('cl\xe9', 'http://effbot.org/ns')),
|
|
])
|
|
|
|
source = io.StringIO("<document />junk")
|
|
it = iterparse(source)
|
|
action, elem = next(it)
|
|
self.assertEqual((action, elem.tag), ('end', 'document'))
|
|
with self.assertRaises(ET.ParseError) as cm:
|
|
next(it)
|
|
self.assertEqual(str(cm.exception),
|
|
'junk after document element: line 1, column 12')
|
|
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
with open(TESTFN, "wb") as f:
|
|
f.write(b"<document />junk")
|
|
it = iterparse(TESTFN)
|
|
action, elem = next(it)
|
|
self.assertEqual((action, elem.tag), ('end', 'document'))
|
|
with warnings_helper.check_no_resource_warning(self):
|
|
with self.assertRaises(ET.ParseError) as cm:
|
|
next(it)
|
|
self.assertEqual(str(cm.exception),
|
|
'junk after document element: line 1, column 12')
|
|
del cm, it
|
|
|
|
# Not exhausting the iterator still closes the resource (bpo-43292)
|
|
with warnings_helper.check_no_resource_warning(self):
|
|
it = iterparse(SIMPLE_XMLFILE)
|
|
del it
|
|
|
|
with warnings_helper.check_no_resource_warning(self):
|
|
it = iterparse(SIMPLE_XMLFILE)
|
|
it.close()
|
|
del it
|
|
|
|
with warnings_helper.check_no_resource_warning(self):
|
|
it = iterparse(SIMPLE_XMLFILE)
|
|
action, elem = next(it)
|
|
self.assertEqual((action, elem.tag), ('end', 'element'))
|
|
del it, elem
|
|
|
|
with warnings_helper.check_no_resource_warning(self):
|
|
it = iterparse(SIMPLE_XMLFILE)
|
|
action, elem = next(it)
|
|
it.close()
|
|
self.assertEqual((action, elem.tag), ('end', 'element'))
|
|
del it, elem
|
|
|
|
with self.assertRaises(FileNotFoundError):
|
|
iterparse("nonexistent")
|
|
|
|
def test_iterparse_close(self):
|
|
iterparse = ET.iterparse
|
|
|
|
it = iterparse(SIMPLE_XMLFILE)
|
|
it.close()
|
|
with self.assertRaises(StopIteration):
|
|
next(it)
|
|
it.close() # idempotent
|
|
|
|
with open(SIMPLE_XMLFILE, 'rb') as source:
|
|
it = iterparse(source)
|
|
it.close()
|
|
self.assertFalse(source.closed)
|
|
with self.assertRaises(StopIteration):
|
|
next(it)
|
|
it.close() # idempotent
|
|
|
|
it = iterparse(SIMPLE_XMLFILE)
|
|
action, elem = next(it)
|
|
self.assertEqual((action, elem.tag), ('end', 'element'))
|
|
it.close()
|
|
with self.assertRaises(StopIteration):
|
|
next(it)
|
|
it.close() # idempotent
|
|
|
|
with open(SIMPLE_XMLFILE, 'rb') as source:
|
|
it = iterparse(source)
|
|
action, elem = next(it)
|
|
self.assertEqual((action, elem.tag), ('end', 'element'))
|
|
it.close()
|
|
self.assertFalse(source.closed)
|
|
with self.assertRaises(StopIteration):
|
|
next(it)
|
|
it.close() # idempotent
|
|
|
|
it = iterparse(SIMPLE_XMLFILE)
|
|
list(it)
|
|
it.close()
|
|
with self.assertRaises(StopIteration):
|
|
next(it)
|
|
it.close() # idempotent
|
|
|
|
with open(SIMPLE_XMLFILE, 'rb') as source:
|
|
it = iterparse(source)
|
|
list(it)
|
|
it.close()
|
|
self.assertFalse(source.closed)
|
|
with self.assertRaises(StopIteration):
|
|
next(it)
|
|
it.close() # idempotent
|
|
|
|
def test_writefile(self):
|
|
elem = ET.Element("tag")
|
|
elem.text = "text"
|
|
self.serialize_check(elem, '<tag>text</tag>')
|
|
ET.SubElement(elem, "subtag").text = "subtext"
|
|
self.serialize_check(elem, '<tag>text<subtag>subtext</subtag></tag>')
|
|
|
|
# Test tag suppression
|
|
elem.tag = None
|
|
self.serialize_check(elem, 'text<subtag>subtext</subtag>')
|
|
elem.insert(0, ET.Comment("comment"))
|
|
self.serialize_check(elem,
|
|
'text<!--comment--><subtag>subtext</subtag>') # assumes 1.3
|
|
|
|
elem[0] = ET.PI("key", "value")
|
|
self.serialize_check(elem, 'text<?key value?><subtag>subtext</subtag>')
|
|
|
|
def test_custom_builder(self):
|
|
# Test parser w. custom builder.
|
|
|
|
with open(SIMPLE_XMLFILE) as f:
|
|
data = f.read()
|
|
class Builder(list):
|
|
def start(self, tag, attrib):
|
|
self.append(("start", tag))
|
|
def end(self, tag):
|
|
self.append(("end", tag))
|
|
def data(self, text):
|
|
pass
|
|
builder = Builder()
|
|
parser = ET.XMLParser(target=builder)
|
|
parser.feed(data)
|
|
self.assertEqual(builder, [
|
|
('start', 'root'),
|
|
('start', 'element'),
|
|
('end', 'element'),
|
|
('start', 'element'),
|
|
('end', 'element'),
|
|
('start', 'empty-element'),
|
|
('end', 'empty-element'),
|
|
('end', 'root'),
|
|
])
|
|
|
|
with open(SIMPLE_NS_XMLFILE) as f:
|
|
data = f.read()
|
|
class Builder(list):
|
|
def start(self, tag, attrib):
|
|
self.append(("start", tag))
|
|
def end(self, tag):
|
|
self.append(("end", tag))
|
|
def data(self, text):
|
|
pass
|
|
def pi(self, target, data):
|
|
self.append(("pi", target, data))
|
|
def comment(self, data):
|
|
self.append(("comment", data))
|
|
def start_ns(self, prefix, uri):
|
|
self.append(("start-ns", prefix, uri))
|
|
def end_ns(self, prefix):
|
|
self.append(("end-ns", prefix))
|
|
builder = Builder()
|
|
parser = ET.XMLParser(target=builder)
|
|
parser.feed(data)
|
|
self.assertEqual(builder, [
|
|
('pi', 'pi', 'data'),
|
|
('comment', ' comment '),
|
|
('start-ns', '', 'namespace'),
|
|
('start', '{namespace}root'),
|
|
('start', '{namespace}element'),
|
|
('end', '{namespace}element'),
|
|
('start', '{namespace}element'),
|
|
('end', '{namespace}element'),
|
|
('start', '{namespace}empty-element'),
|
|
('end', '{namespace}empty-element'),
|
|
('end', '{namespace}root'),
|
|
('end-ns', ''),
|
|
])
|
|
|
|
def test_custom_builder_only_end_ns(self):
|
|
class Builder(list):
|
|
def end_ns(self, prefix):
|
|
self.append(("end-ns", prefix))
|
|
|
|
builder = Builder()
|
|
parser = ET.XMLParser(target=builder)
|
|
parser.feed(textwrap.dedent("""\
|
|
<?pi data?>
|
|
<!-- comment -->
|
|
<root xmlns='namespace' xmlns:p='pns' xmlns:a='ans'>
|
|
<a:element key='value'>text</a:element>
|
|
<p:element>text</p:element>tail
|
|
<empty-element/>
|
|
</root>
|
|
"""))
|
|
self.assertEqual(builder, [
|
|
('end-ns', 'a'),
|
|
('end-ns', 'p'),
|
|
('end-ns', ''),
|
|
])
|
|
|
|
def test_initialize_parser_without_target(self):
|
|
# Explicit None
|
|
parser = ET.XMLParser(target=None)
|
|
self.assertIsInstance(parser.target, ET.TreeBuilder)
|
|
|
|
# Implicit None
|
|
parser2 = ET.XMLParser()
|
|
self.assertIsInstance(parser2.target, ET.TreeBuilder)
|
|
|
|
def test_children(self):
|
|
# Test Element children iteration
|
|
|
|
with open(SIMPLE_XMLFILE, "rb") as f:
|
|
tree = ET.parse(f)
|
|
self.assertEqual([summarize_list(elem)
|
|
for elem in tree.getroot().iter()], [
|
|
['element', 'element', 'empty-element'],
|
|
[],
|
|
[],
|
|
[],
|
|
])
|
|
self.assertEqual([summarize_list(elem)
|
|
for elem in tree.iter()], [
|
|
['element', 'element', 'empty-element'],
|
|
[],
|
|
[],
|
|
[],
|
|
])
|
|
|
|
elem = ET.XML(SAMPLE_XML)
|
|
self.assertEqual(len(list(elem)), 3)
|
|
self.assertEqual(len(list(elem[2])), 1)
|
|
self.assertEqual(elem[:], list(elem))
|
|
child1 = elem[0]
|
|
child2 = elem[2]
|
|
del elem[1:2]
|
|
self.assertEqual(len(list(elem)), 2)
|
|
self.assertEqual(child1, elem[0])
|
|
self.assertEqual(child2, elem[1])
|
|
elem[0:2] = [child2, child1]
|
|
self.assertEqual(child2, elem[0])
|
|
self.assertEqual(child1, elem[1])
|
|
self.assertNotEqual(child1, elem[0])
|
|
elem.clear()
|
|
self.assertEqual(list(elem), [])
|
|
|
|
def test_writestring(self):
|
|
elem = ET.XML("<html><body>text</body></html>")
|
|
self.assertEqual(ET.tostring(elem), b'<html><body>text</body></html>')
|
|
elem = ET.fromstring("<html><body>text</body></html>")
|
|
self.assertEqual(ET.tostring(elem), b'<html><body>text</body></html>')
|
|
|
|
def test_indent(self):
|
|
elem = ET.XML("<root></root>")
|
|
ET.indent(elem)
|
|
self.assertEqual(ET.tostring(elem), b'<root />')
|
|
|
|
elem = ET.XML("<html><body>text</body></html>")
|
|
ET.indent(elem)
|
|
self.assertEqual(ET.tostring(elem), b'<html>\n <body>text</body>\n</html>')
|
|
|
|
elem = ET.XML("<html> <body>text</body> </html>")
|
|
ET.indent(elem)
|
|
self.assertEqual(ET.tostring(elem), b'<html>\n <body>text</body>\n</html>')
|
|
|
|
elem = ET.XML("<html><body>text</body>tail</html>")
|
|
ET.indent(elem)
|
|
self.assertEqual(ET.tostring(elem), b'<html>\n <body>text</body>tail</html>')
|
|
|
|
elem = ET.XML("<html><body><p>par</p>\n<p>text</p>\t<p><br/></p></body></html>")
|
|
ET.indent(elem)
|
|
self.assertEqual(
|
|
ET.tostring(elem),
|
|
b'<html>\n'
|
|
b' <body>\n'
|
|
b' <p>par</p>\n'
|
|
b' <p>text</p>\n'
|
|
b' <p>\n'
|
|
b' <br />\n'
|
|
b' </p>\n'
|
|
b' </body>\n'
|
|
b'</html>'
|
|
)
|
|
|
|
elem = ET.XML("<html><body><p>pre<br/>post</p><p>text</p></body></html>")
|
|
ET.indent(elem)
|
|
self.assertEqual(
|
|
ET.tostring(elem),
|
|
b'<html>\n'
|
|
b' <body>\n'
|
|
b' <p>pre<br />post</p>\n'
|
|
b' <p>text</p>\n'
|
|
b' </body>\n'
|
|
b'</html>'
|
|
)
|
|
|
|
def test_indent_space(self):
|
|
elem = ET.XML("<html><body><p>pre<br/>post</p><p>text</p></body></html>")
|
|
ET.indent(elem, space='\t')
|
|
self.assertEqual(
|
|
ET.tostring(elem),
|
|
b'<html>\n'
|
|
b'\t<body>\n'
|
|
b'\t\t<p>pre<br />post</p>\n'
|
|
b'\t\t<p>text</p>\n'
|
|
b'\t</body>\n'
|
|
b'</html>'
|
|
)
|
|
|
|
elem = ET.XML("<html><body><p>pre<br/>post</p><p>text</p></body></html>")
|
|
ET.indent(elem, space='')
|
|
self.assertEqual(
|
|
ET.tostring(elem),
|
|
b'<html>\n'
|
|
b'<body>\n'
|
|
b'<p>pre<br />post</p>\n'
|
|
b'<p>text</p>\n'
|
|
b'</body>\n'
|
|
b'</html>'
|
|
)
|
|
|
|
def test_indent_space_caching(self):
|
|
elem = ET.XML("<html><body><p>par</p><p>text</p><p><br/></p><p /></body></html>")
|
|
ET.indent(elem)
|
|
self.assertEqual(
|
|
{el.tail for el in elem.iter()},
|
|
{None, "\n", "\n ", "\n "}
|
|
)
|
|
self.assertEqual(
|
|
{el.text for el in elem.iter()},
|
|
{None, "\n ", "\n ", "\n ", "par", "text"}
|
|
)
|
|
self.assertEqual(
|
|
len({el.tail for el in elem.iter()}),
|
|
len({id(el.tail) for el in elem.iter()}),
|
|
)
|
|
|
|
def test_indent_level(self):
|
|
elem = ET.XML("<html><body><p>pre<br/>post</p><p>text</p></body></html>")
|
|
with self.assertRaises(ValueError):
|
|
ET.indent(elem, level=-1)
|
|
self.assertEqual(
|
|
ET.tostring(elem),
|
|
b"<html><body><p>pre<br />post</p><p>text</p></body></html>"
|
|
)
|
|
|
|
ET.indent(elem, level=2)
|
|
self.assertEqual(
|
|
ET.tostring(elem),
|
|
b'<html>\n'
|
|
b' <body>\n'
|
|
b' <p>pre<br />post</p>\n'
|
|
b' <p>text</p>\n'
|
|
b' </body>\n'
|
|
b' </html>'
|
|
)
|
|
|
|
elem = ET.XML("<html><body><p>pre<br/>post</p><p>text</p></body></html>")
|
|
ET.indent(elem, level=1, space=' ')
|
|
self.assertEqual(
|
|
ET.tostring(elem),
|
|
b'<html>\n'
|
|
b' <body>\n'
|
|
b' <p>pre<br />post</p>\n'
|
|
b' <p>text</p>\n'
|
|
b' </body>\n'
|
|
b' </html>'
|
|
)
|
|
|
|
def test_tostring_default_namespace(self):
|
|
elem = ET.XML('<body xmlns="http://effbot.org/ns"><tag/></body>')
|
|
self.assertEqual(
|
|
ET.tostring(elem, encoding='unicode'),
|
|
'<ns0:body xmlns:ns0="http://effbot.org/ns"><ns0:tag /></ns0:body>'
|
|
)
|
|
self.assertEqual(
|
|
ET.tostring(elem, encoding='unicode', default_namespace='http://effbot.org/ns'),
|
|
'<body xmlns="http://effbot.org/ns"><tag /></body>'
|
|
)
|
|
|
|
def test_tostring_default_namespace_different_namespace(self):
|
|
elem = ET.XML('<body xmlns="http://effbot.org/ns"><tag/></body>')
|
|
self.assertEqual(
|
|
ET.tostring(elem, encoding='unicode', default_namespace='foobar'),
|
|
'<ns1:body xmlns="foobar" xmlns:ns1="http://effbot.org/ns"><ns1:tag /></ns1:body>'
|
|
)
|
|
|
|
def test_tostring_default_namespace_original_no_namespace(self):
|
|
elem = ET.XML('<body><tag/></body>')
|
|
EXPECTED_MSG = '^cannot use non-qualified names with default_namespace option$'
|
|
with self.assertRaisesRegex(ValueError, EXPECTED_MSG):
|
|
ET.tostring(elem, encoding='unicode', default_namespace='foobar')
|
|
|
|
def test_tostring_no_xml_declaration(self):
|
|
elem = ET.XML('<body><tag/></body>')
|
|
self.assertEqual(
|
|
ET.tostring(elem, encoding='unicode'),
|
|
'<body><tag /></body>'
|
|
)
|
|
|
|
def test_tostring_xml_declaration(self):
|
|
elem = ET.XML('<body><tag/></body>')
|
|
self.assertEqual(
|
|
ET.tostring(elem, encoding='utf8', xml_declaration=True),
|
|
b"<?xml version='1.0' encoding='utf8'?>\n<body><tag /></body>"
|
|
)
|
|
|
|
def test_tostring_xml_declaration_unicode_encoding(self):
|
|
elem = ET.XML('<body><tag/></body>')
|
|
self.assertEqual(
|
|
ET.tostring(elem, encoding='unicode', xml_declaration=True),
|
|
"<?xml version='1.0' encoding='utf-8'?>\n<body><tag /></body>"
|
|
)
|
|
|
|
def test_tostring_xml_declaration_cases(self):
|
|
elem = ET.XML('<body><tag>ø</tag></body>')
|
|
TESTCASES = [
|
|
# (expected_retval, encoding, xml_declaration)
|
|
# ... xml_declaration = None
|
|
(b'<body><tag>ø</tag></body>', None, None),
|
|
(b'<body><tag>\xc3\xb8</tag></body>', 'UTF-8', None),
|
|
(b'<body><tag>ø</tag></body>', 'US-ASCII', None),
|
|
(b"<?xml version='1.0' encoding='ISO-8859-1'?>\n"
|
|
b"<body><tag>\xf8</tag></body>", 'ISO-8859-1', None),
|
|
('<body><tag>ø</tag></body>', 'unicode', None),
|
|
|
|
# ... xml_declaration = False
|
|
(b"<body><tag>ø</tag></body>", None, False),
|
|
(b"<body><tag>\xc3\xb8</tag></body>", 'UTF-8', False),
|
|
(b"<body><tag>ø</tag></body>", 'US-ASCII', False),
|
|
(b"<body><tag>\xf8</tag></body>", 'ISO-8859-1', False),
|
|
("<body><tag>ø</tag></body>", 'unicode', False),
|
|
|
|
# ... xml_declaration = True
|
|
(b"<?xml version='1.0' encoding='us-ascii'?>\n"
|
|
b"<body><tag>ø</tag></body>", None, True),
|
|
(b"<?xml version='1.0' encoding='UTF-8'?>\n"
|
|
b"<body><tag>\xc3\xb8</tag></body>", 'UTF-8', True),
|
|
(b"<?xml version='1.0' encoding='US-ASCII'?>\n"
|
|
b"<body><tag>ø</tag></body>", 'US-ASCII', True),
|
|
(b"<?xml version='1.0' encoding='ISO-8859-1'?>\n"
|
|
b"<body><tag>\xf8</tag></body>", 'ISO-8859-1', True),
|
|
("<?xml version='1.0' encoding='utf-8'?>\n"
|
|
"<body><tag>ø</tag></body>", 'unicode', True),
|
|
|
|
]
|
|
for expected_retval, encoding, xml_declaration in TESTCASES:
|
|
with self.subTest(f'encoding={encoding} '
|
|
f'xml_declaration={xml_declaration}'):
|
|
self.assertEqual(
|
|
ET.tostring(
|
|
elem,
|
|
encoding=encoding,
|
|
xml_declaration=xml_declaration
|
|
),
|
|
expected_retval
|
|
)
|
|
|
|
def test_tostringlist_default_namespace(self):
|
|
elem = ET.XML('<body xmlns="http://effbot.org/ns"><tag/></body>')
|
|
self.assertEqual(
|
|
''.join(ET.tostringlist(elem, encoding='unicode')),
|
|
'<ns0:body xmlns:ns0="http://effbot.org/ns"><ns0:tag /></ns0:body>'
|
|
)
|
|
self.assertEqual(
|
|
''.join(ET.tostringlist(elem, encoding='unicode', default_namespace='http://effbot.org/ns')),
|
|
'<body xmlns="http://effbot.org/ns"><tag /></body>'
|
|
)
|
|
|
|
def test_tostringlist_xml_declaration(self):
|
|
elem = ET.XML('<body><tag/></body>')
|
|
self.assertEqual(
|
|
''.join(ET.tostringlist(elem, encoding='unicode')),
|
|
'<body><tag /></body>'
|
|
)
|
|
self.assertEqual(
|
|
b''.join(ET.tostringlist(elem, xml_declaration=True)),
|
|
b"<?xml version='1.0' encoding='us-ascii'?>\n<body><tag /></body>"
|
|
)
|
|
|
|
stringlist = ET.tostringlist(elem, encoding='unicode', xml_declaration=True)
|
|
self.assertEqual(
|
|
''.join(stringlist),
|
|
"<?xml version='1.0' encoding='utf-8'?>\n<body><tag /></body>"
|
|
)
|
|
self.assertRegex(stringlist[0], r"^<\?xml version='1.0' encoding='.+'?>")
|
|
self.assertEqual(['<body', '>', '<tag', ' />', '</body>'], stringlist[1:])
|
|
|
|
def test_encoding(self):
|
|
def check(encoding, body=''):
|
|
xml = ("<?xml version='1.0' encoding='%s'?><xml>%s</xml>" %
|
|
(encoding, body))
|
|
self.assertEqual(ET.XML(xml.encode(encoding)).text, body)
|
|
self.assertEqual(ET.XML(xml).text, body)
|
|
check("ascii", 'a')
|
|
check("us-ascii", 'a')
|
|
check("iso-8859-1", '\xbd')
|
|
check("iso-8859-15", '\u20ac')
|
|
check("cp437", '\u221a')
|
|
check("mac-roman", '\u02da')
|
|
|
|
def xml(encoding):
|
|
return "<?xml version='1.0' encoding='%s'?><xml />" % encoding
|
|
def bxml(encoding):
|
|
return xml(encoding).encode(encoding)
|
|
supported_encodings = [
|
|
'ascii', 'utf-8', 'utf-8-sig', 'utf-16', 'utf-16be', 'utf-16le',
|
|
'iso8859-1', 'iso8859-2', 'iso8859-3', 'iso8859-4', 'iso8859-5',
|
|
'iso8859-6', 'iso8859-7', 'iso8859-8', 'iso8859-9', 'iso8859-10',
|
|
'iso8859-13', 'iso8859-14', 'iso8859-15', 'iso8859-16',
|
|
'cp437', 'cp720', 'cp737', 'cp775', 'cp850', 'cp852',
|
|
'cp855', 'cp856', 'cp857', 'cp858', 'cp860', 'cp861', 'cp862',
|
|
'cp863', 'cp865', 'cp866', 'cp869', 'cp874', 'cp1006', 'cp1125',
|
|
'cp1250', 'cp1251', 'cp1252', 'cp1253', 'cp1254', 'cp1255',
|
|
'cp1256', 'cp1257', 'cp1258',
|
|
'mac-cyrillic', 'mac-greek', 'mac-iceland', 'mac-latin2',
|
|
'mac-roman', 'mac-turkish',
|
|
'iso2022-jp', 'iso2022-jp-1', 'iso2022-jp-2', 'iso2022-jp-2004',
|
|
'iso2022-jp-3', 'iso2022-jp-ext',
|
|
'koi8-r', 'koi8-t', 'koi8-u', 'kz1048',
|
|
'hz', 'ptcp154',
|
|
]
|
|
for encoding in supported_encodings:
|
|
self.assertEqual(ET.tostring(ET.XML(bxml(encoding))), b'<xml />')
|
|
|
|
unsupported_ascii_compatible_encodings = [
|
|
'big5', 'big5hkscs',
|
|
'cp932', 'cp949', 'cp950',
|
|
'euc-jp', 'euc-jis-2004', 'euc-jisx0213', 'euc-kr',
|
|
'gb2312', 'gbk', 'gb18030',
|
|
'iso2022-kr', 'johab',
|
|
'shift-jis', 'shift-jis-2004', 'shift-jisx0213',
|
|
'utf-7',
|
|
]
|
|
for encoding in unsupported_ascii_compatible_encodings:
|
|
self.assertRaises(ValueError, ET.XML, bxml(encoding))
|
|
|
|
unsupported_ascii_incompatible_encodings = [
|
|
'cp037', 'cp424', 'cp500', 'cp864', 'cp875', 'cp1026', 'cp1140',
|
|
'utf_32', 'utf_32_be', 'utf_32_le',
|
|
]
|
|
for encoding in unsupported_ascii_incompatible_encodings:
|
|
self.assertRaises(ET.ParseError, ET.XML, bxml(encoding))
|
|
|
|
self.assertRaises(ValueError, ET.XML, xml('undefined').encode('ascii'))
|
|
self.assertRaises(LookupError, ET.XML, xml('xxx').encode('ascii'))
|
|
|
|
def test_methods(self):
|
|
# Test serialization methods.
|
|
|
|
e = ET.XML("<html><link/><script>1 < 2</script></html>")
|
|
e.tail = "\n"
|
|
self.assertEqual(serialize(e),
|
|
'<html><link /><script>1 < 2</script></html>\n')
|
|
self.assertEqual(serialize(e, method=None),
|
|
'<html><link /><script>1 < 2</script></html>\n')
|
|
self.assertEqual(serialize(e, method="xml"),
|
|
'<html><link /><script>1 < 2</script></html>\n')
|
|
self.assertEqual(serialize(e, method="html"),
|
|
'<html><link><script>1 < 2</script></html>\n')
|
|
self.assertEqual(serialize(e, method="text"), '1 < 2\n')
|
|
|
|
def test_issue18347(self):
|
|
e = ET.XML('<html><CamelCase>text</CamelCase></html>')
|
|
self.assertEqual(serialize(e),
|
|
'<html><CamelCase>text</CamelCase></html>')
|
|
self.assertEqual(serialize(e, method="html"),
|
|
'<html><CamelCase>text</CamelCase></html>')
|
|
|
|
def test_entity(self):
|
|
# Test entity handling.
|
|
|
|
# 1) good entities
|
|
|
|
e = ET.XML("<document title='舰'>test</document>")
|
|
self.assertEqual(serialize(e, encoding="us-ascii"),
|
|
b'<document title="舰">test</document>')
|
|
self.serialize_check(e, '<document title="\u8230">test</document>')
|
|
|
|
# 2) bad entities
|
|
|
|
with self.assertRaises(ET.ParseError) as cm:
|
|
ET.XML("<document>&entity;</document>")
|
|
self.assertEqual(str(cm.exception),
|
|
'undefined entity: line 1, column 10')
|
|
|
|
with self.assertRaises(ET.ParseError) as cm:
|
|
ET.XML(ENTITY_XML)
|
|
self.assertEqual(str(cm.exception),
|
|
'undefined entity &entity;: line 5, column 10')
|
|
|
|
# 3) custom entity
|
|
|
|
parser = ET.XMLParser()
|
|
parser.entity["entity"] = "text"
|
|
parser.feed(ENTITY_XML)
|
|
root = parser.close()
|
|
self.serialize_check(root, '<document>text</document>')
|
|
|
|
# 4) external (SYSTEM) entity
|
|
|
|
with self.assertRaises(ET.ParseError) as cm:
|
|
ET.XML(EXTERNAL_ENTITY_XML)
|
|
self.assertEqual(str(cm.exception),
|
|
'undefined entity &entity;: line 4, column 10')
|
|
|
|
def test_namespace(self):
|
|
# Test namespace issues.
|
|
|
|
# 1) xml namespace
|
|
|
|
elem = ET.XML("<tag xml:lang='en' />")
|
|
self.serialize_check(elem, '<tag xml:lang="en" />') # 1.1
|
|
|
|
# 2) other "well-known" namespaces
|
|
|
|
elem = ET.XML("<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#' />")
|
|
self.serialize_check(elem,
|
|
'<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" />') # 2.1
|
|
|
|
elem = ET.XML("<html:html xmlns:html='http://www.w3.org/1999/xhtml' />")
|
|
self.serialize_check(elem,
|
|
'<html:html xmlns:html="http://www.w3.org/1999/xhtml" />') # 2.2
|
|
|
|
elem = ET.XML("<soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope' />")
|
|
self.serialize_check(elem,
|
|
'<ns0:Envelope xmlns:ns0="http://schemas.xmlsoap.org/soap/envelope" />') # 2.3
|
|
|
|
# 3) unknown namespaces
|
|
elem = ET.XML(SAMPLE_XML_NS)
|
|
self.serialize_check(elem,
|
|
'<ns0:body xmlns:ns0="http://effbot.org/ns">\n'
|
|
' <ns0:tag>text</ns0:tag>\n'
|
|
' <ns0:tag />\n'
|
|
' <ns0:section>\n'
|
|
' <ns0:tag>subtext</ns0:tag>\n'
|
|
' </ns0:section>\n'
|
|
'</ns0:body>')
|
|
|
|
def test_qname(self):
|
|
# Test QName handling.
|
|
|
|
# 1) decorated tags
|
|
|
|
elem = ET.Element("{uri}tag")
|
|
self.serialize_check(elem, '<ns0:tag xmlns:ns0="uri" />') # 1.1
|
|
elem = ET.Element(ET.QName("{uri}tag"))
|
|
self.serialize_check(elem, '<ns0:tag xmlns:ns0="uri" />') # 1.2
|
|
elem = ET.Element(ET.QName("uri", "tag"))
|
|
self.serialize_check(elem, '<ns0:tag xmlns:ns0="uri" />') # 1.3
|
|
elem = ET.Element(ET.QName("uri", "tag"))
|
|
subelem = ET.SubElement(elem, ET.QName("uri", "tag1"))
|
|
subelem = ET.SubElement(elem, ET.QName("uri", "tag2"))
|
|
self.serialize_check(elem,
|
|
'<ns0:tag xmlns:ns0="uri"><ns0:tag1 /><ns0:tag2 /></ns0:tag>') # 1.4
|
|
|
|
# 2) decorated attributes
|
|
|
|
elem.clear()
|
|
elem.attrib["{uri}key"] = "value"
|
|
self.serialize_check(elem,
|
|
'<ns0:tag xmlns:ns0="uri" ns0:key="value" />') # 2.1
|
|
|
|
elem.clear()
|
|
elem.attrib[ET.QName("{uri}key")] = "value"
|
|
self.serialize_check(elem,
|
|
'<ns0:tag xmlns:ns0="uri" ns0:key="value" />') # 2.2
|
|
|
|
# 3) decorated values are not converted by default, but the
|
|
# QName wrapper can be used for values
|
|
|
|
elem.clear()
|
|
elem.attrib["{uri}key"] = "{uri}value"
|
|
self.serialize_check(elem,
|
|
'<ns0:tag xmlns:ns0="uri" ns0:key="{uri}value" />') # 3.1
|
|
|
|
elem.clear()
|
|
elem.attrib["{uri}key"] = ET.QName("{uri}value")
|
|
self.serialize_check(elem,
|
|
'<ns0:tag xmlns:ns0="uri" ns0:key="ns0:value" />') # 3.2
|
|
|
|
elem.clear()
|
|
subelem = ET.Element("tag")
|
|
subelem.attrib["{uri1}key"] = ET.QName("{uri2}value")
|
|
elem.append(subelem)
|
|
elem.append(subelem)
|
|
self.serialize_check(elem,
|
|
'<ns0:tag xmlns:ns0="uri" xmlns:ns1="uri1" xmlns:ns2="uri2">'
|
|
'<tag ns1:key="ns2:value" />'
|
|
'<tag ns1:key="ns2:value" />'
|
|
'</ns0:tag>') # 3.3
|
|
|
|
# 4) Direct QName tests
|
|
|
|
self.assertEqual(str(ET.QName('ns', 'tag')), '{ns}tag')
|
|
self.assertEqual(str(ET.QName('{ns}tag')), '{ns}tag')
|
|
q1 = ET.QName('ns', 'tag')
|
|
q2 = ET.QName('ns', 'tag')
|
|
self.assertEqual(q1, q2)
|
|
q2 = ET.QName('ns', 'other-tag')
|
|
self.assertNotEqual(q1, q2)
|
|
self.assertNotEqual(q1, 'ns:tag')
|
|
self.assertEqual(q1, '{ns}tag')
|
|
|
|
def test_doctype_public(self):
|
|
# Test PUBLIC doctype.
|
|
|
|
elem = ET.XML('<!DOCTYPE html PUBLIC'
|
|
' "-//W3C//DTD XHTML 1.0 Transitional//EN"'
|
|
' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
|
|
'<html>text</html>')
|
|
|
|
def test_xpath_tokenizer(self):
|
|
# Test the XPath tokenizer.
|
|
from xml.etree import ElementPath
|
|
def check(p, expected, namespaces=None):
|
|
self.assertEqual([op or tag
|
|
for op, tag in ElementPath.xpath_tokenizer(p, namespaces)],
|
|
expected)
|
|
|
|
# tests from the xml specification
|
|
check("*", ['*'])
|
|
check("text()", ['text', '()'])
|
|
check("@name", ['@', 'name'])
|
|
check("@*", ['@', '*'])
|
|
check("para[1]", ['para', '[', '1', ']'])
|
|
check("para[last()]", ['para', '[', 'last', '()', ']'])
|
|
check("*/para", ['*', '/', 'para'])
|
|
check("/doc/chapter[5]/section[2]",
|
|
['/', 'doc', '/', 'chapter', '[', '5', ']',
|
|
'/', 'section', '[', '2', ']'])
|
|
check("chapter//para", ['chapter', '//', 'para'])
|
|
check("//para", ['//', 'para'])
|
|
check("//olist/item", ['//', 'olist', '/', 'item'])
|
|
check(".", ['.'])
|
|
check(".//para", ['.', '//', 'para'])
|
|
check("..", ['..'])
|
|
check("../@lang", ['..', '/', '@', 'lang'])
|
|
check("chapter[title]", ['chapter', '[', 'title', ']'])
|
|
check("employee[@secretary and @assistant]", ['employee',
|
|
'[', '@', 'secretary', '', 'and', '', '@', 'assistant', ']'])
|
|
|
|
# additional tests
|
|
check("@{ns}attr", ['@', '{ns}attr'])
|
|
check("{http://spam}egg", ['{http://spam}egg'])
|
|
check("./spam.egg", ['.', '/', 'spam.egg'])
|
|
check(".//{http://spam}egg", ['.', '//', '{http://spam}egg'])
|
|
|
|
# wildcard tags
|
|
check("{ns}*", ['{ns}*'])
|
|
check("{}*", ['{}*'])
|
|
check("{*}tag", ['{*}tag'])
|
|
check("{*}*", ['{*}*'])
|
|
check(".//{*}tag", ['.', '//', '{*}tag'])
|
|
|
|
# namespace prefix resolution
|
|
check("./xsd:type", ['.', '/', '{http://www.w3.org/2001/XMLSchema}type'],
|
|
{'xsd': 'http://www.w3.org/2001/XMLSchema'})
|
|
check("type", ['{http://www.w3.org/2001/XMLSchema}type'],
|
|
{'': 'http://www.w3.org/2001/XMLSchema'})
|
|
check("@xsd:type", ['@', '{http://www.w3.org/2001/XMLSchema}type'],
|
|
{'xsd': 'http://www.w3.org/2001/XMLSchema'})
|
|
check("@type", ['@', 'type'],
|
|
{'': 'http://www.w3.org/2001/XMLSchema'})
|
|
check("@{*}type", ['@', '{*}type'],
|
|
{'': 'http://www.w3.org/2001/XMLSchema'})
|
|
check("@{ns}attr", ['@', '{ns}attr'],
|
|
{'': 'http://www.w3.org/2001/XMLSchema',
|
|
'ns': 'http://www.w3.org/2001/XMLSchema'})
|
|
|
|
def test_processinginstruction(self):
|
|
# Test ProcessingInstruction directly
|
|
|
|
self.assertEqual(ET.tostring(ET.ProcessingInstruction('test', 'instruction')),
|
|
b'<?test instruction?>')
|
|
self.assertEqual(ET.tostring(ET.PI('test', 'instruction')),
|
|
b'<?test instruction?>')
|
|
|
|
# Issue #2746
|
|
|
|
self.assertEqual(ET.tostring(ET.PI('test', '<testing&>')),
|
|
b'<?test <testing&>?>')
|
|
self.assertEqual(ET.tostring(ET.PI('test', '<testing&>\xe3'), 'latin-1'),
|
|
b"<?xml version='1.0' encoding='latin-1'?>\n"
|
|
b"<?test <testing&>\xe3?>")
|
|
|
|
def test_html_empty_elems_serialization(self):
|
|
# issue 15970
|
|
# from http://www.w3.org/TR/html401/index/elements.html
|
|
for element in ['AREA', 'BASE', 'BASEFONT', 'BR', 'COL', 'EMBED', 'FRAME',
|
|
'HR', 'IMG', 'INPUT', 'ISINDEX', 'LINK', 'META', 'PARAM',
|
|
'SOURCE', 'TRACK', 'WBR']:
|
|
for elem in [element, element.lower()]:
|
|
expected = '<%s>' % elem
|
|
serialized = serialize(ET.XML('<%s />' % elem), method='html')
|
|
self.assertEqual(serialized, expected)
|
|
serialized = serialize(ET.XML('<%s></%s>' % (elem,elem)),
|
|
method='html')
|
|
self.assertEqual(serialized, expected)
|
|
|
|
def test_dump_attribute_order(self):
|
|
# See BPO 34160
|
|
e = ET.Element('cirriculum', status='public', company='example')
|
|
with support.captured_stdout() as stdout:
|
|
ET.dump(e)
|
|
self.assertEqual(stdout.getvalue(),
|
|
'<cirriculum status="public" company="example" />\n')
|
|
|
|
def test_tree_write_attribute_order(self):
|
|
# See BPO 34160
|
|
root = ET.Element('cirriculum', status='public', company='example')
|
|
self.assertEqual(serialize(root),
|
|
'<cirriculum status="public" company="example" />')
|
|
self.assertEqual(serialize(root, method='html'),
|
|
'<cirriculum status="public" company="example"></cirriculum>')
|
|
|
|
def test_attlist_default(self):
|
|
# Test default attribute values; See BPO 42151.
|
|
root = ET.fromstring(ATTLIST_XML)
|
|
self.assertEqual(root[0].attrib,
|
|
{'{http://www.w3.org/XML/1998/namespace}lang': 'eng'})
|
|
|
|
|
|
class XMLPullParserTest(unittest.TestCase):
|
|
|
|
def _feed(self, parser, data, chunk_size=None, flush=False):
|
|
if chunk_size is None:
|
|
parser.feed(data)
|
|
else:
|
|
for i in range(0, len(data), chunk_size):
|
|
parser.feed(data[i:i+chunk_size])
|
|
if flush:
|
|
parser.flush()
|
|
|
|
def assert_events(self, parser, expected, max_events=None):
|
|
self.assertEqual(
|
|
[(event, (elem.tag, elem.text))
|
|
for event, elem in islice(parser.read_events(), max_events)],
|
|
expected)
|
|
|
|
def assert_event_tuples(self, parser, expected, max_events=None):
|
|
self.assertEqual(
|
|
list(islice(parser.read_events(), max_events)),
|
|
expected)
|
|
|
|
def assert_event_tags(self, parser, expected, max_events=None):
|
|
events = islice(parser.read_events(), max_events)
|
|
self.assertEqual([(action, elem.tag) for action, elem in events],
|
|
expected)
|
|
|
|
def test_simple_xml(self, chunk_size=None, flush=False):
|
|
parser = ET.XMLPullParser()
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser, "<!-- comment -->\n", chunk_size, flush)
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser,
|
|
"<root>\n <element key='value'>text</element",
|
|
chunk_size, flush)
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser, ">\n", chunk_size, flush)
|
|
self.assert_event_tags(parser, [('end', 'element')])
|
|
self._feed(parser, "<element>text</element>tail\n", chunk_size, flush)
|
|
self._feed(parser, "<empty-element/>\n", chunk_size, flush)
|
|
self.assert_event_tags(parser, [
|
|
('end', 'element'),
|
|
('end', 'empty-element'),
|
|
])
|
|
self._feed(parser, "</root>\n", chunk_size, flush)
|
|
self.assert_event_tags(parser, [('end', 'root')])
|
|
self.assertIsNone(parser.close())
|
|
|
|
def test_simple_xml_chunk_1(self):
|
|
self.test_simple_xml(chunk_size=1, flush=True)
|
|
|
|
def test_simple_xml_chunk_5(self):
|
|
self.test_simple_xml(chunk_size=5, flush=True)
|
|
|
|
def test_simple_xml_chunk_22(self):
|
|
self.test_simple_xml(chunk_size=22)
|
|
|
|
def test_feed_while_iterating(self):
|
|
parser = ET.XMLPullParser()
|
|
it = parser.read_events()
|
|
self._feed(parser, "<root>\n <element key='value'>text</element>\n")
|
|
action, elem = next(it)
|
|
self.assertEqual((action, elem.tag), ('end', 'element'))
|
|
self._feed(parser, "</root>\n")
|
|
action, elem = next(it)
|
|
self.assertEqual((action, elem.tag), ('end', 'root'))
|
|
with self.assertRaises(StopIteration):
|
|
next(it)
|
|
|
|
def test_simple_xml_with_ns(self):
|
|
parser = ET.XMLPullParser()
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser, "<!-- comment -->\n")
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser, "<root xmlns='namespace'>\n")
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser, "<element key='value'>text</element")
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser, ">\n")
|
|
self.assert_event_tags(parser, [('end', '{namespace}element')])
|
|
self._feed(parser, "<element>text</element>tail\n")
|
|
self._feed(parser, "<empty-element/>\n")
|
|
self.assert_event_tags(parser, [
|
|
('end', '{namespace}element'),
|
|
('end', '{namespace}empty-element'),
|
|
])
|
|
self._feed(parser, "</root>\n")
|
|
self.assert_event_tags(parser, [('end', '{namespace}root')])
|
|
self.assertIsNone(parser.close())
|
|
|
|
def test_ns_events(self):
|
|
parser = ET.XMLPullParser(events=('start-ns', 'end-ns'))
|
|
self._feed(parser, "<!-- comment -->\n")
|
|
self._feed(parser, "<root xmlns='namespace'>\n")
|
|
self.assertEqual(
|
|
list(parser.read_events()),
|
|
[('start-ns', ('', 'namespace'))])
|
|
self._feed(parser, "<element key='value'>text</element")
|
|
self._feed(parser, ">\n")
|
|
self._feed(parser, "<element>text</element>tail\n")
|
|
self._feed(parser, "<empty-element/>\n")
|
|
self._feed(parser, "</root>\n")
|
|
self.assertEqual(list(parser.read_events()), [('end-ns', None)])
|
|
self.assertIsNone(parser.close())
|
|
|
|
def test_ns_events_start(self):
|
|
parser = ET.XMLPullParser(events=('start-ns', 'start', 'end'))
|
|
self._feed(parser, "<tag xmlns='abc' xmlns:p='xyz'>\n")
|
|
self.assert_event_tuples(parser, [
|
|
('start-ns', ('', 'abc')),
|
|
('start-ns', ('p', 'xyz')),
|
|
], max_events=2)
|
|
self.assert_event_tags(parser, [
|
|
('start', '{abc}tag'),
|
|
], max_events=1)
|
|
|
|
self._feed(parser, "<child />\n")
|
|
self.assert_event_tags(parser, [
|
|
('start', '{abc}child'),
|
|
('end', '{abc}child'),
|
|
])
|
|
|
|
self._feed(parser, "</tag>\n")
|
|
parser.close()
|
|
self.assert_event_tags(parser, [
|
|
('end', '{abc}tag'),
|
|
])
|
|
|
|
def test_ns_events_start_end(self):
|
|
parser = ET.XMLPullParser(events=('start-ns', 'start', 'end', 'end-ns'))
|
|
self._feed(parser, "<tag xmlns='abc' xmlns:p='xyz'>\n")
|
|
self.assert_event_tuples(parser, [
|
|
('start-ns', ('', 'abc')),
|
|
('start-ns', ('p', 'xyz')),
|
|
], max_events=2)
|
|
self.assert_event_tags(parser, [
|
|
('start', '{abc}tag'),
|
|
], max_events=1)
|
|
|
|
self._feed(parser, "<child />\n")
|
|
self.assert_event_tags(parser, [
|
|
('start', '{abc}child'),
|
|
('end', '{abc}child'),
|
|
])
|
|
|
|
self._feed(parser, "</tag>\n")
|
|
parser.close()
|
|
self.assert_event_tags(parser, [
|
|
('end', '{abc}tag'),
|
|
], max_events=1)
|
|
self.assert_event_tuples(parser, [
|
|
('end-ns', None),
|
|
('end-ns', None),
|
|
])
|
|
|
|
def test_events(self):
|
|
parser = ET.XMLPullParser(events=())
|
|
self._feed(parser, "<root/>\n")
|
|
self.assert_event_tags(parser, [])
|
|
|
|
parser = ET.XMLPullParser(events=('start', 'end'))
|
|
self._feed(parser, "<!-- text here -->\n")
|
|
self.assert_events(parser, [])
|
|
|
|
parser = ET.XMLPullParser(events=('start', 'end'))
|
|
self._feed(parser, "<root>\n")
|
|
self.assert_event_tags(parser, [('start', 'root')])
|
|
self._feed(parser, "<element key='value'>text</element")
|
|
self.assert_event_tags(parser, [('start', 'element')])
|
|
self._feed(parser, ">\n")
|
|
self.assert_event_tags(parser, [('end', 'element')])
|
|
self._feed(parser,
|
|
"<element xmlns='foo'>text<empty-element/></element>tail\n")
|
|
self.assert_event_tags(parser, [
|
|
('start', '{foo}element'),
|
|
('start', '{foo}empty-element'),
|
|
('end', '{foo}empty-element'),
|
|
('end', '{foo}element'),
|
|
])
|
|
self._feed(parser, "</root>")
|
|
self.assertIsNone(parser.close())
|
|
self.assert_event_tags(parser, [('end', 'root')])
|
|
|
|
parser = ET.XMLPullParser(events=('start',))
|
|
self._feed(parser, "<!-- comment -->\n")
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser, "<root>\n")
|
|
self.assert_event_tags(parser, [('start', 'root')])
|
|
self._feed(parser, "<element key='value'>text</element")
|
|
self.assert_event_tags(parser, [('start', 'element')])
|
|
self._feed(parser, ">\n")
|
|
self.assert_event_tags(parser, [])
|
|
self._feed(parser,
|
|
"<element xmlns='foo'>text<empty-element/></element>tail\n")
|
|
self.assert_event_tags(parser, [
|
|
('start', '{foo}element'),
|
|
('start', '{foo}empty-element'),
|
|
])
|
|
self._feed(parser, "</root>")
|
|
self.assertIsNone(parser.close())
|
|
|
|
def test_events_comment(self):
|
|
parser = ET.XMLPullParser(events=('start', 'comment', 'end'))
|
|
self._feed(parser, "<!-- text here -->\n")
|
|
self.assert_events(parser, [('comment', (ET.Comment, ' text here '))])
|
|
self._feed(parser, "<!-- more text here -->\n")
|
|
self.assert_events(parser, [('comment', (ET.Comment, ' more text here '))])
|
|
self._feed(parser, "<root-tag>text")
|
|
self.assert_event_tags(parser, [('start', 'root-tag')])
|
|
self._feed(parser, "<!-- inner comment-->\n")
|
|
self.assert_events(parser, [('comment', (ET.Comment, ' inner comment'))])
|
|
self._feed(parser, "</root-tag>\n")
|
|
self.assert_event_tags(parser, [('end', 'root-tag')])
|
|
self._feed(parser, "<!-- outer comment -->\n")
|
|
self.assert_events(parser, [('comment', (ET.Comment, ' outer comment '))])
|
|
|
|
parser = ET.XMLPullParser(events=('comment',))
|
|
self._feed(parser, "<!-- text here -->\n")
|
|
self.assert_events(parser, [('comment', (ET.Comment, ' text here '))])
|
|
|
|
def test_events_pi(self):
|
|
parser = ET.XMLPullParser(events=('start', 'pi', 'end'))
|
|
self._feed(parser, "<?pitarget?>\n")
|
|
self.assert_events(parser, [('pi', (ET.PI, 'pitarget'))])
|
|
parser = ET.XMLPullParser(events=('pi',))
|
|
self._feed(parser, "<?pitarget some text ?>\n")
|
|
self.assert_events(parser, [('pi', (ET.PI, 'pitarget some text '))])
|
|
|
|
def test_events_sequence(self):
|
|
# Test that events can be some sequence that's not just a tuple or list
|
|
eventset = {'end', 'start'}
|
|
parser = ET.XMLPullParser(events=eventset)
|
|
self._feed(parser, "<foo>bar</foo>")
|
|
self.assert_event_tags(parser, [('start', 'foo'), ('end', 'foo')])
|
|
|
|
class DummyIter:
|
|
def __init__(self):
|
|
self.events = iter(['start', 'end', 'start-ns'])
|
|
def __iter__(self):
|
|
return self
|
|
def __next__(self):
|
|
return next(self.events)
|
|
|
|
parser = ET.XMLPullParser(events=DummyIter())
|
|
self._feed(parser, "<foo>bar</foo>")
|
|
self.assert_event_tags(parser, [('start', 'foo'), ('end', 'foo')])
|
|
|
|
def test_unknown_event(self):
|
|
with self.assertRaises(ValueError):
|
|
ET.XMLPullParser(events=('start', 'end', 'bogus'))
|
|
|
|
@unittest.skipIf(pyexpat.version_info < (2, 6, 0),
|
|
f'Expat {pyexpat.version_info} does not '
|
|
'support reparse deferral')
|
|
def test_flush_reparse_deferral_enabled(self):
|
|
parser = ET.XMLPullParser(events=('start', 'end'))
|
|
|
|
for chunk in ("<doc", ">"):
|
|
parser.feed(chunk)
|
|
|
|
self.assert_event_tags(parser, []) # i.e. no elements started
|
|
if ET is pyET:
|
|
self.assertTrue(parser._parser._parser.GetReparseDeferralEnabled())
|
|
|
|
parser.flush()
|
|
|
|
self.assert_event_tags(parser, [('start', 'doc')])
|
|
if ET is pyET:
|
|
self.assertTrue(parser._parser._parser.GetReparseDeferralEnabled())
|
|
|
|
parser.feed("</doc>")
|
|
parser.close()
|
|
|
|
self.assert_event_tags(parser, [('end', 'doc')])
|
|
|
|
def test_flush_reparse_deferral_disabled(self):
|
|
parser = ET.XMLPullParser(events=('start', 'end'))
|
|
|
|
for chunk in ("<doc", ">"):
|
|
parser.feed(chunk)
|
|
|
|
if pyexpat.version_info >= (2, 6, 0):
|
|
if not ET is pyET:
|
|
self.skipTest(f'XMLParser.(Get|Set)ReparseDeferralEnabled '
|
|
'methods not available in C')
|
|
parser._parser._parser.SetReparseDeferralEnabled(False)
|
|
self.assert_event_tags(parser, []) # i.e. no elements started
|
|
|
|
if ET is pyET:
|
|
self.assertFalse(parser._parser._parser.GetReparseDeferralEnabled())
|
|
|
|
parser.flush()
|
|
|
|
self.assert_event_tags(parser, [('start', 'doc')])
|
|
if ET is pyET:
|
|
self.assertFalse(parser._parser._parser.GetReparseDeferralEnabled())
|
|
|
|
parser.feed("</doc>")
|
|
parser.close()
|
|
|
|
self.assert_event_tags(parser, [('end', 'doc')])
|
|
|
|
#
|
|
# xinclude tests (samples from appendix C of the xinclude specification)
|
|
|
|
XINCLUDE = {}
|
|
|
|
XINCLUDE["C1.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>120 Mz is adequate for an average home user.</p>
|
|
<xi:include href="disclaimer.xml"/>
|
|
</document>
|
|
"""
|
|
|
|
XINCLUDE["disclaimer.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<disclaimer>
|
|
<p>The opinions represented herein represent those of the individual
|
|
and should not be interpreted as official policy endorsed by this
|
|
organization.</p>
|
|
</disclaimer>
|
|
"""
|
|
|
|
XINCLUDE["C2.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>This document has been accessed
|
|
<xi:include href="count.txt" parse="text"/> times.</p>
|
|
</document>
|
|
"""
|
|
|
|
XINCLUDE["count.txt"] = "324387"
|
|
|
|
XINCLUDE["C2b.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>This document has been <em>accessed</em>
|
|
<xi:include href="count.txt" parse="text"/> times.</p>
|
|
</document>
|
|
"""
|
|
|
|
XINCLUDE["C3.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>The following is the source of the "data.xml" resource:</p>
|
|
<example><xi:include href="data.xml" parse="text"/></example>
|
|
</document>
|
|
"""
|
|
|
|
XINCLUDE["data.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<data>
|
|
<item><![CDATA[Brooks & Shields]]></item>
|
|
</data>
|
|
"""
|
|
|
|
XINCLUDE["C5.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<div xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<xi:include href="example.txt" parse="text">
|
|
<xi:fallback>
|
|
<xi:include href="fallback-example.txt" parse="text">
|
|
<xi:fallback><a href="mailto:bob@example.org">Report error</a></xi:fallback>
|
|
</xi:include>
|
|
</xi:fallback>
|
|
</xi:include>
|
|
</div>
|
|
"""
|
|
|
|
XINCLUDE["default.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>Example.</p>
|
|
<xi:include href="{}"/>
|
|
</document>
|
|
""".format(html.escape(SIMPLE_XMLFILE, True))
|
|
|
|
XINCLUDE["include_c1_repeated.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>The following is the source code of Recursive1.xml:</p>
|
|
<xi:include href="C1.xml"/>
|
|
<xi:include href="C1.xml"/>
|
|
<xi:include href="C1.xml"/>
|
|
<xi:include href="C1.xml"/>
|
|
</document>
|
|
"""
|
|
|
|
#
|
|
# badly formatted xi:include tags
|
|
|
|
XINCLUDE_BAD = {}
|
|
|
|
XINCLUDE_BAD["B1.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>120 Mz is adequate for an average home user.</p>
|
|
<xi:include href="disclaimer.xml" parse="BAD_TYPE"/>
|
|
</document>
|
|
"""
|
|
|
|
XINCLUDE_BAD["B2.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<div xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<xi:fallback></xi:fallback>
|
|
</div>
|
|
"""
|
|
|
|
XINCLUDE["Recursive1.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>The following is the source code of Recursive2.xml:</p>
|
|
<xi:include href="Recursive2.xml"/>
|
|
</document>
|
|
"""
|
|
|
|
XINCLUDE["Recursive2.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>The following is the source code of Recursive3.xml:</p>
|
|
<xi:include href="Recursive3.xml"/>
|
|
</document>
|
|
"""
|
|
|
|
XINCLUDE["Recursive3.xml"] = """\
|
|
<?xml version='1.0'?>
|
|
<document xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<p>The following is the source code of Recursive1.xml:</p>
|
|
<xi:include href="Recursive1.xml"/>
|
|
</document>
|
|
"""
|
|
|
|
|
|
class XIncludeTest(unittest.TestCase):
|
|
|
|
def xinclude_loader(self, href, parse="xml", encoding=None):
|
|
try:
|
|
data = XINCLUDE[href]
|
|
except KeyError:
|
|
raise OSError("resource not found")
|
|
if parse == "xml":
|
|
data = ET.XML(data)
|
|
return data
|
|
|
|
def none_loader(self, href, parser, encoding=None):
|
|
return None
|
|
|
|
def _my_loader(self, href, parse):
|
|
# Used to avoid a test-dependency problem where the default loader
|
|
# of ElementInclude uses the pyET parser for cET tests.
|
|
if parse == 'xml':
|
|
with open(href, 'rb') as f:
|
|
return ET.parse(f).getroot()
|
|
else:
|
|
return None
|
|
|
|
def test_xinclude_default(self):
|
|
from xml.etree import ElementInclude
|
|
doc = self.xinclude_loader('default.xml')
|
|
ElementInclude.include(doc, self._my_loader)
|
|
self.assertEqual(serialize(doc),
|
|
'<document>\n'
|
|
' <p>Example.</p>\n'
|
|
' <root>\n'
|
|
' <element key="value">text</element>\n'
|
|
' <element>text</element>tail\n'
|
|
' <empty-element />\n'
|
|
'</root>\n'
|
|
'</document>')
|
|
|
|
def test_xinclude(self):
|
|
from xml.etree import ElementInclude
|
|
|
|
# Basic inclusion example (XInclude C.1)
|
|
document = self.xinclude_loader("C1.xml")
|
|
ElementInclude.include(document, self.xinclude_loader)
|
|
self.assertEqual(serialize(document),
|
|
'<document>\n'
|
|
' <p>120 Mz is adequate for an average home user.</p>\n'
|
|
' <disclaimer>\n'
|
|
' <p>The opinions represented herein represent those of the individual\n'
|
|
' and should not be interpreted as official policy endorsed by this\n'
|
|
' organization.</p>\n'
|
|
'</disclaimer>\n'
|
|
'</document>') # C1
|
|
|
|
# Textual inclusion example (XInclude C.2)
|
|
document = self.xinclude_loader("C2.xml")
|
|
ElementInclude.include(document, self.xinclude_loader)
|
|
self.assertEqual(serialize(document),
|
|
'<document>\n'
|
|
' <p>This document has been accessed\n'
|
|
' 324387 times.</p>\n'
|
|
'</document>') # C2
|
|
|
|
# Textual inclusion after sibling element (based on modified XInclude C.2)
|
|
document = self.xinclude_loader("C2b.xml")
|
|
ElementInclude.include(document, self.xinclude_loader)
|
|
self.assertEqual(serialize(document),
|
|
'<document>\n'
|
|
' <p>This document has been <em>accessed</em>\n'
|
|
' 324387 times.</p>\n'
|
|
'</document>') # C2b
|
|
|
|
# Textual inclusion of XML example (XInclude C.3)
|
|
document = self.xinclude_loader("C3.xml")
|
|
ElementInclude.include(document, self.xinclude_loader)
|
|
self.assertEqual(serialize(document),
|
|
'<document>\n'
|
|
' <p>The following is the source of the "data.xml" resource:</p>\n'
|
|
" <example><?xml version='1.0'?>\n"
|
|
'<data>\n'
|
|
' <item><![CDATA[Brooks & Shields]]></item>\n'
|
|
'</data>\n'
|
|
'</example>\n'
|
|
'</document>') # C3
|
|
|
|
# Fallback example (XInclude C.5)
|
|
# Note! Fallback support is not yet implemented
|
|
document = self.xinclude_loader("C5.xml")
|
|
with self.assertRaises(OSError) as cm:
|
|
ElementInclude.include(document, self.xinclude_loader)
|
|
self.assertEqual(str(cm.exception), 'resource not found')
|
|
self.assertEqual(serialize(document),
|
|
'<div xmlns:ns0="http://www.w3.org/2001/XInclude">\n'
|
|
' <ns0:include href="example.txt" parse="text">\n'
|
|
' <ns0:fallback>\n'
|
|
' <ns0:include href="fallback-example.txt" parse="text">\n'
|
|
' <ns0:fallback><a href="mailto:bob@example.org">Report error</a></ns0:fallback>\n'
|
|
' </ns0:include>\n'
|
|
' </ns0:fallback>\n'
|
|
' </ns0:include>\n'
|
|
'</div>') # C5
|
|
|
|
def test_xinclude_repeated(self):
|
|
from xml.etree import ElementInclude
|
|
|
|
document = self.xinclude_loader("include_c1_repeated.xml")
|
|
ElementInclude.include(document, self.xinclude_loader)
|
|
self.assertEqual(1+4*2, len(document.findall(".//p")))
|
|
|
|
def test_xinclude_failures(self):
|
|
from xml.etree import ElementInclude
|
|
|
|
# Test failure to locate included XML file.
|
|
document = ET.XML(XINCLUDE["C1.xml"])
|
|
with self.assertRaises(ElementInclude.FatalIncludeError) as cm:
|
|
ElementInclude.include(document, loader=self.none_loader)
|
|
self.assertEqual(str(cm.exception),
|
|
"cannot load 'disclaimer.xml' as 'xml'")
|
|
|
|
# Test failure to locate included text file.
|
|
document = ET.XML(XINCLUDE["C2.xml"])
|
|
with self.assertRaises(ElementInclude.FatalIncludeError) as cm:
|
|
ElementInclude.include(document, loader=self.none_loader)
|
|
self.assertEqual(str(cm.exception),
|
|
"cannot load 'count.txt' as 'text'")
|
|
|
|
# Test bad parse type.
|
|
document = ET.XML(XINCLUDE_BAD["B1.xml"])
|
|
with self.assertRaises(ElementInclude.FatalIncludeError) as cm:
|
|
ElementInclude.include(document, loader=self.none_loader)
|
|
self.assertEqual(str(cm.exception),
|
|
"unknown parse type in xi:include tag ('BAD_TYPE')")
|
|
|
|
# Test xi:fallback outside xi:include.
|
|
document = ET.XML(XINCLUDE_BAD["B2.xml"])
|
|
with self.assertRaises(ElementInclude.FatalIncludeError) as cm:
|
|
ElementInclude.include(document, loader=self.none_loader)
|
|
self.assertEqual(str(cm.exception),
|
|
"xi:fallback tag must be child of xi:include "
|
|
"('{http://www.w3.org/2001/XInclude}fallback')")
|
|
|
|
# Test infinitely recursive includes.
|
|
document = self.xinclude_loader("Recursive1.xml")
|
|
with self.assertRaises(ElementInclude.FatalIncludeError) as cm:
|
|
ElementInclude.include(document, self.xinclude_loader)
|
|
self.assertEqual(str(cm.exception),
|
|
"recursive include of Recursive2.xml")
|
|
|
|
# Test 'max_depth' limitation.
|
|
document = self.xinclude_loader("Recursive1.xml")
|
|
with self.assertRaises(ElementInclude.FatalIncludeError) as cm:
|
|
ElementInclude.include(document, self.xinclude_loader, max_depth=None)
|
|
self.assertEqual(str(cm.exception),
|
|
"recursive include of Recursive2.xml")
|
|
|
|
document = self.xinclude_loader("Recursive1.xml")
|
|
with self.assertRaises(ElementInclude.LimitedRecursiveIncludeError) as cm:
|
|
ElementInclude.include(document, self.xinclude_loader, max_depth=0)
|
|
self.assertEqual(str(cm.exception),
|
|
"maximum xinclude depth reached when including file Recursive2.xml")
|
|
|
|
document = self.xinclude_loader("Recursive1.xml")
|
|
with self.assertRaises(ElementInclude.LimitedRecursiveIncludeError) as cm:
|
|
ElementInclude.include(document, self.xinclude_loader, max_depth=1)
|
|
self.assertEqual(str(cm.exception),
|
|
"maximum xinclude depth reached when including file Recursive3.xml")
|
|
|
|
document = self.xinclude_loader("Recursive1.xml")
|
|
with self.assertRaises(ElementInclude.LimitedRecursiveIncludeError) as cm:
|
|
ElementInclude.include(document, self.xinclude_loader, max_depth=2)
|
|
self.assertEqual(str(cm.exception),
|
|
"maximum xinclude depth reached when including file Recursive1.xml")
|
|
|
|
document = self.xinclude_loader("Recursive1.xml")
|
|
with self.assertRaises(ElementInclude.FatalIncludeError) as cm:
|
|
ElementInclude.include(document, self.xinclude_loader, max_depth=3)
|
|
self.assertEqual(str(cm.exception),
|
|
"recursive include of Recursive2.xml")
|
|
|
|
|
|
# --------------------------------------------------------------------
|
|
# reported bugs
|
|
|
|
class BugsTest(unittest.TestCase):
|
|
|
|
def test_bug_xmltoolkit21(self):
|
|
# marshaller gives obscure errors for non-string values
|
|
|
|
def check(elem):
|
|
with self.assertRaises(TypeError) as cm:
|
|
serialize(elem)
|
|
self.assertEqual(str(cm.exception),
|
|
'cannot serialize 123 (type int)')
|
|
|
|
elem = ET.Element(123)
|
|
check(elem) # tag
|
|
|
|
elem = ET.Element("elem")
|
|
elem.text = 123
|
|
check(elem) # text
|
|
|
|
elem = ET.Element("elem")
|
|
elem.tail = 123
|
|
check(elem) # tail
|
|
|
|
elem = ET.Element("elem")
|
|
elem.set(123, "123")
|
|
check(elem) # attribute key
|
|
|
|
elem = ET.Element("elem")
|
|
elem.set("123", 123)
|
|
check(elem) # attribute value
|
|
|
|
def test_bug_xmltoolkit25(self):
|
|
# typo in ElementTree.findtext
|
|
|
|
elem = ET.XML(SAMPLE_XML)
|
|
tree = ET.ElementTree(elem)
|
|
self.assertEqual(tree.findtext("tag"), 'text')
|
|
self.assertEqual(tree.findtext("section/tag"), 'subtext')
|
|
|
|
def test_bug_xmltoolkit28(self):
|
|
# .//tag causes exceptions
|
|
|
|
tree = ET.XML("<doc><table><tbody/></table></doc>")
|
|
self.assertEqual(summarize_list(tree.findall(".//thead")), [])
|
|
self.assertEqual(summarize_list(tree.findall(".//tbody")), ['tbody'])
|
|
|
|
def test_bug_xmltoolkitX1(self):
|
|
# dump() doesn't flush the output buffer
|
|
|
|
tree = ET.XML("<doc><table><tbody/></table></doc>")
|
|
with support.captured_stdout() as stdout:
|
|
ET.dump(tree)
|
|
self.assertEqual(stdout.getvalue(), '<doc><table><tbody /></table></doc>\n')
|
|
|
|
def test_bug_xmltoolkit39(self):
|
|
# non-ascii element and attribute names doesn't work
|
|
|
|
tree = ET.XML(b"<?xml version='1.0' encoding='iso-8859-1'?><t\xe4g />")
|
|
self.assertEqual(ET.tostring(tree, "utf-8"), b'<t\xc3\xa4g />')
|
|
|
|
tree = ET.XML(b"<?xml version='1.0' encoding='iso-8859-1'?>"
|
|
b"<tag \xe4ttr='välue' />")
|
|
self.assertEqual(tree.attrib, {'\xe4ttr': 'v\xe4lue'})
|
|
self.assertEqual(ET.tostring(tree, "utf-8"),
|
|
b'<tag \xc3\xa4ttr="v\xc3\xa4lue" />')
|
|
|
|
tree = ET.XML(b"<?xml version='1.0' encoding='iso-8859-1'?>"
|
|
b'<t\xe4g>text</t\xe4g>')
|
|
self.assertEqual(ET.tostring(tree, "utf-8"),
|
|
b'<t\xc3\xa4g>text</t\xc3\xa4g>')
|
|
|
|
tree = ET.Element("t\u00e4g")
|
|
self.assertEqual(ET.tostring(tree, "utf-8"), b'<t\xc3\xa4g />')
|
|
|
|
tree = ET.Element("tag")
|
|
tree.set("\u00e4ttr", "v\u00e4lue")
|
|
self.assertEqual(ET.tostring(tree, "utf-8"),
|
|
b'<tag \xc3\xa4ttr="v\xc3\xa4lue" />')
|
|
|
|
def test_bug_xmltoolkit54(self):
|
|
# problems handling internally defined entities
|
|
|
|
e = ET.XML("<!DOCTYPE doc [<!ENTITY ldots '舰'>]>"
|
|
'<doc>&ldots;</doc>')
|
|
self.assertEqual(serialize(e, encoding="us-ascii"),
|
|
b'<doc>舰</doc>')
|
|
self.assertEqual(serialize(e), '<doc>\u8230</doc>')
|
|
|
|
def test_bug_xmltoolkit55(self):
|
|
# make sure we're reporting the first error, not the last
|
|
|
|
with self.assertRaises(ET.ParseError) as cm:
|
|
ET.XML(b"<!DOCTYPE doc SYSTEM 'doc.dtd'>"
|
|
b'<doc>&ldots;&ndots;&rdots;</doc>')
|
|
self.assertEqual(str(cm.exception),
|
|
'undefined entity &ldots;: line 1, column 36')
|
|
|
|
def test_bug_xmltoolkit60(self):
|
|
# Handle crash in stream source.
|
|
|
|
class ExceptionFile:
|
|
def read(self, x):
|
|
raise OSError
|
|
|
|
self.assertRaises(OSError, ET.parse, ExceptionFile())
|
|
|
|
def test_bug_xmltoolkit62(self):
|
|
# Don't crash when using custom entities.
|
|
|
|
ENTITIES = {'rsquo': '\u2019', 'lsquo': '\u2018'}
|
|
parser = ET.XMLParser()
|
|
parser.entity.update(ENTITIES)
|
|
parser.feed("""<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE patent-application-publication SYSTEM "pap-v15-2001-01-31.dtd" []>
|
|
<patent-application-publication>
|
|
<subdoc-abstract>
|
|
<paragraph id="A-0001" lvl="0">A new cultivar of Begonia plant named ‘BCT9801BEG’.</paragraph>
|
|
</subdoc-abstract>
|
|
</patent-application-publication>""")
|
|
t = parser.close()
|
|
self.assertEqual(t.find('.//paragraph').text,
|
|
'A new cultivar of Begonia plant named \u2018BCT9801BEG\u2019.')
|
|
|
|
@unittest.skipIf(sys.gettrace(), "Skips under coverage.")
|
|
def test_bug_xmltoolkit63(self):
|
|
# Check reference leak.
|
|
def xmltoolkit63():
|
|
tree = ET.TreeBuilder()
|
|
tree.start("tag", {})
|
|
tree.data("text")
|
|
tree.end("tag")
|
|
|
|
xmltoolkit63()
|
|
count = sys.getrefcount(None)
|
|
for i in range(1000):
|
|
xmltoolkit63()
|
|
self.assertEqual(sys.getrefcount(None), count)
|
|
|
|
def test_bug_200708_newline(self):
|
|
# Preserve newlines in attributes.
|
|
|
|
e = ET.Element('SomeTag', text="def _f():\n return 3\n")
|
|
self.assertEqual(ET.tostring(e),
|
|
b'<SomeTag text="def _f(): return 3 " />')
|
|
self.assertEqual(ET.XML(ET.tostring(e)).get("text"),
|
|
'def _f():\n return 3\n')
|
|
self.assertEqual(ET.tostring(ET.XML(ET.tostring(e))),
|
|
b'<SomeTag text="def _f(): return 3 " />')
|
|
|
|
def test_bug_200708_close(self):
|
|
# Test default builder.
|
|
parser = ET.XMLParser() # default
|
|
parser.feed("<element>some text</element>")
|
|
self.assertEqual(parser.close().tag, 'element')
|
|
|
|
# Test custom builder.
|
|
class EchoTarget:
|
|
def close(self):
|
|
return ET.Element("element") # simulate root
|
|
parser = ET.XMLParser(target=EchoTarget())
|
|
parser.feed("<element>some text</element>")
|
|
self.assertEqual(parser.close().tag, 'element')
|
|
|
|
def test_bug_200709_default_namespace(self):
|
|
e = ET.Element("{default}elem")
|
|
s = ET.SubElement(e, "{default}elem")
|
|
self.assertEqual(serialize(e, default_namespace="default"), # 1
|
|
'<elem xmlns="default"><elem /></elem>')
|
|
|
|
e = ET.Element("{default}elem")
|
|
s = ET.SubElement(e, "{default}elem")
|
|
s = ET.SubElement(e, "{not-default}elem")
|
|
self.assertEqual(serialize(e, default_namespace="default"), # 2
|
|
'<elem xmlns="default" xmlns:ns1="not-default">'
|
|
'<elem />'
|
|
'<ns1:elem />'
|
|
'</elem>')
|
|
|
|
e = ET.Element("{default}elem")
|
|
s = ET.SubElement(e, "{default}elem")
|
|
s = ET.SubElement(e, "elem") # unprefixed name
|
|
with self.assertRaises(ValueError) as cm:
|
|
serialize(e, default_namespace="default") # 3
|
|
self.assertEqual(str(cm.exception),
|
|
'cannot use non-qualified names with default_namespace option')
|
|
|
|
def test_bug_200709_register_namespace(self):
|
|
e = ET.Element("{http://namespace.invalid/does/not/exist/}title")
|
|
self.assertEqual(ET.tostring(e),
|
|
b'<ns0:title xmlns:ns0="http://namespace.invalid/does/not/exist/" />')
|
|
ET.register_namespace("foo", "http://namespace.invalid/does/not/exist/")
|
|
e = ET.Element("{http://namespace.invalid/does/not/exist/}title")
|
|
self.assertEqual(ET.tostring(e),
|
|
b'<foo:title xmlns:foo="http://namespace.invalid/does/not/exist/" />')
|
|
|
|
# And the Dublin Core namespace is in the default list:
|
|
|
|
e = ET.Element("{http://purl.org/dc/elements/1.1/}title")
|
|
self.assertEqual(ET.tostring(e),
|
|
b'<dc:title xmlns:dc="http://purl.org/dc/elements/1.1/" />')
|
|
|
|
def test_bug_200709_element_comment(self):
|
|
# Not sure if this can be fixed, really (since the serializer needs
|
|
# ET.Comment, not cET.comment).
|
|
|
|
a = ET.Element('a')
|
|
a.append(ET.Comment('foo'))
|
|
self.assertEqual(a[0].tag, ET.Comment)
|
|
|
|
a = ET.Element('a')
|
|
a.append(ET.PI('foo'))
|
|
self.assertEqual(a[0].tag, ET.PI)
|
|
|
|
def test_bug_200709_element_insert(self):
|
|
a = ET.Element('a')
|
|
b = ET.SubElement(a, 'b')
|
|
c = ET.SubElement(a, 'c')
|
|
d = ET.Element('d')
|
|
a.insert(0, d)
|
|
self.assertEqual(summarize_list(a), ['d', 'b', 'c'])
|
|
a.insert(-1, d)
|
|
self.assertEqual(summarize_list(a), ['d', 'b', 'd', 'c'])
|
|
|
|
def test_bug_200709_iter_comment(self):
|
|
a = ET.Element('a')
|
|
b = ET.SubElement(a, 'b')
|
|
comment_b = ET.Comment("TEST-b")
|
|
b.append(comment_b)
|
|
self.assertEqual(summarize_list(a.iter(ET.Comment)), [ET.Comment])
|
|
|
|
# --------------------------------------------------------------------
|
|
# reported on bugs.python.org
|
|
|
|
def test_bug_1534630(self):
|
|
bob = ET.TreeBuilder()
|
|
e = bob.data("data")
|
|
e = bob.start("tag", {})
|
|
e = bob.end("tag")
|
|
e = bob.close()
|
|
self.assertEqual(serialize(e), '<tag />')
|
|
|
|
def test_issue6233(self):
|
|
e = ET.XML(b"<?xml version='1.0' encoding='utf-8'?>"
|
|
b'<body>t\xc3\xa3g</body>')
|
|
self.assertEqual(ET.tostring(e, 'ascii'),
|
|
b"<?xml version='1.0' encoding='ascii'?>\n"
|
|
b'<body>tãg</body>')
|
|
e = ET.XML(b"<?xml version='1.0' encoding='iso-8859-1'?>"
|
|
b'<body>t\xe3g</body>')
|
|
self.assertEqual(ET.tostring(e, 'ascii'),
|
|
b"<?xml version='1.0' encoding='ascii'?>\n"
|
|
b'<body>tãg</body>')
|
|
|
|
def test_issue6565(self):
|
|
elem = ET.XML("<body><tag/></body>")
|
|
self.assertEqual(summarize_list(elem), ['tag'])
|
|
newelem = ET.XML(SAMPLE_XML)
|
|
elem[:] = newelem[:]
|
|
self.assertEqual(summarize_list(elem), ['tag', 'tag', 'section'])
|
|
|
|
def test_issue10777(self):
|
|
# Registering a namespace twice caused a "dictionary changed size during
|
|
# iteration" bug.
|
|
|
|
ET.register_namespace('test10777', 'http://myuri/')
|
|
ET.register_namespace('test10777', 'http://myuri/')
|
|
|
|
def test_lost_text(self):
|
|
# Issue #25902: Borrowed text can disappear
|
|
class Text:
|
|
def __bool__(self):
|
|
e.text = 'changed'
|
|
return True
|
|
|
|
e = ET.Element('tag')
|
|
e.text = Text()
|
|
i = e.itertext()
|
|
t = next(i)
|
|
self.assertIsInstance(t, Text)
|
|
self.assertIsInstance(e.text, str)
|
|
self.assertEqual(e.text, 'changed')
|
|
|
|
def test_lost_tail(self):
|
|
# Issue #25902: Borrowed tail can disappear
|
|
class Text:
|
|
def __bool__(self):
|
|
e[0].tail = 'changed'
|
|
return True
|
|
|
|
e = ET.Element('root')
|
|
e.append(ET.Element('tag'))
|
|
e[0].tail = Text()
|
|
i = e.itertext()
|
|
t = next(i)
|
|
self.assertIsInstance(t, Text)
|
|
self.assertIsInstance(e[0].tail, str)
|
|
self.assertEqual(e[0].tail, 'changed')
|
|
|
|
def test_lost_elem(self):
|
|
# Issue #25902: Borrowed element can disappear
|
|
class Tag:
|
|
def __eq__(self, other):
|
|
e[0] = ET.Element('changed')
|
|
next(i)
|
|
return True
|
|
|
|
e = ET.Element('root')
|
|
e.append(ET.Element(Tag()))
|
|
e.append(ET.Element('tag'))
|
|
i = e.iter('tag')
|
|
try:
|
|
t = next(i)
|
|
except ValueError:
|
|
self.skipTest('generators are not reentrant')
|
|
self.assertIsInstance(t.tag, Tag)
|
|
self.assertIsInstance(e[0].tag, str)
|
|
self.assertEqual(e[0].tag, 'changed')
|
|
|
|
def check_expat224_utf8_bug(self, text):
|
|
xml = b'<a b="%s"/>' % text
|
|
root = ET.XML(xml)
|
|
self.assertEqual(root.get('b'), text.decode('utf-8'))
|
|
|
|
def test_expat224_utf8_bug(self):
|
|
# bpo-31170: Expat 2.2.3 had a bug in its UTF-8 decoder.
|
|
# Check that Expat 2.2.4 fixed the bug.
|
|
#
|
|
# Test buffer bounds at odd and even positions.
|
|
|
|
text = b'\xc3\xa0' * 1024
|
|
self.check_expat224_utf8_bug(text)
|
|
|
|
text = b'x' + b'\xc3\xa0' * 1024
|
|
self.check_expat224_utf8_bug(text)
|
|
|
|
def test_expat224_utf8_bug_file(self):
|
|
with open(UTF8_BUG_XMLFILE, 'rb') as fp:
|
|
raw = fp.read()
|
|
root = ET.fromstring(raw)
|
|
xmlattr = root.get('b')
|
|
|
|
# "Parse" manually the XML file to extract the value of the 'b'
|
|
# attribute of the <a b='xxx' /> XML element
|
|
text = raw.decode('utf-8').strip()
|
|
text = text.replace('\r\n', ' ')
|
|
text = text[6:-4]
|
|
self.assertEqual(root.get('b'), text)
|
|
|
|
def test_39495_treebuilder_start(self):
|
|
self.assertRaises(TypeError, ET.TreeBuilder().start, "tag")
|
|
self.assertRaises(TypeError, ET.TreeBuilder().start, "tag", None)
|
|
|
|
def test_issue123213_correct_extend_exception(self):
|
|
# Does not hide the internal exception when extending the element
|
|
self.assertRaises(ZeroDivisionError, ET.Element('tag').extend,
|
|
(1/0 for i in range(2)))
|
|
|
|
# Still raises the TypeError when extending with a non-iterable
|
|
self.assertRaises(TypeError, ET.Element('tag').extend, None)
|
|
|
|
# Preserves the TypeError message when extending with a generator
|
|
def f():
|
|
raise TypeError("mymessage")
|
|
|
|
self.assertRaisesRegex(
|
|
TypeError, 'mymessage',
|
|
ET.Element('tag').extend, (f() for i in range(2)))
|
|
|
|
|
|
|
|
# --------------------------------------------------------------------
|
|
|
|
|
|
class BasicElementTest(ElementTestCase, unittest.TestCase):
|
|
|
|
def test___init__(self):
|
|
tag = "foo"
|
|
attrib = { "zix": "wyp" }
|
|
|
|
element_foo = ET.Element(tag, attrib)
|
|
|
|
# traits of an element
|
|
self.assertIsInstance(element_foo, ET.Element)
|
|
self.assertIn("tag", dir(element_foo))
|
|
self.assertIn("attrib", dir(element_foo))
|
|
self.assertIn("text", dir(element_foo))
|
|
self.assertIn("tail", dir(element_foo))
|
|
|
|
# string attributes have expected values
|
|
self.assertEqual(element_foo.tag, tag)
|
|
self.assertIsNone(element_foo.text)
|
|
self.assertIsNone(element_foo.tail)
|
|
|
|
# attrib is a copy
|
|
self.assertIsNot(element_foo.attrib, attrib)
|
|
self.assertEqual(element_foo.attrib, attrib)
|
|
|
|
# attrib isn't linked
|
|
attrib["bar"] = "baz"
|
|
self.assertIsNot(element_foo.attrib, attrib)
|
|
self.assertNotEqual(element_foo.attrib, attrib)
|
|
|
|
def test___copy__(self):
|
|
element_foo = ET.Element("foo", { "zix": "wyp" })
|
|
element_foo.append(ET.Element("bar", { "baz": "qix" }))
|
|
|
|
element_foo2 = copy.copy(element_foo)
|
|
|
|
# elements are not the same
|
|
self.assertIsNot(element_foo2, element_foo)
|
|
|
|
# string attributes are equal
|
|
self.assertEqual(element_foo2.tag, element_foo.tag)
|
|
self.assertEqual(element_foo2.text, element_foo.text)
|
|
self.assertEqual(element_foo2.tail, element_foo.tail)
|
|
|
|
# number of children is the same
|
|
self.assertEqual(len(element_foo2), len(element_foo))
|
|
|
|
# children are the same
|
|
for (child1, child2) in itertools.zip_longest(element_foo, element_foo2):
|
|
self.assertIs(child1, child2)
|
|
|
|
# attrib is a copy
|
|
self.assertEqual(element_foo2.attrib, element_foo.attrib)
|
|
|
|
def test___deepcopy__(self):
|
|
element_foo = ET.Element("foo", { "zix": "wyp" })
|
|
element_foo.append(ET.Element("bar", { "baz": "qix" }))
|
|
|
|
element_foo2 = copy.deepcopy(element_foo)
|
|
|
|
# elements are not the same
|
|
self.assertIsNot(element_foo2, element_foo)
|
|
|
|
# string attributes are equal
|
|
self.assertEqual(element_foo2.tag, element_foo.tag)
|
|
self.assertEqual(element_foo2.text, element_foo.text)
|
|
self.assertEqual(element_foo2.tail, element_foo.tail)
|
|
|
|
# number of children is the same
|
|
self.assertEqual(len(element_foo2), len(element_foo))
|
|
|
|
# children are not the same
|
|
for (child1, child2) in itertools.zip_longest(element_foo, element_foo2):
|
|
self.assertIsNot(child1, child2)
|
|
|
|
# attrib is a copy
|
|
self.assertIsNot(element_foo2.attrib, element_foo.attrib)
|
|
self.assertEqual(element_foo2.attrib, element_foo.attrib)
|
|
|
|
# attrib isn't linked
|
|
element_foo.attrib["bar"] = "baz"
|
|
self.assertIsNot(element_foo2.attrib, element_foo.attrib)
|
|
self.assertNotEqual(element_foo2.attrib, element_foo.attrib)
|
|
|
|
def test_augmentation_type_errors(self):
|
|
e = ET.Element('joe')
|
|
self.assertRaises(TypeError, e.append, 'b')
|
|
self.assertRaises(TypeError, e.extend, [ET.Element('bar'), 'foo'])
|
|
self.assertRaises(TypeError, e.insert, 0, 'foo')
|
|
e[:] = [ET.Element('bar')]
|
|
with self.assertRaises(TypeError):
|
|
e[0] = 'foo'
|
|
with self.assertRaises(TypeError):
|
|
e[:] = [ET.Element('bar'), 'foo']
|
|
|
|
if hasattr(e, '__setstate__'):
|
|
state = {
|
|
'tag': 'tag',
|
|
'_children': [None], # non-Element
|
|
'attrib': 'attr',
|
|
'tail': 'tail',
|
|
'text': 'text',
|
|
}
|
|
self.assertRaises(TypeError, e.__setstate__, state)
|
|
|
|
if hasattr(e, '__deepcopy__'):
|
|
class E(ET.Element):
|
|
def __deepcopy__(self, memo):
|
|
return None # non-Element
|
|
e[:] = [E('bar')]
|
|
self.assertRaises(TypeError, copy.deepcopy, e)
|
|
|
|
def test_cyclic_gc(self):
|
|
class Dummy:
|
|
pass
|
|
|
|
# Test the shortest cycle: d->element->d
|
|
d = Dummy()
|
|
d.dummyref = ET.Element('joe', attr=d)
|
|
wref = weakref.ref(d)
|
|
del d
|
|
gc_collect()
|
|
self.assertIsNone(wref())
|
|
|
|
# A longer cycle: d->e->e2->d
|
|
e = ET.Element('joe')
|
|
d = Dummy()
|
|
d.dummyref = e
|
|
wref = weakref.ref(d)
|
|
e2 = ET.SubElement(e, 'foo', attr=d)
|
|
del d, e, e2
|
|
gc_collect()
|
|
self.assertIsNone(wref())
|
|
|
|
# A cycle between Element objects as children of one another
|
|
# e1->e2->e3->e1
|
|
e1 = ET.Element('e1')
|
|
e2 = ET.Element('e2')
|
|
e3 = ET.Element('e3')
|
|
e3.append(e1)
|
|
e2.append(e3)
|
|
e1.append(e2)
|
|
wref = weakref.ref(e1)
|
|
del e1, e2, e3
|
|
gc_collect()
|
|
self.assertIsNone(wref())
|
|
|
|
def test_weakref(self):
|
|
flag = False
|
|
def wref_cb(w):
|
|
nonlocal flag
|
|
flag = True
|
|
e = ET.Element('e')
|
|
wref = weakref.ref(e, wref_cb)
|
|
self.assertEqual(wref().tag, 'e')
|
|
del e
|
|
gc_collect() # For PyPy or other GCs.
|
|
self.assertEqual(flag, True)
|
|
self.assertEqual(wref(), None)
|
|
|
|
def test_get_keyword_args(self):
|
|
e1 = ET.Element('foo' , x=1, y=2, z=3)
|
|
self.assertEqual(e1.get('x', default=7), 1)
|
|
self.assertEqual(e1.get('w', default=7), 7)
|
|
|
|
def test_pickle(self):
|
|
# issue #16076: the C implementation wasn't pickleable.
|
|
for proto in range(2, pickle.HIGHEST_PROTOCOL + 1):
|
|
for dumper, loader in product(self.modules, repeat=2):
|
|
e = dumper.Element('foo', bar=42)
|
|
e.text = "text goes here"
|
|
e.tail = "opposite of head"
|
|
dumper.SubElement(e, 'child').append(dumper.Element('grandchild'))
|
|
e.append(dumper.Element('child'))
|
|
e.findall('.//grandchild')[0].set('attr', 'other value')
|
|
|
|
e2 = self.pickleRoundTrip(e, 'xml.etree.ElementTree',
|
|
dumper, loader, proto)
|
|
|
|
self.assertEqual(e2.tag, 'foo')
|
|
self.assertEqual(e2.attrib['bar'], 42)
|
|
self.assertEqual(len(e2), 2)
|
|
self.assertEqualElements(e, e2)
|
|
|
|
def test_pickle_issue18997(self):
|
|
for proto in range(2, pickle.HIGHEST_PROTOCOL + 1):
|
|
for dumper, loader in product(self.modules, repeat=2):
|
|
XMLTEXT = """<?xml version="1.0"?>
|
|
<group><dogs>4</dogs>
|
|
</group>"""
|
|
e1 = dumper.fromstring(XMLTEXT)
|
|
self.assertEqual(e1.__getstate__()['tag'], 'group')
|
|
e2 = self.pickleRoundTrip(e1, 'xml.etree.ElementTree',
|
|
dumper, loader, proto)
|
|
self.assertEqual(e2.tag, 'group')
|
|
self.assertEqual(e2[0].tag, 'dogs')
|
|
|
|
|
|
class BadElementTest(ElementTestCase, unittest.TestCase):
|
|
def test_extend_mutable_list(self):
|
|
class X:
|
|
@property
|
|
def __class__(self):
|
|
L[:] = [ET.Element('baz')]
|
|
return ET.Element
|
|
L = [X()]
|
|
e = ET.Element('foo')
|
|
try:
|
|
e.extend(L)
|
|
except TypeError:
|
|
pass
|
|
|
|
class Y(X, ET.Element):
|
|
pass
|
|
L = [Y('x')]
|
|
e = ET.Element('foo')
|
|
e.extend(L)
|
|
|
|
def test_extend_mutable_list2(self):
|
|
class X:
|
|
@property
|
|
def __class__(self):
|
|
del L[:]
|
|
return ET.Element
|
|
L = [X(), ET.Element('baz')]
|
|
e = ET.Element('foo')
|
|
try:
|
|
e.extend(L)
|
|
except TypeError:
|
|
pass
|
|
|
|
class Y(X, ET.Element):
|
|
pass
|
|
L = [Y('bar'), ET.Element('baz')]
|
|
e = ET.Element('foo')
|
|
e.extend(L)
|
|
|
|
def test_remove_with_mutating(self):
|
|
class X(ET.Element):
|
|
def __eq__(self, o):
|
|
del e[:]
|
|
return False
|
|
e = ET.Element('foo')
|
|
e.extend([X('bar')])
|
|
self.assertRaises(ValueError, e.remove, ET.Element('baz'))
|
|
|
|
e = ET.Element('foo')
|
|
e.extend([ET.Element('bar')])
|
|
self.assertRaises(ValueError, e.remove, X('baz'))
|
|
|
|
@support.infinite_recursion(25)
|
|
def test_recursive_repr(self):
|
|
# Issue #25455
|
|
e = ET.Element('foo')
|
|
with swap_attr(e, 'tag', e):
|
|
with self.assertRaises(RuntimeError):
|
|
repr(e) # Should not crash
|
|
|
|
def test_element_get_text(self):
|
|
# Issue #27863
|
|
class X(str):
|
|
def __del__(self):
|
|
try:
|
|
elem.text
|
|
except NameError:
|
|
pass
|
|
|
|
b = ET.TreeBuilder()
|
|
b.start('tag', {})
|
|
b.data('ABCD')
|
|
b.data(X('EFGH'))
|
|
b.data('IJKL')
|
|
b.end('tag')
|
|
|
|
elem = b.close()
|
|
self.assertEqual(elem.text, 'ABCDEFGHIJKL')
|
|
|
|
def test_element_get_tail(self):
|
|
# Issue #27863
|
|
class X(str):
|
|
def __del__(self):
|
|
try:
|
|
elem[0].tail
|
|
except NameError:
|
|
pass
|
|
|
|
b = ET.TreeBuilder()
|
|
b.start('root', {})
|
|
b.start('tag', {})
|
|
b.end('tag')
|
|
b.data('ABCD')
|
|
b.data(X('EFGH'))
|
|
b.data('IJKL')
|
|
b.end('root')
|
|
|
|
elem = b.close()
|
|
self.assertEqual(elem[0].tail, 'ABCDEFGHIJKL')
|
|
|
|
def test_subscr(self):
|
|
# Issue #27863
|
|
class X:
|
|
def __index__(self):
|
|
del e[:]
|
|
return 1
|
|
|
|
e = ET.Element('elem')
|
|
e.append(ET.Element('child'))
|
|
e[:X()] # shouldn't crash
|
|
|
|
e.append(ET.Element('child'))
|
|
e[0:10:X()] # shouldn't crash
|
|
|
|
def test_ass_subscr(self):
|
|
# Issue #27863
|
|
class X:
|
|
def __index__(self):
|
|
e[:] = []
|
|
return 1
|
|
|
|
e = ET.Element('elem')
|
|
for _ in range(10):
|
|
e.insert(0, ET.Element('child'))
|
|
|
|
e[0:10:X()] = [] # shouldn't crash
|
|
|
|
def test_treebuilder_start(self):
|
|
# Issue #27863
|
|
def element_factory(x, y):
|
|
return []
|
|
b = ET.TreeBuilder(element_factory=element_factory)
|
|
|
|
b.start('tag', {})
|
|
b.data('ABCD')
|
|
self.assertRaises(AttributeError, b.start, 'tag2', {})
|
|
del b
|
|
gc_collect()
|
|
|
|
def test_treebuilder_end(self):
|
|
# Issue #27863
|
|
def element_factory(x, y):
|
|
return []
|
|
b = ET.TreeBuilder(element_factory=element_factory)
|
|
|
|
b.start('tag', {})
|
|
b.data('ABCD')
|
|
self.assertRaises(AttributeError, b.end, 'tag')
|
|
del b
|
|
gc_collect()
|
|
|
|
|
|
class MutatingElementPath(str):
|
|
def __new__(cls, elem, *args):
|
|
self = str.__new__(cls, *args)
|
|
self.elem = elem
|
|
return self
|
|
def __eq__(self, o):
|
|
del self.elem[:]
|
|
return True
|
|
MutatingElementPath.__hash__ = str.__hash__
|
|
|
|
class BadElementPath(str):
|
|
def __eq__(self, o):
|
|
raise 1/0
|
|
BadElementPath.__hash__ = str.__hash__
|
|
|
|
class BadElementPathTest(ElementTestCase, unittest.TestCase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
from xml.etree import ElementPath
|
|
self.path_cache = ElementPath._cache
|
|
ElementPath._cache = {}
|
|
|
|
def tearDown(self):
|
|
from xml.etree import ElementPath
|
|
ElementPath._cache = self.path_cache
|
|
super().tearDown()
|
|
|
|
def test_find_with_mutating(self):
|
|
e = ET.Element('foo')
|
|
e.extend([ET.Element('bar')])
|
|
e.find(MutatingElementPath(e, 'x'))
|
|
|
|
def test_find_with_error(self):
|
|
e = ET.Element('foo')
|
|
e.extend([ET.Element('bar')])
|
|
try:
|
|
e.find(BadElementPath('x'))
|
|
except ZeroDivisionError:
|
|
pass
|
|
|
|
def test_findtext_with_mutating(self):
|
|
e = ET.Element('foo')
|
|
e.extend([ET.Element('bar')])
|
|
e.findtext(MutatingElementPath(e, 'x'))
|
|
|
|
def test_findtext_with_error(self):
|
|
e = ET.Element('foo')
|
|
e.extend([ET.Element('bar')])
|
|
try:
|
|
e.findtext(BadElementPath('x'))
|
|
except ZeroDivisionError:
|
|
pass
|
|
|
|
def test_findtext_with_falsey_text_attribute(self):
|
|
root_elem = ET.Element('foo')
|
|
sub_elem = ET.SubElement(root_elem, 'bar')
|
|
falsey = ["", 0, False, [], (), {}]
|
|
for val in falsey:
|
|
sub_elem.text = val
|
|
self.assertEqual(root_elem.findtext('./bar'), val)
|
|
|
|
def test_findtext_with_none_text_attribute(self):
|
|
root_elem = ET.Element('foo')
|
|
sub_elem = ET.SubElement(root_elem, 'bar')
|
|
sub_elem.text = None
|
|
self.assertEqual(root_elem.findtext('./bar'), '')
|
|
|
|
def test_findall_with_mutating(self):
|
|
e = ET.Element('foo')
|
|
e.extend([ET.Element('bar')])
|
|
e.findall(MutatingElementPath(e, 'x'))
|
|
|
|
def test_findall_with_error(self):
|
|
e = ET.Element('foo')
|
|
e.extend([ET.Element('bar')])
|
|
try:
|
|
e.findall(BadElementPath('x'))
|
|
except ZeroDivisionError:
|
|
pass
|
|
|
|
|
|
class ElementTreeTypeTest(unittest.TestCase):
|
|
def test_istype(self):
|
|
self.assertIsInstance(ET.ParseError, type)
|
|
self.assertIsInstance(ET.QName, type)
|
|
self.assertIsInstance(ET.ElementTree, type)
|
|
self.assertIsInstance(ET.Element, type)
|
|
self.assertIsInstance(ET.TreeBuilder, type)
|
|
self.assertIsInstance(ET.XMLParser, type)
|
|
|
|
def test_Element_subclass_trivial(self):
|
|
class MyElement(ET.Element):
|
|
pass
|
|
|
|
mye = MyElement('foo')
|
|
self.assertIsInstance(mye, ET.Element)
|
|
self.assertIsInstance(mye, MyElement)
|
|
self.assertEqual(mye.tag, 'foo')
|
|
|
|
# test that attribute assignment works (issue 14849)
|
|
mye.text = "joe"
|
|
self.assertEqual(mye.text, "joe")
|
|
|
|
def test_Element_subclass_constructor(self):
|
|
class MyElement(ET.Element):
|
|
def __init__(self, tag, attrib={}, **extra):
|
|
super(MyElement, self).__init__(tag + '__', attrib, **extra)
|
|
|
|
mye = MyElement('foo', {'a': 1, 'b': 2}, c=3, d=4)
|
|
self.assertEqual(mye.tag, 'foo__')
|
|
self.assertEqual(sorted(mye.items()),
|
|
[('a', 1), ('b', 2), ('c', 3), ('d', 4)])
|
|
|
|
def test_Element_subclass_new_method(self):
|
|
class MyElement(ET.Element):
|
|
def newmethod(self):
|
|
return self.tag
|
|
|
|
mye = MyElement('joe')
|
|
self.assertEqual(mye.newmethod(), 'joe')
|
|
|
|
def test_Element_subclass_find(self):
|
|
class MyElement(ET.Element):
|
|
pass
|
|
|
|
e = ET.Element('foo')
|
|
e.text = 'text'
|
|
sub = MyElement('bar')
|
|
sub.text = 'subtext'
|
|
e.append(sub)
|
|
self.assertEqual(e.findtext('bar'), 'subtext')
|
|
self.assertEqual(e.find('bar').tag, 'bar')
|
|
found = list(e.findall('bar'))
|
|
self.assertEqual(len(found), 1, found)
|
|
self.assertEqual(found[0].tag, 'bar')
|
|
|
|
|
|
class ElementFindTest(unittest.TestCase):
|
|
def test_find_simple(self):
|
|
e = ET.XML(SAMPLE_XML)
|
|
self.assertEqual(e.find('tag').tag, 'tag')
|
|
self.assertEqual(e.find('section/tag').tag, 'tag')
|
|
self.assertEqual(e.find('./tag').tag, 'tag')
|
|
|
|
e[2] = ET.XML(SAMPLE_SECTION)
|
|
self.assertEqual(e.find('section/nexttag').tag, 'nexttag')
|
|
|
|
self.assertEqual(e.findtext('./tag'), 'text')
|
|
self.assertEqual(e.findtext('section/tag'), 'subtext')
|
|
|
|
# section/nexttag is found but has no text
|
|
self.assertEqual(e.findtext('section/nexttag'), '')
|
|
self.assertEqual(e.findtext('section/nexttag', 'default'), '')
|
|
|
|
# tog doesn't exist and 'default' kicks in
|
|
self.assertIsNone(e.findtext('tog'))
|
|
self.assertEqual(e.findtext('tog', 'default'), 'default')
|
|
|
|
# Issue #16922
|
|
self.assertEqual(ET.XML('<tag><empty /></tag>').findtext('empty'), '')
|
|
|
|
def test_find_xpath(self):
|
|
LINEAR_XML = '''
|
|
<body>
|
|
<tag class='a'/>
|
|
<tag class='b'/>
|
|
<tag class='c'/>
|
|
<tag class='d'/>
|
|
</body>'''
|
|
e = ET.XML(LINEAR_XML)
|
|
|
|
# Test for numeric indexing and last()
|
|
self.assertEqual(e.find('./tag[1]').attrib['class'], 'a')
|
|
self.assertEqual(e.find('./tag[2]').attrib['class'], 'b')
|
|
self.assertEqual(e.find('./tag[last()]').attrib['class'], 'd')
|
|
self.assertEqual(e.find('./tag[last()-1]').attrib['class'], 'c')
|
|
self.assertEqual(e.find('./tag[last()-2]').attrib['class'], 'b')
|
|
|
|
self.assertRaisesRegex(SyntaxError, 'XPath', e.find, './tag[0]')
|
|
self.assertRaisesRegex(SyntaxError, 'XPath', e.find, './tag[-1]')
|
|
self.assertRaisesRegex(SyntaxError, 'XPath', e.find, './tag[last()-0]')
|
|
self.assertRaisesRegex(SyntaxError, 'XPath', e.find, './tag[last()+1]')
|
|
|
|
def test_findall(self):
|
|
e = ET.XML(SAMPLE_XML)
|
|
e[2] = ET.XML(SAMPLE_SECTION)
|
|
self.assertEqual(summarize_list(e.findall('.')), ['body'])
|
|
self.assertEqual(summarize_list(e.findall('tag')), ['tag', 'tag'])
|
|
self.assertEqual(summarize_list(e.findall('tog')), [])
|
|
self.assertEqual(summarize_list(e.findall('tog/foo')), [])
|
|
self.assertEqual(summarize_list(e.findall('*')),
|
|
['tag', 'tag', 'section'])
|
|
self.assertEqual(summarize_list(e.findall('.//tag')),
|
|
['tag'] * 4)
|
|
self.assertEqual(summarize_list(e.findall('section/tag')), ['tag'])
|
|
self.assertEqual(summarize_list(e.findall('section//tag')), ['tag'] * 2)
|
|
self.assertEqual(summarize_list(e.findall('section/*')),
|
|
['tag', 'nexttag', 'nextsection'])
|
|
self.assertEqual(summarize_list(e.findall('section//*')),
|
|
['tag', 'nexttag', 'nextsection', 'tag'])
|
|
self.assertEqual(summarize_list(e.findall('section/.//*')),
|
|
['tag', 'nexttag', 'nextsection', 'tag'])
|
|
self.assertEqual(summarize_list(e.findall('*/*')),
|
|
['tag', 'nexttag', 'nextsection'])
|
|
self.assertEqual(summarize_list(e.findall('*//*')),
|
|
['tag', 'nexttag', 'nextsection', 'tag'])
|
|
self.assertEqual(summarize_list(e.findall('*/tag')), ['tag'])
|
|
self.assertEqual(summarize_list(e.findall('*/./tag')), ['tag'])
|
|
self.assertEqual(summarize_list(e.findall('./tag')), ['tag'] * 2)
|
|
self.assertEqual(summarize_list(e.findall('././tag')), ['tag'] * 2)
|
|
|
|
self.assertEqual(summarize_list(e.findall('.//tag[@class]')),
|
|
['tag'] * 3)
|
|
self.assertEqual(summarize_list(e.findall('.//tag[@class="a"]')),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall('.//tag[@class!="a"]')),
|
|
['tag'] * 2)
|
|
self.assertEqual(summarize_list(e.findall('.//tag[@class="b"]')),
|
|
['tag'] * 2)
|
|
self.assertEqual(summarize_list(e.findall('.//tag[@class!="b"]')),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall('.//tag[@id]')),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall('.//section[tag]')),
|
|
['section'])
|
|
self.assertEqual(summarize_list(e.findall('.//section[element]')), [])
|
|
self.assertEqual(summarize_list(e.findall('../tag')), [])
|
|
self.assertEqual(summarize_list(e.findall('section/../tag')),
|
|
['tag'] * 2)
|
|
self.assertEqual(e.findall('section//'), e.findall('section//*'))
|
|
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag='subtext']")),
|
|
['section'])
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag ='subtext']")),
|
|
['section'])
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag= 'subtext']")),
|
|
['section'])
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag = 'subtext']")),
|
|
['section'])
|
|
self.assertEqual(summarize_list(e.findall(".//section[ tag = 'subtext' ]")),
|
|
['section'])
|
|
|
|
# Negations of above tests. They match nothing because the sole section
|
|
# tag has subtext.
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag!='subtext']")),
|
|
[])
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag !='subtext']")),
|
|
[])
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag!= 'subtext']")),
|
|
[])
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag != 'subtext']")),
|
|
[])
|
|
self.assertEqual(summarize_list(e.findall(".//section[ tag != 'subtext' ]")),
|
|
[])
|
|
|
|
self.assertEqual(summarize_list(e.findall(".//tag[.='subtext']")),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall(".//tag[. ='subtext']")),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall('.//tag[.= "subtext"]')),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall('.//tag[ . = "subtext" ]')),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall(".//tag[. = 'subtext']")),
|
|
['tag'])
|
|
self.assertEqual(summarize_list(e.findall(".//tag[. = 'subtext ']")),
|
|
[])
|
|
self.assertEqual(summarize_list(e.findall(".//tag[.= ' subtext']")),
|
|
[])
|
|
|
|
# Negations of above tests.
|
|
# Matches everything but the tag containing subtext
|
|
self.assertEqual(summarize_list(e.findall(".//tag[.!='subtext']")),
|
|
['tag'] * 3)
|
|
self.assertEqual(summarize_list(e.findall(".//tag[. !='subtext']")),
|
|
['tag'] * 3)
|
|
self.assertEqual(summarize_list(e.findall('.//tag[.!= "subtext"]')),
|
|
['tag'] * 3)
|
|
self.assertEqual(summarize_list(e.findall('.//tag[ . != "subtext" ]')),
|
|
['tag'] * 3)
|
|
self.assertEqual(summarize_list(e.findall(".//tag[. != 'subtext']")),
|
|
['tag'] * 3)
|
|
# Matches all tags.
|
|
self.assertEqual(summarize_list(e.findall(".//tag[. != 'subtext ']")),
|
|
['tag'] * 4)
|
|
self.assertEqual(summarize_list(e.findall(".//tag[.!= ' subtext']")),
|
|
['tag'] * 4)
|
|
|
|
# duplicate section => 2x tag matches
|
|
e[1] = e[2]
|
|
self.assertEqual(summarize_list(e.findall(".//section[tag = 'subtext']")),
|
|
['section', 'section'])
|
|
self.assertEqual(summarize_list(e.findall(".//tag[. = 'subtext']")),
|
|
['tag', 'tag'])
|
|
|
|
def test_test_find_with_ns(self):
|
|
e = ET.XML(SAMPLE_XML_NS)
|
|
self.assertEqual(summarize_list(e.findall('tag')), [])
|
|
self.assertEqual(
|
|
summarize_list(e.findall("{http://effbot.org/ns}tag")),
|
|
['{http://effbot.org/ns}tag'] * 2)
|
|
self.assertEqual(
|
|
summarize_list(e.findall(".//{http://effbot.org/ns}tag")),
|
|
['{http://effbot.org/ns}tag'] * 3)
|
|
|
|
def test_findall_different_nsmaps(self):
|
|
root = ET.XML('''
|
|
<a xmlns:x="X" xmlns:y="Y">
|
|
<x:b><c/></x:b>
|
|
<b/>
|
|
<c><x:b/><b/></c><y:b/>
|
|
</a>''')
|
|
nsmap = {'xx': 'X'}
|
|
self.assertEqual(len(root.findall(".//xx:b", namespaces=nsmap)), 2)
|
|
self.assertEqual(len(root.findall(".//b", namespaces=nsmap)), 2)
|
|
nsmap = {'xx': 'Y'}
|
|
self.assertEqual(len(root.findall(".//xx:b", namespaces=nsmap)), 1)
|
|
self.assertEqual(len(root.findall(".//b", namespaces=nsmap)), 2)
|
|
nsmap = {'xx': 'X', '': 'Y'}
|
|
self.assertEqual(len(root.findall(".//xx:b", namespaces=nsmap)), 2)
|
|
self.assertEqual(len(root.findall(".//b", namespaces=nsmap)), 1)
|
|
|
|
def test_findall_wildcard(self):
|
|
root = ET.XML('''
|
|
<a xmlns:x="X" xmlns:y="Y">
|
|
<x:b><c/></x:b>
|
|
<b/>
|
|
<c><x:b/><b/></c><y:b/>
|
|
</a>''')
|
|
root.append(ET.Comment('test'))
|
|
|
|
self.assertEqual(summarize_list(root.findall("{*}b")),
|
|
['{X}b', 'b', '{Y}b'])
|
|
self.assertEqual(summarize_list(root.findall("{*}c")),
|
|
['c'])
|
|
self.assertEqual(summarize_list(root.findall("{X}*")),
|
|
['{X}b'])
|
|
self.assertEqual(summarize_list(root.findall("{Y}*")),
|
|
['{Y}b'])
|
|
self.assertEqual(summarize_list(root.findall("{}*")),
|
|
['b', 'c'])
|
|
self.assertEqual(summarize_list(root.findall("{}b")), # only for consistency
|
|
['b'])
|
|
self.assertEqual(summarize_list(root.findall("{}b")),
|
|
summarize_list(root.findall("b")))
|
|
self.assertEqual(summarize_list(root.findall("{*}*")),
|
|
['{X}b', 'b', 'c', '{Y}b'])
|
|
# This is an unfortunate difference, but that's how find('*') works.
|
|
self.assertEqual(summarize_list(root.findall("{*}*") + [root[-1]]),
|
|
summarize_list(root.findall("*")))
|
|
|
|
self.assertEqual(summarize_list(root.findall(".//{*}b")),
|
|
['{X}b', 'b', '{X}b', 'b', '{Y}b'])
|
|
self.assertEqual(summarize_list(root.findall(".//{*}c")),
|
|
['c', 'c'])
|
|
self.assertEqual(summarize_list(root.findall(".//{X}*")),
|
|
['{X}b', '{X}b'])
|
|
self.assertEqual(summarize_list(root.findall(".//{Y}*")),
|
|
['{Y}b'])
|
|
self.assertEqual(summarize_list(root.findall(".//{}*")),
|
|
['c', 'b', 'c', 'b'])
|
|
self.assertEqual(summarize_list(root.findall(".//{}b")), # only for consistency
|
|
['b', 'b'])
|
|
self.assertEqual(summarize_list(root.findall(".//{}b")),
|
|
summarize_list(root.findall(".//b")))
|
|
|
|
def test_bad_find(self):
|
|
e = ET.XML(SAMPLE_XML)
|
|
with self.assertRaisesRegex(SyntaxError, 'cannot use absolute path'):
|
|
e.findall('/tag')
|
|
|
|
def test_find_through_ElementTree(self):
|
|
e = ET.XML(SAMPLE_XML)
|
|
self.assertEqual(ET.ElementTree(e).find('tag').tag, 'tag')
|
|
self.assertEqual(ET.ElementTree(e).findtext('tag'), 'text')
|
|
self.assertEqual(summarize_list(ET.ElementTree(e).findall('tag')),
|
|
['tag'] * 2)
|
|
# this produces a warning
|
|
msg = ("This search is broken in 1.3 and earlier, and will be fixed "
|
|
"in a future version. If you rely on the current behaviour, "
|
|
"change it to '.+'")
|
|
with self.assertWarnsRegex(FutureWarning, msg):
|
|
it = ET.ElementTree(e).findall('//tag')
|
|
self.assertEqual(summarize_list(it), ['tag'] * 3)
|
|
|
|
|
|
class ElementIterTest(unittest.TestCase):
|
|
def _ilist(self, elem, tag=None):
|
|
return summarize_list(elem.iter(tag))
|
|
|
|
def test_basic(self):
|
|
doc = ET.XML("<html><body>this is a <i>paragraph</i>.</body>..</html>")
|
|
self.assertEqual(self._ilist(doc), ['html', 'body', 'i'])
|
|
self.assertEqual(self._ilist(doc.find('body')), ['body', 'i'])
|
|
self.assertEqual(next(doc.iter()).tag, 'html')
|
|
self.assertEqual(''.join(doc.itertext()), 'this is a paragraph...')
|
|
self.assertEqual(''.join(doc.find('body').itertext()),
|
|
'this is a paragraph.')
|
|
self.assertEqual(next(doc.itertext()), 'this is a ')
|
|
|
|
# iterparse should return an iterator
|
|
sourcefile = serialize(doc, to_string=False)
|
|
self.assertEqual(next(ET.iterparse(sourcefile))[0], 'end')
|
|
|
|
# With an explicit parser too (issue #9708)
|
|
sourcefile = serialize(doc, to_string=False)
|
|
parser = ET.XMLParser(target=ET.TreeBuilder())
|
|
self.assertEqual(next(ET.iterparse(sourcefile, parser=parser))[0], 'end')
|
|
|
|
tree = ET.ElementTree(None)
|
|
self.assertRaises(AttributeError, tree.iter)
|
|
|
|
# Issue #16913
|
|
doc = ET.XML("<root>a&<sub>b&</sub>c&</root>")
|
|
self.assertEqual(''.join(doc.itertext()), 'a&b&c&')
|
|
|
|
def test_corners(self):
|
|
# single root, no subelements
|
|
a = ET.Element('a')
|
|
self.assertEqual(self._ilist(a), ['a'])
|
|
|
|
# one child
|
|
b = ET.SubElement(a, 'b')
|
|
self.assertEqual(self._ilist(a), ['a', 'b'])
|
|
|
|
# one child and one grandchild
|
|
c = ET.SubElement(b, 'c')
|
|
self.assertEqual(self._ilist(a), ['a', 'b', 'c'])
|
|
|
|
# two children, only first with grandchild
|
|
d = ET.SubElement(a, 'd')
|
|
self.assertEqual(self._ilist(a), ['a', 'b', 'c', 'd'])
|
|
|
|
# replace first child by second
|
|
a[0] = a[1]
|
|
del a[1]
|
|
self.assertEqual(self._ilist(a), ['a', 'd'])
|
|
|
|
def test_iter_by_tag(self):
|
|
doc = ET.XML('''
|
|
<document>
|
|
<house>
|
|
<room>bedroom1</room>
|
|
<room>bedroom2</room>
|
|
</house>
|
|
<shed>nothing here
|
|
</shed>
|
|
<house>
|
|
<room>bedroom8</room>
|
|
</house>
|
|
</document>''')
|
|
|
|
self.assertEqual(self._ilist(doc, 'room'), ['room'] * 3)
|
|
self.assertEqual(self._ilist(doc, 'house'), ['house'] * 2)
|
|
|
|
# test that iter also accepts 'tag' as a keyword arg
|
|
self.assertEqual(
|
|
summarize_list(doc.iter(tag='room')),
|
|
['room'] * 3)
|
|
|
|
# make sure both tag=None and tag='*' return all tags
|
|
all_tags = ['document', 'house', 'room', 'room',
|
|
'shed', 'house', 'room']
|
|
self.assertEqual(summarize_list(doc.iter()), all_tags)
|
|
self.assertEqual(self._ilist(doc), all_tags)
|
|
self.assertEqual(self._ilist(doc, '*'), all_tags)
|
|
|
|
def test_copy(self):
|
|
a = ET.Element('a')
|
|
it = a.iter()
|
|
with self.assertRaises(TypeError):
|
|
copy.copy(it)
|
|
|
|
def test_pickle(self):
|
|
a = ET.Element('a')
|
|
it = a.iter()
|
|
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
|
|
with self.assertRaises((TypeError, pickle.PicklingError)):
|
|
pickle.dumps(it, proto)
|
|
|
|
|
|
class TreeBuilderTest(unittest.TestCase):
|
|
sample1 = ('<!DOCTYPE html PUBLIC'
|
|
' "-//W3C//DTD XHTML 1.0 Transitional//EN"'
|
|
' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
|
|
'<html>text<div>subtext</div>tail</html>')
|
|
|
|
sample2 = '''<toplevel>sometext</toplevel>'''
|
|
|
|
def _check_sample1_element(self, e):
|
|
self.assertEqual(e.tag, 'html')
|
|
self.assertEqual(e.text, 'text')
|
|
self.assertEqual(e.tail, None)
|
|
self.assertEqual(e.attrib, {})
|
|
children = list(e)
|
|
self.assertEqual(len(children), 1)
|
|
child = children[0]
|
|
self.assertEqual(child.tag, 'div')
|
|
self.assertEqual(child.text, 'subtext')
|
|
self.assertEqual(child.tail, 'tail')
|
|
self.assertEqual(child.attrib, {})
|
|
|
|
def test_dummy_builder(self):
|
|
class BaseDummyBuilder:
|
|
def close(self):
|
|
return 42
|
|
|
|
class DummyBuilder(BaseDummyBuilder):
|
|
data = start = end = lambda *a: None
|
|
|
|
parser = ET.XMLParser(target=DummyBuilder())
|
|
parser.feed(self.sample1)
|
|
self.assertEqual(parser.close(), 42)
|
|
|
|
parser = ET.XMLParser(target=BaseDummyBuilder())
|
|
parser.feed(self.sample1)
|
|
self.assertEqual(parser.close(), 42)
|
|
|
|
parser = ET.XMLParser(target=object())
|
|
parser.feed(self.sample1)
|
|
self.assertIsNone(parser.close())
|
|
|
|
def test_treebuilder_comment(self):
|
|
b = ET.TreeBuilder()
|
|
self.assertEqual(b.comment('ctext').tag, ET.Comment)
|
|
self.assertEqual(b.comment('ctext').text, 'ctext')
|
|
|
|
b = ET.TreeBuilder(comment_factory=ET.Comment)
|
|
self.assertEqual(b.comment('ctext').tag, ET.Comment)
|
|
self.assertEqual(b.comment('ctext').text, 'ctext')
|
|
|
|
b = ET.TreeBuilder(comment_factory=len)
|
|
self.assertEqual(b.comment('ctext'), len('ctext'))
|
|
|
|
def test_treebuilder_pi(self):
|
|
b = ET.TreeBuilder()
|
|
self.assertEqual(b.pi('target', None).tag, ET.PI)
|
|
self.assertEqual(b.pi('target', None).text, 'target')
|
|
|
|
b = ET.TreeBuilder(pi_factory=ET.PI)
|
|
self.assertEqual(b.pi('target').tag, ET.PI)
|
|
self.assertEqual(b.pi('target').text, "target")
|
|
self.assertEqual(b.pi('pitarget', ' text ').tag, ET.PI)
|
|
self.assertEqual(b.pi('pitarget', ' text ').text, "pitarget text ")
|
|
|
|
b = ET.TreeBuilder(pi_factory=lambda target, text: (len(target), text))
|
|
self.assertEqual(b.pi('target'), (len('target'), None))
|
|
self.assertEqual(b.pi('pitarget', ' text '), (len('pitarget'), ' text '))
|
|
|
|
def test_late_tail(self):
|
|
# Issue #37399: The tail of an ignored comment could overwrite the text before it.
|
|
class TreeBuilderSubclass(ET.TreeBuilder):
|
|
pass
|
|
|
|
xml = "<a>text<!-- comment -->tail</a>"
|
|
a = ET.fromstring(xml)
|
|
self.assertEqual(a.text, "texttail")
|
|
|
|
parser = ET.XMLParser(target=TreeBuilderSubclass())
|
|
parser.feed(xml)
|
|
a = parser.close()
|
|
self.assertEqual(a.text, "texttail")
|
|
|
|
xml = "<a>text<?pi data?>tail</a>"
|
|
a = ET.fromstring(xml)
|
|
self.assertEqual(a.text, "texttail")
|
|
|
|
xml = "<a>text<?pi data?>tail</a>"
|
|
parser = ET.XMLParser(target=TreeBuilderSubclass())
|
|
parser.feed(xml)
|
|
a = parser.close()
|
|
self.assertEqual(a.text, "texttail")
|
|
|
|
def test_late_tail_mix_pi_comments(self):
|
|
# Issue #37399: The tail of an ignored comment could overwrite the text before it.
|
|
# Test appending tails to comments/pis.
|
|
class TreeBuilderSubclass(ET.TreeBuilder):
|
|
pass
|
|
|
|
xml = "<a>text<?pi1?> <!-- comment -->\n<?pi2?>tail</a>"
|
|
parser = ET.XMLParser(target=ET.TreeBuilder(insert_comments=True))
|
|
parser.feed(xml)
|
|
a = parser.close()
|
|
self.assertEqual(a[0].text, ' comment ')
|
|
self.assertEqual(a[0].tail, '\ntail')
|
|
self.assertEqual(a.text, "text ")
|
|
|
|
parser = ET.XMLParser(target=TreeBuilderSubclass(insert_comments=True))
|
|
parser.feed(xml)
|
|
a = parser.close()
|
|
self.assertEqual(a[0].text, ' comment ')
|
|
self.assertEqual(a[0].tail, '\ntail')
|
|
self.assertEqual(a.text, "text ")
|
|
|
|
xml = "<a>text<!-- comment -->\n<?pi data?>tail</a>"
|
|
parser = ET.XMLParser(target=ET.TreeBuilder(insert_pis=True))
|
|
parser.feed(xml)
|
|
a = parser.close()
|
|
self.assertEqual(a[0].text, 'pi data')
|
|
self.assertEqual(a[0].tail, 'tail')
|
|
self.assertEqual(a.text, "text\n")
|
|
|
|
parser = ET.XMLParser(target=TreeBuilderSubclass(insert_pis=True))
|
|
parser.feed(xml)
|
|
a = parser.close()
|
|
self.assertEqual(a[0].text, 'pi data')
|
|
self.assertEqual(a[0].tail, 'tail')
|
|
self.assertEqual(a.text, "text\n")
|
|
|
|
def test_treebuilder_elementfactory_none(self):
|
|
parser = ET.XMLParser(target=ET.TreeBuilder(element_factory=None))
|
|
parser.feed(self.sample1)
|
|
e = parser.close()
|
|
self._check_sample1_element(e)
|
|
|
|
def test_subclass(self):
|
|
class MyTreeBuilder(ET.TreeBuilder):
|
|
def foobar(self, x):
|
|
return x * 2
|
|
|
|
tb = MyTreeBuilder()
|
|
self.assertEqual(tb.foobar(10), 20)
|
|
|
|
parser = ET.XMLParser(target=tb)
|
|
parser.feed(self.sample1)
|
|
|
|
e = parser.close()
|
|
self._check_sample1_element(e)
|
|
|
|
def test_subclass_comment_pi(self):
|
|
class MyTreeBuilder(ET.TreeBuilder):
|
|
def foobar(self, x):
|
|
return x * 2
|
|
|
|
tb = MyTreeBuilder(comment_factory=ET.Comment, pi_factory=ET.PI)
|
|
self.assertEqual(tb.foobar(10), 20)
|
|
|
|
parser = ET.XMLParser(target=tb)
|
|
parser.feed(self.sample1)
|
|
parser.feed('<!-- a comment--><?and a pi?>')
|
|
|
|
e = parser.close()
|
|
self._check_sample1_element(e)
|
|
|
|
def test_element_factory(self):
|
|
lst = []
|
|
def myfactory(tag, attrib):
|
|
nonlocal lst
|
|
lst.append(tag)
|
|
return ET.Element(tag, attrib)
|
|
|
|
tb = ET.TreeBuilder(element_factory=myfactory)
|
|
parser = ET.XMLParser(target=tb)
|
|
parser.feed(self.sample2)
|
|
parser.close()
|
|
|
|
self.assertEqual(lst, ['toplevel'])
|
|
|
|
def _check_element_factory_class(self, cls):
|
|
tb = ET.TreeBuilder(element_factory=cls)
|
|
|
|
parser = ET.XMLParser(target=tb)
|
|
parser.feed(self.sample1)
|
|
e = parser.close()
|
|
self.assertIsInstance(e, cls)
|
|
self._check_sample1_element(e)
|
|
|
|
def test_element_factory_subclass(self):
|
|
class MyElement(ET.Element):
|
|
pass
|
|
self._check_element_factory_class(MyElement)
|
|
|
|
def test_element_factory_pure_python_subclass(self):
|
|
# Mimic SimpleTAL's behaviour (issue #16089): both versions of
|
|
# TreeBuilder should be able to cope with a subclass of the
|
|
# pure Python Element class.
|
|
base = ET._Element_Py
|
|
# Not from a C extension
|
|
self.assertEqual(base.__module__, 'xml.etree.ElementTree')
|
|
# Force some multiple inheritance with a C class to make things
|
|
# more interesting.
|
|
class MyElement(base, ValueError):
|
|
pass
|
|
self._check_element_factory_class(MyElement)
|
|
|
|
def test_doctype(self):
|
|
class DoctypeParser:
|
|
_doctype = None
|
|
|
|
def doctype(self, name, pubid, system):
|
|
self._doctype = (name, pubid, system)
|
|
|
|
def close(self):
|
|
return self._doctype
|
|
|
|
parser = ET.XMLParser(target=DoctypeParser())
|
|
parser.feed(self.sample1)
|
|
|
|
self.assertEqual(parser.close(),
|
|
('html', '-//W3C//DTD XHTML 1.0 Transitional//EN',
|
|
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'))
|
|
|
|
def test_builder_lookup_errors(self):
|
|
class RaisingBuilder:
|
|
def __init__(self, raise_in=None, what=ValueError):
|
|
self.raise_in = raise_in
|
|
self.what = what
|
|
|
|
def __getattr__(self, name):
|
|
if name == self.raise_in:
|
|
raise self.what(self.raise_in)
|
|
def handle(*args):
|
|
pass
|
|
return handle
|
|
|
|
ET.XMLParser(target=RaisingBuilder())
|
|
# cET also checks for 'close' and 'doctype', PyET does it only at need
|
|
for event in ('start', 'data', 'end', 'comment', 'pi'):
|
|
with self.assertRaisesRegex(ValueError, event):
|
|
ET.XMLParser(target=RaisingBuilder(event))
|
|
|
|
ET.XMLParser(target=RaisingBuilder(what=AttributeError))
|
|
for event in ('start', 'data', 'end', 'comment', 'pi'):
|
|
parser = ET.XMLParser(target=RaisingBuilder(event, what=AttributeError))
|
|
parser.feed(self.sample1)
|
|
self.assertIsNone(parser.close())
|
|
|
|
|
|
class XMLParserTest(unittest.TestCase):
|
|
sample1 = b'<file><line>22</line></file>'
|
|
sample2 = (b'<!DOCTYPE html PUBLIC'
|
|
b' "-//W3C//DTD XHTML 1.0 Transitional//EN"'
|
|
b' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
|
|
b'<html>text</html>')
|
|
sample3 = ('<?xml version="1.0" encoding="iso-8859-1"?>\n'
|
|
'<money value="$\xa3\u20ac\U0001017b">$\xa3\u20ac\U0001017b</money>')
|
|
|
|
def _check_sample_element(self, e):
|
|
self.assertEqual(e.tag, 'file')
|
|
self.assertEqual(e[0].tag, 'line')
|
|
self.assertEqual(e[0].text, '22')
|
|
|
|
def test_constructor_args(self):
|
|
parser2 = ET.XMLParser(encoding='utf-8',
|
|
target=ET.TreeBuilder())
|
|
parser2.feed(self.sample1)
|
|
self._check_sample_element(parser2.close())
|
|
|
|
def test_subclass(self):
|
|
class MyParser(ET.XMLParser):
|
|
pass
|
|
parser = MyParser()
|
|
parser.feed(self.sample1)
|
|
self._check_sample_element(parser.close())
|
|
|
|
def test_doctype_warning(self):
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter('error', DeprecationWarning)
|
|
parser = ET.XMLParser()
|
|
parser.feed(self.sample2)
|
|
parser.close()
|
|
|
|
def test_subclass_doctype(self):
|
|
_doctype = None
|
|
class MyParserWithDoctype(ET.XMLParser):
|
|
def doctype(self, *args, **kwargs):
|
|
nonlocal _doctype
|
|
_doctype = (args, kwargs)
|
|
|
|
parser = MyParserWithDoctype()
|
|
with self.assertWarnsRegex(RuntimeWarning, 'doctype'):
|
|
parser.feed(self.sample2)
|
|
parser.close()
|
|
self.assertIsNone(_doctype)
|
|
|
|
_doctype = _doctype2 = None
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter('error', DeprecationWarning)
|
|
warnings.simplefilter('error', RuntimeWarning)
|
|
class DoctypeParser:
|
|
def doctype(self, name, pubid, system):
|
|
nonlocal _doctype2
|
|
_doctype2 = (name, pubid, system)
|
|
|
|
parser = MyParserWithDoctype(target=DoctypeParser())
|
|
parser.feed(self.sample2)
|
|
parser.close()
|
|
self.assertIsNone(_doctype)
|
|
self.assertEqual(_doctype2,
|
|
('html', '-//W3C//DTD XHTML 1.0 Transitional//EN',
|
|
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'))
|
|
|
|
def test_inherited_doctype(self):
|
|
'''Ensure that ordinary usage is not deprecated (Issue 19176)'''
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter('error', DeprecationWarning)
|
|
warnings.simplefilter('error', RuntimeWarning)
|
|
class MyParserWithoutDoctype(ET.XMLParser):
|
|
pass
|
|
parser = MyParserWithoutDoctype()
|
|
parser.feed(self.sample2)
|
|
parser.close()
|
|
|
|
def test_parse_string(self):
|
|
parser = ET.XMLParser(target=ET.TreeBuilder())
|
|
parser.feed(self.sample3)
|
|
e = parser.close()
|
|
self.assertEqual(e.tag, 'money')
|
|
self.assertEqual(e.attrib['value'], '$\xa3\u20ac\U0001017b')
|
|
self.assertEqual(e.text, '$\xa3\u20ac\U0001017b')
|
|
|
|
|
|
class NamespaceParseTest(unittest.TestCase):
|
|
def test_find_with_namespace(self):
|
|
nsmap = {'h': 'hello', 'f': 'foo'}
|
|
doc = ET.fromstring(SAMPLE_XML_NS_ELEMS)
|
|
|
|
self.assertEqual(len(doc.findall('{hello}table', nsmap)), 1)
|
|
self.assertEqual(len(doc.findall('.//{hello}td', nsmap)), 2)
|
|
self.assertEqual(len(doc.findall('.//{foo}name', nsmap)), 1)
|
|
|
|
|
|
class ElementSlicingTest(unittest.TestCase):
|
|
def _elem_tags(self, elemlist):
|
|
return [e.tag for e in elemlist]
|
|
|
|
def _subelem_tags(self, elem):
|
|
return self._elem_tags(list(elem))
|
|
|
|
def _make_elem_with_children(self, numchildren):
|
|
"""Create an Element with a tag 'a', with the given amount of children
|
|
named 'a0', 'a1' ... and so on.
|
|
|
|
"""
|
|
e = ET.Element('a')
|
|
for i in range(numchildren):
|
|
ET.SubElement(e, 'a%s' % i)
|
|
return e
|
|
|
|
def test_getslice_single_index(self):
|
|
e = self._make_elem_with_children(10)
|
|
|
|
self.assertEqual(e[1].tag, 'a1')
|
|
self.assertEqual(e[-2].tag, 'a8')
|
|
|
|
self.assertRaises(IndexError, lambda: e[12])
|
|
self.assertRaises(IndexError, lambda: e[-12])
|
|
|
|
def test_getslice_range(self):
|
|
e = self._make_elem_with_children(6)
|
|
|
|
self.assertEqual(self._elem_tags(e[3:]), ['a3', 'a4', 'a5'])
|
|
self.assertEqual(self._elem_tags(e[3:6]), ['a3', 'a4', 'a5'])
|
|
self.assertEqual(self._elem_tags(e[3:16]), ['a3', 'a4', 'a5'])
|
|
self.assertEqual(self._elem_tags(e[3:5]), ['a3', 'a4'])
|
|
self.assertEqual(self._elem_tags(e[3:-1]), ['a3', 'a4'])
|
|
self.assertEqual(self._elem_tags(e[:2]), ['a0', 'a1'])
|
|
|
|
def test_getslice_steps(self):
|
|
e = self._make_elem_with_children(10)
|
|
|
|
self.assertEqual(self._elem_tags(e[8:10:1]), ['a8', 'a9'])
|
|
self.assertEqual(self._elem_tags(e[::3]), ['a0', 'a3', 'a6', 'a9'])
|
|
self.assertEqual(self._elem_tags(e[::8]), ['a0', 'a8'])
|
|
self.assertEqual(self._elem_tags(e[1::8]), ['a1', 'a9'])
|
|
self.assertEqual(self._elem_tags(e[3::sys.maxsize]), ['a3'])
|
|
self.assertEqual(self._elem_tags(e[3::sys.maxsize<<64]), ['a3'])
|
|
|
|
def test_getslice_negative_steps(self):
|
|
e = self._make_elem_with_children(4)
|
|
|
|
self.assertEqual(self._elem_tags(e[::-1]), ['a3', 'a2', 'a1', 'a0'])
|
|
self.assertEqual(self._elem_tags(e[::-2]), ['a3', 'a1'])
|
|
self.assertEqual(self._elem_tags(e[3::-sys.maxsize]), ['a3'])
|
|
self.assertEqual(self._elem_tags(e[3::-sys.maxsize-1]), ['a3'])
|
|
self.assertEqual(self._elem_tags(e[3::-sys.maxsize<<64]), ['a3'])
|
|
|
|
def test_delslice(self):
|
|
e = self._make_elem_with_children(4)
|
|
del e[0:2]
|
|
self.assertEqual(self._subelem_tags(e), ['a2', 'a3'])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
del e[0:]
|
|
self.assertEqual(self._subelem_tags(e), [])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
del e[::-1]
|
|
self.assertEqual(self._subelem_tags(e), [])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
del e[::-2]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'a2'])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
del e[1::2]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'a2'])
|
|
|
|
e = self._make_elem_with_children(2)
|
|
del e[::2]
|
|
self.assertEqual(self._subelem_tags(e), ['a1'])
|
|
|
|
def test_setslice_single_index(self):
|
|
e = self._make_elem_with_children(4)
|
|
e[1] = ET.Element('b')
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b', 'a2', 'a3'])
|
|
|
|
e[-2] = ET.Element('c')
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b', 'c', 'a3'])
|
|
|
|
with self.assertRaises(IndexError):
|
|
e[5] = ET.Element('d')
|
|
with self.assertRaises(IndexError):
|
|
e[-5] = ET.Element('d')
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b', 'c', 'a3'])
|
|
|
|
def test_setslice_range(self):
|
|
e = self._make_elem_with_children(4)
|
|
e[1:3] = [ET.Element('b%s' % i) for i in range(2)]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b0', 'b1', 'a3'])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
e[1:3] = [ET.Element('b')]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b', 'a3'])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
e[1:3] = [ET.Element('b%s' % i) for i in range(3)]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b0', 'b1', 'b2', 'a3'])
|
|
|
|
def test_setslice_steps(self):
|
|
e = self._make_elem_with_children(6)
|
|
e[1:5:2] = [ET.Element('b%s' % i) for i in range(2)]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b0', 'a2', 'b1', 'a4', 'a5'])
|
|
|
|
e = self._make_elem_with_children(6)
|
|
with self.assertRaises(ValueError):
|
|
e[1:5:2] = [ET.Element('b')]
|
|
with self.assertRaises(ValueError):
|
|
e[1:5:2] = [ET.Element('b%s' % i) for i in range(3)]
|
|
with self.assertRaises(ValueError):
|
|
e[1:5:2] = []
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'a1', 'a2', 'a3', 'a4', 'a5'])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
e[1::sys.maxsize] = [ET.Element('b')]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b', 'a2', 'a3'])
|
|
e[1::sys.maxsize<<64] = [ET.Element('c')]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'c', 'a2', 'a3'])
|
|
|
|
def test_setslice_negative_steps(self):
|
|
e = self._make_elem_with_children(4)
|
|
e[2:0:-1] = [ET.Element('b%s' % i) for i in range(2)]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b1', 'b0', 'a3'])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
with self.assertRaises(ValueError):
|
|
e[2:0:-1] = [ET.Element('b')]
|
|
with self.assertRaises(ValueError):
|
|
e[2:0:-1] = [ET.Element('b%s' % i) for i in range(3)]
|
|
with self.assertRaises(ValueError):
|
|
e[2:0:-1] = []
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'a1', 'a2', 'a3'])
|
|
|
|
e = self._make_elem_with_children(4)
|
|
e[1::-sys.maxsize] = [ET.Element('b')]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'b', 'a2', 'a3'])
|
|
e[1::-sys.maxsize-1] = [ET.Element('c')]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'c', 'a2', 'a3'])
|
|
e[1::-sys.maxsize<<64] = [ET.Element('d')]
|
|
self.assertEqual(self._subelem_tags(e), ['a0', 'd', 'a2', 'a3'])
|
|
|
|
def test_issue123213_setslice_exception(self):
|
|
e = ET.Element('tag')
|
|
# Does not hide the internal exception when assigning to the element
|
|
with self.assertRaises(ZeroDivisionError):
|
|
e[:1] = (1/0 for i in range(2))
|
|
|
|
# Still raises the TypeError when assigning with a non-iterable
|
|
with self.assertRaises(TypeError):
|
|
e[:1] = None
|
|
|
|
# Preserve the original TypeError message when assigning.
|
|
def f():
|
|
raise TypeError("mymessage")
|
|
|
|
with self.assertRaisesRegex(TypeError, 'mymessage'):
|
|
e[:1] = (f() for i in range(2))
|
|
|
|
class IOTest(unittest.TestCase):
|
|
def test_encoding(self):
|
|
# Test encoding issues.
|
|
elem = ET.Element("tag")
|
|
elem.text = "abc"
|
|
self.assertEqual(serialize(elem), '<tag>abc</tag>')
|
|
for enc in ("utf-8", "us-ascii"):
|
|
with self.subTest(enc):
|
|
self.assertEqual(serialize(elem, encoding=enc),
|
|
b'<tag>abc</tag>')
|
|
self.assertEqual(serialize(elem, encoding=enc.upper()),
|
|
b'<tag>abc</tag>')
|
|
for enc in ("iso-8859-1", "utf-16", "utf-32"):
|
|
with self.subTest(enc):
|
|
self.assertEqual(serialize(elem, encoding=enc),
|
|
("<?xml version='1.0' encoding='%s'?>\n"
|
|
"<tag>abc</tag>" % enc).encode(enc))
|
|
upper = enc.upper()
|
|
self.assertEqual(serialize(elem, encoding=upper),
|
|
("<?xml version='1.0' encoding='%s'?>\n"
|
|
"<tag>abc</tag>" % upper).encode(enc))
|
|
|
|
elem = ET.Element("tag")
|
|
elem.text = "<&\"\'>"
|
|
self.assertEqual(serialize(elem), '<tag><&"\'></tag>')
|
|
self.assertEqual(serialize(elem, encoding="utf-8"),
|
|
b'<tag><&"\'></tag>')
|
|
self.assertEqual(serialize(elem, encoding="us-ascii"),
|
|
b'<tag><&"\'></tag>')
|
|
for enc in ("iso-8859-1", "utf-16", "utf-32"):
|
|
self.assertEqual(serialize(elem, encoding=enc),
|
|
("<?xml version='1.0' encoding='%s'?>\n"
|
|
"<tag><&\"'></tag>" % enc).encode(enc))
|
|
|
|
elem = ET.Element("tag")
|
|
elem.attrib["key"] = "<&\"\'>"
|
|
self.assertEqual(serialize(elem), '<tag key="<&"\'>" />')
|
|
self.assertEqual(serialize(elem, encoding="utf-8"),
|
|
b'<tag key="<&"\'>" />')
|
|
self.assertEqual(serialize(elem, encoding="us-ascii"),
|
|
b'<tag key="<&"\'>" />')
|
|
for enc in ("iso-8859-1", "utf-16", "utf-32"):
|
|
self.assertEqual(serialize(elem, encoding=enc),
|
|
("<?xml version='1.0' encoding='%s'?>\n"
|
|
"<tag key=\"<&"'>\" />" % enc).encode(enc))
|
|
|
|
elem = ET.Element("tag")
|
|
elem.text = '\xe5\xf6\xf6<>'
|
|
self.assertEqual(serialize(elem), '<tag>\xe5\xf6\xf6<></tag>')
|
|
self.assertEqual(serialize(elem, encoding="utf-8"),
|
|
b'<tag>\xc3\xa5\xc3\xb6\xc3\xb6<></tag>')
|
|
self.assertEqual(serialize(elem, encoding="us-ascii"),
|
|
b'<tag>åöö<></tag>')
|
|
for enc in ("iso-8859-1", "utf-16", "utf-32"):
|
|
self.assertEqual(serialize(elem, encoding=enc),
|
|
("<?xml version='1.0' encoding='%s'?>\n"
|
|
"<tag>åöö<></tag>" % enc).encode(enc))
|
|
|
|
elem = ET.Element("tag")
|
|
elem.attrib["key"] = '\xe5\xf6\xf6<>'
|
|
self.assertEqual(serialize(elem), '<tag key="\xe5\xf6\xf6<>" />')
|
|
self.assertEqual(serialize(elem, encoding="utf-8"),
|
|
b'<tag key="\xc3\xa5\xc3\xb6\xc3\xb6<>" />')
|
|
self.assertEqual(serialize(elem, encoding="us-ascii"),
|
|
b'<tag key="åöö<>" />')
|
|
for enc in ("iso-8859-1", "utf-16", "utf-16le", "utf-16be", "utf-32"):
|
|
self.assertEqual(serialize(elem, encoding=enc),
|
|
("<?xml version='1.0' encoding='%s'?>\n"
|
|
"<tag key=\"åöö<>\" />" % enc).encode(enc))
|
|
|
|
def test_write_to_filename(self):
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
tree.write(TESTFN)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b'''<site>ø</site>''')
|
|
|
|
def test_write_to_filename_with_encoding(self):
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
tree.write(TESTFN, encoding='utf-8')
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b'''<site>\xc3\xb8</site>''')
|
|
|
|
tree.write(TESTFN, encoding='ISO-8859-1')
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), convlinesep(
|
|
b'''<?xml version='1.0' encoding='ISO-8859-1'?>\n'''
|
|
b'''<site>\xf8</site>'''))
|
|
|
|
def test_write_to_filename_as_unicode(self):
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
with open(TESTFN, 'w') as f:
|
|
encoding = f.encoding
|
|
os_helper.unlink(TESTFN)
|
|
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
tree.write(TESTFN, encoding='unicode')
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b"<site>\xc3\xb8</site>")
|
|
|
|
def test_write_to_text_file(self):
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
with open(TESTFN, 'w', encoding='utf-8') as f:
|
|
tree.write(f, encoding='unicode')
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b'''<site>\xc3\xb8</site>''')
|
|
|
|
with open(TESTFN, 'w', encoding='ascii', errors='xmlcharrefreplace') as f:
|
|
tree.write(f, encoding='unicode')
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b'''<site>ø</site>''')
|
|
|
|
with open(TESTFN, 'w', encoding='ISO-8859-1') as f:
|
|
tree.write(f, encoding='unicode')
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b'''<site>\xf8</site>''')
|
|
|
|
def test_write_to_binary_file(self):
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
with open(TESTFN, 'wb') as f:
|
|
tree.write(f)
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b'''<site>ø</site>''')
|
|
|
|
def test_write_to_binary_file_with_encoding(self):
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
with open(TESTFN, 'wb') as f:
|
|
tree.write(f, encoding='utf-8')
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(), b'''<site>\xc3\xb8</site>''')
|
|
|
|
with open(TESTFN, 'wb') as f:
|
|
tree.write(f, encoding='ISO-8859-1')
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(),
|
|
b'''<?xml version='1.0' encoding='ISO-8859-1'?>\n'''
|
|
b'''<site>\xf8</site>''')
|
|
|
|
def test_write_to_binary_file_with_bom(self):
|
|
self.addCleanup(os_helper.unlink, TESTFN)
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
# test BOM writing to buffered file
|
|
with open(TESTFN, 'wb') as f:
|
|
tree.write(f, encoding='utf-16')
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(),
|
|
'''<?xml version='1.0' encoding='utf-16'?>\n'''
|
|
'''<site>\xf8</site>'''.encode("utf-16"))
|
|
# test BOM writing to non-buffered file
|
|
with open(TESTFN, 'wb', buffering=0) as f:
|
|
tree.write(f, encoding='utf-16')
|
|
self.assertFalse(f.closed)
|
|
with open(TESTFN, 'rb') as f:
|
|
self.assertEqual(f.read(),
|
|
'''<?xml version='1.0' encoding='utf-16'?>\n'''
|
|
'''<site>\xf8</site>'''.encode("utf-16"))
|
|
|
|
def test_read_from_stringio(self):
|
|
tree = ET.ElementTree()
|
|
stream = io.StringIO('''<?xml version="1.0"?><site></site>''')
|
|
tree.parse(stream)
|
|
self.assertEqual(tree.getroot().tag, 'site')
|
|
|
|
def test_write_to_stringio(self):
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
stream = io.StringIO()
|
|
tree.write(stream, encoding='unicode')
|
|
self.assertEqual(stream.getvalue(), '''<site>\xf8</site>''')
|
|
|
|
def test_read_from_bytesio(self):
|
|
tree = ET.ElementTree()
|
|
raw = io.BytesIO(b'''<?xml version="1.0"?><site></site>''')
|
|
tree.parse(raw)
|
|
self.assertEqual(tree.getroot().tag, 'site')
|
|
|
|
def test_write_to_bytesio(self):
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
raw = io.BytesIO()
|
|
tree.write(raw)
|
|
self.assertEqual(raw.getvalue(), b'''<site>ø</site>''')
|
|
|
|
class dummy:
|
|
pass
|
|
|
|
def test_read_from_user_text_reader(self):
|
|
stream = io.StringIO('''<?xml version="1.0"?><site></site>''')
|
|
reader = self.dummy()
|
|
reader.read = stream.read
|
|
tree = ET.ElementTree()
|
|
tree.parse(reader)
|
|
self.assertEqual(tree.getroot().tag, 'site')
|
|
|
|
def test_write_to_user_text_writer(self):
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
stream = io.StringIO()
|
|
writer = self.dummy()
|
|
writer.write = stream.write
|
|
tree.write(writer, encoding='unicode')
|
|
self.assertEqual(stream.getvalue(), '''<site>\xf8</site>''')
|
|
|
|
def test_read_from_user_binary_reader(self):
|
|
raw = io.BytesIO(b'''<?xml version="1.0"?><site></site>''')
|
|
reader = self.dummy()
|
|
reader.read = raw.read
|
|
tree = ET.ElementTree()
|
|
tree.parse(reader)
|
|
self.assertEqual(tree.getroot().tag, 'site')
|
|
tree = ET.ElementTree()
|
|
|
|
def test_write_to_user_binary_writer(self):
|
|
tree = ET.ElementTree(ET.XML('''<site>\xf8</site>'''))
|
|
raw = io.BytesIO()
|
|
writer = self.dummy()
|
|
writer.write = raw.write
|
|
tree.write(writer)
|
|
self.assertEqual(raw.getvalue(), b'''<site>ø</site>''')
|
|
|
|
def test_write_to_user_binary_writer_with_bom(self):
|
|
tree = ET.ElementTree(ET.XML('''<site />'''))
|
|
raw = io.BytesIO()
|
|
writer = self.dummy()
|
|
writer.write = raw.write
|
|
writer.seekable = lambda: True
|
|
writer.tell = raw.tell
|
|
tree.write(writer, encoding="utf-16")
|
|
self.assertEqual(raw.getvalue(),
|
|
'''<?xml version='1.0' encoding='utf-16'?>\n'''
|
|
'''<site />'''.encode("utf-16"))
|
|
|
|
def test_tostringlist_invariant(self):
|
|
root = ET.fromstring('<tag>foo</tag>')
|
|
self.assertEqual(
|
|
ET.tostring(root, 'unicode'),
|
|
''.join(ET.tostringlist(root, 'unicode')))
|
|
self.assertEqual(
|
|
ET.tostring(root, 'utf-16'),
|
|
b''.join(ET.tostringlist(root, 'utf-16')))
|
|
|
|
def test_short_empty_elements(self):
|
|
root = ET.fromstring('<tag>a<x />b<y></y>c</tag>')
|
|
self.assertEqual(
|
|
ET.tostring(root, 'unicode'),
|
|
'<tag>a<x />b<y />c</tag>')
|
|
self.assertEqual(
|
|
ET.tostring(root, 'unicode', short_empty_elements=True),
|
|
'<tag>a<x />b<y />c</tag>')
|
|
self.assertEqual(
|
|
ET.tostring(root, 'unicode', short_empty_elements=False),
|
|
'<tag>a<x></x>b<y></y>c</tag>')
|
|
|
|
|
|
class ParseErrorTest(unittest.TestCase):
|
|
def test_subclass(self):
|
|
self.assertIsInstance(ET.ParseError(), SyntaxError)
|
|
|
|
def _get_error(self, s):
|
|
try:
|
|
ET.fromstring(s)
|
|
except ET.ParseError as e:
|
|
return e
|
|
|
|
def test_error_position(self):
|
|
self.assertEqual(self._get_error('foo').position, (1, 0))
|
|
self.assertEqual(self._get_error('<tag>&foo;</tag>').position, (1, 5))
|
|
self.assertEqual(self._get_error('foobar<').position, (1, 6))
|
|
|
|
def test_error_code(self):
|
|
import xml.parsers.expat.errors as ERRORS
|
|
self.assertEqual(self._get_error('foo').code,
|
|
ERRORS.codes[ERRORS.XML_ERROR_SYNTAX])
|
|
|
|
|
|
class KeywordArgsTest(unittest.TestCase):
|
|
# Test various issues with keyword arguments passed to ET.Element
|
|
# constructor and methods
|
|
def test_issue14818(self):
|
|
x = ET.XML("<a>foo</a>")
|
|
self.assertEqual(x.find('a', None),
|
|
x.find(path='a', namespaces=None))
|
|
self.assertEqual(x.findtext('a', None, None),
|
|
x.findtext(path='a', default=None, namespaces=None))
|
|
self.assertEqual(x.findall('a', None),
|
|
x.findall(path='a', namespaces=None))
|
|
self.assertEqual(list(x.iterfind('a', None)),
|
|
list(x.iterfind(path='a', namespaces=None)))
|
|
|
|
self.assertEqual(ET.Element('a').attrib, {})
|
|
elements = [
|
|
ET.Element('a', dict(href="#", id="foo")),
|
|
ET.Element('a', attrib=dict(href="#", id="foo")),
|
|
ET.Element('a', dict(href="#"), id="foo"),
|
|
ET.Element('a', href="#", id="foo"),
|
|
ET.Element('a', dict(href="#", id="foo"), href="#", id="foo"),
|
|
]
|
|
for e in elements:
|
|
self.assertEqual(e.tag, 'a')
|
|
self.assertEqual(e.attrib, dict(href="#", id="foo"))
|
|
|
|
e2 = ET.SubElement(elements[0], 'foobar', attrib={'key1': 'value1'})
|
|
self.assertEqual(e2.attrib['key1'], 'value1')
|
|
|
|
with self.assertRaisesRegex(TypeError, 'must be dict, not str'):
|
|
ET.Element('a', "I'm not a dict")
|
|
with self.assertRaisesRegex(TypeError, 'must be dict, not str'):
|
|
ET.Element('a', attrib="I'm not a dict")
|
|
|
|
# --------------------------------------------------------------------
|
|
|
|
class NoAcceleratorTest(unittest.TestCase):
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
if ET is not pyET:
|
|
raise unittest.SkipTest('only for the Python version')
|
|
|
|
# Test that the C accelerator was not imported for pyET
|
|
def test_correct_import_pyET(self):
|
|
# The type of methods defined in Python code is types.FunctionType,
|
|
# while the type of methods defined inside _elementtree is
|
|
# <class 'wrapper_descriptor'>
|
|
self.assertIsInstance(pyET.Element.__init__, types.FunctionType)
|
|
self.assertIsInstance(pyET.XMLParser.__init__, types.FunctionType)
|
|
|
|
# --------------------------------------------------------------------
|
|
|
|
class BoolTest(unittest.TestCase):
|
|
def test_warning(self):
|
|
e = ET.fromstring('<a style="new"></a>')
|
|
msg = (
|
|
r"Testing an element's truth value will always return True in "
|
|
r"future versions. "
|
|
r"Use specific 'len\(elem\)' or 'elem is not None' test instead.")
|
|
with self.assertWarnsRegex(DeprecationWarning, msg):
|
|
result = bool(e)
|
|
# Emulate prior behavior for now
|
|
self.assertIs(result, False)
|
|
|
|
# Element with children
|
|
ET.SubElement(e, 'b')
|
|
with self.assertWarnsRegex(DeprecationWarning, msg):
|
|
new_result = bool(e)
|
|
self.assertIs(new_result, True)
|
|
|
|
# --------------------------------------------------------------------
|
|
|
|
def c14n_roundtrip(xml, **options):
|
|
return pyET.canonicalize(xml, **options)
|
|
|
|
|
|
class C14NTest(unittest.TestCase):
|
|
maxDiff = None
|
|
|
|
#
|
|
# simple roundtrip tests (from c14n.py)
|
|
|
|
def test_simple_roundtrip(self):
|
|
# Basics
|
|
self.assertEqual(c14n_roundtrip("<doc/>"), '<doc></doc>')
|
|
self.assertEqual(c14n_roundtrip("<doc xmlns='uri'/>"), # FIXME
|
|
'<doc xmlns="uri"></doc>')
|
|
self.assertEqual(c14n_roundtrip("<prefix:doc xmlns:prefix='uri'/>"),
|
|
'<prefix:doc xmlns:prefix="uri"></prefix:doc>')
|
|
self.assertEqual(c14n_roundtrip("<doc xmlns:prefix='uri'><prefix:bar/></doc>"),
|
|
'<doc><prefix:bar xmlns:prefix="uri"></prefix:bar></doc>')
|
|
self.assertEqual(c14n_roundtrip("<elem xmlns:wsu='http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/' />"),
|
|
'<elem></elem>')
|
|
|
|
# C14N spec
|
|
self.assertEqual(c14n_roundtrip("<doc>Hello, world!<!-- Comment 1 --></doc>"),
|
|
'<doc>Hello, world!</doc>')
|
|
self.assertEqual(c14n_roundtrip("<value>2</value>"),
|
|
'<value>2</value>')
|
|
self.assertEqual(c14n_roundtrip('<compute><![CDATA[value>"0" && value<"10" ?"valid":"error"]]></compute>'),
|
|
'<compute>value>"0" && value<"10" ?"valid":"error"</compute>')
|
|
self.assertEqual(c14n_roundtrip('''<compute expr='value>"0" && value<"10" ?"valid":"error"'>valid</compute>'''),
|
|
'<compute expr="value>"0" && value<"10" ?"valid":"error"">valid</compute>')
|
|
self.assertEqual(c14n_roundtrip("<norm attr=' '   
	 ' '/>"),
|
|
'<norm attr=" \' 
	 \' "></norm>')
|
|
self.assertEqual(c14n_roundtrip("<normNames attr=' A   
	 B '/>"),
|
|
'<normNames attr=" A 
	 B "></normNames>')
|
|
self.assertEqual(c14n_roundtrip("<normId id=' '   
	 ' '/>"),
|
|
'<normId id=" \' 
	 \' "></normId>')
|
|
|
|
# fragments from PJ's tests
|
|
#self.assertEqual(c14n_roundtrip("<doc xmlns:x='http://example.com/x' xmlns='http://example.com/default'><b y:a1='1' xmlns='http://example.com/default' a3='3' xmlns:y='http://example.com/y' y:a2='2'/></doc>"),
|
|
#'<doc xmlns:x="http://example.com/x"><b xmlns:y="http://example.com/y" a3="3" y:a1="1" y:a2="2"></b></doc>')
|
|
|
|
# Namespace issues
|
|
xml = '<X xmlns="http://nps/a"><Y targets="abc,xyz"></Y></X>'
|
|
self.assertEqual(c14n_roundtrip(xml), xml)
|
|
xml = '<X xmlns="http://nps/a"><Y xmlns="http://nsp/b" targets="abc,xyz"></Y></X>'
|
|
self.assertEqual(c14n_roundtrip(xml), xml)
|
|
xml = '<X xmlns="http://nps/a"><Y xmlns:b="http://nsp/b" b:targets="abc,xyz"></Y></X>'
|
|
self.assertEqual(c14n_roundtrip(xml), xml)
|
|
|
|
def test_c14n_exclusion(self):
|
|
xml = textwrap.dedent("""\
|
|
<root xmlns:x="http://example.com/x">
|
|
<a x:attr="attrx">
|
|
<b>abtext</b>
|
|
</a>
|
|
<b>btext</b>
|
|
<c>
|
|
<x:d>dtext</x:d>
|
|
</c>
|
|
</root>
|
|
""")
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, strip_text=True),
|
|
'<root>'
|
|
'<a xmlns:x="http://example.com/x" x:attr="attrx"><b>abtext</b></a>'
|
|
'<b>btext</b>'
|
|
'<c><x:d xmlns:x="http://example.com/x">dtext</x:d></c>'
|
|
'</root>')
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, strip_text=True, exclude_attrs=['{http://example.com/x}attr']),
|
|
'<root>'
|
|
'<a><b>abtext</b></a>'
|
|
'<b>btext</b>'
|
|
'<c><x:d xmlns:x="http://example.com/x">dtext</x:d></c>'
|
|
'</root>')
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, strip_text=True, exclude_tags=['{http://example.com/x}d']),
|
|
'<root>'
|
|
'<a xmlns:x="http://example.com/x" x:attr="attrx"><b>abtext</b></a>'
|
|
'<b>btext</b>'
|
|
'<c></c>'
|
|
'</root>')
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, strip_text=True, exclude_attrs=['{http://example.com/x}attr'],
|
|
exclude_tags=['{http://example.com/x}d']),
|
|
'<root>'
|
|
'<a><b>abtext</b></a>'
|
|
'<b>btext</b>'
|
|
'<c></c>'
|
|
'</root>')
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, strip_text=True, exclude_tags=['a', 'b']),
|
|
'<root>'
|
|
'<c><x:d xmlns:x="http://example.com/x">dtext</x:d></c>'
|
|
'</root>')
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, exclude_tags=['a', 'b']),
|
|
'<root>\n'
|
|
' \n'
|
|
' \n'
|
|
' <c>\n'
|
|
' <x:d xmlns:x="http://example.com/x">dtext</x:d>\n'
|
|
' </c>\n'
|
|
'</root>')
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, strip_text=True, exclude_tags=['{http://example.com/x}d', 'b']),
|
|
'<root>'
|
|
'<a xmlns:x="http://example.com/x" x:attr="attrx"></a>'
|
|
'<c></c>'
|
|
'</root>')
|
|
self.assertEqual(
|
|
c14n_roundtrip(xml, exclude_tags=['{http://example.com/x}d', 'b']),
|
|
'<root>\n'
|
|
' <a xmlns:x="http://example.com/x" x:attr="attrx">\n'
|
|
' \n'
|
|
' </a>\n'
|
|
' \n'
|
|
' <c>\n'
|
|
' \n'
|
|
' </c>\n'
|
|
'</root>')
|
|
|
|
#
|
|
# basic method=c14n tests from the c14n 2.0 specification. uses
|
|
# test files under xmltestdata/c14n-20.
|
|
|
|
# note that this uses generated C14N versions of the standard ET.write
|
|
# output, not roundtripped C14N (see above).
|
|
|
|
def test_xml_c14n2(self):
|
|
datadir = findfile("c14n-20", subdir="xmltestdata")
|
|
full_path = partial(os.path.join, datadir)
|
|
|
|
files = [filename[:-4] for filename in sorted(os.listdir(datadir))
|
|
if filename.endswith('.xml')]
|
|
input_files = [
|
|
filename for filename in files
|
|
if filename.startswith('in')
|
|
]
|
|
configs = {
|
|
filename: {
|
|
# <c14n2:PrefixRewrite>sequential</c14n2:PrefixRewrite>
|
|
option.tag.split('}')[-1]: ((option.text or '').strip(), option)
|
|
for option in ET.parse(full_path(filename) + ".xml").getroot()
|
|
}
|
|
for filename in files
|
|
if filename.startswith('c14n')
|
|
}
|
|
|
|
tests = {
|
|
input_file: [
|
|
(filename, configs[filename.rsplit('_', 1)[-1]])
|
|
for filename in files
|
|
if filename.startswith(f'out_{input_file}_')
|
|
and filename.rsplit('_', 1)[-1] in configs
|
|
]
|
|
for input_file in input_files
|
|
}
|
|
|
|
# Make sure we found all test cases.
|
|
self.assertEqual(30, len([
|
|
output_file for output_files in tests.values()
|
|
for output_file in output_files]))
|
|
|
|
def get_option(config, option_name, default=None):
|
|
return config.get(option_name, (default, ()))[0]
|
|
|
|
for input_file, output_files in tests.items():
|
|
for output_file, config in output_files:
|
|
keep_comments = get_option(
|
|
config, 'IgnoreComments') == 'true' # no, it's right :)
|
|
strip_text = get_option(
|
|
config, 'TrimTextNodes') == 'true'
|
|
rewrite_prefixes = get_option(
|
|
config, 'PrefixRewrite') == 'sequential'
|
|
if 'QNameAware' in config:
|
|
qattrs = [
|
|
f"{{{el.get('NS')}}}{el.get('Name')}"
|
|
for el in config['QNameAware'][1].findall(
|
|
'{http://www.w3.org/2010/xml-c14n2}QualifiedAttr')
|
|
]
|
|
qtags = [
|
|
f"{{{el.get('NS')}}}{el.get('Name')}"
|
|
for el in config['QNameAware'][1].findall(
|
|
'{http://www.w3.org/2010/xml-c14n2}Element')
|
|
]
|
|
else:
|
|
qtags = qattrs = None
|
|
|
|
# Build subtest description from config.
|
|
config_descr = ','.join(
|
|
f"{name}={value or ','.join(c.tag.split('}')[-1] for c in children)}"
|
|
for name, (value, children) in sorted(config.items())
|
|
)
|
|
|
|
with self.subTest(f"{output_file}({config_descr})"):
|
|
if input_file == 'inNsRedecl' and not rewrite_prefixes:
|
|
self.skipTest(
|
|
f"Redeclared namespace handling is not supported in {output_file}")
|
|
if input_file == 'inNsSuperfluous' and not rewrite_prefixes:
|
|
self.skipTest(
|
|
f"Redeclared namespace handling is not supported in {output_file}")
|
|
if 'QNameAware' in config and config['QNameAware'][1].find(
|
|
'{http://www.w3.org/2010/xml-c14n2}XPathElement') is not None:
|
|
self.skipTest(
|
|
f"QName rewriting in XPath text is not supported in {output_file}")
|
|
|
|
f = full_path(input_file + ".xml")
|
|
if input_file == 'inC14N5':
|
|
# Hack: avoid setting up external entity resolution in the parser.
|
|
with open(full_path('world.txt'), 'rb') as entity_file:
|
|
with open(f, 'rb') as f:
|
|
f = io.BytesIO(f.read().replace(b'&ent2;', entity_file.read()))
|
|
|
|
text = ET.canonicalize(
|
|
from_file=f,
|
|
with_comments=keep_comments,
|
|
strip_text=strip_text,
|
|
rewrite_prefixes=rewrite_prefixes,
|
|
qname_aware_tags=qtags, qname_aware_attrs=qattrs)
|
|
|
|
with open(full_path(output_file + ".xml"), 'r', encoding='utf8') as f:
|
|
expected = f.read()
|
|
if input_file == 'inC14N3':
|
|
# FIXME: cET resolves default attributes but ET does not!
|
|
expected = expected.replace(' attr="default"', '')
|
|
text = text.replace(' attr="default"', '')
|
|
self.assertEqual(expected, text)
|
|
|
|
# --------------------------------------------------------------------
|
|
|
|
def setUpModule(module=None):
|
|
# When invoked without a module, runs the Python ET tests by loading pyET.
|
|
# Otherwise, uses the given module as the ET.
|
|
global pyET
|
|
pyET = import_fresh_module('xml.etree.ElementTree',
|
|
blocked=['_elementtree'])
|
|
if module is None:
|
|
module = pyET
|
|
|
|
global ET
|
|
ET = module
|
|
|
|
# don't interfere with subsequent tests
|
|
def cleanup():
|
|
global ET, pyET
|
|
ET = pyET = None
|
|
unittest.addModuleCleanup(cleanup)
|
|
|
|
# Provide default namespace mapping and path cache.
|
|
from xml.etree import ElementPath
|
|
nsmap = ET.register_namespace._namespace_map
|
|
# Copy the default namespace mapping
|
|
nsmap_copy = nsmap.copy()
|
|
unittest.addModuleCleanup(nsmap.update, nsmap_copy)
|
|
unittest.addModuleCleanup(nsmap.clear)
|
|
|
|
# Copy the path cache (should be empty)
|
|
path_cache = ElementPath._cache
|
|
unittest.addModuleCleanup(setattr, ElementPath, "_cache", path_cache)
|
|
ElementPath._cache = path_cache.copy()
|
|
|
|
# Align the Comment/PI factories.
|
|
if hasattr(ET, '_set_factories'):
|
|
old_factories = ET._set_factories(ET.Comment, ET.PI)
|
|
unittest.addModuleCleanup(ET._set_factories, *old_factories)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|