Enhance tests: test NULL and release the GIL

Author: vstinner

Lib/test/test_capi/test_object.py

@@ -14,6 +14,7 @@
 _testcapi = import_helper.import_module('_testcapi')
 _testinternalcapi = import_helper.import_module('_testinternalcapi')
 
+NULL = None
 STDERR_FD = 2
 
 
@@ -250,39 +251,54 @@ def func(x):
 
         func(object())
 
-    def test_pyobject_dump(self):
+    def pyobject_dump(self, obj, release_gil=False):
         pyobject_dump = _testcapi.pyobject_dump
-        obj = 'test string'
-
-        filename = os_helper.TESTFN
-        self.addCleanup(os_helper.unlink, filename)
 
         try:
             old_stderr = os.dup(STDERR_FD)
         except OSError as exc:
             # os.dup(STDERR_FD) is not supported on WASI
             self.skipTest(f"os.dup() failed with {exc!r}")
 
+        filename = os_helper.TESTFN
         try:
-            with open(filename, "wb") as fp:
-                fd = fp.fileno()
-                os.dup2(fd, STDERR_FD)
-                pyobject_dump(obj)
+            try:
+                with open(filename, "wb") as fp:
+                    fd = fp.fileno()
+                    os.dup2(fd, STDERR_FD)
+                    pyobject_dump(obj, release_gil)
+            finally:
+                os.dup2(old_stderr, STDERR_FD)
+                os.close(old_stderr)
+
+            with open(filename) as fp:
+                return fp.read().rstrip()
         finally:
-            os.dup2(old_stderr, STDERR_FD)
-            os.close(old_stderr)
-
-        with open(filename) as fp:
-            output = fp.read()
+            os_helper.unlink(filename)
 
+    def test_pyobject_dump(self):
+        # test string object
+        str_obj = 'test string'
+        output = self.pyobject_dump(str_obj)
         hex_regex = r'(0x)?[0-9a-fA-F]+'
-        self.assertRegex(output.rstrip(),
+        regex = (
             fr"object address  : {hex_regex}\n"
              r"object refcount : [0-9]+\n"
             fr"object type     : {hex_regex}\n"
              r"object type name: str\n"
              r"object repr     : 'test string'"
         )
+        self.assertRegex(output, regex)
+
+        # release the GIL
+        output = self.pyobject_dump(str_obj, release_gil=True)
+        self.assertRegex(output, regex)
+
+        # test NULL object
+        output = self.pyobject_dump(NULL)
+        hex_regex = r'(0x)?[0-9a-fA-F]+'
+        self.assertEqual(output,
+                         '<object at (nil) is freed>')
 
 
 if __name__ == "__main__":

Modules/_testcapi/object.c

@@ -486,9 +486,25 @@ is_uniquely_referenced(PyObject *self, PyObject *op)
 
 
 static PyObject *
-pyobject_dump(PyObject *self, PyObject *op)
+pyobject_dump(PyObject *self, PyObject *args)
 {
-    PyObject_Dump(op);
+    PyObject *op;
+    int release_gil = 0;
+
+    if (!PyArg_ParseTuple(args, "O|i", &op, &release_gil)) {
+        return NULL;
+    }
+    NULLABLE(op);
+
+    if (release_gil) {
+        Py_BEGIN_ALLOW_THREADS
+        PyObject_Dump(op);
+        Py_END_ALLOW_THREADS
+
+    }
+    else {
+        PyObject_Dump(op);
+    }
     Py_RETURN_NONE;
 }
 
@@ -519,7 +535,7 @@ static PyMethodDef test_methods[] = {
     {"test_py_is_funcs", test_py_is_funcs, METH_NOARGS},
     {"clear_managed_dict", clear_managed_dict, METH_O, NULL},
     {"is_uniquely_referenced", is_uniquely_referenced, METH_O},
-    {"pyobject_dump", pyobject_dump, METH_O},
+    {"pyobject_dump", pyobject_dump, METH_VARARGS},
     {NULL},
 };