feat!: automatically register the BigQuery magics when bigframes is imported

bigframes/__init__.py

@@ -14,6 +14,8 @@
 
 """BigQuery DataFrames provides a DataFrame API scaled by the BigQuery engine."""
 
+import IPython
+
 from bigframes._config import option_context, options
 from bigframes._config.bigquery_options import BigQueryOptions
 from bigframes.core.global_session import close_session, get_global_session
@@ -22,6 +24,20 @@
 from bigframes.session import connect, Session
 from bigframes.version import __version__
 
+
+def load_ipython_extension(ipython):
+    """Called by IPython when this module is loaded as an IPython extension."""
+    # Import here to avoid circular imports.
+    import bigframes.magics
+
+    if ipython is not None:
+        bigframes.magics.load_ipython_extension(ipython)
+
+
+# Automatically load the extension, to make the magics easier to discover.
+load_ipython_extension(IPython.get_ipython())
+
+
 __all__ = [
     "options",
     "BigQueryOptions",

bigframes/magics.py

@@ -0,0 +1,39 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import bigquery_magics  # type: ignore
+import bigquery_magics.config  # type: ignore
+
+
+def load_ipython_extension(ipython):
+    """Called by IPython when this module is loaded as an IPython extension."""
+    bigquery_magics.load_ipython_extension(ipython)
+
+    if bigquery_magics.context.credentials is not None:
+        # The %%bigquery magics must have been run before BigQuery DataFrames
+        # was imported. In this case, we don't want to break any existing
+        # notebooks, so don't make any BigQuery DataFrames changes to the
+        # magics.
+        return
+
+    bigquery_magics.context = Context()
+
+
+class Context(bigquery_magics.config.Context):
+    """A provider for bigquery-magics configuration, derived from bigframes
+    global options and global default session.
+    """
+
+    def __init__(self):
+        pass

setup.py

@@ -34,6 +34,7 @@
 release_status = "Development Status :: 5 - Production/Stable"
 dependencies = [
     # please keep these in sync with the minimum versions in testing/constraints-3.9.txt
+    "bigquery-magics >= 0.5.0",
     "cloudpickle >= 2.0.0",
     "fsspec >=2023.3.0",
     "gcsfs >=2023.3.0",

testing/constraints-3.11.txt

@@ -0,0 +1,2 @@
+# IMPORTANT: When Python 3.10 support is dropped, update these to
+# match the minimums in setup.py.

testing/constraints-3.12.txt

@@ -0,0 +1,2 @@
+# IMPORTANT: When Python 3.11 support is dropped, update these to
+# match the minimums in setup.py.

testing/constraints-3.13.txt

@@ -0,0 +1,2 @@
+# IMPORTANT: When Python 3.12 support is dropped, update these to
+# match the minimums in setup.py.

testing/constraints-3.9.txt

@@ -1,4 +1,5 @@
 # please keep these in sync with the minimum versions in setup.py
+bigquery-magics==0.5.0
 cloudpickle==2.0.0
 fsspec==2023.3.0
 gcsfs==2023.3.0