From 6e002942f475bf3ea11d2b1fc837c7a9620d9d44 Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 13:40:12 +0530 Subject: [PATCH 1/7] DOC: add GL08 for pandas.Index.view --- pandas/core/indexes/base.py | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 2bf0aca31449e..f4a66584dfad6 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1013,6 +1013,41 @@ def ravel(self, order: str_t = "C") -> Self: return self[:] def view(self, cls=None): + """ + Return a view on self. + + Parameters + ---------- + cls : data-type or ndarray sub-class, optional + Data-type descriptor of the returned view, e.g., float32 or int16. + Omitting it results in the view having the same data-type as `self`. + This argument can also be specified as an ndarray sub-class, + e.g., np.int64 or np.float32 which then specifies the type of + the returned object. + + Returns + ------- + numpy.ndarray + A new view of the same data in memory. + + See Also + -------- + numpy.ndarray.view : Returns a new view of array with the same data. + + Examples + -------- + >>> s = pd.Series([1, 2, 3], index=["1", "2", "3"]) + >>> s.index.view("object") + ['1' '2' '3'] + + >>> s = pd.Series([1, 2, 3], index=[-1, 0, 1]) + >>> s.index.view(np.int64) + [-1 0 1] + >>> s.index.view(np.float32) + [nan nan 0.e+00 0.e+00 1.e-45 0.e+00] + >>> s.index.view(np.uint64) + [18446744073709551615 0 1] + """ # we need to see if we are subclassing an # index type here if cls is not None: From f590c344008d5fdc4183b4ba2ae02f76a6ad317f Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 13:40:40 +0530 Subject: [PATCH 2/7] DOC: remove GL08 for pandas.Index.view --- ci/code_checks.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 161047197ff6f..8d9edba7fefda 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -104,7 +104,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Index.slice_indexer PR07,RT03,SA01" \ -i "pandas.Index.str PR01,SA01" \ -i "pandas.Index.take PR01,PR07" \ - -i "pandas.Index.view GL08" \ -i "pandas.Int16Dtype SA01" \ -i "pandas.Int32Dtype SA01" \ -i "pandas.Int64Dtype SA01" \ From fb51532d8258397f2c3aee1e70ad30537742d5a4 Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 14:31:09 +0530 Subject: [PATCH 3/7] DOC: fix examples in docstring --- pandas/core/indexes/base.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index f4a66584dfad6..5fed0a65942ae 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1038,15 +1038,15 @@ def view(self, cls=None): -------- >>> s = pd.Series([1, 2, 3], index=["1", "2", "3"]) >>> s.index.view("object") - ['1' '2' '3'] + array(['1', '2', '3'], dtype=object) >>> s = pd.Series([1, 2, 3], index=[-1, 0, 1]) >>> s.index.view(np.int64) - [-1 0 1] + array([-1 0 1], dtype=int64) >>> s.index.view(np.float32) - [nan nan 0.e+00 0.e+00 1.e-45 0.e+00] + array([nan nan 0.e+00 0.e+00 1.e-45 0.e+00], dtype=float32) >>> s.index.view(np.uint64) - [18446744073709551615 0 1] + array([18446744073709551615 0 1], dtype=uint64) """ # we need to see if we are subclassing an # index type here From 2f977898e903940d971de6a88d836d2a7c77b92c Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 15:12:47 +0530 Subject: [PATCH 4/7] DOC: fix examples in docstring --- pandas/core/indexes/base.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 5fed0a65942ae..413ed7fdec13c 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1042,11 +1042,11 @@ def view(self, cls=None): >>> s = pd.Series([1, 2, 3], index=[-1, 0, 1]) >>> s.index.view(np.int64) - array([-1 0 1], dtype=int64) + array([-1, 0, 1]) >>> s.index.view(np.float32) - array([nan nan 0.e+00 0.e+00 1.e-45 0.e+00], dtype=float32) + array([nan, nan, 0.e+00, 0.e+00, 1.e-45, 0.e+00]) >>> s.index.view(np.uint64) - array([18446744073709551615 0 1], dtype=uint64) + array([18446744073709551615, 0, 1]) """ # we need to see if we are subclassing an # index type here From 3ef5ef423101f309392e87d9e19d0869ac4a501f Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 15:27:21 +0530 Subject: [PATCH 5/7] DOC: fix examples in docstring --- pandas/core/indexes/base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 413ed7fdec13c..b3afb6352fe11 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1044,7 +1044,7 @@ def view(self, cls=None): >>> s.index.view(np.int64) array([-1, 0, 1]) >>> s.index.view(np.float32) - array([nan, nan, 0.e+00, 0.e+00, 1.e-45, 0.e+00]) + array([ nan, nan, 0.e+00, 0.e+00, 1.e-45, 0.e+00], dtype=float32) >>> s.index.view(np.uint64) array([18446744073709551615, 0, 1]) """ From 1893cb6eca9ed775786ec35832e17bef7abb53ef Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 15:33:43 +0530 Subject: [PATCH 6/7] DOC: fix examples in docstring --- pandas/core/indexes/base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index b3afb6352fe11..eee3a6440e134 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1046,7 +1046,7 @@ def view(self, cls=None): >>> s.index.view(np.float32) array([ nan, nan, 0.e+00, 0.e+00, 1.e-45, 0.e+00], dtype=float32) >>> s.index.view(np.uint64) - array([18446744073709551615, 0, 1]) + array([18446744073709551615, 0, 1],dtype=uint64) """ # we need to see if we are subclassing an # index type here From 03b8f56033f5887a543c00b30bd9d7b803c9ebca Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 16:13:17 +0530 Subject: [PATCH 7/7] DOC: fix examples in docstring --- pandas/core/indexes/base.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index eee3a6440e134..f10d92a2f6b11 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1046,7 +1046,8 @@ def view(self, cls=None): >>> s.index.view(np.float32) array([ nan, nan, 0.e+00, 0.e+00, 1.e-45, 0.e+00], dtype=float32) >>> s.index.view(np.uint64) - array([18446744073709551615, 0, 1],dtype=uint64) + array([18446744073709551615, 0, 1], + dtype=uint64) """ # we need to see if we are subclassing an # index type here