bpo-40241: Add PyObject_GC_IsTracked and PyObject_GC_IsFinalized to the public C-API (GH-19461)

pablogsal · web-flow · commit f13072b8a89a · 2020-04-11T01:21:54.000+01:00
Add the functions PyObject_GC_IsTracked and PyObject_GC_IsFinalized to the public API to allow to query if Python objects are being currently tracked or have been already finalized by the garbage collector respectively.
diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst
@@ -60,6 +60,24 @@ Constructors for container types must conform to two rules:
    followed by the :c:member:`~PyTypeObject.tp_traverse` handler become valid, usually near the
    end of the constructor.
 
+.. c:function:: int PyObject_GC_IsTracked(PyObject *op)
+
+   Returns 1 if the object type of *op* implements the GC protocol and *op* is being
+   currently tracked by the garbage collector and 0 otherwise.
+
+   This is analogous to the Python function :func:`gc.is_tracked`.
+
+   .. versionadded:: 3.9
+
+
+.. c:function:: int PyObject_GC_IsFinalized(PyObject *op)
+
+   Returns 1 if the object type of *op* implements the GC protocol and *op* has been
+   already finalized by the garbage collector and 0 otherwise.
+
+   This is analogous to the Python function :func:`gc.is_finalized`.
+
+   .. versionadded:: 3.9
 
 Similarly, the deallocator for the object must conform to a similar pair of
 rules:
diff --git a/Doc/whatsnew/3.9.rst b/Doc/whatsnew/3.9.rst
@@ -564,6 +564,13 @@ Build and C API Changes
   Windows.
   (Contributed by Zackery Spytz in :issue:`8901`.)
 
+* Add the functions :c:func:`PyObject_GC_IsTracked` and
+  :c:func:`PyObject_GC_IsFinalized` to the public API to allow to query if
+  Python objects are being currently tracked or have been already finalized by
+  the garbage collector respectively. (Contributed by Pablo Galindo in
+  :issue:`40241`.)
+
+
 Deprecated
 ==========
 
diff --git a/Include/objimpl.h b/Include/objimpl.h
@@ -186,6 +186,8 @@ PyAPI_FUNC(void) PyObject_GC_Del(void *);
 #define PyObject_GC_NewVar(type, typeobj, n) \
                 ( (type *) _PyObject_GC_NewVar((typeobj), (n)) )
 
+PyAPI_FUNC(int) PyObject_GC_IsTracked(PyObject *);
+PyAPI_FUNC(int) PyObject_GC_IsFinalized(PyObject *);
 
 /* Utility macro to help write tp_traverse functions.
  * To use this macro, the tp_traverse function must name its arguments
diff --git a/Misc/NEWS.d/next/C API/2020-04-10-19-43-04.bpo-40241.Xm3w-1.rst b/Misc/NEWS.d/next/C API/2020-04-10-19-43-04.bpo-40241.Xm3w-1.rst
@@ -0,0 +1,4 @@
+Add the functions :c:func:`PyObject_GC_IsTracked` and
+:c:func:`PyObject_GC_IsFinalized` to the public API to allow to query if
+Python objects are being currently tracked or have been already finalized by
+the garbage collector respectively. Patch by Pablo Galindo.
diff --git a/Modules/_testcapimodule.c b/Modules/_testcapimodule.c
@@ -3588,7 +3588,7 @@ slot_tp_del(PyObject *self)
         _Py_NewReference(self);
         Py_SET_REFCNT(self, refcnt);
     }
-    assert(!PyType_IS_GC(Py_TYPE(self)) || _PyObject_GC_IS_TRACKED(self));
+    assert(!PyType_IS_GC(Py_TYPE(self)) || PyObject_GC_IsTracked(self));
     /* If Py_REF_DEBUG macro is defined, _Py_NewReference() increased
        _Py_RefTotal, so we need to undo that. */
 #ifdef Py_REF_DEBUG
diff --git a/Modules/gcmodule.c b/Modules/gcmodule.c
@@ -2312,3 +2312,21 @@ PyObject_GC_Del(void *op)
     }
     PyObject_FREE(g);
 }
+
+int
+PyObject_GC_IsTracked(PyObject* obj)
+{
+    if (PyObject_IS_GC(obj) && _PyObject_GC_IS_TRACKED(obj)) {
+        return 1;
+    }
+    return 0;
+}
+
+int
+PyObject_GC_IsFinalized(PyObject *obj)
+{
+    if (PyObject_IS_GC(obj) && _PyGCHead_FINALIZED(AS_GC(obj))) {
+         return 1;
+    }
+    return 0;
+}

Original file line number	Diff line number	Diff line change
`@@ -3588,7 +3588,7 @@ slot_tp_del(PyObject *self)`
`3588`	`3588`	`_Py_NewReference(self);`
`3589`	`3589`	`Py_SET_REFCNT(self, refcnt);`
`3590`	`3590`	`}`
`3591`		`- assert(!PyType_IS_GC(Py_TYPE(self)) \|\| _PyObject_GC_IS_TRACKED(self));`
	`3591`	`+ assert(!PyType_IS_GC(Py_TYPE(self)) \|\| PyObject_GC_IsTracked(self));`
`3592`	`3592`	`/* If Py_REF_DEBUG macro is defined, _Py_NewReference() increased`
`3593`	`3593`	`_Py_RefTotal, so we need to undo that. */`
`3594`	`3594`	`#ifdef Py_REF_DEBUG`