Skip to content

Commit 25397f9

Browse files
authored
gh-142766: Clear frame when generator.close() is called (gh-142838)
1 parent 77b56ea commit 25397f9

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

Lib/test/test_generators.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,33 @@ def __iter__(self):
290290

291291
self.assertEqual([1,2], list(i for i in C()))
292292

293+
def test_close_clears_frame(self):
294+
# gh-142766: Test that closing a generator clears its frame
295+
class DetectDelete:
296+
def __init__(self):
297+
DetectDelete.deleted = False
298+
299+
def __del__(self):
300+
DetectDelete.deleted = True
301+
302+
def generator(arg):
303+
yield
304+
305+
# Test a freshly created generator (not suspended)
306+
g = generator(DetectDelete())
307+
g.close()
308+
self.assertTrue(DetectDelete.deleted)
309+
310+
# Test a suspended generator
311+
g = generator(DetectDelete())
312+
next(g)
313+
g.close()
314+
self.assertTrue(DetectDelete.deleted)
315+
316+
# Clear via gi_frame.clear()
317+
g = generator(DetectDelete())
318+
g.gi_frame.clear()
319+
self.assertTrue(DetectDelete.deleted)
293320

294321
class ModifyUnderlyingIterableTest(unittest.TestCase):
295322
iterables = [
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clear the frame of a generator when :meth:`generator.close` is called.

Objects/genobject.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,7 @@ gen_close(PyObject *self, PyObject *args)
390390

391391
if (gen->gi_frame_state == FRAME_CREATED) {
392392
gen->gi_frame_state = FRAME_COMPLETED;
393+
gen_clear_frame(gen);
393394
Py_RETURN_NONE;
394395
}
395396
if (FRAME_STATE_FINISHED(gen->gi_frame_state)) {

0 commit comments

Comments
 (0)