Skip to content

Commit ee81ad0

Browse files
committed
Fix: Address review comments on PandasBatches and docstring
- Reinstated 'Iterator[pd.DataFrame]' inheritance for 'PandasBatches' in 'bigframes/core/blocks.py'. - Removed internal type hint 'bigframes.core.blocks.PandasBatches:' from 'to_pandas_batches' docstring in 'bigframes/dataframe.py' to avoid exposing internal types in public documentation.
1 parent df64564 commit ee81ad0

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

bigframes/core/blocks.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999

100100

101101
@dataclasses.dataclass
102-
class PandasBatches:
102+
class PandasBatches(Iterator[pd.DataFrame]):
103103
"""Interface for mutable objects with state represented by a block value object."""
104104

105105
def __init__(

bigframes/dataframe.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1929,10 +1929,9 @@ def to_pandas_batches(
19291929
over the default size limit of 10 GB.
19301930
19311931
Returns:
1932-
bigframes.core.blocks.PandasBatches:
1933-
An iterable of smaller dataframes which combine to
1934-
form the original dataframe. Results stream from bigquery,
1935-
see https://cloud.google.com/python/docs/reference/bigquery/latest/google.cloud.bigquery.table.RowIterator#google_cloud_bigquery_table_RowIterator_to_arrow_iterable
1932+
An iterable of smaller dataframes which combine to
1933+
form the original dataframe. Results stream from bigquery,
1934+
see https://cloud.google.com/python/docs/reference/bigquery/latest/google.cloud.bigquery.table.RowIterator#google_cloud_bigquery_table_RowIterator_to_arrow_iterable
19361935
"""
19371936
return self._block.to_pandas_batches(
19381937
page_size=page_size,

0 commit comments

Comments
 (0)