Fix interruption of %%time and %%debug magics
#14890
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the interruption behavior for the %%time and %%debug magics by updating exception capture and adding tests that simulate KeyboardInterrupt scenarios.
- Add new tests to verify that %%time and %%timeit (and similarly %%debug) correctly propagate KeyboardInterrupt.
- Update exception handling in execution.py to explicitly catch Exception rather than a bare except, improving clarity and behavior.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/test_magic.py | Added tests for interruption of %%time and %%timeit magics and removed duplicate imports. |
| IPython/core/magics/execution.py | Refactored exception capture and improved formatting in the timing magics. |
Comments suppressed due to low confidence (2)
tests/test_magic.py:862
- Consider using a timeout with thread.join (e.g. thread.join(5)) to avoid potential hanging tests if the interruption mechanism fails.
thread.join()
tests/test_magic.py:859
- [nitpick] Add an inline comment or reference for _interrupt_after_1s to clarify its purpose in the test, which will help future maintainers understand the interruption strategy.
thread = Thread(target=_interrupt_after_1s)
Collaborator
|
LGTM 👍 |
meeseeksmachine
pushed a commit
to meeseeksmachine/ipython
that referenced
this pull request
Apr 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
%%timeand%%timeitmagics (the former should fail)%%timemagic exception captureNote that this fix is fully backward compatible since users would not get timing information if there was an exception anyways due to an early return in line 1379:
ipython/IPython/core/magics/execution.py
Lines 1377 to 1379 in aa25535
%%debugmagic exception capture