Skip to content

Fix: Update display import for compatibility with latest IPython Fixes: #13763 #13787

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+4 −1
Open

Fix: Update display import for compatibility with latest IPython Fixes: #13763 #13787

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96fff1e
FIx Display issue, for changed iPython modules/ functions
rnihesh Apr 4, 2025
372ac60
Fix with Try/Except for older versions
rnihesh May 12, 2025
97161c3
Merge branch 'explosion:master' into nv1
rnihesh May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion spacy/displacy/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,10 @@ def render(
if jupyter or (jupyter is None and is_in_jupyter()):
# return HTML rendered by IPython display()
# See #4840 for details on span wrapper to disable mathjax
from IPython.core.display import HTML, display
try:
from IPython.display import HTML, display
except ImportError:
from IPython.core.display import HTML, display
Copy link

@Carreau Carreau Oct 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IPython maintainer here, the correct import has been from IPython.display import ... since 2012 (circa IPython 0.13), (or at least it should have been)

And in general you should avoid ImportError (it's unclear why, and use version numbers checking otherwise)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess your docs have been changed, when I raised this PR, I even saw the docs, specifying .core.display is to be used, can't get the link, but will add a reference here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://ipython.org/ipython-doc/rel-1.0.0/api/generated/IPython.core.display.html

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THe docs are autogenerated, and it's not because an object is defined in IPython.core.display that it should be imported from there.

See how IPython/disaply.py defines

from IPython.core.display import *

https://github.com/ipython/ipython/blob/rel-1.0.0/IPython/display.py#L15

Which (should) makes the .core unnecessary everywhere.


return display(HTML('<span class="tex2jax_ignore">{}</span>'.format(html)))
return html
Expand Down