From 25397f9541be89264d35d41a67defcfeaa950844 Mon Sep 17 00:00:00 2001 From: Sam Gross Date: Wed, 17 Dec 2025 13:06:32 -0500 Subject: [PATCH] gh-142766: Clear frame when `generator.close()` is called (gh-142838) --- 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 3e41c7b96634..358bb27b117f 100644 --- 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 index 000000000000..6a14976a6dcf --- /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 e47180a23d26..3694198289de 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)) { -- 2.47.3