Uh oh!
There was an error while loading. Please reload this page.
fix: Correct DataFrame widget rendering in Colab - #2319
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
| # Handle both tuple (data, metadata) and dict returns | ||
| if isinstance(widget_repr_result, tuple): | ||
| widget_repr, widget_metadata = widget_repr_result |
There was a problem hiding this comment.
Even though this PR is a large one, the only difference from #2271 is this added metadata part. PR 2271 discards metadata, which causes the widget is not displayed at colab notebook. I modify the method to ensure metadata is preserved and returned. Verified at: screen/AjTEQC8SrSfMqhN
860 861 # Handle both tuple (data, metadata) and dict returns 862 if isinstance(widget_repr_result, tuple): 863 - widget_repr = dict(widget_repr_result[0]) # Extract data dict from tuple 863 + widget_repr, widget_metadata = widget_repr_result 864 else: 865 - widget_repr = dict(widget_repr_result) 865 + widget_repr = widget_repr_result 866 + widget_metadata = None 867 868 + widget_repr = dict(widget_repr) 869 + 870 # At this point, we have already executed the query as part of the 871 # widget construction. Let's use the information available to render 872 # the HTML and plain text versions. 876 widget._cached_data, widget.row_count 877 ) 878 879 + if widget_metadata is not None: 880 + return widget_repr, widget_metadata 881 return widget_repr 882 
tswast
left a comment
There was a problem hiding this comment.
Thanks! Some small changes requested.
I've tested this in Jupyter, VS Code, and BQ Studio as well, and it works great.
Even though, we're using Anywidget, I couldn't get it to work on Marimo. marimo-team/marimo#5099 (comment) I've filed b/467647693 to track this (very low priority).
| # At this point, we have already executed the query as part of the | ||
| # widget construction. Let's use the information available to render | ||
| # the HTML and plain text versions. | ||
| widget_repr["text/html"] = widget.table_html |
There was a problem hiding this comment.
I notice that when I reload the notebook in VS Code and Jupyter, I miss out on the fact that there are additional pages / rows. Let's call the create HTML representation function here, too.
P.S. Here's the minimal notebook I'm using for testing:
importbigframes.pandasasbpdbpd.options.display.repr_mode="anywidget"df=bpd._read_gbq_colab("select * from `bigquery-public-data.usa_names.usa_1910_2013` where name like '%T%';")
df| df[col] = df[col].blob._get_runtime(mode="R", with_metadata=True) | ||
| return df, blob_cols | ||
| def _get_anywidget_bundle(self, include=None, exclude=None): |
There was a problem hiding this comment.
Let's add a return type here, which is a tuple with two dictionaries.
| else: | ||
| blob_cols = [] | ||
| widget_repr = widget_repr_result | ||
| widget_metadata = None |
There was a problem hiding this comment.
we can simplify our return type by constructing an empty dictionary here.
| if widget_metadata is not None: | ||
| return widget_repr, widget_metadata | ||
| return widget_repr |
There was a problem hiding this comment.
We can simplify this to always return a tuple if we set widget_metadata to an empty dictionary instead of None.
shuoweil
commented
Dec 11, 2025
I added a TODO as well. |
shuoweil
commented
Dec 11, 2025
Upon checking, failed e2e and doctest are not related to my change. |
93ccb3a to
63c15ddCompareUh oh!
There was an error while loading. Please reload this page.
This PR fix the _get_anywidget_bundle method. Previously, when the underlying widget's repr_mimebundle method returned a (data, metadata) tuple, the code was only extracting the data portion and discarding the metadata. This resulted in the widget not rendering correctly in environments like Colab, which rely on this metadata.
The change corrects this by properly unpacking the tuple into widget_repr and widget_metadata. The method now preserves the metadata and returns it along with the data, ensuring that the necessary information for widget rendering is passed on.
We also revert commit 4df3428 to reapply "refactor: Migrate DataFrame display to use IPython's repr_mimebundle() protocol for anywidget mode (#2271)"
A testcase is added to verify this new change. We also verified at colab: screen/AzGa5RMTJnMH5NH
Fixes #<466155761> 🦕