#!/usr/bin/env python # # Copyright (c), 2018-2021, 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 # import unittest from unittest.mock import patch import xml.etree.ElementTree as ElementTree from elementpath import * from elementpath.schema_proxy import AbstractXsdType DummyXsdType = type( 'XsdType', (AbstractXsdType,), dict(name=None, local_name=None, is_matching=lambda x: False, **{ k: lambda x: None for k in AbstractXsdType.__dict__ if k[0] != '_' })) class XPathContextTest(unittest.TestCase): root = ElementTree.XML('Dickens') def test_basic_initialization(self): self.assertRaises(TypeError, XPathContext, None) def test_timezone_argument(self): context = XPathContext(self.root) self.assertIsNone(context.timezone) context = XPathContext(self.root, timezone='Z') self.assertIsInstance(context.timezone, datatypes.Timezone) def test_repr(self): self.assertEqual( repr(XPathContext(self.root)), "XPathContext(root={0}, item={0})".format(self.root) ) def test_copy(self): root = ElementTree.XML('') context = XPathContext(root) self.assertIsInstance(context.copy(), XPathContext) self.assertIsNot(context.copy(), context) context = XPathContext(root, axis='children') self.assertIsNone(context.copy().axis) self.assertEqual(context.copy(clear_axis=False).axis, 'children') def test_parent_map(self): root = ElementTree.XML('') context = XPathContext(root) self.assertEqual(context.parent_map, {root[0]: root, root[1]: root}) with patch.object(DummyXsdType(), 'is_element_only', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root, xsd_type, '')) self.assertEqual(context.parent_map, {root[0]: root, root[1]: root}) root = ElementTree.XML('') context = XPathContext(root) result = { root[0]: root, root[0][0]: root[0], root[1]: root, root[2]: root, root[2][0]: root[2], root[2][1]: root[2] } self.assertEqual(context.parent_map, result) self.assertEqual(context.parent_map, result) # Test property caching with patch.object(DummyXsdType(), 'is_element_only', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root, xsd_type, None)) self.assertEqual(context.parent_map, result) def test_get_parent(self): root = ElementTree.XML('') context = XPathContext(root) self.assertIsNone(context._parent_map) self.assertIsNone(context.get_parent(root)) self.assertIsNone(context._parent_map) self.assertEqual(context.get_parent(root[0]), root) self.assertIsInstance(context._parent_map, dict) parent_map_id = id(context._parent_map) self.assertEqual(context.get_parent(root[1]), root) self.assertEqual(context.get_parent(root[2]), root) self.assertEqual(context.get_parent(root[2][1]), root[2]) with patch.object(DummyXsdType(), 'is_empty', return_value=True) as xsd_type: self.assertEqual(context.get_parent(TypedElement(root[2][1], xsd_type, None)), root[2]) self.assertEqual(id(context._parent_map), parent_map_id) self.assertIsNone(context.get_parent(AttributeNode('max', '10'))) self.assertNotEqual(id(context._parent_map), parent_map_id) parent_map_id = id(context._parent_map) self.assertIsNone(context.get_parent(AttributeNode('max', '10'))) self.assertEqual( id(context._parent_map), parent_map_id # LRU cache prevents parent map rebuild ) document = ElementTree.ElementTree(root) context = XPathContext(root=document) self.assertEqual(context.get_parent(root[1]), root) self.assertEqual(context.get_parent(root[2]), root) self.assertEqual(context.get_parent(root[2][1]), root[2]) def test_get_path(self): root = ElementTree.XML('') context = XPathContext(root) self.assertEqual(context.get_path(None), '') self.assertEqual(context.get_path(root), '/A') self.assertEqual(context.get_path(root[0]), '/A/B1') self.assertEqual(context.get_path(root[0][0]), '/A/B1/C1') self.assertEqual(context.get_path(root[1]), '/A/B2') self.assertEqual(context.get_path(root[2]), '/A/B3') self.assertEqual(context.get_path(root[2][0]), '/A/B3/C1') self.assertEqual(context.get_path(root[2][1]), '/A/B3/C2') context._elem = root[2][1] self.assertEqual(context.get_path(AttributeNode('max', '10')), '/A/B3/C2/@max') document = ElementTree.ElementTree(root) context = XPathContext(root=document) self.assertEqual(context.get_path(root[2][0]), '/A/B3/C1') root = ElementTree.XML('10') context = XPathContext(root) with patch.object(DummyXsdType(), 'is_simple', return_value=True) as xsd_type: self.assertEqual(context.get_path(TypedElement(root[0], xsd_type, 10)), '/A/B1') with patch.object(DummyXsdType(), 'is_simple', return_value=True) as xsd_type: attr = TypedAttribute(AttributeNode('min', '1'), xsd_type, 1) context = XPathContext(root) context._elem = root[1] self.assertEqual(context.get_path(attr), '/A/B2/@min') def test_is_principal_node_kind(self): root = ElementTree.XML('') context = XPathContext(root) self.assertTrue(hasattr(context.item, 'tag')) self.assertTrue(context.is_principal_node_kind()) context.item = AttributeNode('a1', '10') self.assertFalse(context.is_principal_node_kind()) context.axis = 'attribute' self.assertTrue(context.is_principal_node_kind()) def test_iter_product(self): context = XPathContext(self.root) def sel1(_context): yield from range(2) def sel2(_context): yield from range(3) expected = [(0, 0), (0, 1), (0, 2), (1, 0), (1, 1), (1, 2)] self.assertListEqual(list(context.iter_product([sel1, sel2])), expected) self.assertEqual(context.variables, {}) self.assertListEqual(list(context.iter_product([sel1, sel2], [])), expected) self.assertEqual(context.variables, {}) self.assertListEqual(list(context.iter_product([sel1, sel2], ['a', 'b'])), expected) self.assertEqual(context.variables, {'a': 1, 'b': 2}) context.variables = {'a': 0, 'b': 0} self.assertListEqual(list(context.iter_product([sel1, sel2], ['a', 'b'])), expected) self.assertEqual(context.variables, {'a': 1, 'b': 2}) context.variables = {'a': 0, 'b': 0} self.assertListEqual(list(context.iter_product([sel1, sel2], ['a'])), expected) self.assertEqual(context.variables, {'a': 1, 'b': 0}) context.variables = {'a': 0, 'b': 0} self.assertListEqual(list(context.iter_product([sel1, sel2], ['c', 'b'])), expected) self.assertEqual(context.variables, {'a': 0, 'b': 2, 'c': 1}) context.variables = {'a': 0, 'b': 0} self.assertListEqual(list(context.iter_product([sel1, sel2], ['b'])), expected) self.assertEqual(context.variables, {'a': 0, 'b': 1}) def test_iter_attributes(self): root = ElementTree.XML('') attributes = [AttributeNode(*x, parent=root) for x in root.attrib.items()] context = XPathContext(root) self.assertListEqual(list(context.iter_attributes()), attributes) context.item = AttributeNode('a1', '10', root) self.assertListEqual(list(context.iter_attributes()), [AttributeNode('a1', '10', root)]) with patch.object(DummyXsdType(), 'has_simple_content', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root, xsd_type, '')) self.assertListEqual(list(context.iter_attributes()), attributes) context.item = None self.assertListEqual(list(context.iter_attributes()), []) def test_iter_children_or_self(self): doc = ElementTree.ElementTree(self.root) context = XPathContext(doc) self.assertListEqual(list(context.iter_children_or_self()), [self.root]) context.item = self.root self.assertListEqual(list(context.iter_children_or_self()), [TextNode(self.root.text, self.root)]) context.item = doc self.assertListEqual(list(context.iter_children_or_self()), [self.root]) def test_iter_parent(self): root = ElementTree.XML('') context = XPathContext(root, item=None) self.assertListEqual(list(context.iter_parent()), []) context = XPathContext(root) self.assertListEqual(list(context.iter_parent()), []) with patch.object(DummyXsdType(), 'has_simple_content', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root, xsd_type, '')) self.assertListEqual(list(context.iter_parent()), []) root = ElementTree.XML('') context = XPathContext(root, item=None) self.assertListEqual(list(context.iter_parent()), []) context = XPathContext(root, item=root[2][0]) self.assertListEqual(list(context.iter_parent()), [root[2]]) with patch.object(DummyXsdType(), 'is_empty', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root[2][0], xsd_type, None)) self.assertListEqual(list(context.iter_parent()), [root[2]]) def test_iter_siblings(self): root = ElementTree.XML('') context = XPathContext(root) self.assertListEqual(list(context.iter_siblings()), []) context = XPathContext(root, item=root[2]) self.assertListEqual(list(context.iter_siblings()), list(root[3:])) with patch.object(DummyXsdType(), 'is_element_only', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root[2], xsd_type, None)) self.assertListEqual(list(context.iter_siblings()), list(root[3:])) context = XPathContext(root, item=root[2]) self.assertListEqual(list(context.iter_siblings('preceding-sibling')), list(root[:2])) with patch.object(DummyXsdType(), 'is_element_only', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root[2], xsd_type, None)) self.assertListEqual(list(context.iter_siblings('preceding-sibling')), list(root[:2])) def test_iter_descendants(self): root = ElementTree.XML('') attr = AttributeNode('a1', '10') self.assertListEqual(list(XPathContext(root).iter_descendants()), [root, root[0], root[1]]) self.assertListEqual( list(XPathContext(root, item=attr).iter_descendants(axis='descendant')), [] ) self.assertListEqual( list(XPathContext(root, item=attr).iter_descendants()), [attr] ) with patch.object(DummyXsdType(), 'has_mixed_content', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root, xsd_type, '')) self.assertListEqual(list(context.iter_descendants()), [root, root[0], root[1]]) def test_iter_ancestors(self): root = ElementTree.XML('') attr = AttributeNode('a1', '10') self.assertListEqual(list(XPathContext(root).iter_ancestors()), []) self.assertListEqual(list(XPathContext(root, item=root[1]).iter_ancestors()), [root]) self.assertListEqual(list(XPathContext(root, item=attr).iter_ancestors()), []) with patch.object(DummyXsdType(), 'has_mixed_content', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root[1], xsd_type, None)) self.assertListEqual(list(context.iter_ancestors()), [root]) def test_iter(self): root = ElementTree.XML('') context = XPathContext(root) self.assertListEqual(list(context.iter()), list(root.iter())) doc = ElementTree.ElementTree(root) context = XPathContext(doc) expected = [doc] expected.extend(e for e in root.iter()) self.assertListEqual(list(context.iter()), expected) def test_iter_preceding(self): root = ElementTree.XML('') context = XPathContext(root, item=None) self.assertListEqual(list(context.iter_preceding()), []) context = XPathContext(root) self.assertListEqual(list(context.iter_preceding()), []) with patch.object(DummyXsdType(), 'has_simple_content', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root, xsd_type, '')) self.assertListEqual(list(context.iter_preceding()), []) context = XPathContext(root, item='text') self.assertListEqual(list(context.iter_preceding()), []) root = ElementTree.XML('') context = XPathContext(root, item=root[2][1]) self.assertListEqual(list(context.iter_preceding()), [root[0], root[0][0], root[1], root[2][0]]) def test_iter_following(self): root = ElementTree.XML('') context = XPathContext(root) self.assertListEqual(list(context.iter_followings()), []) context = XPathContext(root, item=AttributeNode('a', '1', root)) self.assertListEqual(list(context.iter_followings()), []) context = XPathContext(root, item=root[2]) self.assertListEqual(list(context.iter_followings()), list(root[3:])) context = XPathContext(root, item=root[1]) result = [root[2], root[2][0], root[3], root[4]] self.assertListEqual(list(context.iter_followings()), result) with patch.object(DummyXsdType(), 'has_mixed_content', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root[1], xsd_type, None)) self.assertListEqual(list(context.iter_followings()), result) def test_iter_results(self): root = ElementTree.XML('') results = [root[2], root[0][0]] context = XPathContext(root) self.assertListEqual(list(context.iter_results(results)), [root[0][0], root[2]]) with patch.object(DummyXsdType(), 'is_empty', return_value=True) as xsd_type: context = XPathContext(root, item=TypedElement(root, xsd_type, None)) self.assertListEqual(list(context.iter_results(results)), [root[0][0], root[2]]) results = [root[2], TypedElement(root[0][0], xsd_type, None)] context = XPathContext(root) self.assertListEqual(list(context.iter_results(results)), [TypedElement(root[0][0], xsd_type, None), root[2]]) context = XPathContext(root, item=TypedElement(root, xsd_type, None)) self.assertListEqual(list(context.iter_results(results)), [TypedElement(root[0][0], xsd_type, None), root[2]]) with patch.object(DummyXsdType(), 'is_simple', return_value=True) as xsd_type: results = [ TypedAttribute(AttributeNode('max', '10', root[2][1]), xsd_type, 10), root[0] ] context = XPathContext(root) self.assertListEqual(list(context.iter_results(results)), results[::-1]) results = [ TypedAttribute(AttributeNode('max', '11'), xsd_type, 11), root[0] ] context = XPathContext(root) self.assertListEqual(list(context.iter_results(results)), results[1:]) if __name__ == '__main__': unittest.main()