From b6f8ab41f7abccfad988e280351758b384e0a6de Mon Sep 17 00:00:00 2001 From: Sam Gross Date: Tue, 16 Dec 2025 11:57:31 -0500 Subject: [PATCH 1/2] gh-142766: Clear frame when `generator.close()` is called --- Lib/test/test_generators.py | 27 +++++++++++++++++++ ...-12-16-11-56-20.gh-issue-142766.Uy2HTm.rst | 1 + Objects/genobject.c | 1 + 3 files changed, 29 insertions(+) create mode 100644 Misc/NEWS.d/next/Core_and_Builtins/2025-12-16-11-56-20.gh-issue-142766.Uy2HTm.rst diff --git a/Lib/test/test_generators.py b/Lib/test/test_generators.py index 3e41c7b9663491..358bb27b117fbf 100644 --- a/Lib/test/test_generators.py +++ b/Lib/test/test_generators.py @@ -290,6 +290,33 @@ def __iter__(self): 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 index 00000000000000..261e4913740e6b --- /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 out a generator's frame when generator.close() is called. diff --git a/Objects/genobject.c b/Objects/genobject.c index e47180a23d2626..3694198289de8c 100644 --- 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)) { From b2f177feb949b7be5beed7cff2ac2a02e115754e Mon Sep 17 00:00:00 2001 From: Sam Gross Date: Tue, 16 Dec 2025 11:59:16 -0500 Subject: [PATCH 2/2] Update blurb --- .../2025-12-16-11-56-20.gh-issue-142766.Uy2HTm.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 index 261e4913740e6b..6a14976a6dcf94 100644 --- 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 @@ -1 +1 @@ -Clear out a generator's frame when generator.close() is called. +Clear the frame of a generator when :meth:`generator.close` is called.