]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-142766: Clear frame when `generator.close()` is called (gh-142838)
authorSam Gross <colesbury@gmail.com>
Wed, 17 Dec 2025 18:06:32 +0000 (13:06 -0500)
committerGitHub <noreply@github.com>
Wed, 17 Dec 2025 18:06:32 +0000 (13:06 -0500)
Lib/test/test_generators.py
Misc/NEWS.d/next/Core_and_Builtins/2025-12-16-11-56-20.gh-issue-142766.Uy2HTm.rst [new file with mode: 0644]
Objects/genobject.c

index 3e41c7b9663491a05508d0b0e1f3a968b8b510d0..358bb27b117fbf33fccffe3de2d756954ba11e56 100644 (file)
@@ -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
@@ -0,0 +1 @@
+Clear the frame of a generator when :meth:`generator.close` is called.
index e47180a23d262652e4a878c073de27ecfdf0c3c8..3694198289de8c12918dbe2859a162867674a535 100644 (file)
@@ -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)) {