1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
#
# Copyright (c), 2016-2020, SISSA (International School for Advanced Studies).
# All rights reserved.
# This file is distributed under the terms of the MIT License.
# See the file 'LICENSE' in the root directory of the present
# distribution, or http://opensource.org/licenses/MIT.
#
# @author Davide Brunato <brunato@sissa.it>
#
import re
from collections.abc import Iterator
from typing import Any, Type, Union
from xml.etree.ElementTree import Element
from xmlschema.utils.qnames import get_namespace, get_qname
_REGEX_SPACES = re.compile(r'\s+')
def iter_nested_items(items: Union[dict[Any, Any], list[Any]],
dict_class: Type[dict[Any, Any]] = dict,
list_class: Type[list[Any]] = list) -> Iterator[Any]:
"""Iterates a nested object composed by lists and dictionaries."""
if isinstance(items, dict_class):
for k, v in items.items():
yield from iter_nested_items(v, dict_class, list_class)
elif isinstance(items, list_class):
for item in items:
yield from iter_nested_items(item, dict_class, list_class)
elif isinstance(items, dict):
raise TypeError(f"{items!r}: is a dict() instead of {dict_class!r}.")
elif isinstance(items, list):
raise TypeError(f"{items!r}: is a list() instead of {list_class!r}.")
else:
yield items
def etree_elements_assert_equal(elem: Element, other: Element,
strict: bool = True, skip_comments: bool = True,
unordered: bool = False,
check_nsmap: bool = False) -> None:
"""
Tests the equality of two XML Element trees.
:param elem: the master Element tree, reference for namespace mapping.
:param other: the other Element tree that has to be compared.
:param strict: asserts strictly equality. `True` for default.
:param skip_comments: skip comments from comparison.
:param unordered: children may have different order.
:param check_nsmap: if to check namespace maps.
:raise: an AssertionError containing information about first difference encountered.
"""
children: Union[Element, list[Element]]
if unordered:
children = sorted(elem, key=lambda x: '' if callable(x.tag) else x.tag)
other_children = iter(sorted(
other, key=lambda x: '' if callable(x.tag) else x.tag
))
else:
children = elem
other_children = iter(other)
namespace = ''
for e1 in children:
if skip_comments and callable(e1.tag):
continue
for e2 in other_children:
if not skip_comments or not callable(e2.tag):
break
else:
raise AssertionError(f"Node {elem!r} has more children than {other!r}")
if strict or e1 is elem:
if e1.tag != e2.tag:
raise AssertionError(f"{e1!r} != {e2!r}: tags differ")
else:
namespace = get_namespace(e1.tag) or namespace
if get_qname(namespace, e1.tag) != get_qname(namespace, e2.tag):
raise AssertionError(f"{e1!r} != {e2!r}: tags differ")
# Attributes
if e1.attrib != e2.attrib:
if strict:
msg = "{!r} != {!r}: attributes differ: {!r} != {!r}"
raise AssertionError(msg.format(e1, e2, e1.attrib, e2.attrib))
else:
msg = "%r != %r: attribute keys differ: %r != %r"
if sorted(e1.attrib.keys()) != sorted(e2.attrib.keys()):
raise AssertionError(msg % (e1, e2, e1.attrib.keys(), e2.attrib.keys()))
for k in e1.attrib:
a1, a2 = e1.attrib[k].strip(), e2.attrib[k].strip()
if a1 != a2:
try:
if float(a1) != float(a2):
raise ValueError()
except (ValueError, TypeError):
msg = "%r != %r: attribute %r values differ: %r != %r"
raise AssertionError(msg % (e1, e2, k, a1, a2)) from None
# Namespace maps
if check_nsmap:
nsmap1 = getattr(e1, 'nsmap', None)
nsmap2 = getattr(e2, 'nsmap', None)
if nsmap1 != nsmap2:
if strict or (nsmap1 or None) != (nsmap2 or None):
if (nsmap1 is None) ^ (nsmap2 is None):
msg = "{!r} != {!r}: different ElementTree implementations"
raise AssertionError(msg.format(e1, e2))
else:
msg = "{!r} != {!r}: nsmaps differ: {!r} != {!r}"
raise AssertionError(msg.format(e1, e2, nsmap1, nsmap2))
# Number of children
if skip_comments:
nc1 = len([c for c in e1 if not callable(c.tag)])
nc2 = len([c for c in e2 if not callable(c.tag)])
else:
nc1 = len(e1)
nc2 = len(e2)
if nc1 != nc2:
msg = "%r != %r: children number differ: %r != %r"
raise AssertionError(msg % (e1, e2, nc1, nc2))
# Text
if e1.text != e2.text:
message = f"{e1!r} != {e2!r}: texts differ: {e1.text!r} != {e2.text!r}"
if strict:
raise AssertionError(message)
elif e1.text is None:
if e2.text is not None and e2.text.strip():
raise AssertionError(message)
elif e2.text is None:
if e1.text.strip():
raise AssertionError(message)
elif _REGEX_SPACES.sub('', e1.text.strip()) != _REGEX_SPACES.sub('', e2.text.strip()):
text1 = e1.text.strip()
text2 = e2.text.strip()
if text1 == 'false':
if text2 != '0':
raise AssertionError(message)
elif text1 == 'true':
if text2 != '1':
raise AssertionError(message)
elif text2 == 'false':
if text1 != '0':
raise AssertionError(message)
elif text2 == 'true':
if text1 != '1':
raise AssertionError(message)
else:
try:
items1 = text1.split()
items2 = text2.split()
if len(items1) != len(items2):
raise ValueError()
if not all(float(x1) == float(x2) for x1, x2 in zip(items1, items2)):
raise ValueError()
except (AssertionError, ValueError, TypeError):
raise AssertionError(message) from None
# Tail
if e1.tail != e2.tail:
message = f"{e1!r} != {e2!r}: tails differ: {e1.tail!r} != {e2.tail!r}"
if strict:
raise AssertionError(message)
elif e1.tail is None:
if e2.tail is not None and e2.tail.strip():
raise AssertionError(message)
elif e2.tail is None:
if e1.tail.strip():
raise AssertionError(message)
elif e1.tail.strip() != e2.tail.strip():
raise AssertionError(message)
etree_elements_assert_equal(e1, e2, strict, skip_comments, unordered)
try:
next(other_children)
except StopIteration:
pass
else:
raise AssertionError(f"Node {elem!r} has lesser children than {other!r}.")
|
