Skip to content

Commit 9029602

Browse files
ammaraskarammaraskar
committed
bpo-40624: Add support for the XPath != operator in xml.etree
1 parent 207c321 commit 9029602

File tree

4 files changed

+79
-7
lines changed

4 files changed

+79
-7
lines changed

‎Doc/library/xml.etree.elementtree.rst

+18
Original file line numberDiff line numberDiff line change
@@ -449,6 +449,12 @@ Supported XPath syntax
449449
| | has the given value. The value cannot contain |
450450
| | quotes. |
451451
+-----------------------+------------------------------------------------------+
452+
| ``[@attrib!='value']``| Selects all elements for which the given attribute |
453+
| | does not have the given value. The value cannot |
454+
| | contain quotes. |
455+
| | |
456+
| | .. versionadded:: 3.10 |
457+
+-----------------------+------------------------------------------------------+
452458
| ``[tag]`` | Selects all elements that have a child named |
453459
| | ``tag``. Only immediate children are supported. |
454460
+-----------------------+------------------------------------------------------+
@@ -457,10 +463,22 @@ Supported XPath syntax
457463
| | |
458464
| | .. versionadded:: 3.7 |
459465
+-----------------------+------------------------------------------------------+
466+
| ``[.!='text']`` | Selects all elements whose complete text content, |
467+
| | including descendants, does not equal the given |
468+
| | ``text``. |
469+
| | |
470+
| | .. versionadded:: 3.10 |
471+
+-----------------------+------------------------------------------------------+
460472
| ``[tag='text']`` | Selects all elements that have a child named |
461473
| | ``tag`` whose complete text content, including |
462474
| | descendants, equals the given ``text``. |
463475
+-----------------------+------------------------------------------------------+
476+
| ``[tag!='text']`` | Selects all elements that have a child named |
477+
| | ``tag`` whose complete text content, including |
478+
| | descendants, does not equal the given ``text``. |
479+
| | |
480+
| | .. versionadded:: 3.10 |
481+
+-----------------------+------------------------------------------------------+
464482
| ``[position]`` | Selects all elements that are located at the given |
465483
| | position. The position can be either an integer |
466484
| | (1 is the first position), the expression ``last()`` |

‎Lib/test/test_xml_etree.py

+35
Original file line numberDiff line numberDiff line change
@@ -2852,8 +2852,12 @@ def test_findall(self):
28522852
['tag'] * 3)
28532853
self.assertEqual(summarize_list(e.findall('.//tag[@class="a"]')),
28542854
['tag'])
2855+
self.assertEqual(summarize_list(e.findall('.//tag[@class!="a"]')),
2856+
['tag'] * 2)
28552857
self.assertEqual(summarize_list(e.findall('.//tag[@class="b"]')),
28562858
['tag'] * 2)
2859+
self.assertEqual(summarize_list(e.findall('.//tag[@class!="b"]')),
2860+
['tag'])
28572861
self.assertEqual(summarize_list(e.findall('.//tag[@id]')),
28582862
['tag'])
28592863
self.assertEqual(summarize_list(e.findall('.//section[tag]')),
@@ -2875,6 +2879,19 @@ def test_findall(self):
28752879
self.assertEqual(summarize_list(e.findall(".//section[ tag = 'subtext' ]")),
28762880
['section'])
28772881

2882+
# Negations of above tests. They match nothing because the sole section
2883+
# tag has subtext.
2884+
self.assertEqual(summarize_list(e.findall(".//section[tag!='subtext']")),
2885+
[])
2886+
self.assertEqual(summarize_list(e.findall(".//section[tag !='subtext']")),
2887+
[])
2888+
self.assertEqual(summarize_list(e.findall(".//section[tag!= 'subtext']")),
2889+
[])
2890+
self.assertEqual(summarize_list(e.findall(".//section[tag != 'subtext']")),
2891+
[])
2892+
self.assertEqual(summarize_list(e.findall(".//section[ tag != 'subtext' ]")),
2893+
[])
2894+
28782895
self.assertEqual(summarize_list(e.findall(".//tag[.='subtext']")),
28792896
['tag'])
28802897
self.assertEqual(summarize_list(e.findall(".//tag[. ='subtext']")),
@@ -2890,6 +2907,24 @@ def test_findall(self):
28902907
self.assertEqual(summarize_list(e.findall(".//tag[.= ' subtext']")),
28912908
[])
28922909

2910+
# Negations of above tests.
2911+
# Matches everything but the tag containing subtext
2912+
self.assertEqual(summarize_list(e.findall(".//tag[.!='subtext']")),
2913+
['tag'] * 3)
2914+
self.assertEqual(summarize_list(e.findall(".//tag[. !='subtext']")),
2915+
['tag'] * 3)
2916+
self.assertEqual(summarize_list(e.findall('.//tag[.!= "subtext"]')),
2917+
['tag'] * 3)
2918+
self.assertEqual(summarize_list(e.findall('.//tag[ . != "subtext" ]')),
2919+
['tag'] * 3)
2920+
self.assertEqual(summarize_list(e.findall(".//tag[. != 'subtext']")),
2921+
['tag'] * 3)
2922+
# Matches all tags.
2923+
self.assertEqual(summarize_list(e.findall(".//tag[. != 'subtext ']")),
2924+
['tag'] * 4)
2925+
self.assertEqual(summarize_list(e.findall(".//tag[.!= ' subtext']")),
2926+
['tag'] * 4)
2927+
28932928
# duplicate section => 2x tag matches
28942929
e[1] = e[2]
28952930
self.assertEqual(summarize_list(e.findall(".//section[tag = 'subtext']")),

‎Lib/xml/etree/ElementPath.py

+25-7
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@
6565
r"//?|"
6666
r"\.\.|"
6767
r"\(\)|"
68+
r"!=|"
6869
r"[/.*:\[\]\(\)@=])|"
69-
r"((?:\{[^}]+\})?[^/\[\]\(\)@=\s]+)|"
70+
r"((?:\{[^}]+\})?[^/\[\]\(\)@!=\s]+)|"
7071
r"\s+"
7172
)
7273

@@ -253,15 +254,20 @@ def select(context, result):
253254
if elem.get(key) is not None:
254255
yield elem
255256
return select
256-
if signature == "@-='":
257-
# [@attribute='value']
257+
if signature == "@-='" or signature == "@-!='":
258+
# [@attribute='value'] or [@attribute!='value']
258259
key = predicate[1]
259260
value = predicate[-1]
260261
def select(context, result):
261262
for elem in result:
262263
if elem.get(key) == value:
263264
yield elem
264-
return select
265+
def select_negated(context, result):
266+
for elem in result:
267+
if elem.get(key) is not None and elem.get(key) != value:
268+
yield elem
269+
negate_predicate = '!' in signature
270+
return select_negated if negate_predicate else select
265271
if signature == "-" and not re.match(r"\-?\d+$", predicate[0]):
266272
# [tag]
267273
tag = predicate[0]
@@ -270,8 +276,9 @@ def select(context, result):
270276
if elem.find(tag) is not None:
271277
yield elem
272278
return select
273-
if signature == ".='" or (signature == "-='" and not re.match(r"\-?\d+$", predicate[0])):
274-
# [.='value'] or [tag='value']
279+
if signature == ".='" or signature == ".!='" or ((signature == "-='" or signature == "-!='")
280+
and not re.match(r"\-?\d+$", predicate[0])):
281+
# [.='value'] or [tag='value'] or [.!='value'] or [tag!='value']
275282
tag = predicate[0]
276283
value = predicate[-1]
277284
if tag:
@@ -281,12 +288,23 @@ def select(context, result):
281288
if "".join(e.itertext()) == value:
282289
yield elem
283290
break
291+
def select_negated(context, result):
292+
for elem in result:
293+
for e in elem.findall(tag):
294+
if "".join(e.itertext()) != value:
295+
yield elem
296+
break
284297
else:
285298
def select(context, result):
286299
for elem in result:
287300
if "".join(elem.itertext()) == value:
288301
yield elem
289-
return select
302+
def select_negated(context, result):
303+
for elem in result:
304+
if "".join(elem.itertext()) != value:
305+
yield elem
306+
negate_predicate = '!' in signature
307+
return select_negated if negate_predicate else select
290308
if signature == "-" or signature == "-()" or signature == "-()-":
291309
# [index] or [last()] or [last()-index]
292310
if signature == "-":

‎Misc/NEWS.d/next/Library/2020-09-08-03-19-04.bpo-40624.0-gYfx.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added support for the XPath ``!=`` operator in xml.etree

0 commit comments

Comments
 (0)