docs: add missing classes

Author: tswast

bigframes/pandas/__init__.py

@@ -28,14 +28,12 @@
 
 import bigframes._config as config
 from bigframes.core import log_adapter
-import bigframes.core.blocks
 import bigframes.core.global_session as global_session
 import bigframes.core.indexes
 from bigframes.core.reshape.api import concat, crosstab, cut, get_dummies, merge, qcut
-import bigframes.core.tools
 import bigframes.dataframe
-import bigframes.enums
 import bigframes.functions._utils as bff_utils
+from bigframes.pandas import api
 from bigframes.pandas.core.api import to_timedelta
 from bigframes.pandas.io.api import (
     _read_gbq_colab,
@@ -56,7 +54,6 @@
 import bigframes.series
 import bigframes.session
 import bigframes.session._io.bigquery
-import bigframes.session.clients
 import bigframes.version
 
 try:
@@ -410,8 +407,40 @@ def reset_session():
     from_glob_path,
 ]
 
-_function_names = [_function.__name__ for _function in _functions]
-_other_names = [
+# Use __all__ to let type checkers know what is part of the public API.
+# Note that static analysis checkers like pylance depend on these being string
+# literals, not derived at runtime.
+__all__ = [
+    # Function names
+    "clean_up_by_session_id",
+    "concat",
+    "crosstab",
+    "cut",
+    "deploy_remote_function",
+    "deploy_udf",
+    "get_default_session_id",
+    "get_dummies",
+    "merge",
+    "qcut",
+    "read_csv",
+    "read_arrow",
+    "read_gbq",
+    "_read_gbq_colab",
+    "read_gbq_function",
+    "read_gbq_model",
+    "read_gbq_object_table",
+    "read_gbq_query",
+    "read_gbq_table",
+    "read_json",
+    "read_pandas",
+    "read_parquet",
+    "read_pickle",
+    "remote_function",
+    "to_datetime",
+    "to_timedelta",
+    "from_glob_path",
+    # Other names
+    "api",
     # pandas dtype attributes
     "NA",
     "BooleanDtype",
@@ -437,9 +466,6 @@ def reset_session():
     "udf",
 ]
 
-# Use __all__ to let type checkers know what is part of the public API.
-__all__ = _function_names + _other_names
-
 _module = sys.modules[__name__]
 
 for _function in _functions:

bigframes/pandas/api/__init__.py

@@ -0,0 +1,21 @@
+# Copyright 2025 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.
+
+"""BigQuery DataFrames public pandas APIs."""
+
+from bigframes.pandas.api import typing
+
+__all__ = [
+    "typing",
+]

bigframes/pandas/api/typing.py

@@ -0,0 +1,35 @@
+# Copyright 2025 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.
+
+"""BigQuery DataFrames public pandas types that aren't exposed in bigframes.pandas.
+
+Note: These objects aren't intended to be constructed directly.
+"""
+
+from bigframes.core.groupby.dataframe_group_by import DataFrameGroupBy
+from bigframes.core.groupby.series_group_by import SeriesGroupBy
+from bigframes.core.window import Window
+from bigframes.operations.datetimes import DatetimeMethods
+from bigframes.operations.strings import StringMethods
+from bigframes.operations.structs import StructAccessor, StructFrameAccessor
+
+__all__ = [
+    "DataFrameGroupBy",
+    "DatetimeMethods",
+    "SeriesGroupBy",
+    "StringMethods",
+    "StructAccessor",
+    "StructFrameAccessor",
+    "Window",
+]

docs/reference/index.rst

@@ -15,6 +15,7 @@ packages.
     bigframes.exceptions
     bigframes.geopandas
     bigframes.pandas
+    bigframes.pandas.api.typing
     bigframes.streaming
 
 ML APIs

scripts/publish_api_coverage.py

@@ -38,13 +38,13 @@
 BIGFRAMES_OBJECT = {
     "pandas": "bigframes.pandas",
     "dataframe": "bigframes.pandas.DataFrame",
-    "dataframegroupby": "bigframes.core.groupby.DataFrameGroupBy",
-    "index": "bigframes.core.indexes.base.Index",
+    "dataframegroupby": "bigframes.pandas.api.typing.DataFrameGroupBy",
+    "index": "bigframes.pandas.Index",
     "series": "bigframes.pandas.Series",
-    "seriesgroupby": "bigframes.core.groupby.SeriesGroupBy",
-    "datetimemethods": "bigframes.operations.datetimes.DatetimeMethods",
-    "stringmethods": "bigframes.operations.strings.StringMethods",
-    "window": "bigframes.core.window.Window",
+    "seriesgroupby": "bigframes.pandas.api.typing.SeriesGroupBy",
+    "datetimemethods": "bigframes.pandas.api.typing.DatetimeMethods",
+    "stringmethods": "bigframes.pandas.api.typing.StringMethods",
+    "window": "bigframes.pandas.api.typing.Window",
 }
 
 
@@ -288,8 +288,9 @@ def build_api_coverage_table(bigframes_version: str, release_version: str):
 
 
 def format_api(api_names, is_in_bigframes, api_prefix):
-    api_name = api_names.str.slice(start=len(f"{api_prefix}."))
-    formatted = "<code>" + api_name + "</code>"
+    api_names = api_names.str.slice(start=len(f"{api_prefix}."))
+    api_names = api_names[~(api_names.str.startswith("_"))]
+    formatted = "<code>" + api_names + "</code>"
     bigframes_object = BIGFRAMES_OBJECT.get(api_prefix)
     if bigframes_object is None:
         return formatted
@@ -298,7 +299,7 @@ def format_api(api_names, is_in_bigframes, api_prefix):
         '<a href="https://dataframes.bigquery.dev/reference/api/'
         + bigframes_object
         + "."
-        + api_name
+        + api_names
         + '.html">'
         + formatted
         + "</a>"