From 2497df6e13cd775f48895ac862396483934f21d2 Mon Sep 17 00:00:00 2001 From: Sam Gross Date: Wed, 17 Dec 2025 13:06:32 -0500 Subject: [PATCH] [3.13] gh-142766: Clear frame when `generator.close()` is called (gh-142838) (cherry picked from commit 25397f9541be89264d35d41a67defcfeaa950844) Co-authored-by: Sam Gross --- 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 e48d79d34f479f..d6014fd9d63cdf 100644 --- a/Lib/test/test_generators.py +++ b/Lib/test/test_generators.py @@ -246,6 +246,33 @@ def loop(): #This should not raise loop() + 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..6a14976a6dcf94 --- /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 0273dea958efc1..412d3c1090b522 100644 --- a/Objects/genobject.c +++ b/Objects/genobject.c @@ -366,6 +366,7 @@ gen_close(PyGenObject *gen, 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)) {