Skip to content

gh-79932: raise exception if frame.clear() is called on a suspended frame #111792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 7, 2023
+27 −7
Merged

gh-79932: raise exception if frame.clear() is called on a suspended frame #111792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
af0b965
gh-79932: deprecate clearing a suspended frame and add option to get …
iritkatriel Nov 6, 2023
0e570d0
update traceback module to use the new arg
iritkatriel Nov 6, 2023
d23dfb6
update docs for traceback
iritkatriel Nov 6, 2023
765e013
Revert "update docs for traceback"
iritkatriel Nov 6, 2023
07b480a
Revert "update traceback module to use the new arg"
iritkatriel Nov 6, 2023
4196b0a
revert deprecation, treat as bugfix
iritkatriel Nov 6, 2023
82c6341
tweak docs, remove repetition in test
iritkatriel Nov 6, 2023
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
7 changes: 6 additions & 1 deletion Doc/reference/datamodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1214,10 +1214,15 @@ Frame objects support one method:
objects (for example when catching an exception and storing its
traceback for later use).

:exc:`RuntimeError` is raised if the frame is currently executing.
:exc:`RuntimeError` is raised if the frame is currently executing
or suspended.

.. versionadded:: 3.4

.. versionchanged:: 3.13
Attempting to clear a suspended frame raises :exc:`RuntimeError`
(as has always been the case for executing frames).


.. _traceback-objects:

Expand Down
4 changes: 4 additions & 0 deletions Doc/whatsnew/3.13.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,10 @@ Deprecated
and methods that consider plural forms even if the translation was not found.
(Contributed by Serhiy Storchaka in :gh:`88434`.)

* Calling :meth:`frame.clear` on a suspended frame raises :exc:`RuntimeError`
(as has always been the case for an executing frame).
(Contributed by Irit Katriel in :gh:`79932`.)


Pending Removal in Python 3.14
------------------------------
Expand Down
15 changes: 9 additions & 6 deletions Lib/test/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,11 @@ def g():
gen = g()
next(gen)
self.assertFalse(endly)
# Clearing the frame closes the generator
gen.gi_frame.clear()
self.assertTrue(endly)

# Cannot clear a suspended frame
with self.assertRaisesRegex(RuntimeError, r'suspended frame'):
gen.gi_frame.clear()
self.assertFalse(endly)

def test_clear_executing(self):
# Attempting to clear an executing frame is forbidden.
Expand Down Expand Up @@ -114,9 +116,10 @@ def g():
gen = g()
f = next(gen)
self.assertFalse(endly)
# Clearing the frame closes the generator
f.clear()
self.assertTrue(endly)
# Cannot clear a suspended frame
with self.assertRaisesRegex(RuntimeError, 'suspended frame'):
f.clear()
self.assertFalse(endly)

def test_lineno_with_tracing(self):
def record_line():
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2023-11-06-16-44-09.gh-issue-79932.2qv7uD.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Raise exception if :meth:`frame.clear` is called on a suspended frame.
7 changes: 7 additions & 0 deletions Objects/frameobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,6 +940,9 @@ frame_clear(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
if (gen->gi_frame_state == FRAME_EXECUTING) {
goto running;
}
if (FRAME_STATE_SUSPENDED(gen->gi_frame_state)) {
goto suspended;
}
_PyGen_Finalize((PyObject *)gen);
}
else if (f->f_frame->owner == FRAME_OWNED_BY_THREAD) {
Expand All @@ -954,6 +957,10 @@ frame_clear(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
PyErr_SetString(PyExc_RuntimeError,
"cannot clear an executing frame");
return NULL;
suspended:
PyErr_SetString(PyExc_RuntimeError,
"cannot clear a suspended frame");
return NULL;
}

PyDoc_STRVAR(clear__doc__,
Expand Down