gh-121288: Make error message for index() methods consistent (GH-121395)

serhiy-storchaka · web-flow · commit 8ecb8962e339 · 2024-07-05T10:50:45.000-07:00
Make error message for index() methods consistent

Remove the repr of the searched value (which can be arbitrary large)
from ValueError messages for list.index(), range.index(), deque.index(),
deque.remove() and ShareableList.index().  Make the error messages
consistent with error messages for other index() and remove()
methods.
diff --git a/Lib/multiprocessing/shared_memory.py b/Lib/multiprocessing/shared_memory.py
@@ -539,6 +539,6 @@ def index(self, value):
             if value == entry:
                 return position
         else:
-            raise ValueError(f"{value!r} not in this container")
+            raise ValueError("ShareableList.index(x): x not in list")
 
     __class_getitem__ = classmethod(types.GenericAlias)
diff --git a/Misc/NEWS.d/next/Core and Builtins/2024-07-05-11-29-27.gh-issue-121288.lYKYYP.rst b/Misc/NEWS.d/next/Core and Builtins/2024-07-05-11-29-27.gh-issue-121288.lYKYYP.rst
@@ -0,0 +1,5 @@
+:exc:`ValueError` messages for :meth:`!list.index()`, :meth:`!range.index()`,
+:meth:`!deque.index()`, :meth:`!deque.remove()` and
+:meth:`!ShareableList.index()` no longer contain the repr of the searched
+value (which can be arbitrary large) and are consistent with error messages
+for other :meth:`!index()` and :meth:`!remove()` methods.
diff --git a/Modules/_collectionsmodule.c b/Modules/_collectionsmodule.c
@@ -1293,7 +1293,7 @@ deque_index_impl(dequeobject *deque, PyObject *v, Py_ssize_t start,
             index = 0;
         }
     }
-    PyErr_Format(PyExc_ValueError, "%R is not in deque", v);
+    PyErr_SetString(PyExc_ValueError, "deque.index(x): x not in deque");
     return NULL;
 }
 
@@ -1462,7 +1462,7 @@ deque_remove_impl(dequeobject *deque, PyObject *value)
         }
     }
     if (i == n) {
-        PyErr_Format(PyExc_ValueError, "%R is not in deque", value);
+        PyErr_SetString(PyExc_ValueError, "deque.remove(x): x not in deque");
         return NULL;
     }
     rv = deque_del_item(deque, i);
diff --git a/Objects/listobject.c b/Objects/listobject.c
@@ -3244,7 +3244,7 @@ list_index_impl(PyListObject *self, PyObject *value, Py_ssize_t start,
         else if (cmp < 0)
             return NULL;
     }
-    PyErr_Format(PyExc_ValueError, "%R is not in list", value);
+    PyErr_SetString(PyExc_ValueError, "list.index(x): x not in list");
     return NULL;
 }
 
diff --git a/Objects/rangeobject.c b/Objects/rangeobject.c
@@ -655,7 +655,7 @@ range_index(rangeobject *r, PyObject *ob)
     }
 
     /* object is not in the range */
-    PyErr_Format(PyExc_ValueError, "%R is not in range", ob);
+    PyErr_SetString(PyExc_ValueError, "range.index(x): x not in range");
     return NULL;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1293,7 +1293,7 @@ deque_index_impl(dequeobject deque, PyObject v, Py_ssize_t start,`
`1293`	`1293`	`index = 0;`
`1294`	`1294`	`}`
`1295`	`1295`	`}`
`1296`		`- PyErr_Format(PyExc_ValueError, "%R is not in deque", v);`
	`1296`	`+ PyErr_SetString(PyExc_ValueError, "deque.index(x): x not in deque");`
`1297`	`1297`	`return NULL;`
`1298`	`1298`	`}`
`1299`	`1299`
`@@ -1462,7 +1462,7 @@ deque_remove_impl(dequeobject deque, PyObject value)`
`1462`	`1462`	`}`
`1463`	`1463`	`}`
`1464`	`1464`	`if (i == n) {`
`1465`		`- PyErr_Format(PyExc_ValueError, "%R is not in deque", value);`
	`1465`	`+ PyErr_SetString(PyExc_ValueError, "deque.remove(x): x not in deque");`
`1466`	`1466`	`return NULL;`
`1467`	`1467`	`}`
`1468`	`1468`	`rv = deque_del_item(deque, i);`
Original file line number	Diff line number	Diff line change
`@@ -3244,7 +3244,7 @@ list_index_impl(PyListObject self, PyObject value, Py_ssize_t start,`
`3244`	`3244`	`else if (cmp < 0)`
`3245`	`3245`	`return NULL;`
`3246`	`3246`	`}`
`3247`		`- PyErr_Format(PyExc_ValueError, "%R is not in list", value);`
	`3247`	`+ PyErr_SetString(PyExc_ValueError, "list.index(x): x not in list");`
`3248`	`3248`	`return NULL;`
`3249`	`3249`	`}`
`3250`	`3250`
Original file line number	Diff line number	Diff line change
`@@ -655,7 +655,7 @@ range_index(rangeobject r, PyObject ob)`
`655`	`655`	`}`
`656`	`656`
`657`	`657`	`/* object is not in the range */`
`658`		`- PyErr_Format(PyExc_ValueError, "%R is not in range", ob);`
	`658`	`+ PyErr_SetString(PyExc_ValueError, "range.index(x): x not in range");`
`659`	`659`	`return NULL;`
`660`	`660`	`}`
`661`	`661`