feat(core): export execution_history from base namespace instead of pandas

Author: shuoweil

bigframes/__init__.py

@@ -28,6 +28,7 @@
 from bigframes._config.bigquery_options import BigQueryOptions  # noqa: E402
 from bigframes.core.global_session import (  # noqa: E402
     close_session,
+    execution_history,
     get_global_session,
 )
 import bigframes.enums as enums  # noqa: E402
@@ -57,6 +58,7 @@ def load_ipython_extension(ipython):
     "BigQueryOptions",
     "get_global_session",
     "close_session",
+    "execution_history",
     "enums",
     "exceptions",
     "connect",

bigframes/core/global_session.py

@@ -26,6 +26,8 @@
 import bigframes.exceptions as bfe
 
 if TYPE_CHECKING:
+    import pandas
+
     import bigframes.session
 
 _global_session: Optional[bigframes.session.Session] = None
@@ -124,6 +126,14 @@ def with_default_session(func_: Callable[..., _T], *args, **kwargs) -> _T:
     return func_(get_global_session(), *args, **kwargs)
 
 
+def execution_history() -> "pandas.DataFrame":
+    import pandas  # noqa: F401
+
+    import bigframes.session
+
+    return with_default_session(bigframes.session.Session.execution_history)
+
+
 class _GlobalSessionContext:
     """
     Context manager for testing that sets global session.

bigframes/pandas/__init__.py

@@ -422,15 +422,6 @@ def reset_session():
 reset_session.__doc__ = global_session.close_session.__doc__
 
 
-def execution_history() -> pandas.DataFrame:
-    return global_session.with_default_session(
-        bigframes.session.Session.execution_history
-    )
-
-
-execution_history.__doc__ = inspect.getdoc(bigframes.session.Session.execution_history)
-
-
 # SQL Compilation uses recursive algorithms on deep trees
 # 10M tree depth should be sufficient to generate any sql that is under bigquery limit
 # Note: This limit does not have the desired effect on Python 3.12 in
@@ -454,7 +445,6 @@ def execution_history() -> pandas.DataFrame:
     deploy_remote_function,
     deploy_udf,
     get_default_session_id,
-    execution_history,
     get_dummies,
     merge,
     qcut,
@@ -490,7 +480,6 @@ def execution_history() -> pandas.DataFrame:
     "deploy_remote_function",
     "deploy_udf",
     "get_default_session_id",
-    "execution_history",
     "get_dummies",
     "merge",
     "qcut",

notebooks/dataframes/execution_history.ipynb

@@ -4,7 +4,7 @@
    "id": "e19aa997",
    "cell_type": "markdown",
    "source": [
-    "# Execution History Manual Test\\n\\nThis notebook demonstrates and manually tests the `bigframes.pandas.execution_history()` functionality."
+    "# Execution History Manual Test\\n\\nThis notebook demonstrates and manually tests the `bigframes.execution_history()` functionality."
    ],
    "metadata": {},
    "execution_count": null
@@ -13,12 +13,7 @@
    "id": "84d3ccf6",
    "cell_type": "code",
    "source": [
-    "import pandas as pd\n",
-    "import bigframes.pandas as bpd\n",
-    "\n",
-    "# Set options if needed, e.g. project/location\\n\n",
-    "# bpd.options.bigquery.project = \"YOUR_PROJECT\"\\n\n",
-    "# bpd.options.bigquery.location = \"US\""
+    "import pandas as pd\\nimport bigframes.pandas as bpd\\nimport bigframes\\n\\n# Set options if needed, e.g. project/location\\n# bpd.options.bigquery.project = \"YOUR_PROJECT\"\\n# bpd.options.bigquery.location = \"US\""
    ],
    "metadata": {},
    "execution_count": null
@@ -95,7 +90,7 @@
    "id": "73b3754f",
    "cell_type": "code",
    "source": [
-    "history = bpd.execution_history()\\nhistory"
+    "history = bigframes.execution_history()\\nhistory"
    ],
    "metadata": {},
    "execution_count": null

tests/unit/session/test_execution_history.py

@@ -18,7 +18,7 @@
 import google.cloud.bigquery as bigquery
 import pandas
 
-import bigframes.pandas as bpd
+import bigframes
 import bigframes.session
 import bigframes.session.metrics as metrics
 
@@ -60,7 +60,7 @@ def test_pandas_execution_history(monkeypatch):
 
     session._metrics.count_job_stats(query_job=query_job)
 
-    df = bpd.execution_history()
+    df = bigframes.execution_history()
 
     assert isinstance(df, pandas.DataFrame)
     assert len(df) == 1