Improve message and fix test

Author: donbarbos

Lib/test/test_type_annotations.py

@@ -301,7 +301,7 @@ def check_annotations(self, f):
             print(f.__annotations__)
 
         f.__annotate__ = lambda x: 42
-        with self.assertRaisesRegex(TypeError, r"__annotate__ returned non-dict of type 'int'"):
+        with self.assertRaisesRegex(TypeError, r"__annotate__() must return type dict of type 'int'"):
             print(f.__annotations__)
 
         f.__annotate__ = lambda x: {"x": x}

Objects/abstract.c

@@ -887,7 +887,8 @@ PyObject_Format(PyObject *obj, PyObject *format_spec)
 
     if (result && !PyUnicode_Check(result)) {
         PyErr_Format(PyExc_TypeError,
-                     "__format__ must return type str (not %T)", result);
+                     "%T.__format__() must return type str (not %T)",
+                     obj, result);
         Py_SETREF(result, NULL);
         goto done;
     }
@@ -1420,14 +1421,14 @@ _PyNumber_Index(PyObject *item)
 
     if (!PyLong_Check(result)) {
         PyErr_Format(PyExc_TypeError,
-                     "%T.__index__ must return type int (not %T)",
+                     "%T.__index__() must return type int (not %T)",
                      item, result);
         Py_DECREF(result);
         return NULL;
     }
     /* Issue #17576: warn if 'result' not of exact type int. */
     if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
-            "%T.__index__ must return type int (not %T).  "
+            "%T.__index__() must return type int (not %T).  "
             "The ability to return an instance of a strict subclass of int "
             "is deprecated, and may be removed in a future version of Python.",
             item, result)) {
@@ -1530,14 +1531,14 @@ PyNumber_Long(PyObject *o)
 
         if (!PyLong_Check(result)) {
             PyErr_Format(PyExc_TypeError,
-                         "%T.__int__ must return type int (not %T)",
+                         "%T.__int__() must return type int (not %T)",
                          o, result);
             Py_DECREF(result);
             return NULL;
         }
         /* Issue #17576: warn if 'result' not of exact type int. */
         if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
-                "%T.__int__ must return type int (not %T).  "
+                "%T.__int__() must return type int (not %T).  "
                 "The ability to return an instance of a strict subclass of int "
                 "is deprecated, and may be removed in a future version of Python.",
                 o, result)) {
@@ -1608,13 +1609,13 @@ PyNumber_Float(PyObject *o)
 
         if (!PyFloat_Check(res)) {
             PyErr_Format(PyExc_TypeError,
-                         "%T.__float__ must return type float (not %T)", o, res);
+                         "%T.__float__() must return type float (not %T)", o, res);
             Py_DECREF(res);
             return NULL;
         }
         /* Issue #26983: warn if 'res' not of exact type float. */
         if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
-                "%T.__float__ must return type float (not %T).  "
+                "%T.__float__() must return type float (not %T).  "
                 "The ability to return an instance of a strict subclass of float "
                 "is deprecated, and may be removed in a future version of Python.",
                 o, res)) {

Objects/bytesobject.c

@@ -566,7 +566,7 @@ format_obj(PyObject *v, const char **pbuf, Py_ssize_t *plen)
             return NULL;
         if (!PyBytes_Check(result)) {
             PyErr_Format(PyExc_TypeError,
-                         "%T.__bytes__ must return type bytes (not %T)",
+                         "%T.__bytes__() must return type bytes (not %T)",
                          v, result);
             Py_DECREF(result);
             return NULL;
@@ -2788,7 +2788,7 @@ bytes_new_impl(PyTypeObject *type, PyObject *x, const char *encoding,
             return NULL;
         if (!PyBytes_Check(bytes)) {
             PyErr_Format(PyExc_TypeError,
-                         "%T.__bytes__ must return type bytes (not %T)",
+                         "%T.__bytes__() must return type bytes (not %T)",
                          x, bytes);
             Py_DECREF(bytes);
             return NULL;

Objects/complexobject.c

@@ -499,14 +499,14 @@ try_complex_special_method(PyObject *op)
         }
         if (!PyComplex_Check(res)) {
             PyErr_Format(PyExc_TypeError,
-                "%T.__complex__ must return type complex (not %T)",
+                "%T.__complex__() must return type complex (not %T)",
                 op, res);
             Py_DECREF(res);
             return NULL;
         }
         /* Issue #29894: warn if 'res' not of exact type complex. */
         if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
-                "%T.__complex__ must return type complex (not %T).  "
+                "%T.__complex__() must return type complex (not %T).  "
                 "The ability to return an instance of a strict subclass of complex "
                 "is deprecated, and may be removed in a future version of Python.",
                 op, res)) {

Objects/object.c

@@ -781,7 +781,7 @@ PyObject_Repr(PyObject *v)
     }
     if (!PyUnicode_Check(res)) {
         _PyErr_Format(tstate, PyExc_TypeError,
-                      "%T.__repr__ must return type str (not %T)", v, res);
+                      "%T.__repr__() must return type str (not %T)", v, res);
         Py_DECREF(res);
         return NULL;
     }
@@ -823,7 +823,7 @@ PyObject_Str(PyObject *v)
     }
     if (!PyUnicode_Check(res)) {
         _PyErr_Format(tstate, PyExc_TypeError,
-                      "%T.__str__ must return type str (not %T)", v, res);
+                      "%T.__str__() must return type str (not %T)", v, res);
         Py_DECREF(res);
         return NULL;
     }
@@ -878,7 +878,7 @@ PyObject_Bytes(PyObject *v)
             return NULL;
         if (!PyBytes_Check(result)) {
             PyErr_Format(PyExc_TypeError,
-                         "%T.__bytes__ must return type bytes (not %T)",
+                         "%T.__bytes__() must return type bytes (not %T)",
                          v, result);
             Py_DECREF(result);
             return NULL;

Objects/typeobject.c

@@ -2029,7 +2029,7 @@ type_get_annotations(PyObject *tp, void *Py_UNUSED(closure))
             }
             if (!PyDict_Check(annotations)) {
                 PyErr_Format(PyExc_TypeError,
-                             "__annotate__ must return type dict of type '%T'",
+                             "__annotate__() must return type dict of type '%T'",
                              annotations);
                 Py_DECREF(annotations);
                 Py_DECREF(annotate);
@@ -10077,7 +10077,7 @@ slot_nb_bool(PyObject *self)
     }
     else {
         PyErr_Format(PyExc_TypeError,
-                     "%T.__bool__ must return type bool (not %T)",
+                     "%T.__bool__() must return type bool (not %T)",
                      self, value);
         result = -1;
     }