Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions Lib/test/test_generators.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 = [
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
Clear the frame of a generator when :meth:`generator.close` is called.
1 change: 1 addition & 0 deletions Objects/genobject.c
Original file line numberDiff line numberDiff line change
Expand Up@@ -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)){
Expand Down