-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Don't show traceback for :okexcept: #48394
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Empty file.
60 changes: 60 additions & 0 deletions
60
doc/sphinxext/ipython_sphinxext/ipython_console_highlighting.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 |
---|---|---|
@@ -0,0 +1,60 @@ | ||
""" | ||
reST directive for syntax-highlighting ipython interactive sessions. | ||
|
||
""" | ||
|
||
from IPython.lib.lexers import IPyLexer | ||
from sphinx import highlighting | ||
|
||
|
||
def patch_IPythonConsoleLexer(): | ||
"""Patch lexers.IPythonConsoleLexer.ipytb_start. | ||
|
||
This extension uses IPyLexer to highlight the exception. An exception is | ||
recognized by the traceback. The start of a traceback is found using the | ||
ipytb_start regex. This regex has to be patched to also find exceptions | ||
without a preceding traceback. | ||
""" | ||
import builtins | ||
import re | ||
|
||
from IPython.lib import lexers | ||
|
||
exceptions = [ | ||
name | ||
for name, value in builtins.__dict__.items() | ||
if isinstance(value, type) | ||
and issubclass(value, Exception) | ||
and not issubclass(value, Warning) | ||
] | ||
lexers.IPythonConsoleLexer.ipytb_start = re.compile( | ||
r"^(\^C)?(-+\n)|^( File)(.*)(, line )(\d+\n)|^(" | ||
+ "|".join(exceptions) | ||
+ r"): \S.*\n" | ||
) | ||
|
||
|
||
patch_IPythonConsoleLexer() | ||
|
||
|
||
def setup(app): | ||
"""Setup as a sphinx extension.""" | ||
|
||
# This is only a lexer, so adding it below to pygments appears sufficient. | ||
# But if somebody knows what the right API usage should be to do that via | ||
# sphinx, by all means fix it here. At least having this setup.py | ||
# suppresses the sphinx warning we'd get without it. | ||
metadata = {"parallel_read_safe": True, "parallel_write_safe": True} | ||
return metadata | ||
|
||
|
||
# Register the extension as a valid pygments lexer. | ||
# Alternatively, we could register the lexer with pygments instead. This would | ||
# require using setuptools entrypoints: http://pygments.org/docs/plugins | ||
|
||
ipy2 = IPyLexer(python3=False) | ||
ipy3 = IPyLexer(python3=True) | ||
|
||
highlighting.lexers["ipython"] = ipy2 | ||
highlighting.lexers["ipython2"] = ipy2 | ||
highlighting.lexers["ipython3"] = ipy3 |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.