gh-107455: ctypes: Improve error messages when converting to an incompatible type (#107456)

tomasr8 · web-flow · commit 62a3a15119cf · 2023-08-03T10:59:03.000+05:30
diff --git a/Lib/test/test_ctypes/test_functions.py b/Lib/test/test_ctypes/test_functions.py
@@ -4,8 +4,8 @@
 import unittest
 from ctypes import (CDLL, Structure, Array, CFUNCTYPE,
                     byref, POINTER, pointer, ArgumentError,
-                    c_char, c_wchar, c_byte, c_char_p,
-                    c_short, c_int, c_long, c_longlong,
+                    c_char, c_wchar, c_byte, c_char_p, c_wchar_p,
+                    c_short, c_int, c_long, c_longlong, c_void_p,
                     c_float, c_double, c_longdouble)
 from _ctypes import _Pointer,  _SimpleCData
 
@@ -92,6 +92,54 @@ def test_wchar_parm(self):
                          "argument 2: TypeError: one character unicode string "
                          "expected")
 
+    def test_c_char_p_parm(self):
+        """Test the error message when converting an incompatible type to c_char_p."""
+        proto = CFUNCTYPE(c_int, c_char_p)
+        def callback(*args):
+            return 0
+
+        callback = proto(callback)
+        self.assertEqual(callback(b"abc"), 0)
+
+        with self.assertRaises(ArgumentError) as cm:
+            callback(10)
+
+        self.assertEqual(str(cm.exception),
+                         "argument 1: TypeError: 'int' object cannot be "
+                         "interpreted as ctypes.c_char_p")
+
+    def test_c_wchar_p_parm(self):
+        """Test the error message when converting an incompatible type to c_wchar_p."""
+        proto = CFUNCTYPE(c_int, c_wchar_p)
+        def callback(*args):
+            return 0
+
+        callback = proto(callback)
+        self.assertEqual(callback("abc"), 0)
+
+        with self.assertRaises(ArgumentError) as cm:
+            callback(10)
+
+        self.assertEqual(str(cm.exception),
+                         "argument 1: TypeError: 'int' object cannot be "
+                         "interpreted as ctypes.c_wchar_p")
+
+    def test_c_void_p_parm(self):
+        """Test the error message when converting an incompatible type to c_void_p."""
+        proto = CFUNCTYPE(c_int, c_void_p)
+        def callback(*args):
+            return 0
+
+        callback = proto(callback)
+        self.assertEqual(callback(5), 0)
+
+        with self.assertRaises(ArgumentError) as cm:
+            callback(2.5)
+
+        self.assertEqual(str(cm.exception),
+                         "argument 1: TypeError: 'float' object cannot be "
+                         "interpreted as ctypes.c_void_p")
+
     def test_wchar_result(self):
         f = dll._testfunc_i_bhilfd
         f.argtypes = [c_byte, c_short, c_int, c_long, c_float, c_double]
diff --git a/Misc/NEWS.d/next/Core and Builtins/2023-07-30-14-18-49.gh-issue-107455.Es53l7.rst b/Misc/NEWS.d/next/Core and Builtins/2023-07-30-14-18-49.gh-issue-107455.Es53l7.rst
@@ -0,0 +1,3 @@
+Improve error messages when converting an incompatible type to
+:class:`ctypes.c_char_p`, :class:`ctypes.c_wchar_p` and
+:class:`ctypes.c_void_p`.
diff --git a/Modules/_ctypes/_ctypes.c b/Modules/_ctypes/_ctypes.c
@@ -1728,9 +1728,9 @@ c_wchar_p_from_param(PyObject *type, PyObject *value)
         Py_DECREF(as_parameter);
         return value;
     }
-    /* XXX better message */
-    PyErr_SetString(PyExc_TypeError,
-                    "wrong type");
+    PyErr_Format(PyExc_TypeError,
+                 "'%.200s' object cannot be interpreted "
+                 "as ctypes.c_wchar_p", Py_TYPE(value)->tp_name);
     return NULL;
 }
 
@@ -1792,9 +1792,9 @@ c_char_p_from_param(PyObject *type, PyObject *value)
         Py_DECREF(as_parameter);
         return value;
     }
-    /* XXX better message */
-    PyErr_SetString(PyExc_TypeError,
-                    "wrong type");
+    PyErr_Format(PyExc_TypeError,
+                 "'%.200s' object cannot be interpreted "
+                 "as ctypes.c_char_p", Py_TYPE(value)->tp_name);
     return NULL;
 }
 
@@ -1927,9 +1927,9 @@ c_void_p_from_param(PyObject *type, PyObject *value)
         Py_DECREF(as_parameter);
         return value;
     }
-    /* XXX better message */
-    PyErr_SetString(PyExc_TypeError,
-                    "wrong type");
+    PyErr_Format(PyExc_TypeError,
+                 "'%.200s' object cannot be interpreted "
+                 "as ctypes.c_void_p", Py_TYPE(value)->tp_name);
     return NULL;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Improve error messages when converting an incompatible type to`
	`2`	+:class:`ctypes.c_char_p`, :class:`ctypes.c_wchar_p` and
	`3`	+:class:`ctypes.c_void_p`.
Original file line number	Diff line number	Diff line change
`@@ -1728,9 +1728,9 @@ c_wchar_p_from_param(PyObject type, PyObject value)`
`1728`	`1728`	`Py_DECREF(as_parameter);`
`1729`	`1729`	`return value;`
`1730`	`1730`	`}`
`1731`		`- /* XXX better message */`
`1732`		`- PyErr_SetString(PyExc_TypeError,`
`1733`		`- "wrong type");`
	`1731`	`+ PyErr_Format(PyExc_TypeError,`
	`1732`	`+ "'%.200s' object cannot be interpreted "`
	`1733`	`+ "as ctypes.c_wchar_p", Py_TYPE(value)->tp_name);`
`1734`	`1734`	`return NULL;`
`1735`	`1735`	`}`
`1736`	`1736`
`@@ -1792,9 +1792,9 @@ c_char_p_from_param(PyObject type, PyObject value)`
`1792`	`1792`	`Py_DECREF(as_parameter);`
`1793`	`1793`	`return value;`
`1794`	`1794`	`}`
`1795`		`- /* XXX better message */`
`1796`		`- PyErr_SetString(PyExc_TypeError,`
`1797`		`- "wrong type");`
	`1795`	`+ PyErr_Format(PyExc_TypeError,`
	`1796`	`+ "'%.200s' object cannot be interpreted "`
	`1797`	`+ "as ctypes.c_char_p", Py_TYPE(value)->tp_name);`
`1798`	`1798`	`return NULL;`
`1799`	`1799`	`}`
`1800`	`1800`
`@@ -1927,9 +1927,9 @@ c_void_p_from_param(PyObject type, PyObject value)`
`1927`	`1927`	`Py_DECREF(as_parameter);`
`1928`	`1928`	`return value;`
`1929`	`1929`	`}`
`1930`		`- /* XXX better message */`
`1931`		`- PyErr_SetString(PyExc_TypeError,`
`1932`		`- "wrong type");`
	`1930`	`+ PyErr_Format(PyExc_TypeError,`
	`1931`	`+ "'%.200s' object cannot be interpreted "`
	`1932`	`+ "as ctypes.c_void_p", Py_TYPE(value)->tp_name);`
`1933`	`1933`	`return NULL;`
`1934`	`1934`	`}`
`1935`	`1935`