Skip to content

Commit 1a73628

Browse files
committed
docs: add todo back
1 parent 971ee33 commit 1a73628

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

bigframes/dataframe.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -823,6 +823,8 @@ def _repr_mimebundle_(self, include=None, exclude=None):
823823
Custom display method for IPython/Jupyter environments.
824824
This is called by IPython's display system when the object is displayed.
825825
"""
826+
# TODO(b/467647693): Anywidget integration has been tested in Jupyter, VS Code, and
827+
# BQ Studio, but there is a known compatibility issue with Marimo that needs to be addressed.
826828
from bigframes.display import html
827829

828830
return html.repr_mimebundle(self, include=include, exclude=exclude)

bigframes/display/html.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,13 +233,18 @@ def repr_mimebundle(
233233
"""
234234
Custom display method for IPython/Jupyter environments.
235235
"""
236+
# TODO(b/467647693): Anywidget integration has been tested in Jupyter, VS Code, and
237+
# BQ Studio, but there is a known compatibility issue with Marimo that needs to be addressed.
236238
from bigframes.series import Series
237239

238240
opts = options.display
239241
if opts.repr_mode == "anywidget":
240242
try:
241243
return get_anywidget_bundle(obj, include=include, exclude=exclude)
242244
except ImportError:
245+
# Anywidget is an optional dependency, so warn rather than fail.
246+
# TODO(shuowei): When Anywidget becomes the default for all repr modes,
247+
# remove this warning.
243248
warnings.warn(
244249
"Anywidget mode is not available. "
245250
"Please `pip install anywidget traitlets` or `pip install 'bigframes[anywidget]'` to use interactive tables. "

bigframes/series.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,8 @@ def _repr_mimebundle_(self, include=None, exclude=None):
573573
Custom display method for IPython/Jupyter environments.
574574
This is called by IPython's display system when the object is displayed.
575575
"""
576+
# TODO(b/467647693): Anywidget integration has been tested in Jupyter, VS Code, and
577+
# BQ Studio, but there is a known compatibility issue with Marimo that needs to be addressed.
576578
from bigframes.display import html
577579

578580
return html.repr_mimebundle(self, include=include, exclude=exclude)

0 commit comments

Comments
 (0)