chore: add blob display size options (#1657)

Author: GarrettWu

bigframes/_config/experiment_options.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Optional
 import warnings
 
 import bigframes.exceptions as bfe
@@ -26,6 +27,9 @@ def __init__(self):
         self._semantic_operators: bool = False
         self._ai_operators: bool = False
         self._blob: bool = False
+        self._blob_display: bool = True
+        self._blob_display_width: Optional[int] = None
+        self._blob_display_height: Optional[int] = None
 
     @property
     def semantic_operators(self) -> bool:
@@ -67,3 +71,30 @@ def blob(self, value: bool):
             )
             warnings.warn(msg, category=bfe.PreviewWarning)
         self._blob = value
+
+    @property
+    def blob_display(self) -> bool:
+        """Whether to display the blob content in notebook DataFrame preview. Default True."""
+        return self._blob_display
+
+    @blob_display.setter
+    def blob_display(self, value: bool):
+        self._blob_display = value
+
+    @property
+    def blob_display_width(self) -> Optional[int]:
+        """Width in pixels that the blob constrained to."""
+        return self._blob_display_width
+
+    @blob_display_width.setter
+    def blob_display_width(self, value: Optional[int]):
+        self._blob_display_width = value
+
+    @property
+    def blob_display_height(self) -> Optional[int]:
+        """Height in pixels that the blob constrained to."""
+        return self._blob_display_height
+
+    @blob_display_height.setter
+    def blob_display_height(self, value: Optional[int]):
+        self._blob_display_height = value

bigframes/dataframe.py

@@ -765,7 +765,10 @@ def _repr_html_(self) -> str:
             return formatter.repr_query_job(self._compute_dry_run())
 
         df = self.copy()
-        if bigframes.options.experiments.blob:
+        if (
+            bigframes.options.experiments.blob
+            and bigframes.options.experiments.blob_display
+        ):
             blob_cols = [
                 col
                 for col in df.columns
@@ -788,7 +791,10 @@ def _repr_html_(self) -> str:
 
         with display_options.pandas_repr(opts):
             # Allows to preview images in the DataFrame. The implementation changes the string repr as well, that it doesn't truncate strings or escape html charaters such as "<" and ">". We may need to implement a full-fledged repr module to better support types not in pandas.
-            if bigframes.options.experiments.blob:
+            if (
+                bigframes.options.experiments.blob
+                and bigframes.options.experiments.blob_display
+            ):
 
                 def obj_ref_rt_to_html(obj_ref_rt) -> str:
                     obj_ref_rt_json = json.loads(obj_ref_rt)
@@ -799,8 +805,16 @@ def obj_ref_rt_to_html(obj_ref_rt) -> str:
                             str, gcs_metadata.get("content_type", "")
                         )
                         if content_type.startswith("image"):
+                            size_str = ""
+                            if bigframes.options.experiments.blob_display_width:
+                                size_str = f' width="{bigframes.options.experiments.blob_display_width}"'
+                            if bigframes.options.experiments.blob_display_height:
+                                size_str = (
+                                    size_str
+                                    + f' height="{bigframes.options.experiments.blob_display_height}"'
+                                )
                             url = obj_ref_rt_json["access_urls"]["read_url"]
-                            return f'<img src="{url}">'
+                            return f'<img src="{url}"{size_str}>'
 
                     return f'uri: {obj_ref_rt_json["objectref"]["uri"]}, authorizer: {obj_ref_rt_json["objectref"]["authorizer"]}'
 

bigframes/operations/blob.py

@@ -241,9 +241,12 @@ def display(
         Args:
             n (int, default 3): number of sample blob objects to display.
             content_type (str, default ""): content type of the blob. If unset, use the blob metadata of the storage. Possible values are "image", "audio" and "video".
-            width (int or None, default None): width in pixels that the image/video are constrained to. If unset, use the image/video's original size or ratio. No-op for other content types.
-            height (int or None, default None): height in pixels that the image/video are constrained to. If unset, use the image/video's original size or ratio. No-op for other content types.
+            width (int or None, default None): width in pixels that the image/video are constrained to. If unset, use the global setting in bigframes.options.experiments.blob_display_width, otherwise image/video's original size or ratio is used. No-op for other content types.
+            height (int or None, default None): height in pixels that the image/video are constrained to. If unset, use the global setting in bigframes.options.experiments.blob_display_height, otherwise image/video's original size or ratio is used. No-op for other content types.
         """
+        width = width or bigframes.options.experiments.blob_display_width
+        height = height or bigframes.options.experiments.blob_display_height
+
         # col name doesn't matter here. Rename to avoid column name conflicts
         df = bigframes.series.Series(self._block).rename("blob_col").to_frame()
 

samples/snippets/multimodal_test.py

@@ -21,6 +21,8 @@ def test_multimodal_dataframe(gcs_dst_bucket: str) -> None:
 
     # Flag to enable the feature
     bigframes.options.experiments.blob = True
+    # Flags to control preview image/video preview size
+    bigframes.options.experiments.blob_display_width = 300
 
     import bigframes.pandas as bpd
 
@@ -47,10 +49,12 @@ def test_multimodal_dataframe(gcs_dst_bucket: str) -> None:
     df_image["size"] = df_image["image"].blob.size()
     df_image["updated"] = df_image["image"].blob.updated()
     df_image
+    # [END bigquery_dataframes_multimodal_dataframe_merge]
 
+    # [START bigquery_dataframes_multimodal_dataframe_filter]
     # Filter images and display, you can also display audio and video types. Use width/height parameters to constrain window sizes.
-    df_image[df_image["author"] == "alice"]["image"].blob.display(width=400)
-    # [END bigquery_dataframes_multimodal_dataframe_merge]
+    df_image[df_image["author"] == "alice"]["image"].blob.display()
+    # [END bigquery_dataframes_multimodal_dataframe_filter]
 
     # [START bigquery_dataframes_multimodal_dataframe_image_transform]
     df_image["blurred"] = df_image["image"].blob.image_blur(