chore: add experimental series.blob.display() function (#1232)

Author: GarrettWu

bigframes/core/compile/scalar_op_compiler.py

@@ -1212,8 +1212,13 @@ def json_extract_string_array_op_impl(
 
 # Blob Ops
 @scalar_op_compiler.register_unary_op(ops.obj_fetch_metadata_op)
-def obj_fetch_metadata_op_impl(x: ibis_types.Value):
- return obj_fetch_metadata(obj_ref=x)
+def obj_fetch_metadata_op_impl(obj_ref: ibis_types.Value):
+ return obj_fetch_metadata(obj_ref=obj_ref)
+
+
+@scalar_op_compiler.register_unary_op(ops.ObjGetAccessUrl, pass_op=True)
+def obj_get_access_url_op_impl(obj_ref: ibis_types.Value, op: ops.ObjGetAccessUrl):
+ return obj_get_access_url(obj_ref=obj_ref, mode=op.mode)
 
 
 ### Binary Ops
@@ -1917,3 +1922,8 @@ def obj_fetch_metadata(obj_ref: _OBJ_REF_IBIS_DTYPE) -> _OBJ_REF_IBIS_DTYPE: #
 @ibis_udf.scalar.builtin(name="OBJ.MAKE_REF")
 def obj_make_ref(uri: str, authorizer: str) -> _OBJ_REF_IBIS_DTYPE: # type: ignore
  """Make ObjectRef Struct from uri and connection."""
+
+
+@ibis_udf.scalar.builtin(name="OBJ.GET_ACCESS_URL")
+def obj_get_access_url(obj_ref: _OBJ_REF_IBIS_DTYPE, mode: ibis_dtypes.String) -> ibis_dtypes.JSON: # type: ignore
+ """Get access url (as ObjectRefRumtime JSON) from ObjectRef."""

bigframes/operations/__init__.py

@@ -740,6 +740,16 @@ def output_type(self, *input_types):
  )
 
 
+## Blob Ops
+@dataclasses.dataclass(frozen=True)
+class ObjGetAccessUrl(UnaryOp):
+ name: typing.ClassVar[str] = "obj_get_access_url"
+ mode: str # access mode, e.g. R read, W write, RW read & write
+
+ def output_type(self, *input_types):
+ return dtypes.JSON_DTYPE
+
+
 # Binary Ops
 fillna_op = create_binary_op(name="fillna", type_signature=op_typing.COERCE)
 maximum_op = create_binary_op(name="maximum", type_signature=op_typing.COERCE)

bigframes/operations/blob.py

@@ -14,9 +14,12 @@
 
 from __future__ import annotations
 
-import bigframes
+import IPython.display as ipy_display
+import requests
+
 from bigframes.operations import base
 import bigframes.operations as ops
+import bigframes.series
 
 
 class BlobAccessor(base.SeriesMethods):
@@ -26,7 +29,7 @@ def __init__(self, *args, **kwargs):
 
  super().__init__(*args, **kwargs)
 
- def metadata(self):
+ def metadata(self) -> bigframes.series.Series:
  """Retrive the metadata of the Blob.
 
  .. note::
@@ -37,7 +40,29 @@ def metadata(self):
  details_json = self._apply_unary_op(ops.obj_fetch_metadata_op).struct.field(
  "details"
  )
-
  import bigframes.bigquery as bbq
 
  return bbq.json_extract(details_json, "$.gcs_metadata")
+
+ def display(self, n: int = 3):
+ """Display the blob content in the IPython Notebook environment. Only works for image type now.
+
+ .. note::
+ BigFrames Blob is still under experiments. It may not work and subject to change in the future.
+
+ Args:
+ n (int, default 3): number of sample blob objects to display.
+ """
+ import bigframes.bigquery as bbq
+
+ s = bigframes.series.Series(self._block).head(n)
+
+ obj_ref_runtime = s._apply_unary_op(ops.ObjGetAccessUrl(mode="R"))
+ read_urls = bbq.json_extract(
+ obj_ref_runtime, json_path="$.access_urls.read_url"
+ )
+
+ for read_url in read_urls:
+ read_url = str(read_url).strip('"')
+ response = requests.get(read_url)
+ ipy_display.display(ipy_display.Image(response.content))