From 70b9a5b57a1c3a9f47e25d41c34d9e49ebfd0cf2 Mon Sep 17 00:00:00 2001 From: gboeker Date: Thu, 2 May 2024 18:05:52 -0400 Subject: [PATCH 1/7] fix line too long --- ci/code_checks.sh | 1 - pandas/core/arrays/base.py | 6 ++++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index d124cde769af7..7954506d90b18 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -375,7 +375,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Timestamp.weekday SA01" \ -i "pandas.Timestamp.weekofyear SA01" \ -i "pandas.Timestamp.year GL08" \ - -i "pandas.api.extensions.ExtensionArray SA01" \ -i "pandas.api.extensions.ExtensionArray._accumulate RT03,SA01" \ -i "pandas.api.extensions.ExtensionArray._concat_same_type PR07,SA01" \ -i "pandas.api.extensions.ExtensionArray._formatter SA01" \ diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 8a2856d0a7e64..1b80fa3d76f26 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -158,6 +158,12 @@ class ExtensionArray: _values_for_argsort _values_for_factorize + See Also + -------- + api.extensions.ExtensionDtype : A custom data type, to be paired with an + ExtensionArray. + api.extensions.ExtensionArray.dtype : An instance of ExtensionDtype. + Notes ----- The interface includes the following abstract methods that must be From 8120164b70f2a13e5872886a4f6edaa72b0eab06 Mon Sep 17 00:00:00 2001 From: gboeker Date: Thu, 2 May 2024 18:13:17 -0400 Subject: [PATCH 2/7] fix docstring errors for pandas.api.extensions.ExtensionArray._accumulate --- ci/code_checks.sh | 1 - pandas/core/arrays/base.py | 9 +++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 7954506d90b18..c6b97dce8ad16 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -375,7 +375,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Timestamp.weekday SA01" \ -i "pandas.Timestamp.weekofyear SA01" \ -i "pandas.Timestamp.year GL08" \ - -i "pandas.api.extensions.ExtensionArray._accumulate RT03,SA01" \ -i "pandas.api.extensions.ExtensionArray._concat_same_type PR07,SA01" \ -i "pandas.api.extensions.ExtensionArray._formatter SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence SA01" \ diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 1b80fa3d76f26..8a94783684450 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -1844,11 +1844,20 @@ def _accumulate( Returns ------- array + An array performing the accumulation operation. Raises ------ NotImplementedError : subclass does not define accumulations + See Also + -------- + api.extensions.ExtensionArray._concat_same_type : Concatenate multiple + array of this dtype. + api.extensions.ExtensionArray.view : Return a view on the array. + api.extensions.ExtensionArray._explode : Transform each element of + list-like to a row. + Examples -------- >>> arr = pd.array([1, 2, 3]) From bf9fa9ff4f8b841c72e6bdfa57a43f5709360e9f Mon Sep 17 00:00:00 2001 From: gboeker Date: Thu, 2 May 2024 18:20:15 -0400 Subject: [PATCH 3/7] fix SA01 error for pandas.api.extensions.ExtensionArray._concat_same_type --- ci/code_checks.sh | 2 +- pandas/core/arrays/base.py | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index c6b97dce8ad16..4186bac5c79f0 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -375,7 +375,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Timestamp.weekday SA01" \ -i "pandas.Timestamp.weekofyear SA01" \ -i "pandas.Timestamp.year GL08" \ - -i "pandas.api.extensions.ExtensionArray._concat_same_type PR07,SA01" \ + -i "pandas.api.extensions.ExtensionArray._concat_same_type PR07" \ -i "pandas.api.extensions.ExtensionArray._formatter SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence_of_strings SA01" \ diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 8a94783684450..982f67a9052b9 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -1794,6 +1794,15 @@ def _concat_same_type(cls, to_concat: Sequence[Self]) -> Self: ------- ExtensionArray + See Also + -------- + api.extensions.ExtensionArray._explode : Transform each element of + list-like to a row. + api.extensions.ExtensionArray._formatter : Formatting function for + scalar values. + api.extensions.ExtensionArray._from_factorized : Reconstruct an + ExtensionArray after factorization. + Examples -------- >>> arr1 = pd.array([1, 2, 3]) From 6401744abadb89591eed7d6a29abbaf4cb6b7973 Mon Sep 17 00:00:00 2001 From: gboeker Date: Thu, 2 May 2024 18:23:58 -0400 Subject: [PATCH 4/7] fix PR07 error for pandas.api.extensions.ExtensionArray._concat_same_type --- pandas/core/arrays/base.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 982f67a9052b9..71a03e61ab83a 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -1713,6 +1713,9 @@ def _formatter(self, boxed: bool = False) -> Callable[[Any], str | None]: when ``boxed=False`` and :func:`str` is used when ``boxed=True``. + See Also + -------- + Examples -------- >>> class MyExtensionArray(pd.arrays.NumpyExtensionArray): @@ -1789,6 +1792,7 @@ def _concat_same_type(cls, to_concat: Sequence[Self]) -> Self: Parameters ---------- to_concat : sequence of this type + An array of the same dtype to concatenate. Returns ------- From 59e2fef467ddbb406fdd9719c1e4c894fb5bb31b Mon Sep 17 00:00:00 2001 From: gboeker Date: Thu, 2 May 2024 18:27:55 -0400 Subject: [PATCH 5/7] fix docstring issues for pandas.api.extensions.ExtensionArray._formatter --- ci/code_checks.sh | 1 - pandas/core/arrays/base.py | 11 +++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 4186bac5c79f0..4a1f90b136f8f 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -375,7 +375,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Timestamp.weekday SA01" \ -i "pandas.Timestamp.weekofyear SA01" \ -i "pandas.Timestamp.year GL08" \ - -i "pandas.api.extensions.ExtensionArray._concat_same_type PR07" \ -i "pandas.api.extensions.ExtensionArray._formatter SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence_of_strings SA01" \ diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 71a03e61ab83a..1a024209dc543 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -1715,6 +1715,17 @@ def _formatter(self, boxed: bool = False) -> Callable[[Any], str | None]: See Also -------- + api.extensions.ExtensionArray._concat_same_type : Concatenate multiple + array of this dtype. + api.extensions.ExtensionArray._explode : Transform each element of + list-like to a row. + api.extensions.ExtensionArray._from_factorized : Reconstruct an + ExtensionArray after factorization. + api.extensions.ExtensionArray._from_sequence : Construct a new + ExtensionArray from a sequence of scalars. + + + Examples -------- From f4bd4262dc5f509fe1e56f8da922cbd60f9c5571 Mon Sep 17 00:00:00 2001 From: gboeker Date: Thu, 2 May 2024 18:28:30 -0400 Subject: [PATCH 6/7] delete extra lines --- ci/code_checks.sh | 1 - pandas/core/arrays/base.py | 3 --- 2 files changed, 4 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 4a1f90b136f8f..42722d602e5d4 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -375,7 +375,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Timestamp.weekday SA01" \ -i "pandas.Timestamp.weekofyear SA01" \ -i "pandas.Timestamp.year GL08" \ - -i "pandas.api.extensions.ExtensionArray._formatter SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence_of_strings SA01" \ -i "pandas.api.extensions.ExtensionArray._hash_pandas_object RT03,SA01" \ diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 1a024209dc543..f7e32350c73cc 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -1724,9 +1724,6 @@ def _formatter(self, boxed: bool = False) -> Callable[[Any], str | None]: api.extensions.ExtensionArray._from_sequence : Construct a new ExtensionArray from a sequence of scalars. - - - Examples -------- >>> class MyExtensionArray(pd.arrays.NumpyExtensionArray): From a464f4fe246e12601ab00cdd38d5e9e2405c7dbe Mon Sep 17 00:00:00 2001 From: gboeker Date: Thu, 2 May 2024 18:31:57 -0400 Subject: [PATCH 7/7] docstring errors fixed for pandas.api.extensions.ExtensionArray._from_sequence --- ci/code_checks.sh | 1 - pandas/core/arrays/base.py | 7 +++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 42722d602e5d4..66043cc3b0c93 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -375,7 +375,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Timestamp.weekday SA01" \ -i "pandas.Timestamp.weekofyear SA01" \ -i "pandas.Timestamp.year GL08" \ - -i "pandas.api.extensions.ExtensionArray._from_sequence SA01" \ -i "pandas.api.extensions.ExtensionArray._from_sequence_of_strings SA01" \ -i "pandas.api.extensions.ExtensionArray._hash_pandas_object RT03,SA01" \ -i "pandas.api.extensions.ExtensionArray._pad_or_backfill PR01,RT03,SA01" \ diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index f7e32350c73cc..e363c5380a8e7 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -295,6 +295,13 @@ def _from_sequence( ------- ExtensionArray + See Also + -------- + api.extensions.ExtensionArray._from_sequence_of_strings : Construct a new + ExtensionArray from a sequence of strings. + api.extensions.ExtensionArray._hash_pandas_object : Hook for + hash_pandas_object. + Examples -------- >>> pd.arrays.IntegerArray._from_sequence([4, 5])