Skip to content

bpo-45813: Drop redundant assertion from frame.clear() #29990

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 3 commits into from
Dec 8, 2021
Merged

bpo-45813: Drop redundant assertion from frame.clear() #29990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f26d5c3
bpo-45813: Drop redundant assertion from frame.clear()
asvetlov Dec 8, 2021
71dc583
Move assertion to frame_dealloc()
asvetlov Dec 8, 2021
f3c3000
Fix warning
asvetlov Dec 8, 2021
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
13 changes: 11 additions & 2 deletions Lib/test/test_coroutines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2191,13 +2191,22 @@ async def run_gen():
return 'end'
self.assertEqual(run_async(run_gen()), ([], 'end'))

def test_bpo_45813(self):
def test_bpo_45813_1(self):
'This would crash the interpreter in 3.11a2'
async def f():
pass
frame = f().cr_frame
with self.assertWarns(RuntimeWarning):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suppress printing RuntimeWarning: coroutine 'CoroutineTest.test_bpo_....<locals>.f' was never awaited on the console.

frame = f().cr_frame
frame.clear()

def test_bpo_45813_2(self):
'This would crash the interpreter in 3.11a2'
async def f():
pass
gen = f()
with self.assertWarns(RuntimeWarning):
gen.cr_frame.clear()


class CoroAsyncIOCompatTest(unittest.TestCase):

Expand Down
5 changes: 4 additions & 1 deletion Objects/frameobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,10 @@ static PyGetSetDef frame_getsetlist[] = {
static void
frame_dealloc(PyFrameObject *f)
{
/* It is the responsibility of the owning generator/coroutine
* to have cleared the generator pointer */
assert(f->f_frame->generator == NULL);

if (_PyObject_GC_IS_TRACKED(f)) {
_PyObject_GC_UNTRACK(f);
}
Expand Down Expand Up @@ -686,7 +690,6 @@ frame_clear(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
}
if (f->f_frame->generator) {
_PyGen_Finalize(f->f_frame->generator);
assert(f->f_frame->generator == NULL);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The check doesn't make sense, frame->generator consistency is checked by InterpreterFrame (Python/frame.c), not by PyFrameObject (Objects/frameobject.c).

@markshannon I very much appreciate it if you find time for the review.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. This assert would be appropriate in the dealloc function, but not in clear.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant idea. Added assertion to frame_dealloc().

}
(void)frame_tp_clear(f);
Py_RETURN_NONE;
Expand Down