[3.12] gh-111058: Change coro.cr_frame/gen.gi_frame to be None for a closed coroutine/generator. (GH-112428) (#112589)

miss-islington · web-flow · commit 7eff607debb6 · 2023-12-01T14:13:15.000Z
diff --git a/Include/internal/pycore_frame.h b/Include/internal/pycore_frame.h
@@ -39,6 +39,8 @@ typedef enum _framestate {
     FRAME_CLEARED = 4
 } PyFrameState;
 
+#define FRAME_STATE_FINISHED(S) ((S) >= FRAME_COMPLETED)
+
 enum _frameowner {
     FRAME_OWNED_BY_THREAD = 0,
     FRAME_OWNED_BY_GENERATOR = 1,
diff --git a/Lib/test/test_coroutines.py b/Lib/test/test_coroutines.py
@@ -2216,6 +2216,14 @@ async def f():
             gen.cr_frame.clear()
         gen.close()
 
+    def test_cr_frame_after_close(self):
+        async def f():
+            pass
+        gen = f()
+        self.assertIsNotNone(gen.cr_frame)
+        gen.close()
+        self.assertIsNone(gen.cr_frame)
+
     def test_stack_in_coroutine_throw(self):
         # Regression test for https://github.com/python/cpython/issues/93592
         async def a():
diff --git a/Lib/test/test_inspect/test_inspect.py b/Lib/test/test_inspect/test_inspect.py
@@ -2264,6 +2264,10 @@ def test_closed_after_immediate_exception(self):
             self.generator.throw(RuntimeError)
         self.assertEqual(self._generatorstate(), inspect.GEN_CLOSED)
 
+    def test_closed_after_close(self):
+        self.generator.close()
+        self.assertEqual(self._generatorstate(), inspect.GEN_CLOSED)
+
     def test_running(self):
         # As mentioned on issue #10220, checking for the RUNNING state only
         # makes sense inside the generator itself.
@@ -2373,6 +2377,10 @@ def test_closed_after_immediate_exception(self):
             self.coroutine.throw(RuntimeError)
         self.assertEqual(self._coroutinestate(), inspect.CORO_CLOSED)
 
+    def test_closed_after_close(self):
+        self.coroutine.close()
+        self.assertEqual(self._coroutinestate(), inspect.CORO_CLOSED)
+
     def test_easy_debugging(self):
         # repr() and str() of a coroutine state should contain the state name
         names = 'CORO_CREATED CORO_RUNNING CORO_SUSPENDED CORO_CLOSED'.split()
diff --git a/Misc/NEWS.d/next/Core and Builtins/2023-11-26-21-30-11.gh-issue-111058.q4DqDY.rst b/Misc/NEWS.d/next/Core and Builtins/2023-11-26-21-30-11.gh-issue-111058.q4DqDY.rst
@@ -0,0 +1,3 @@
+Change coro.cr_frame/gen.gi_frame to return ``None`` after the coroutine/generator has been closed.
+This fixes a bug where :func:`~inspect.getcoroutinestate` and :func:`~inspect.getgeneratorstate`
+return the wrong state for a closed coroutine/generator.
diff --git a/Objects/genobject.c b/Objects/genobject.c
@@ -750,7 +750,7 @@ _gen_getframe(PyGenObject *gen, const char *const name)
     if (PySys_Audit("object.__getattr__", "Os", gen, name) < 0) {
         return NULL;
     }
-    if (gen->gi_frame_state == FRAME_CLEARED) {
+    if (FRAME_STATE_FINISHED(gen->gi_frame_state)) {
         Py_RETURN_NONE;
     }
     return _Py_XNewRef((PyObject *)_PyFrame_GetFrameObject((_PyInterpreterFrame *)gen->gi_iframe));

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Change coro.cr_frame/gen.gi_frame to return ``None`` after the coroutine/generator has been closed.
	`2`	+This fixes a bug where :func:`~inspect.getcoroutinestate` and :func:`~inspect.getgeneratorstate`
	`3`	`+return the wrong state for a closed coroutine/generator.`
Original file line number	Diff line number	Diff line change
`@@ -750,7 +750,7 @@ _gen_getframe(PyGenObject gen, const char const name)`
`750`	`750`	`if (PySys_Audit("object.__getattr__", "Os", gen, name) < 0) {`
`751`	`751`	`return NULL;`
`752`	`752`	`}`
`753`		`- if (gen->gi_frame_state == FRAME_CLEARED) {`
	`753`	`+ if (FRAME_STATE_FINISHED(gen->gi_frame_state)) {`
`754`	`754`	`Py_RETURN_NONE;`
`755`	`755`	`}`
`756`	`756`	`return _Py_XNewRef((PyObject )_PyFrame_GetFrameObject((_PyInterpreterFrame )gen->gi_iframe));`