gh-142766: Clear frame when generator.close() is called (gh-142838)

This commit is contained in:
Sam Gross 2025-12-17 13:06:32 -05:00 committed by GitHub
parent 77b56eafde
commit 25397f9541
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 29 additions and 0 deletions

View file

@ -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 = [

View file

@ -0,0 +1 @@
Clear the frame of a generator when :meth:`generator.close` is called.

View 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)) {