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.

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

Conversation

iritkatriel
Copy link
Member

@iritkatriel iritkatriel commented Nov 6, 2023

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

There is already a perfectly general mechanism to turn selected warnings into exceptions, using the warnings module and/or the -W flag. Why do we need a specific flag argument here to accomplish the same thing?

@iritkatriel
Copy link
Member Author

I need to turn it into an exception in a particular call (always). -W wouldn't work for that. Maybe I can use the warnings module locally though?

@gvanrossum
Copy link
Member

What’s the use case for this need? Testing? Or something else?

@iritkatriel
Copy link
Member Author

The reported bug was about traceback.clear_frames, which is called from unittest and can cause the program to freeze.

@iritkatriel
Copy link
Member Author

Another option is to expose the frame state to python, so that the caller can avoid calling clear on a suspended frame.

@gvanrossum
Copy link
Member

Another option is to expose the frame state to python, so that the caller can avoid calling clear on a suspended frame.

Yeah, given that we have an API here to manipulate the frame, and a reason for not using that API when the frame is suspended, it makes sense to allow the caller to detect the frame is in that state. At least that feels better than having a custom flag to turn the warning into an error.

But: I'm not sure this requires deprecation even. It's just a bug, right? frame_clear() looks like it is intended to clear the locals only after the frame has exited -- if it's still running, we don't want to interfere with it. But a suspended frame, in this context, should be seen as not having exited. The actual state check is just wrong, it incorrectly categorizes "suspended" together with "exited" instead of "running". Since the function is already expected to raise RuntimeError, I don't see why we need to tread so lightly around fixing this (to me) obvious bug.

@iritkatriel
Copy link
Member Author

That was my initial plan, but a couple of test failed. I can just change the tests.

@iritkatriel iritkatriel changed the title gh-79932: deprecate clearing a suspended frame and add option to get exception. Apply in traceback.clear_frames(). gh-79932: raise exception if frame.clear() is called on a suspended frame Nov 6, 2023
@gvanrossum
Copy link
Member

That was my initial plan, but a couple of test failed. I can just change the tests.

Most likely those tests were mindlessly testing that the code did what it did, rather than what it should do.

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Thanks, now it makes sense to me.

@iritkatriel iritkatriel merged commit 13405ec into python:main Nov 7, 2023
@gvanrossum
Copy link
Member

Is it worth backporting?

@iritkatriel
Copy link
Member Author

I think there are situations where you clear a suspended frame, it closes the generator, and there's no problem because you don't try to use it anymore. Backporting this could break that.

@gvanrossum
Copy link
Member

Is that really a feature? Then we need to change what we did here?

@iritkatriel
Copy link
Member Author

I wouldn't go as far as calling it a feature. It's possible that sometimes this bug is not causing an actual problem, and it will if we raise exceptions.

@gvanrossum
Copy link
Member

Okay, that's fair. So in 3.13 it will raise, but in 3.12 it might work, or it might cause a deadlock like in the original report. And we recommend that the OP fix their code to stop doing this.

hugovk pushed a commit to hugovk/cpython that referenced this pull request Nov 8, 2023
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

traceback.clear_frames manages to deadlock a background task
2 participants