From 04bc681e7cf5b7effd99e676b7deceb27fb34434 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?=
<10796600+picnixz@users.noreply.github.com>
Date: Fri, 4 Apr 2025 17:04:07 +0200
Subject: gh-131938: Update exception message for `Element.remove()` when an
element is not found (#131972)
The exception message for `xml.etree.ElementTree.Element.remove` when an element is not found
has been updated from "list.remove(x): x not in list" to "Element.remove(x): element not found".
---
Lib/test/test_xml_etree.py | 4 ++--
Lib/xml/etree/ElementTree.py | 6 +++++-
.../next/Library/2025-04-01-13-44-26.gh-issue-131938.dm4Suq.rst | 3 +++
Modules/_elementtree.c | 3 ++-
4 files changed, 12 insertions(+), 4 deletions(-)
create mode 100644 Misc/NEWS.d/next/Library/2025-04-01-13-44-26.gh-issue-131938.dm4Suq.rst
diff --git a/Lib/test/test_xml_etree.py b/Lib/test/test_xml_etree.py
index 7f5945d..5fe9d68 100644
--- a/Lib/test/test_xml_etree.py
+++ b/Lib/test/test_xml_etree.py
@@ -344,9 +344,9 @@ class ElementTreeTest(unittest.TestCase):
self.serialize_check(element, '') # 4
element.remove(subelement)
self.serialize_check(element, '') # 5
- with self.assertRaises(ValueError) as cm:
+ with self.assertRaisesRegex(ValueError,
+ r'Element\.remove\(.+\): element not found'):
element.remove(subelement)
- self.assertEqual(str(cm.exception), 'list.remove(x): x not in list')
self.serialize_check(element, '') # 6
element[0:0] = [subelement, subelement, subelement]
self.serialize_check(element[1], '')
diff --git a/Lib/xml/etree/ElementTree.py b/Lib/xml/etree/ElementTree.py
index ce67d7d..44ab5d1 100644
--- a/Lib/xml/etree/ElementTree.py
+++ b/Lib/xml/etree/ElementTree.py
@@ -267,7 +267,11 @@ class Element:
"""
# assert iselement(element)
- self._children.remove(subelement)
+ try:
+ self._children.remove(subelement)
+ except ValueError:
+ # to align the error message with the C implementation
+ raise ValueError("Element.remove(x): element not found") from None
def find(self, path, namespaces=None):
"""Find first matching element by tag name or path.
diff --git a/Misc/NEWS.d/next/Library/2025-04-01-13-44-26.gh-issue-131938.dm4Suq.rst b/Misc/NEWS.d/next/Library/2025-04-01-13-44-26.gh-issue-131938.dm4Suq.rst
new file mode 100644
index 0000000..6cc212e
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2025-04-01-13-44-26.gh-issue-131938.dm4Suq.rst
@@ -0,0 +1,3 @@
+:mod:`xml.etree.ElementTree`: update the error message when an element to
+remove via :meth:`Element.remove ` is
+not found. Patch by Bénédikt Tran.
diff --git a/Modules/_elementtree.c b/Modules/_elementtree.c
index f4f4853..bf22110 100644
--- a/Modules/_elementtree.c
+++ b/Modules/_elementtree.c
@@ -1654,7 +1654,8 @@ _elementtree_Element_remove_impl(ElementObject *self, PyObject *subelement)
}
if (rc == 0) {
- PyErr_SetString(PyExc_ValueError, "list.remove(x): x not in list");
+ PyErr_SetString(PyExc_ValueError,
+ "Element.remove(x): element not found");
return NULL;
}
--
cgit v0.12