Fix InterfaceMagic compatibility with IPython >= 9.6 #41039
Closed
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
Since IPython 8.27 (with Python 3.12+), the traceback formatter in
IPython.core.ultratb.ListTB._format_exception_only() introduced a
stricter assertion that requires SyntaxError.text to be a string.
When interface cell magics are invoked with invalid options (e.g.,
'%%gap foo'), Sage's InterfaceMagic.cell_magic() raised a SyntaxError
without setting the .text attribute. This caused IPython 8.27+ to
trigger an additional AssertionError during traceback rendering:
AssertionError: assert isinstance(value.text, str)
This fix ensures that the SyntaxError has a properly formatted .text
attribute set before raising it, preventing the assertion failure and
providing better error messages.
The fix also includes a regression test verifying that the .text
attribute is correctly set.
Related IPython changes:
- ipython/ipython#14764
- ipython/ipython#14770
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a compatibility issue with IPython 8.27+ where InterfaceMagic would raise incomplete SyntaxError exceptions that triggered assertion failures in IPython's traceback formatter.
- Ensures SyntaxError objects have a properly formatted
.textattribute before being raised - Adds a doctest to verify the
.textattribute is correctly set on SyntaxError exceptions
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Documentation preview for this PR (built with commit 61d1c5e; changes) is ready! 🎉 |
cxzhong
changed the title
|
seems @tobiasdiez has reported and will fix in next version. We need to skip version 9.6 |
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.
Since IPython 9.6 (with Python 3.12+), the traceback formatter in
IPython.core.ultratb.ListTB._format_exception_only()introduced a stricter assertion that requiresSyntaxError.textto be a string.When interface cell magics are invoked with invalid options (e.g.,
'%%gap foo'), Sage's InterfaceMagic.cell_magic() raised a SyntaxError without setting the .text attribute. This caused IPython 8.27+ to trigger an additional AssertionError during traceback rendering:This fix ensures that the SyntaxError has a properly formatted .text attribute set before raising it, preventing the assertion failure and providing better error messages.
The fix also includes a regression test verifying that the .text attribute is correctly set.
Fix errors raised in #41036 https://github.com/sagemath/sage/actions/runs/18470853388
you can refer to ipython/ipython@db0fde0
📝 Checklist
⌛ Dependencies