From 3d8270ada73ec4b552e8f782c45aa10dafa45e6e Mon Sep 17 00:00:00 2001 From: Ashley Xu Date: Fri, 15 Mar 2024 05:09:21 +0000 Subject: [PATCH 1/3] docs:add the docs for loc and iloc indexers --- docs/reference/bigframes.pandas/index.rst | 1 + docs/reference/bigframes.pandas/indexers.rst | 32 ++++++++++++++++++++ docs/templates/toc.yml | 12 ++++++-- 3 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 docs/reference/bigframes.pandas/indexers.rst diff --git a/docs/reference/bigframes.pandas/index.rst b/docs/reference/bigframes.pandas/index.rst index c7ff586884..3492f236ee 100644 --- a/docs/reference/bigframes.pandas/index.rst +++ b/docs/reference/bigframes.pandas/index.rst @@ -9,6 +9,7 @@ BigQuery DataFrames (pandas) general_functions series frame + indexers indexing window groupby diff --git a/docs/reference/bigframes.pandas/indexers.rst b/docs/reference/bigframes.pandas/indexers.rst new file mode 100644 index 0000000000..a7388bcb6b --- /dev/null +++ b/docs/reference/bigframes.pandas/indexers.rst @@ -0,0 +1,32 @@ + +========= +Indexers +========= + +ILocDataFrameIndexer +-------------------- +.. autoclass:: bigframes.core.indexers.ILocDataFrameIndexer + :members: + :inherited-members: + :undoc-members: + +IlocSeriesIndexer +----------------- +.. autoclass:: bigframes.core.indexers.IlocSeriesIndexer + :members: + :inherited-members: + :undoc-members: + +LocDataFrameIndexer +------------------- +.. autoclass:: bigframes.core.indexers.LocDataFrameIndexer + :members: + :inherited-members: + :undoc-members: + +LocSeriesIndexer +---------------- +.. autoclass:: bigframes.core.indexers.LocSeriesIndexer + :members: + :inherited-members: + :undoc-members: diff --git a/docs/templates/toc.yml b/docs/templates/toc.yml index 66973fc5a2..224b535416 100644 --- a/docs/templates/toc.yml +++ b/docs/templates/toc.yml @@ -40,8 +40,16 @@ - name: SeriesGroupBy uid: bigframes.core.groupby.SeriesGroupBy name: Groupby - - name: Indexes - uid: bigframes.core.indexes.index.Index + - items: + - name: ILocDataFrameIndexer + uid: bigframes.core.indexers.ILocDataFrameIndexer + - name: IlocSeriesIndexer + uid: bigframes.core.indexers.IlocSeriesIndexer + - name: LocDataFrameIndexer + uid: bigframes.core.indexers.LocDataFrameIndexer + - name: LocSeriesIndexer + uid: bigframes.core.indexers.LocSeriesIndexer + name: Indexers - name: pandas uid: bigframes.pandas - items: From af39c20eb3f00cd13aa392fcc9199903954ce5bf Mon Sep 17 00:00:00 2001 From: Ashley Xu Date: Fri, 15 Mar 2024 17:11:20 +0000 Subject: [PATCH 2/3] Add docstrings --- .../bigframes_vendored/pandas/core/frame.py | 15 ++++++++++++++- .../bigframes_vendored/pandas/core/series.py | 15 ++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/third_party/bigframes_vendored/pandas/core/frame.py b/third_party/bigframes_vendored/pandas/core/frame.py index 313c6663c8..4191e3edf9 100644 --- a/third_party/bigframes_vendored/pandas/core/frame.py +++ b/third_party/bigframes_vendored/pandas/core/frame.py @@ -5111,7 +5111,20 @@ def replace( @property def iloc(self): - """Purely integer-location based indexing for selection by position.""" + """Purely integer-location based indexing for selection by position. + + Returns: + ILocDataFrameIndexer: Purely integer-location Indexers. + """ + raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE) + + @property + def loc(self): + """Access a group of rows and columns by label(s) or a boolean array. + + Returns: + ILocDataFrameIndexer: Indexers object. + """ raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE) @property diff --git a/third_party/bigframes_vendored/pandas/core/series.py b/third_party/bigframes_vendored/pandas/core/series.py index beaf8aedb1..2ed5a4a4f0 100644 --- a/third_party/bigframes_vendored/pandas/core/series.py +++ b/third_party/bigframes_vendored/pandas/core/series.py @@ -3313,7 +3313,20 @@ def map( @property def iloc(self): - """Purely integer-location based indexing for selection by position.""" + """Purely integer-location based indexing for selection by position. + + Returns: + IlocSeriesIndexer: Purely integer-location Indexers. + """ + raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE) + + @property + def loc(self): + """Access a group of rows and columns by label(s) or a boolean array. + + Returns: + LocSeriesIndexer: Indexers object. + """ raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE) @property From eb58864e32d9bd8e2400321d9140e1eae895cfa6 Mon Sep 17 00:00:00 2001 From: Ashley Xu Date: Mon, 18 Mar 2024 16:57:52 +0000 Subject: [PATCH 3/3] address comments --- third_party/bigframes_vendored/pandas/core/frame.py | 4 ++-- third_party/bigframes_vendored/pandas/core/series.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/third_party/bigframes_vendored/pandas/core/frame.py b/third_party/bigframes_vendored/pandas/core/frame.py index 4191e3edf9..7793b31a21 100644 --- a/third_party/bigframes_vendored/pandas/core/frame.py +++ b/third_party/bigframes_vendored/pandas/core/frame.py @@ -5114,7 +5114,7 @@ def iloc(self): """Purely integer-location based indexing for selection by position. Returns: - ILocDataFrameIndexer: Purely integer-location Indexers. + bigframes.core.indexers.ILocDataFrameIndexer: Purely integer-location Indexers. """ raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE) @@ -5123,7 +5123,7 @@ def loc(self): """Access a group of rows and columns by label(s) or a boolean array. Returns: - ILocDataFrameIndexer: Indexers object. + bigframes.core.indexers.ILocDataFrameIndexer: Indexers object. """ raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE) diff --git a/third_party/bigframes_vendored/pandas/core/series.py b/third_party/bigframes_vendored/pandas/core/series.py index 2ed5a4a4f0..ab96e731b9 100644 --- a/third_party/bigframes_vendored/pandas/core/series.py +++ b/third_party/bigframes_vendored/pandas/core/series.py @@ -3316,7 +3316,7 @@ def iloc(self): """Purely integer-location based indexing for selection by position. Returns: - IlocSeriesIndexer: Purely integer-location Indexers. + bigframes.core.indexers.IlocSeriesIndexer: Purely integer-location Indexers. """ raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE) @@ -3325,7 +3325,7 @@ def loc(self): """Access a group of rows and columns by label(s) or a boolean array. Returns: - LocSeriesIndexer: Indexers object. + bigframes.core.indexers.LocSeriesIndexer: Indexers object. """ raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)