Prefer _repr_mimebundle_ for notebook display#969
Merged
has2k1 merged 4 commits intohas2k1:mainfrom Aug 28, 2025
Merged
Conversation
These changes replace `_ipython_display_` with `_repr_mimebundle_` protocol displaying plots within notebooks. Previously, plotnine used `_ipython_display_()` for display, which works via side effects and assumes an IPython/Jupyter environment. Since IPython 6.1 (May 2017), the `_repr_mimebundle_()` protocol allows objects to return display data instead of triggering side effects. This decouples rendering from IPython, letting any compatible frontend (e.g., Jupyter, marimo) handle presentation without requiring the object to be aware of the runtime. The repr continues to generate a single format (PNG, SVG, etc.) based on configuration to match prior behavior with the `_ipython_display_`. References: - https://ipython.readthedocs.io/en/stable/config/integrating.html - https://ipython.readthedocs.io/en/stable/api/generated/IPython.core.formatters.html
manzt
force-pushed
the
manzt/repr-mimebundle
branch
from
8ba2d3b to
6a8d87e
Compare
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #969 +/- ##
==========================================
- Coverage 86.69% 86.62% -0.07%
==========================================
Files 194 194
Lines 13330 13360 +30
Branches 1639 1646 +7
==========================================
+ Hits 11556 11573 +17
- Misses 1228 1238 +10
- Partials 546 549 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Owner
|
Thanks for this. I had not picked up on the precedence of |
The previous change made this function an unneccessary.
Caused by newer version of pandas-stubs.
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
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.
These changes replace
_ipython_display_with_repr_mimebundle_protocol displaying plots within notebooks. Previously, plotnine used_ipython_display_()for display, which works via side effects and assumes an IPython/Jupyter environment.Since IPython 6.1 (May 2017), the
_repr_mimebundle_()protocol allows objects to return display data instead of triggering side effects. This decouples rendering from IPython, letting any compatible frontend (e.g., Jupyter, marimo) handle presentation without requiring the object to be aware of the runtime.The repr continues to generate a single format (PNG, SVG, etc.) based on configuration to match prior behavior with the
_ipython_display_.References: