Add system_raise_on_error config option for ! shell operator #15073
Conversation
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
Fixes ipython#12264 Add system_raise_on_error configuration option that raises CalledProcessError when shell commands executed via the ! operator return non-zero exit status. This brings similar error-handling behavior to the ! operator as was added to %%bash magic in PR ipython#11287. Changes: - Add system_raise_on_error Bool traitlet config (default: False) - Import CalledProcessError from subprocess - Modify system_piped() to raise on non-zero exit when enabled - Modify system_raw() to raise on non-zero exit when enabled - Modify getoutput() to raise on non-zero exit when enabled (uses get_output_error_code to capture exit status) When enabled, users can halt notebook execution on command failures: get_ipython().system_raise_on_error = True !false # Now raises CalledProcessError Note: A follow-up PR to ipykernel will be needed to support this in Jupyter notebooks, as ZMQInteractiveShell overrides system_piped().
Author
|
Bumping this. @Carreau would you be able to review it if you have a few minutes to spare? Many thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #12264
Add system_raise_on_error configuration option that raises CalledProcessError when shell commands executed via the ! operator return non-zero exit status. This brings similar error-handling behavior to the ! operator as was added to %%bash magic in PR #11287.
Changes:
When enabled, users can halt notebook execution on command failures:
get_ipython().system_raise_on_error = True
!false # Now raises CalledProcessError
Note: A follow-up PR to ipykernel will be needed to support this in Jupyter notebooks, as ZMQInteractiveShell overrides system_piped().