Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

docs: Update docstrings of Session and related files #1087

Merged
tswast merged 8 commits into from
Oct 22, 2024
Merged

docs: Update docstrings of Session and related files #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
52578c3
docs: Update docstrings
arwas11 Oct 15, 2024
a96d43b
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Oct 15, 2024
e9d2cb1
Remove extra empty lines
arwas11 Oct 15, 2024
6367b94
Remove extra line
arwas11 Oct 15, 2024
386062b
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Oct 17, 2024
93bdb03
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Oct 21, 2024
a0c71ec
Fix docstrings return type description
arwas11 Oct 21, 2024
397d72a
Merge branch 'main' into b296390934-docstrings-type-annotation
arwas11 Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions bigframes/session/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,14 @@ def read_gbq_query(
[2 rows x 3 columns]

See also: :meth:`Session.read_gbq`.

Returns:
bigframes.pandas.DataFrame:
A DataFrame representing results of the query or table.

Raises:
ValueError:
When both columns (preferred) and col_order are specified.
"""
# NOTE: This method doesn't (yet) exist in pandas or pandas-gbq, so
# these docstrings are inline.
Expand Down Expand Up @@ -521,6 +529,14 @@ def read_gbq_table(
>>> df = bpd.read_gbq_table("bigquery-public-data.ml_datasets.penguins")

See also: :meth:`Session.read_gbq`.

Returns:
bigframes.pandas.DataFrame:
A DataFrame representing results of the query or table.

Raises:
ValueError:
When both columns (preferred) and col_order are specified.
"""
# NOTE: This method doesn't (yet) exist in pandas or pandas-gbq, so
# these docstrings are inline.
Expand Down Expand Up @@ -557,6 +573,10 @@ def read_gbq_table_streaming(
>>> bpd.options.display.progress_bar = None

>>> sdf = bst.read_gbq_table("bigquery-public-data.ml_datasets.penguins")

Returns:
bigframes.streaming.dataframe.StreamingDataFrame:
A StreamingDataFrame representing results of the table.
"""
warnings.warn(
"The bigframes.streaming module is a preview feature, and subject to change.",
Expand Down Expand Up @@ -654,6 +674,10 @@ def read_pandas(

Returns:
An equivalent bigframes.pandas.(DataFrame/Series/Index) object

Raises:
ValueError:
When the object is not a Pandas DataFrame.
"""
import bigframes.series as series

Expand Down
2 changes: 1 addition & 1 deletion third_party/bigframes_vendored/pandas/io/gbq.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,6 @@ def read_gbq(
or partitioned tables without primary keys.

Returns:
bigframes.dataframe.DataFrame: A DataFrame representing results of the query or table.
bigframes.pandas.DataFrame: A DataFrame representing results of the query or table.
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
2 changes: 1 addition & 1 deletion third_party/bigframes_vendored/pandas/io/parquet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ def read_parquet(
order is not preserved. Default, ``'auto'``.

Returns:
bigframes.dataframe.DataFrame: A BigQuery DataFrames.
bigframes.pandas.DataFrame: A BigQuery DataFrames.
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
15 changes: 12 additions & 3 deletions third_party/bigframes_vendored/pandas/io/parsers/readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,13 @@ def read_csv(
**kwargs:
keyword arguments for `pandas.read_csv` when not using the BigQuery engine.


Returns:
bigframes.dataframe.DataFrame: A BigQuery DataFrames.
bigframes.pandas.DataFrame: A BigQuery DataFrames.

Raises:
bigframes.exceptions.DefaultIndexWarning:
Using the default index is discouraged, such as with clustered
or partitioned tables without primary keys.
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

Expand Down Expand Up @@ -226,7 +230,12 @@ def read_json(
keyword arguments for `pandas.read_json` when not using the BigQuery engine.

Returns:
bigframes.dataframe.DataFrame:
bigframes.pandas.DataFrame:
The DataFrame representing JSON contents.

Raises:
bigframes.exceptions.DefaultIndexWarning:
Using the default index is discouraged, such as with clustered
or partitioned tables without primary keys.
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
2 changes: 1 addition & 1 deletion third_party/bigframes_vendored/pandas/io/pickle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def read_pickle(
examples on storage options refer here.

Returns:
bigframes.dataframe.DataFrame or bigframes.series.Series: same type as object
bigframes.pandas.DataFrame or bigframes.pandas.Series: same type as object
stored in file.
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)