docs: remove import bigframes.pandas as bpd boilerplate from many samples

Also, fixes several constructors that didn't take a session for
compatibility with multi-session applications.

Author: tswast

bigframes/bigquery/_operations/ai.py

@@ -52,14 +52,13 @@ def generate(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
         >>> country = bpd.Series(["Japan", "Canada"])
-        >>> bbq.ai.generate(("What's the capital city of ", country, " one word only"))
+        >>> bbq.ai.generate(("What's the capital city of ", country, " one word only"))  # doctest: +SKIP
         0    {'result': 'Tokyo\\n', 'full_response': '{"cand...
         1    {'result': 'Ottawa\\n', 'full_response': '{"can...
         dtype: struct<result: string, full_response: extension<dbjson<JSONArrowType>>, status: string>[pyarrow]
 
-        >>> bbq.ai.generate(("What's the capital city of ", country, " one word only")).struct.field("result")
+        >>> bbq.ai.generate(("What's the capital city of ", country, " one word only")).struct.field("result")  # doctest: +SKIP
         0     Tokyo\\n
         1    Ottawa\\n
         Name: result, dtype: string
@@ -125,7 +124,6 @@ def generate_bool(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
         >>> df = bpd.DataFrame({
         ...     "col_1": ["apple", "bear", "pear"],
         ...     "col_2": ["fruit", "animal", "animal"]
@@ -203,8 +201,7 @@ def generate_int(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-        >>> animal = bpd.Series(["Kangaroo", "Rabbit", "Spider"])
+                >>> animal = bpd.Series(["Kangaroo", "Rabbit", "Spider"])
         >>> bbq.ai.generate_int(("How many legs does a ", animal, " have?"))
         0    {'result': 2, 'full_response': '{"candidates":...
         1    {'result': 4, 'full_response': '{"candidates":...
@@ -278,8 +275,7 @@ def generate_double(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-        >>> animal = bpd.Series(["Kangaroo", "Rabbit", "Spider"])
+                >>> animal = bpd.Series(["Kangaroo", "Rabbit", "Spider"])
         >>> bbq.ai.generate_double(("How many legs does a ", animal, " have?"))
         0    {'result': 2.0, 'full_response': '{"candidates...
         1    {'result': 4.0, 'full_response': '{"candidates...
@@ -350,8 +346,7 @@ def if_(
     **Examples:**
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-        >>> us_state = bpd.Series(["Massachusetts", "Illinois", "Hawaii"])
+                >>> us_state = bpd.Series(["Massachusetts", "Illinois", "Hawaii"])
         >>> bbq.ai.if_((us_state, " has a city called Springfield"))
         0     True
         1     True
@@ -400,8 +395,7 @@ def classify(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-        >>> df = bpd.DataFrame({'creature': ['Cat', 'Salmon']})
+                >>> df = bpd.DataFrame({'creature': ['Cat', 'Salmon']})
         >>> df['type'] = bbq.ai.classify(df['creature'], ['Mammal', 'Fish'])
         >>> df
           creature    type
@@ -451,8 +445,7 @@ def score(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-        >>> animal = bpd.Series(["Tiger", "Rabbit", "Blue Whale"])
+                >>> animal = bpd.Series(["Tiger", "Rabbit", "Blue Whale"])
         >>> bbq.ai.score(("Rank the relative weights of ", animal, " on the scale from 1 to 3")) # doctest: +SKIP
         0    2.0
         1    1.0

bigframes/bigquery/_operations/approx_agg.py

@@ -40,7 +40,6 @@ def approx_top_count(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
         >>> s = bpd.Series(["apple", "apple", "pear", "pear", "pear", "banana"])
         >>> bbq.approx_top_count(s, number=2)
         [{'value': 'pear', 'count': 3}, {'value': 'apple', 'count': 2}]

bigframes/bigquery/_operations/array.py

@@ -40,8 +40,6 @@ def array_length(series: series.Series) -> series.Series:
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-
         >>> s = bpd.Series([[1, 2, 8, 3], [], [3, 4]])
         >>> bbq.array_length(s)
         0    4
@@ -78,8 +76,6 @@ def array_agg(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> import numpy as np
-        >>> bpd.options.display.progress_bar = None
 
     For a SeriesGroupBy object:
 
@@ -128,8 +124,6 @@ def array_to_string(series: series.Series, delimiter: str) -> series.Series:
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> import numpy as np
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series([["H", "i", "!"], ["Hello", "World"], np.nan, [], ["Hi"]])
         >>> bbq.array_to_string(s, delimiter=", ")

bigframes/bigquery/_operations/datetime.py

@@ -21,11 +21,8 @@ def unix_seconds(input: series.Series) -> series.Series:
 
     **Examples:**
 
-        >>> import pandas as pd
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-
         >>> s = bpd.Series([pd.Timestamp("1970-01-02", tz="UTC"), pd.Timestamp("1970-01-03", tz="UTC")])
         >>> bbq.unix_seconds(s)
         0     86400
@@ -48,11 +45,8 @@ def unix_millis(input: series.Series) -> series.Series:
 
     **Examples:**
 
-        >>> import pandas as pd
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
-
         >>> s = bpd.Series([pd.Timestamp("1970-01-02", tz="UTC"), pd.Timestamp("1970-01-03", tz="UTC")])
         >>> bbq.unix_millis(s)
         0     86400000
@@ -75,10 +69,8 @@ def unix_micros(input: series.Series) -> series.Series:
 
     **Examples:**
 
-        >>> import pandas as pd
-        >>> import bigframes.pandas as bpd
+                >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series([pd.Timestamp("1970-01-02", tz="UTC"), pd.Timestamp("1970-01-03", tz="UTC")])
         >>> bbq.unix_micros(s)

bigframes/bigquery/_operations/geo.py

@@ -53,8 +53,6 @@ def st_area(
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
         >>> from shapely.geometry import Polygon, LineString, Point
-        >>> bpd.options.display.progress_bar = None
-
         >>> series = bigframes.geopandas.GeoSeries(
         ...         [
         ...             Polygon([(0.0, 0.0), (0.1, 0.1), (0.0, 0.1)]),
@@ -125,8 +123,6 @@ def st_buffer(
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
         >>> from shapely.geometry import Point
-        >>> bpd.options.display.progress_bar = None
-
         >>> series = bigframes.geopandas.GeoSeries(
         ...         [
         ...             Point(0, 0),
@@ -195,8 +191,6 @@ def st_centroid(
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
         >>> from shapely.geometry import Polygon, LineString, Point
-        >>> bpd.options.display.progress_bar = None
-
         >>> series = bigframes.geopandas.GeoSeries(
         ...         [
         ...             Polygon([(0.0, 0.0), (0.1, 0.1), (0.0, 0.1)]),
@@ -250,8 +244,6 @@ def st_convexhull(
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
         >>> from shapely.geometry import Polygon, LineString, Point
-        >>> bpd.options.display.progress_bar = None
-
         >>> series = bigframes.geopandas.GeoSeries(
         ...         [
         ...             Polygon([(0.0, 0.0), (0.1, 0.1), (0.0, 0.1)]),
@@ -312,7 +304,6 @@ def st_difference(
         >>> import bigframes.bigquery as bbq
         >>> import bigframes.geopandas
         >>> from shapely.geometry import Polygon, LineString, Point
-        >>> bpd.options.display.progress_bar = None
 
     We can check two GeoSeries against each other, row by row:
 
@@ -407,7 +398,6 @@ def st_distance(
         >>> import bigframes.bigquery as bbq
         >>> import bigframes.geopandas
         >>> from shapely.geometry import Polygon, LineString, Point
-        >>> bpd.options.display.progress_bar = None
 
     We can check two GeoSeries against each other, row by row.
 
@@ -489,7 +479,6 @@ def st_intersection(
         >>> import bigframes.bigquery as bbq
         >>> import bigframes.geopandas
         >>> from shapely.geometry import Polygon, LineString, Point
-        >>> bpd.options.display.progress_bar = None
 
     We can check two GeoSeries against each other, row by row.
 
@@ -583,7 +572,6 @@ def st_isclosed(
         >>> import bigframes.bigquery as bbq
 
         >>> from shapely.geometry import Point, LineString, Polygon
-        >>> bpd.options.display.progress_bar = None
 
         >>> series = bigframes.geopandas.GeoSeries(
         ...     [
@@ -650,7 +638,6 @@ def st_length(
         >>> import bigframes.bigquery as bbq
 
         >>> from shapely.geometry import Polygon, LineString, Point, GeometryCollection
-        >>> bpd.options.display.progress_bar = None
 
         >>> series = bigframes.geopandas.GeoSeries(
         ...         [

bigframes/bigquery/_operations/json.py

@@ -49,8 +49,6 @@ def json_set(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> import numpy as np
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.read_gbq("SELECT JSON '{\\\"a\\\": 1}' AS data")["data"]
         >>> bbq.json_set(s, json_path_value_pairs=[("$.a", 100), ("$.b", "hi")])
@@ -101,7 +99,6 @@ def json_extract(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['{"class": {"students": [{"id": 5}, {"id": 12}]}}'])
         >>> bbq.json_extract(s, json_path="$.class")
@@ -141,7 +138,6 @@ def json_extract_array(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['[1, 2, 3]', '[4, 5]'])
         >>> bbq.json_extract_array(s)
@@ -204,7 +200,6 @@ def json_extract_string_array(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['[1, 2, 3]', '[4, 5]'])
         >>> bbq.json_extract_string_array(s)
@@ -272,7 +267,6 @@ def json_query(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['{"class": {"students": [{"id": 5}, {"id": 12}]}}'])
         >>> bbq.json_query(s, json_path="$.class")
@@ -303,7 +297,6 @@ def json_query_array(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['[1, 2, 3]', '[4, 5]'])
         >>> bbq.json_query_array(s)
@@ -355,7 +348,6 @@ def json_value(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['{"name": "Jakob", "age": "6"}', '{"name": "Jakob", "age": []}'])
         >>> bbq.json_value(s, json_path="$.age")
@@ -392,7 +384,6 @@ def json_value_array(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['[1, 2, 3]', '[4, 5]'])
         >>> bbq.json_value_array(s)
@@ -439,7 +430,6 @@ def to_json(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series([1, 2, 3])
         >>> bbq.to_json(s)
@@ -473,7 +463,6 @@ def to_json_string(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series([1, 2, 3])
         >>> bbq.to_json_string(s)
@@ -512,7 +501,6 @@ def parse_json(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(['{"class": {"students": [{"id": 5}, {"id": 12}]}}'])
         >>> s

bigframes/bigquery/_operations/search.py

@@ -111,7 +111,6 @@ def vector_search(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> bpd.options.display.progress_bar = None
 
     DataFrame embeddings for which to find nearest neighbors. The ``ARRAY<FLOAT64>`` column
     is used as the search query:

bigframes/bigquery/_operations/sql.py

@@ -36,9 +36,6 @@ def sql_scalar(
 
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
-        >>> import pandas as pd
-        >>> import pyarrow as pa
-        >>> bpd.options.display.progress_bar = None
 
         >>> s = bpd.Series(["1.5", "2.5", "3.5"])
         >>> s = s.astype(pd.ArrowDtype(pa.decimal128(38, 9)))

bigframes/bigquery/_operations/struct.py

@@ -39,7 +39,6 @@ def struct(value: dataframe.DataFrame) -> series.Series:
         >>> import bigframes.pandas as bpd
         >>> import bigframes.bigquery as bbq
         >>> import bigframes.series as series
-        >>> bpd.options.display.progress_bar = None
 
         >>> srs = series.Series([{"version": 1, "project": "pandas"}, {"version": 2, "project": "numpy"},])
         >>> df = srs.struct.explode()

tests/unit/conftest.py bigframes/conftest.pytests/unit/conftest.py renamed to bigframes/conftest.py

@@ -12,8 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
+import numpy as np
+import pandas as pd
+import pyarrow as pa
 import pytest
 
+import bigframes._config
+
 
 @pytest.fixture(scope="session")
 def polars_session():
@@ -22,3 +29,17 @@ def polars_session():
     from bigframes.testing import polars_session
 
     return polars_session.TestSession()
+
+
+@pytest.fixture(autouse=True)
+def default_doctest_imports(doctest_namespace, polars_session):
+    """
+    Avoid some boilerplate in pandas-inspired tests.
+
+    See: https://docs.pytest.org/en/stable/how-to/doctest.html#doctest-namespace-fixture
+    """
+    doctest_namespace["np"] = np
+    doctest_namespace["pd"] = pd
+    doctest_namespace["pa"] = pa
+    doctest_namespace["bpd"] = polars_session
+    bigframes._config.options.display.progress_bar = None