[3.14] gh-142766: Clear frame when `generator.close()` is called (gh-142838) (#142899)

(cherry picked from commit 25397f9541be89264d35d41a67defcfeaa950844)

Co-authored-by: Sam Gross <colesbury@gmail.com>

diff --git a/Lib/test/test_generators.py b/Lib/test/test_generators.py
index cb73179160d10d559565fd3b228f2ff38315d29b..b71c4d1c81951b818402f9cdadfb937fe7eb876e 100644 (file)
--- a/Lib/test/test_generators.py
+++ b/Lib/test/test_generators.py
@@ -290,6 +290,33 @@ class GeneratorTest(unittest.TestCase):
 
         self.assertEqual([1, 2], list(i for i in C()))
 
+    def test_close_clears_frame(self):
+        # gh-142766: Test that closing a generator clears its frame
+        class DetectDelete:
+            def __init__(self):
+                DetectDelete.deleted = False
+
+            def __del__(self):
+                DetectDelete.deleted = True
+
+        def generator(arg):
+            yield
+
+        # Test a freshly created generator (not suspended)
+        g = generator(DetectDelete())
+        g.close()
+        self.assertTrue(DetectDelete.deleted)
+
+        # Test a suspended generator
+        g = generator(DetectDelete())
+        next(g)
+        g.close()
+        self.assertTrue(DetectDelete.deleted)
+
+        # Clear via gi_frame.clear()
+        g = generator(DetectDelete())
+        g.gi_frame.clear()
+        self.assertTrue(DetectDelete.deleted)
 
 class ModifyUnderlyingIterableTest(unittest.TestCase):
     iterables = [

diff --git a/Misc/NEWS.d/next/Core_and_Builtins/2025-12-16-11-56-20.gh-issue-142766.Uy2HTm.rst b/Misc/NEWS.d/next/Core_and_Builtins/2025-12-16-11-56-20.gh-issue-142766.Uy2HTm.rst
new file mode 100644 (file)
index 0000000..6a14976
--- /dev/null
+++ b/Misc/NEWS.d/next/Core_and_Builtins/2025-12-16-11-56-20.gh-issue-142766.Uy2HTm.rst
@@ -0,0 +1 @@
+Clear the frame of a generator when :meth:`generator.close` is called.

diff --git a/Objects/genobject.c b/Objects/genobject.c
index 575752fc84002a11487fbca59b67c5d3dcbc4bb6..c64e6a8dcfee636f6da43544ce885e279e0e448d 100644 (file)
--- a/Objects/genobject.c
+++ b/Objects/genobject.c
@@ -390,6 +390,7 @@ gen_close(PyObject *self, PyObject *args)
 
     if (gen->gi_frame_state == FRAME_CREATED) {
         gen->gi_frame_state = FRAME_COMPLETED;
+        gen_clear_frame(gen);
         Py_RETURN_NONE;
     }
     if (FRAME_STATE_FINISHED(gen->gi_frame_state)) {