Defer DataFrame HTML repr to Anywidget in display mode

Author: shuoweil

bigframes/dataframe.py

@@ -55,6 +55,7 @@
 import pyarrow
 import tabulate
 
+import bigframes
 import bigframes._config.display_options as display_options
 import bigframes.constants
 import bigframes.core
@@ -951,6 +952,10 @@ def _repr_html_(self):
         Renders the DataFrame as HTML.
         This method is used by IPython to display the DataFrame.
         """
+        # If in anywidget mode, return None to defer to _repr_mimebundle_
+        # which will provide the richer anywidget representation.
+        if bigframes.options.display.repr_mode == "anywidget":
+            return None
         return self._repr_mimebundle_()["text/html"]
 
     def _create_html_representation(

tests/system/small/test_anywidget.py

@@ -930,6 +930,12 @@ def test_repr_in_anywidget_mode_should_not_be_deferred(
         assert "page_1_row_1" in representation
 
 
+def test_dataframe_repr_html_anywidget_mode(paginated_bf_df: bf.dataframe.DataFrame):
+    with bf.option_context("display.repr_mode", "anywidget"):
+        result = paginated_bf_df._repr_html_()
+        assert result is None
+
+
 # TODO(b/332316283): Add tests for custom index and multiindex
 # This may not be necessary for the SQL Cell use case but should be
 # considered for completeness.