Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.3k
gh-111375: Fix handling of exceptions within@contextmanager-decorated functions#111676
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
pR0Ps wants to merge11 commits intopython:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Open
Changes from1 commit
Commits
Show all changes
11 commits Select commitHold shift + click to select a range
0138ff1 Add sys._set_exception() to expose the `PyErr_SetHandledExecption` fu…
pR0Psb285e9a Fix exception context in @contextmanagers
pR0Psea784d7 Reference GH issue in comment
pR0Psbf4ef1e Add more checks for exception context
pR0Psbbc212b Fix sys._set_exception() docstring wording
pR0Ps59ef993 Fix test case and add explanation in comment
pR0Psc0e7400 Add exc_context parameter to {gen/coro}.throw()
pR0Ps5e8323a Move exc_context setting into _gen_throw and restore previous exception
pR0Psa7e2dc9 Default .throw()'s exc_context to the current exception
pR0Ps90fdbe0 Remove overactive assert
pR0Ps5da75d0 Rename test case
pR0PsFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
NextNext commit
Add sys._set_exception() to expose the
PyErr_SetHandledExecption fu……nctionExposing this function allows Python code to clear/set the currentexception context as returned by `sys.exception()`. It is prefixed by anunderscore since this functionality is not intended to be accessed byuser-written code.In order to allow `sys._set_exception(None)` to clear the currentexception `_PyErr_GetTopmostException` was changed to consider `Py_None`a valid exception instead of an indication to keep traversing the stacklike `NULL` is. Additionally, `PyErr_SetHandledException` was updated toadd `Py_None` to the exception stack instead of `NULL`.Put together, these changes allow `PyErr_SetHandledException(NULL)` tomask the entire exception chain and "clear" the current exception stateas documented in `Doc/c-api/exceptions.rst`. Furthermore, since`sys._set_exception()` uses `PyErr_SetHandledException`, this allows`sys._set_exception(None)` to clear the current exception contextinstead of just exposing the next exception in the stack.
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
commit0138ff1212dbe2344aa4fa036620676abe177989
There are no files selected for viewing
117 changes: 117 additions & 0 deletionsLib/test/test_sys.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -161,6 +161,123 @@ def f(): | ||
| self.assertIsInstance(e, ValueError) | ||
| self.assertIs(exc, e) | ||
| class SetExceptionTests(unittest.TestCase): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. The suggestion is to move this from sys to contextlib. Right? | ||
| def tearDown(self): | ||
| # make sure we don't leave the global exception set | ||
| sys._set_exception(None); | ||
| def test_set_exc_invalid_values(self): | ||
| for x in (0, "1", b"2"): | ||
| with self.assertRaises(TypeError): | ||
| sys._set_exception(x); | ||
| def test_clear_exc(self): | ||
| try: | ||
| raise ValueError() | ||
| except ValueError: | ||
| self.assertIsInstance(sys.exception(), ValueError) | ||
| sys._set_exception(None) | ||
| self.assertIsNone(sys.exception()) | ||
| def test_set_exc(self): | ||
| exc = ValueError() | ||
| self.assertIsNone(sys.exception()) | ||
| sys._set_exception(exc) | ||
| self.assertIs(sys.exception(), exc) | ||
| def test_set_exc_replaced_by_new_exception_and_restored(self): | ||
| exc = ValueError() | ||
| sys._set_exception(exc) | ||
| self.assertIs(sys.exception(), exc) | ||
| try: | ||
| raise TypeError() | ||
| except TypeError: | ||
| self.assertIsInstance(sys.exception(), TypeError) | ||
| self.assertIs(sys.exception().__context__, exc) | ||
| self.assertIs(sys.exception(), exc) | ||
| def test_set_exc_popped_on_exit_except(self): | ||
| exc = ValueError() | ||
| try: | ||
| raise TypeError() | ||
| except TypeError: | ||
| self.assertIsInstance(sys.exception(), TypeError) | ||
| sys._set_exception(exc) | ||
| self.assertIs(sys.exception(), exc) | ||
| self.assertIsNone(sys.exception()) | ||
| def test_cleared_exc_overridden_and_restored(self): | ||
| try: | ||
| raise ValueError() | ||
| except ValueError: | ||
| try: | ||
| raise TypeError() | ||
| except TypeError: | ||
| self.assertIsInstance(sys.exception(), TypeError) | ||
| sys._set_exception(None) | ||
| self.assertIsNone(sys.exception()) | ||
| try: | ||
| raise IndexError() | ||
| except IndexError: | ||
| self.assertIsInstance(sys.exception(), IndexError) | ||
| self.assertIsNone(sys.exception().__context__) | ||
| self.assertIsNone(sys.exception()) | ||
| self.assertIsInstance(sys.exception(), ValueError) | ||
| self.assertIsNone(sys.exception()) | ||
| def test_clear_exc_in_generator(self): | ||
| def inner(): | ||
| self.assertIsNone(sys.exception()) | ||
| yield | ||
| self.assertIsInstance(sys.exception(), ValueError) | ||
| sys._set_exception(None) | ||
| self.assertIsNone(sys.exception()) | ||
| yield | ||
| self.assertIsNone(sys.exception()) | ||
| # with a single exception in exc_info stack | ||
| g = inner() | ||
| next(g) | ||
| try: | ||
| raise ValueError() | ||
| except: | ||
| self.assertIsInstance(sys.exception(), ValueError) | ||
| next(g) | ||
| self.assertIsInstance(sys.exception(), ValueError) | ||
| self.assertIsNone(sys.exception()) | ||
| with self.assertRaises(StopIteration): | ||
| next(g) | ||
| self.assertIsNone(sys.exception()) | ||
| # with multiple exceptions in exc_info stack by chaining generators | ||
| def outer(): | ||
| g = inner() | ||
| self.assertIsNone(sys.exception()) | ||
| yield next(g) | ||
| self.assertIsInstance(sys.exception(), TypeError) | ||
| try: | ||
| raise ValueError() | ||
| except: | ||
| self.assertIsInstance(sys.exception(), ValueError) | ||
| self.assertIsInstance(sys.exception().__context__, TypeError) | ||
| yield next(g) | ||
| self.assertIsInstance(sys.exception(), ValueError) | ||
| self.assertIsInstance(sys.exception(), TypeError) | ||
pR0Ps marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| g = outer() | ||
| next(g) | ||
| try: | ||
| raise TypeError() | ||
| except: | ||
| self.assertIsInstance(sys.exception(), TypeError) | ||
| next(g) | ||
| self.assertIsInstance(sys.exception(), TypeError) | ||
| self.assertIsNone(sys.exception()) | ||
| with self.assertRaises(StopIteration): | ||
| next(g) | ||
| self.assertIsNone(sys.exception()) | ||
| class ExceptHookTest(unittest.TestCase): | ||
2 changes: 2 additions & 0 deletionsMisc/NEWS.d/next/Core_and_Builtins/2023-12-19-17-27-08.gh-issue-111375.XeHOl_.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Add sys._set_exception() function that can set/clear the current exception | ||
| context. Patch by Carey Metcalfe. |
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
3 changes: 1 addition & 2 deletionsPython/errors.c
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -853,6 +853,32 @@ sys_exception_impl(PyObject *module) | ||
| Py_RETURN_NONE; | ||
| } | ||
| /*[clinic input] | ||
| sys._set_exception | ||
| exception: object | ||
| Set the current exception. | ||
| Subsequent calls to sys.exception()/sys.exc_info() will return | ||
| the provided exception until another exception is raised in the | ||
pR0Ps marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| current thread or the execution stack returns to a frame where | ||
| another exception is being handled. | ||
| [clinic start generated code]*/ | ||
| static PyObject * | ||
| sys__set_exception_impl(PyObject *module, PyObject *exception) | ||
| /*[clinic end generated code: output=39e119ee6b747085 input=46da3b45313a1cfa]*/ | ||
| { | ||
| if (!Py_IsNone(exception) && !PyExceptionInstance_Check(exception)){ | ||
| PyErr_SetString( | ||
| PyExc_TypeError, | ||
| "must be an exception/None" | ||
| ); | ||
| return NULL; | ||
| } | ||
| PyErr_SetHandledException(exception); | ||
| Py_RETURN_NONE; | ||
| } | ||
| /*[clinic input] | ||
| sys.exc_info | ||
| @@ -2772,6 +2798,7 @@ static PyMethodDef sys_methods[] = { | ||
| SYS__CURRENT_EXCEPTIONS_METHODDEF | ||
| SYS_DISPLAYHOOK_METHODDEF | ||
| SYS_EXCEPTION_METHODDEF | ||
| SYS__SET_EXCEPTION_METHODDEF | ||
| SYS_EXC_INFO_METHODDEF | ||
| SYS_EXCEPTHOOK_METHODDEF | ||
| SYS_EXIT_METHODDEF | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.