Issue #22077: Improve index error messages for bytearrays, bytes, lists, and

terryjreedy · terryjreedy · commit ffff1440d118 · 2014-08-02T01:30:37.000-04:00
tuples by adding 'or slices'. Added ', not &lt;typename' for bytearrays.
Original patch by Claudiu Popa.
diff --git a/Lib/test/list_tests.py b/Lib/test/list_tests.py
@@ -30,6 +30,12 @@ def test_init(self):
         self.assertNotEqual(id(a), id(b))
         self.assertEqual(a, b)
 
+    def test_getitem_error(self):
+        msg = "list indices must be integers or slices"
+        with self.assertRaisesRegex(TypeError, msg):
+            a = []
+            a['a'] = "python"
+
     def test_repr(self):
         l0 = []
         l2 = [0, 1, 2]
@@ -120,6 +126,10 @@ def test_setitem(self):
         a[-1] = 9
         self.assertEqual(a, self.type2test([5,6,7,8,9]))
 
+        msg = "list indices must be integers or slices"
+        with self.assertRaisesRegex(TypeError, msg):
+            a['a'] = "python"
+
     def test_delitem(self):
         a = self.type2test([0, 1])
         del a[1]
diff --git a/Lib/test/test_bytes.py b/Lib/test/test_bytes.py
@@ -699,6 +699,11 @@ def test_find_etc_raise_correct_error_messages(self):
 class BytesTest(BaseBytesTest, unittest.TestCase):
     type2test = bytes
 
+    def test_getitem_error(self):
+        msg = "byte indices must be integers or slices"
+        with self.assertRaisesRegex(TypeError, msg):
+            b'python'['a']
+
     def test_buffer_is_readonly(self):
         fd = os.open(__file__, os.O_RDONLY)
         with open(fd, "rb", buffering=0) as f:
@@ -753,6 +758,17 @@ def test_from_format(self):
 class ByteArrayTest(BaseBytesTest, unittest.TestCase):
     type2test = bytearray
 
+    def test_getitem_error(self):
+        msg = "bytearray indices must be integers or slices"
+        with self.assertRaisesRegex(TypeError, msg):
+            bytearray(b'python')['a']
+
+    def test_setitem_error(self):
+        msg = "bytearray indices must be integers or slices"
+        with self.assertRaisesRegex(TypeError, msg):
+            b = bytearray(b'python')
+            b['a'] = "python"
+
     def test_nohash(self):
         self.assertRaises(TypeError, hash, bytearray())
 
diff --git a/Lib/test/test_tuple.py b/Lib/test/test_tuple.py
@@ -6,6 +6,11 @@
 class TupleTest(seq_tests.CommonTest):
     type2test = tuple
 
+    def test_getitem_error(self):
+        msg = "tuple indices must be integers or slices"
+        with self.assertRaisesRegex(TypeError, msg):
+            ()['a']
+
     def test_constructors(self):
         super().test_constructors()
         # calling built-in types without argument must return empty
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -10,6 +10,10 @@ Release date: TBA
 Core and Builtins
 -----------------
 
+- Issue #22077: Improve index error messages for bytearrays, bytes, lists,
+  and tuples by adding 'or slices'. Added ', not <typename' for bytearrays.
+  Original patch by Claudiu Popa.
+
 - Issue #18395: Rename ``_Py_char2wchar()`` to :c:func:`Py_DecodeLocale`,
   rename ``_Py_wchar2char()`` to :c:func:`Py_EncodeLocale`, and document
   these functions.
diff --git a/Objects/bytearrayobject.c b/Objects/bytearrayobject.c
@@ -445,7 +445,9 @@ bytearray_subscript(PyByteArrayObject *self, PyObject *index)
         }
     }
     else {
-        PyErr_SetString(PyExc_TypeError, "bytearray indices must be integers");
+        PyErr_Format(PyExc_TypeError,
+                     "bytearray indices must be integers or slices, not %.200s",
+                     Py_TYPE(index)->tp_name);
         return NULL;
     }
 }
@@ -650,7 +652,9 @@ bytearray_ass_subscript(PyByteArrayObject *self, PyObject *index, PyObject *valu
         }
     }
     else {
-        PyErr_SetString(PyExc_TypeError, "bytearray indices must be integer");
+        PyErr_Format(PyExc_TypeError,
+                     "bytearray indices must be integers or slices, not %.200s",
+                      Py_TYPE(index)->tp_name);
         return -1;
     }
 
diff --git a/Objects/bytesobject.c b/Objects/bytesobject.c
@@ -999,7 +999,7 @@ bytes_subscript(PyBytesObject* self, PyObject* item)
     }
     else {
         PyErr_Format(PyExc_TypeError,
-                     "byte indices must be integers, not %.200s",
+                     "byte indices must be integers or slices, not %.200s",
                      Py_TYPE(item)->tp_name);
         return NULL;
     }
diff --git a/Objects/listobject.c b/Objects/listobject.c
@@ -2444,7 +2444,7 @@ list_subscript(PyListObject* self, PyObject* item)
     }
     else {
         PyErr_Format(PyExc_TypeError,
-                     "list indices must be integers, not %.200s",
+                     "list indices must be integers or slices, not %.200s",
                      item->ob_type->tp_name);
         return NULL;
     }
@@ -2608,7 +2608,7 @@ list_ass_subscript(PyListObject* self, PyObject* item, PyObject* value)
     }
     else {
         PyErr_Format(PyExc_TypeError,
-                     "list indices must be integers, not %.200s",
+                     "list indices must be integers or slices, not %.200s",
                      item->ob_type->tp_name);
         return -1;
     }
diff --git a/Objects/tupleobject.c b/Objects/tupleobject.c
@@ -746,7 +746,7 @@ tuplesubscript(PyTupleObject* self, PyObject* item)
     }
     else {
         PyErr_Format(PyExc_TypeError,
-                     "tuple indices must be integers, not %.200s",
+                     "tuple indices must be integers or slices, not %.200s",
                      Py_TYPE(item)->tp_name);
         return NULL;
     }

Original file line number	Diff line number	Diff line change
`@@ -445,7 +445,9 @@ bytearray_subscript(PyByteArrayObject self, PyObject index)`
`445`	`445`	`}`
`446`	`446`	`}`
`447`	`447`	`else {`
`448`		`- PyErr_SetString(PyExc_TypeError, "bytearray indices must be integers");`
	`448`	`+ PyErr_Format(PyExc_TypeError,`
	`449`	`+ "bytearray indices must be integers or slices, not %.200s",`
	`450`	`+ Py_TYPE(index)->tp_name);`
`449`	`451`	`return NULL;`
`450`	`452`	`}`
`451`	`453`	`}`
`@@ -650,7 +652,9 @@ bytearray_ass_subscript(PyByteArrayObject self, PyObject index, PyObject *valu`
`650`	`652`	`}`
`651`	`653`	`}`
`652`	`654`	`else {`
`653`		`- PyErr_SetString(PyExc_TypeError, "bytearray indices must be integer");`
	`655`	`+ PyErr_Format(PyExc_TypeError,`
	`656`	`+ "bytearray indices must be integers or slices, not %.200s",`
	`657`	`+ Py_TYPE(index)->tp_name);`
`654`	`658`	`return -1;`
`655`	`659`	`}`
`656`	`660`
Original file line number	Diff line number	Diff line change
`@@ -999,7 +999,7 @@ bytes_subscript(PyBytesObject* self, PyObject* item)`
`999`	`999`	`}`
`1000`	`1000`	`else {`
`1001`	`1001`	`PyErr_Format(PyExc_TypeError,`
`1002`		`- "byte indices must be integers, not %.200s",`
	`1002`	`+ "byte indices must be integers or slices, not %.200s",`
`1003`	`1003`	`Py_TYPE(item)->tp_name);`
`1004`	`1004`	`return NULL;`
`1005`	`1005`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2444,7 +2444,7 @@ list_subscript(PyListObject* self, PyObject* item)`
`2444`	`2444`	`}`
`2445`	`2445`	`else {`
`2446`	`2446`	`PyErr_Format(PyExc_TypeError,`
`2447`		`- "list indices must be integers, not %.200s",`
	`2447`	`+ "list indices must be integers or slices, not %.200s",`
`2448`	`2448`	`item->ob_type->tp_name);`
`2449`	`2449`	`return NULL;`
`2450`	`2450`	`}`
`@@ -2608,7 +2608,7 @@ list_ass_subscript(PyListObject* self, PyObject* item, PyObject* value)`
`2608`	`2608`	`}`
`2609`	`2609`	`else {`
`2610`	`2610`	`PyErr_Format(PyExc_TypeError,`
`2611`		`- "list indices must be integers, not %.200s",`
	`2611`	`+ "list indices must be integers or slices, not %.200s",`
`2612`	`2612`	`item->ob_type->tp_name);`
`2613`	`2613`	`return -1;`
`2614`	`2614`	`}`
Original file line number	Diff line number	Diff line change
`@@ -746,7 +746,7 @@ tuplesubscript(PyTupleObject* self, PyObject* item)`
`746`	`746`	`}`
`747`	`747`	`else {`
`748`	`748`	`PyErr_Format(PyExc_TypeError,`
`749`		`- "tuple indices must be integers, not %.200s",`
	`749`	`+ "tuple indices must be integers or slices, not %.200s",`
`750`	`750`	`Py_TYPE(item)->tp_name);`
`751`	`751`	`return NULL;`
`752`	`752`	`}`