guard ipython imports

Author: TrevorBergeron

bigframes/formatting_helpers.py

@@ -25,10 +25,10 @@
 import google.api_core.exceptions as api_core_exceptions
 import google.cloud.bigquery as bigquery
 import humanize
-import IPython
-import IPython.display as display
 
 if TYPE_CHECKING:
+    from IPython import display
+
     import bigframes.core.events
 
 GenericJob = Union[
@@ -160,6 +160,8 @@ def progress_callback(
         progress_bar = "notebook" if in_ipython() else "terminal"
 
     if progress_bar == "notebook":
+        import IPython.display as display
+
         if (
             isinstance(event, bigframes.core.events.ExecutionStarted)
             or current_display is None
@@ -239,6 +241,8 @@ def wait_for_job(job: GenericJob, progress_bar: Optional[str] = None):
 
     try:
         if progress_bar == "notebook":
+            import IPython.display as display
+
             display_id = str(random.random())
             loading_bar = display.HTML(get_base_job_loading_html(job))
             display.display(loading_bar, display_id=display_id)
@@ -607,4 +611,8 @@ def get_bytes_processed_string(val: Any):
 
 def in_ipython():
     """Return True iff we're in a colab-like IPython."""
+    try:
+        import IPython
+    except (ImportError, NameError):
+        return False
     return hasattr(IPython.get_ipython(), "kernel")

bigframes/operations/blob.py

@@ -18,7 +18,6 @@
 from typing import cast, Literal, Optional, Union
 import warnings
 
-import IPython.display as ipy_display
 import pandas as pd
 import requests
 
@@ -241,6 +240,8 @@ def display(
             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.display.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.display.blob_display_height, otherwise image/video's original size or ratio is used. No-op for other content types.
         """
+        import IPython.display as ipy_display
+
         width = width or bigframes.options.display.blob_display_width
         height = height or bigframes.options.display.blob_display_height
 

tests/system/small/blob/test_io.py

@@ -14,12 +14,14 @@
 
 from unittest import mock
 
-import IPython.display
 import pandas as pd
+import pytest
 
 import bigframes
 import bigframes.pandas as bpd
 
+idisplay = pytest.importorskip("IPython.display")
+
 
 def test_blob_create_from_uri_str(
     bq_connection: str, session: bigframes.Session, images_uris
@@ -99,14 +101,14 @@ def test_blob_create_read_gbq_object_table(
 
 def test_display_images(monkeypatch, images_mm_df: bpd.DataFrame):
     mock_display = mock.Mock()
-    monkeypatch.setattr(IPython.display, "display", mock_display)
+    monkeypatch.setattr(idisplay, "display", mock_display)
 
     images_mm_df["blob_col"].blob.display()
 
     for call in mock_display.call_args_list:
         args, _ = call
         arg = args[0]
-        assert isinstance(arg, IPython.display.Image)
+        assert isinstance(arg, idisplay.Image)
 
 
 def test_display_nulls(
@@ -117,7 +119,7 @@ def test_display_nulls(
     uri_series = bpd.Series([None, None, None], dtype="string", session=session)
     blob_series = uri_series.str.to_blob(connection=bq_connection)
     mock_display = mock.Mock()
-    monkeypatch.setattr(IPython.display, "display", mock_display)
+    monkeypatch.setattr(idisplay, "display", mock_display)
 
     blob_series.blob.display()