Datasets:
Samoed
/
PRGen

Dataset card Data Studio Files
xet
 Community
1
title
stringlengths
1
185
diff
stringlengths
0
32.2M
body
stringlengths
0
123k
⌀
url
stringlengths
57
58
created_at
stringlengths
20
20
closed_at
stringlengths
20
20
merged_at
stringlengths
20
20
⌀
updated_at
stringlengths
20
20
Backport PR #54838 on branch 2.1.x (Don't expose EA.pad_or_backfill to users + switch to DeprecationWarning)
diff --git a/doc/source/reference/extensions.rst b/doc/source/reference/extensions.rst index eb2529716b55e..e177e2b1d87d5 100644 --- a/doc/source/reference/extensions.rst +++ b/doc/source/reference/extensions.rst @@ -39,6 +39,7 @@ objects. api.extensions.ExtensionArray._from_sequence api.extensions.ExtensionArray._from_sequence_of_strings api.extensions.ExtensionArray._hash_pandas_object + api.extensions.ExtensionArray._pad_or_backfill api.extensions.ExtensionArray._reduce api.extensions.ExtensionArray._values_for_argsort api.extensions.ExtensionArray._values_for_factorize @@ -54,7 +55,6 @@ objects. api.extensions.ExtensionArray.interpolate api.extensions.ExtensionArray.isin api.extensions.ExtensionArray.isna - api.extensions.ExtensionArray.pad_or_backfill api.extensions.ExtensionArray.ravel api.extensions.ExtensionArray.repeat api.extensions.ExtensionArray.searchsorted diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 7aea1fa99f655..cec61915f342e 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -583,7 +583,7 @@ Other Deprecations - Deprecated positional indexing on :class:`Series` with :meth:`Series.__getitem__` and :meth:`Series.__setitem__`, in a future version ``ser[item]`` will *always* interpret ``item`` as a label, not a position (:issue:`50617`) - Deprecated replacing builtin and NumPy functions in ``.agg``, ``.apply``, and ``.transform``; use the corresponding string alias (e.g. ``"sum"`` for ``sum`` or ``np.sum``) instead (:issue:`53425`) - Deprecated strings ``T``, ``t``, ``L`` and ``l`` denoting units in :func:`to_timedelta` (:issue:`52536`) -- Deprecated the "method" and "limit" keywords in ``.ExtensionArray.fillna``, implement and use ``pad_or_backfill`` instead (:issue:`53621`) +- Deprecated the "method" and "limit" keywords in ``.ExtensionArray.fillna``, implement ``_pad_or_backfill`` instead (:issue:`53621`) - Deprecated the ``method`` and ``limit`` keywords in :meth:`DataFrame.replace` and :meth:`Series.replace` (:issue:`33302`) - Deprecated the ``method`` and ``limit`` keywords on :meth:`Series.fillna`, :meth:`DataFrame.fillna`, :meth:`.SeriesGroupBy.fillna`, :meth:`.DataFrameGroupBy.fillna`, and :meth:`.Resampler.fillna`, use ``obj.bfill()`` or ``obj.ffill()`` instead (:issue:`53394`) - Deprecated the behavior of :meth:`Series.__getitem__`, :meth:`Series.__setitem__`, :meth:`DataFrame.__getitem__`, :meth:`DataFrame.__setitem__` with an integer slice on objects with a floating-dtype index, in a future version this will be treated as *positional* indexing (:issue:`49612`) diff --git a/pandas/core/arrays/_mixins.py b/pandas/core/arrays/_mixins.py index 359e0161e763c..6d21f4a1ac8a2 100644 --- a/pandas/core/arrays/_mixins.py +++ b/pandas/core/arrays/_mixins.py @@ -296,13 +296,8 @@ def _fill_mask_inplace( func = missing.get_fill_func(method, ndim=self.ndim) func(self._ndarray.T, limit=limit, mask=mask.T) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: mask = self.isna() if mask.any(): diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index 70c59e94f6d27..19443e2069270 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -924,19 +924,14 @@ def dropna(self) -> Self: """ return type(self)(pc.drop_null(self._pa_array)) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: if not self._hasna: # TODO(CoW): Not necessary anymore when CoW is the default return self.copy() - if limit is not None and limit_area is not None: + if limit is None: method = missing.clean_fill_method(method) try: if method == "pad": @@ -952,9 +947,7 @@ def pad_or_backfill( # TODO(3.0): after EA.fillna 'method' deprecation is enforced, we can remove # this method entirely. - return super().pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + return super()._pad_or_backfill(method=method, limit=limit, copy=copy) @doc(ExtensionArray.fillna) def fillna( @@ -974,7 +967,7 @@ def fillna( return super().fillna(value=value, method=method, limit=limit, copy=copy) if method is not None: - return super().pad_or_backfill(method=method, limit=limit, copy=copy) + return super().fillna(method=method, limit=limit, copy=copy) if isinstance(value, (np.ndarray, ExtensionArray)): # Similar to check_value_size, but we do not mask here since we may diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 7babce46a3977..a21253db59323 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -132,7 +132,6 @@ class ExtensionArray: interpolate isin isna - pad_or_backfill ravel repeat searchsorted @@ -148,6 +147,7 @@ class ExtensionArray: _from_sequence _from_sequence_of_strings _hash_pandas_object + _pad_or_backfill _reduce _values_for_argsort _values_for_factorize @@ -183,7 +183,7 @@ class ExtensionArray: methods: * fillna - * pad_or_backfill + * _pad_or_backfill * dropna * unique * factorize / _values_for_factorize @@ -917,13 +917,8 @@ def interpolate( f"{type(self).__name__} does not implement interpolate" ) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: """ Pad or backfill values, used by Series/DataFrame ffill and bfill. @@ -959,26 +954,26 @@ def pad_or_backfill( Examples -------- >>> arr = pd.array([np.nan, np.nan, 2, 3, np.nan, np.nan]) - >>> arr.pad_or_backfill(method="backfill", limit=1) + >>> arr._pad_or_backfill(method="backfill", limit=1) <IntegerArray> [<NA>, 2, 2, 3, <NA>, <NA>] Length: 6, dtype: Int64 """ # If a 3rd-party EA has implemented this functionality in fillna, - # we warn that they need to implement pad_or_backfill instead. + # we warn that they need to implement _pad_or_backfill instead. if ( type(self).fillna is not ExtensionArray.fillna - and type(self).pad_or_backfill is ExtensionArray.pad_or_backfill + and type(self)._pad_or_backfill is ExtensionArray._pad_or_backfill ): - # Check for pad_or_backfill here allows us to call - # super().pad_or_backfill without getting this warning + # Check for _pad_or_backfill here allows us to call + # super()._pad_or_backfill without getting this warning warnings.warn( "ExtensionArray.fillna 'method' keyword is deprecated. " - "In a future version. arr.pad_or_backfill will be called " + "In a future version. arr._pad_or_backfill will be called " "instead. 3rd-party ExtensionArray authors need to implement " - "pad_or_backfill.", - FutureWarning, + "_pad_or_backfill.", + DeprecationWarning, stacklevel=find_stack_level(), ) return self.fillna(method=method, limit=limit) @@ -1062,8 +1057,7 @@ def fillna( if method is not None: warnings.warn( f"The 'method' keyword in {type(self).__name__}.fillna is " - "deprecated and will be removed in a future version. " - "Use pad_or_backfill instead.", + "deprecated and will be removed in a future version.", FutureWarning, stacklevel=find_stack_level(), ) diff --git a/pandas/core/arrays/interval.py b/pandas/core/arrays/interval.py index 2fce6631afa9b..d0510ede5a366 100644 --- a/pandas/core/arrays/interval.py +++ b/pandas/core/arrays/interval.py @@ -890,19 +890,12 @@ def max(self, *, axis: AxisInt | None = None, skipna: bool = True) -> IntervalOr indexer = obj.argsort()[-1] return obj[indexer] - def pad_or_backfill( # pylint: disable=useless-parent-delegation - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( # pylint: disable=useless-parent-delegation + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: # TODO(3.0): after EA.fillna 'method' deprecation is enforced, we can remove # this method entirely. - return super().pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + return super()._pad_or_backfill(method=method, limit=limit, copy=copy) def fillna( self, value=None, method=None, limit: int | None = None, copy: bool = True diff --git a/pandas/core/arrays/masked.py b/pandas/core/arrays/masked.py index bec875f2bbfa1..2cf28c28427ab 100644 --- a/pandas/core/arrays/masked.py +++ b/pandas/core/arrays/masked.py @@ -190,13 +190,8 @@ def __getitem__(self, item: PositionalIndexer) -> Self | Any: return self._simple_new(self._data[item], newmask) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: mask = self._mask diff --git a/pandas/core/arrays/numpy_.py b/pandas/core/arrays/numpy_.py index 99a3586871d10..efe0c0df45e00 100644 --- a/pandas/core/arrays/numpy_.py +++ b/pandas/core/arrays/numpy_.py @@ -240,7 +240,10 @@ def _values_for_factorize(self) -> tuple[np.ndarray, float | None]: fv = np.nan return self._ndarray, fv - def pad_or_backfill( + # Base EA class (and all other EA classes) don't have limit_area keyword + # This can be removed here as well when the interpolate ffill/bfill method + # deprecation is enforced + def _pad_or_backfill( self, *, method: FillnaOptions, diff --git a/pandas/core/arrays/period.py b/pandas/core/arrays/period.py index 024cd6d4aad14..a2e4b595c42aa 100644 --- a/pandas/core/arrays/period.py +++ b/pandas/core/arrays/period.py @@ -791,20 +791,13 @@ def searchsorted( m8arr = self._ndarray.view("M8[ns]") return m8arr.searchsorted(npvalue, side=side, sorter=sorter) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: # view as dt64 so we get treated as timelike in core.missing, # similar to dtl._period_dispatch dta = self.view("M8[ns]") - result = dta.pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + result = dta._pad_or_backfill(method=method, limit=limit, copy=copy) if copy: return cast("Self", result.view(self.dtype)) else: diff --git a/pandas/core/arrays/sparse/array.py b/pandas/core/arrays/sparse/array.py index d32c98535d7cb..e38fa0a3bdae5 100644 --- a/pandas/core/arrays/sparse/array.py +++ b/pandas/core/arrays/sparse/array.py @@ -712,19 +712,12 @@ def isna(self): mask[self.sp_index.indices] = isna(self.sp_values) return type(self)(mask, fill_value=False, dtype=dtype) - def pad_or_backfill( # pylint: disable=useless-parent-delegation - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( # pylint: disable=useless-parent-delegation + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: # TODO(3.0): We can remove this method once deprecation for fillna method # keyword is enforced. - return super().pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + return super()._pad_or_backfill(method=method, limit=limit, copy=copy) def fillna( self, diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index a33c5d9303421..c0b78e734b4b4 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -1452,7 +1452,7 @@ def pad_or_backfill( vals = cast(NumpyExtensionArray, self.array_values) if axis == 1: vals = vals.T - new_values = vals.pad_or_backfill( + new_values = vals._pad_or_backfill( method=method, limit=limit, limit_area=limit_area, @@ -1955,9 +1955,9 @@ def pad_or_backfill( if values.ndim == 2 and axis == 1: # NDArrayBackedExtensionArray.fillna assumes axis=0 - new_values = values.T.pad_or_backfill(method=method, limit=limit).T + new_values = values.T._pad_or_backfill(method=method, limit=limit).T else: - new_values = values.pad_or_backfill(method=method, limit=limit) + new_values = values._pad_or_backfill(method=method, limit=limit) return [self.make_block_same_class(new_values)] diff --git a/pandas/tests/arrays/test_datetimelike.py b/pandas/tests/arrays/test_datetimelike.py index 20530e37116f2..96aab94b24ddd 100644 --- a/pandas/tests/arrays/test_datetimelike.py +++ b/pandas/tests/arrays/test_datetimelike.py @@ -258,7 +258,7 @@ def test_fillna_method_doesnt_change_orig(self, method): fill_value = arr[3] if method == "pad" else arr[5] - result = arr.pad_or_backfill(method=method) + result = arr._pad_or_backfill(method=method) assert result[4] == fill_value # check that the original was not changed diff --git a/pandas/tests/arrays/test_datetimes.py b/pandas/tests/arrays/test_datetimes.py index 8e38a8c741b8d..c2d68a79f32d4 100644 --- a/pandas/tests/arrays/test_datetimes.py +++ b/pandas/tests/arrays/test_datetimes.py @@ -497,7 +497,7 @@ def test_fillna_preserves_tz(self, method): dtype=DatetimeTZDtype(tz="US/Central"), ) - result = arr.pad_or_backfill(method=method) + result = arr._pad_or_backfill(method=method) tm.assert_extension_array_equal(result, expected) # assert that arr and dti were not modified in-place @@ -510,12 +510,12 @@ def test_fillna_2d(self): dta[0, 1] = pd.NaT dta[1, 0] = pd.NaT - res1 = dta.pad_or_backfill(method="pad") + res1 = dta._pad_or_backfill(method="pad") expected1 = dta.copy() expected1[1, 0] = dta[0, 0] tm.assert_extension_array_equal(res1, expected1) - res2 = dta.pad_or_backfill(method="backfill") + res2 = dta._pad_or_backfill(method="backfill") expected2 = dta.copy() expected2 = dta.copy() expected2[1, 0] = dta[2, 0] @@ -529,10 +529,10 @@ def test_fillna_2d(self): assert not dta2._ndarray.flags["C_CONTIGUOUS"] tm.assert_extension_array_equal(dta, dta2) - res3 = dta2.pad_or_backfill(method="pad") + res3 = dta2._pad_or_backfill(method="pad") tm.assert_extension_array_equal(res3, expected1) - res4 = dta2.pad_or_backfill(method="backfill") + res4 = dta2._pad_or_backfill(method="backfill") tm.assert_extension_array_equal(res4, expected2) # test the DataFrame method while we're here diff --git a/pandas/tests/extension/base/dim2.py b/pandas/tests/extension/base/dim2.py index a0c24ee068e81..f1d787041d10b 100644 --- a/pandas/tests/extension/base/dim2.py +++ b/pandas/tests/extension/base/dim2.py @@ -160,9 +160,9 @@ def test_fillna_2d_method(self, data_missing, method): assert arr[0].isna().all() assert not arr[1].isna().any() - result = arr.pad_or_backfill(method=method, limit=None) + result = arr._pad_or_backfill(method=method, limit=None) - expected = data_missing.pad_or_backfill(method=method).repeat(2).reshape(2, 2) + expected = data_missing._pad_or_backfill(method=method).repeat(2).reshape(2, 2) tm.assert_extension_array_equal(result, expected) # Reverse so that backfill is not a no-op. @@ -170,10 +170,10 @@ def test_fillna_2d_method(self, data_missing, method): assert not arr2[0].isna().any() assert arr2[1].isna().all() - result2 = arr2.pad_or_backfill(method=method, limit=None) + result2 = arr2._pad_or_backfill(method=method, limit=None) expected2 = ( - data_missing[::-1].pad_or_backfill(method=method).repeat(2).reshape(2, 2) + data_missing[::-1]._pad_or_backfill(method=method).repeat(2).reshape(2, 2) ) tm.assert_extension_array_equal(result2, expected2) diff --git a/pandas/tests/extension/base/missing.py b/pandas/tests/extension/base/missing.py index 2a0bd0770dc07..40cc952d44200 100644 --- a/pandas/tests/extension/base/missing.py +++ b/pandas/tests/extension/base/missing.py @@ -94,7 +94,7 @@ def test_fillna_no_op_returns_copy(self, data): assert result is not data tm.assert_extension_array_equal(result, data) - result = data.pad_or_backfill(method="backfill") + result = data._pad_or_backfill(method="backfill") assert result is not data tm.assert_extension_array_equal(result, data) diff --git a/pandas/tests/extension/decimal/array.py b/pandas/tests/extension/decimal/array.py index d2c3cb395ed44..9ce7ac309b6d3 100644 --- a/pandas/tests/extension/decimal/array.py +++ b/pandas/tests/extension/decimal/array.py @@ -285,7 +285,7 @@ def value_counts(self, dropna: bool = True): return value_counts(self.to_numpy(), dropna=dropna) # We override fillna here to simulate a 3rd party EA that has done so. This - # lets us test the deprecation telling authors to implement pad_or_backfill + # lets us test the deprecation telling authors to implement _pad_or_backfill # Simulate a 3rd-party EA that has not yet updated to include a "copy" # keyword in its fillna method. # error: Signature of "fillna" incompatible with supertype "ExtensionArray" diff --git a/pandas/tests/extension/decimal/test_decimal.py b/pandas/tests/extension/decimal/test_decimal.py index 17dfc4e801ca0..e61a2894b9aa7 100644 --- a/pandas/tests/extension/decimal/test_decimal.py +++ b/pandas/tests/extension/decimal/test_decimal.py @@ -140,26 +140,59 @@ def test_fillna_frame(self, data_missing): def test_fillna_limit_pad(self, data_missing): msg = "ExtensionArray.fillna 'method' keyword is deprecated" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, + ): + super().test_fillna_limit_pad(data_missing) + + msg = "The 'method' keyword in DecimalArray.fillna is deprecated" + with tm.assert_produces_warning( + FutureWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, ): super().test_fillna_limit_pad(data_missing) def test_fillna_limit_backfill(self, data_missing): - msg = "|".join( - [ - "ExtensionArray.fillna added a 'copy' keyword", - "Series.fillna with 'method' is deprecated", - ] - ) + msg = "Series.fillna with 'method' is deprecated" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + FutureWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, ): super().test_fillna_limit_backfill(data_missing) - def test_fillna_no_op_returns_copy(self, data): msg = "ExtensionArray.fillna 'method' keyword is deprecated" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, + ): + super().test_fillna_limit_backfill(data_missing) + + msg = "The 'method' keyword in DecimalArray.fillna is deprecated" + with tm.assert_produces_warning( + FutureWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, + ): + super().test_fillna_limit_backfill(data_missing) + + def test_fillna_no_op_returns_copy(self, data): + msg = "|".join( + [ + "ExtensionArray.fillna 'method' keyword is deprecated", + "The 'method' keyword in DecimalArray.fillna is deprecated", + ] + ) + with tm.assert_produces_warning( + (FutureWarning, DeprecationWarning), match=msg, check_stacklevel=False ): super().test_fillna_no_op_returns_copy(data) @@ -171,9 +204,14 @@ def test_fillna_series(self, data_missing): super().test_fillna_series(data_missing) def test_fillna_series_method(self, data_missing, fillna_method): - msg = "ExtensionArray.fillna 'method' keyword is deprecated" + msg = "|".join( + [ + "ExtensionArray.fillna 'method' keyword is deprecated", + "The 'method' keyword in DecimalArray.fillna is deprecated", + ] + ) with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + (FutureWarning, DeprecationWarning), match=msg, check_stacklevel=False ): super().test_fillna_series_method(data_missing, fillna_method)
Backport PR #54838: Don't expose EA.pad_or_backfill to users + switch to DeprecationWarning
https://api.github.com/repos/pandas-dev/pandas/pulls/54851
2023-08-29T15:52:31Z
2023-08-29T17:54:12Z
2023-08-29T17:54:12Z
2023-08-29T17:54:12Z
DOC: Add date for v2.1.0
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 7aea1fa99f655..9ecdcc1bfe597 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -1,6 +1,6 @@ .. _whatsnew_210: -What's new in 2.1.0 (Aug 11, 2023) +What's new in 2.1.0 (Aug 30, 2023) -------------------------------------- These are the changes in pandas 2.1.0. See :ref:`release` for a full changelog @@ -890,3 +890,5 @@ Other Contributors ~~~~~~~~~~~~ + +.. contributors:: v2.0.3..v2.1.0|HEAD
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54850
2023-08-29T15:20:49Z
2023-08-29T20:30:10Z
2023-08-29T20:30:10Z
2023-08-29T20:39:44Z
Backport PR #54818 on branch 2.1.x (DEP: Deprecate passing fill_value and freq to shift)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 7aea1fa99f655..ebb31733fe370 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -591,6 +591,7 @@ Other Deprecations - Deprecated values ``"pad"``, ``"ffill"``, ``"bfill"``, ``"backfill"`` for :meth:`Series.interpolate` and :meth:`DataFrame.interpolate`, use ``obj.ffill()`` or ``obj.bfill()`` instead (:issue:`53581`) - Deprecated the behavior of :meth:`Index.argmax`, :meth:`Index.argmin`, :meth:`Series.argmax`, :meth:`Series.argmin` with either all-NAs and ``skipna=True`` or any-NAs and ``skipna=False`` returning -1; in a future version this will raise ``ValueError`` (:issue:`33941`, :issue:`33942`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_sql` except ``name`` and ``con`` (:issue:`54229`) +- Deprecated silently ignoring ``fill_value`` when passing both ``freq`` and ``fill_value`` to :meth:`DataFrame.shift`, :meth:`Series.shift` and :meth:`.DataFrameGroupBy.shift`; in a future version this will raise ``ValueError`` (:issue:`53832`) .. --------------------------------------------------------------------------- .. _whatsnew_210.performance: @@ -875,7 +876,6 @@ Other - Bug in :meth:`.DataFrameGroupBy.first`, :meth:`.DataFrameGroupBy.last`, :meth:`.SeriesGroupBy.first`, and :meth:`.SeriesGroupBy.last` where an empty group would return ``np.nan`` instead of the corresponding :class:`.ExtensionArray` NA value (:issue:`39098`) - Bug in :meth:`DataFrame.pivot_table` with casting the mean of ints back to an int (:issue:`16676`) - Bug in :meth:`DataFrame.reindex` with a ``fill_value`` that should be inferred with a :class:`ExtensionDtype` incorrectly inferring ``object`` dtype (:issue:`52586`) -- Bug in :meth:`DataFrame.shift` and :meth:`Series.shift` and :meth:`.DataFrameGroupBy.shift` when passing both ``freq`` and ``fill_value`` silently ignoring ``fill_value`` instead of raising ``ValueError`` (:issue:`53832`) - Bug in :meth:`DataFrame.shift` with ``axis=1`` on a :class:`DataFrame` with a single :class:`ExtensionDtype` column giving incorrect results (:issue:`53832`) - Bug in :meth:`Index.sort_values` when a ``key`` is passed (:issue:`52764`) - Bug in :meth:`Series.align`, :meth:`DataFrame.align`, :meth:`Series.reindex`, :meth:`DataFrame.reindex`, :meth:`Series.interpolate`, :meth:`DataFrame.interpolate`, incorrectly failing to raise with method="asfreq" (:issue:`53620`) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index cdd0545f0a3ec..471db115da8df 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -5617,10 +5617,14 @@ def shift( ) -> DataFrame: if freq is not None and fill_value is not lib.no_default: # GH#53832 - raise ValueError( - "Cannot pass both 'freq' and 'fill_value' to " - f"{type(self).__name__}.shift" + warnings.warn( + "Passing a 'freq' together with a 'fill_value' silently ignores " + "the fill_value and is deprecated. This will raise in a future " + "version.", + FutureWarning, + stacklevel=find_stack_level(), ) + fill_value = lib.no_default axis = self._get_axis_number(axis) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index fce9b35aa5c49..f6bf51f65049a 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -10802,10 +10802,14 @@ def shift( if freq is not None and fill_value is not lib.no_default: # GH#53832 - raise ValueError( - "Cannot pass both 'freq' and 'fill_value' to " - f"{type(self).__name__}.shift" + warnings.warn( + "Passing a 'freq' together with a 'fill_value' silently ignores " + "the fill_value and is deprecated. This will raise in a future " + "version.", + FutureWarning, + stacklevel=find_stack_level(), ) + fill_value = lib.no_default if periods == 0: return self.copy(deep=None) diff --git a/pandas/tests/frame/methods/test_shift.py b/pandas/tests/frame/methods/test_shift.py index 808f0cff2485c..1e88152137b1f 100644 --- a/pandas/tests/frame/methods/test_shift.py +++ b/pandas/tests/frame/methods/test_shift.py @@ -32,19 +32,23 @@ def test_shift_axis1_with_valid_fill_value_one_array(self): expected2 = DataFrame([12345] * 5, dtype="Float64") tm.assert_frame_equal(res2, expected2) - def test_shift_disallow_freq_and_fill_value(self, frame_or_series): + def test_shift_deprecate_freq_and_fill_value(self, frame_or_series): # Can't pass both! obj = frame_or_series( np.random.default_rng(2).standard_normal(5), index=date_range("1/1/2000", periods=5, freq="H"), ) - msg = "Cannot pass both 'freq' and 'fill_value' to (Series|DataFrame).shift" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the " + "fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): obj.shift(1, fill_value=1, freq="H") if frame_or_series is DataFrame: - with pytest.raises(ValueError, match=msg): + obj.columns = date_range("1/1/2000", periods=1, freq="H") + with tm.assert_produces_warning(FutureWarning, match=msg): obj.shift(1, axis=1, fill_value=1, freq="H") @pytest.mark.parametrize( @@ -716,8 +720,11 @@ def test_shift_with_iterable_freq_and_fill_value(self): df.shift(1, freq="H"), ) - msg = r"Cannot pass both 'freq' and 'fill_value' to.*" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the " + "fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): df.shift([1, 2], fill_value=1, freq="H") def test_shift_with_iterable_check_other_arguments(self): diff --git a/pandas/tests/groupby/test_groupby_shift_diff.py b/pandas/tests/groupby/test_groupby_shift_diff.py index 495f3fcd359c7..bb4b9aa866ac9 100644 --- a/pandas/tests/groupby/test_groupby_shift_diff.py +++ b/pandas/tests/groupby/test_groupby_shift_diff.py @@ -166,12 +166,14 @@ def test_shift_periods_freq(): tm.assert_frame_equal(result, expected) -def test_shift_disallow_freq_and_fill_value(): +def test_shift_deprecate_freq_and_fill_value(): # GH 53832 data = {"a": [1, 2, 3, 4, 5, 6], "b": [0, 0, 0, 1, 1, 1]} df = DataFrame(data, index=date_range(start="20100101", periods=6)) - msg = "Cannot pass both 'freq' and 'fill_value' to (Series|DataFrame).shift" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): df.groupby(df.index).shift(periods=-2, freq="D", fill_value="1") @@ -238,12 +240,15 @@ def test_group_shift_with_multiple_periods_and_fill_value(): tm.assert_frame_equal(shifted_df, expected_df) -def test_group_shift_with_multiple_periods_and_both_fill_and_freq_fails(): +def test_group_shift_with_multiple_periods_and_both_fill_and_freq_deprecated(): # GH#44424 df = DataFrame( {"a": [1, 2, 3, 4, 5], "b": [True, True, False, False, True]}, index=date_range("1/1/2000", periods=5, freq="H"), ) - msg = r"Cannot pass both 'freq' and 'fill_value' to.*" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the " + "fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): df.groupby("b")[["a"]].shift([1, 2], fill_value=1, freq="H")
Backport PR #54818: DEP: Deprecate passing fill_value and freq to shift
https://api.github.com/repos/pandas-dev/pandas/pulls/54849
2023-08-29T14:44:11Z
2023-08-29T17:49:53Z
2023-08-29T17:49:53Z
2023-08-29T17:49:53Z
DEPR: remove use of `nan_as_null` from callers of `__dataframe__`
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 3a4e8fdd91362..3424b990a746c 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -893,8 +893,8 @@ def __dataframe__( Parameters ---------- nan_as_null : bool, default False - Whether to tell the DataFrame to overwrite null values in the data - with ``NaN`` (or ``NaT``). + `nan_as_null` is DEPRECATED and has no effect. Please avoid using + it; it will be removed in a future release. allow_copy : bool, default True Whether to allow memory copying when exporting. If set to False it would cause non-zero-copy exports to fail. @@ -909,9 +909,6 @@ def __dataframe__( Details on the interchange protocol: https://data-apis.org/dataframe-protocol/latest/index.html - `nan_as_null` currently has no effect; once support for nullable extension - dtypes is added, this value should be propagated to columns. - Examples -------- >>> df_not_necessarily_pandas = pd.DataFrame({'A': [1, 2], 'B': [3, 4]}) @@ -931,7 +928,7 @@ def __dataframe__( from pandas.core.interchange.dataframe import PandasDataFrameXchg - return PandasDataFrameXchg(self, nan_as_null, allow_copy) + return PandasDataFrameXchg(self, allow_copy=allow_copy) def __dataframe_consortium_standard__( self, *, api_version: str | None = None diff --git a/pandas/core/interchange/dataframe.py b/pandas/core/interchange/dataframe.py index 0ddceb6b8139b..3413f7281de78 100644 --- a/pandas/core/interchange/dataframe.py +++ b/pandas/core/interchange/dataframe.py @@ -27,25 +27,20 @@ class PandasDataFrameXchg(DataFrameXchg): attributes defined on this class. """ - def __init__( - self, df: DataFrame, nan_as_null: bool = False, allow_copy: bool = True - ) -> None: + def __init__(self, df: DataFrame, allow_copy: bool = True) -> None: """ Constructor - an instance of this (private) class is returned from `pd.DataFrame.__dataframe__`. """ self._df = df - # ``nan_as_null`` is a keyword intended for the consumer to tell the - # producer to overwrite null values in the data with ``NaN`` (or ``NaT``). - # This currently has no effect; once support for nullable extension - # dtypes is added, this value should be propagated to columns. - self._nan_as_null = nan_as_null self._allow_copy = allow_copy def __dataframe__( self, nan_as_null: bool = False, allow_copy: bool = True ) -> PandasDataFrameXchg: - return PandasDataFrameXchg(self._df, nan_as_null, allow_copy) + # `nan_as_null` can be removed here once it's removed from + # Dataframe.__dataframe__ + return PandasDataFrameXchg(self._df, allow_copy) @property def metadata(self) -> dict[str, Index]: @@ -84,7 +79,7 @@ def select_columns(self, indices: Sequence[int]) -> PandasDataFrameXchg: indices = list(indices) return PandasDataFrameXchg( - self._df.iloc[:, indices], self._nan_as_null, self._allow_copy + self._df.iloc[:, indices], allow_copy=self._allow_copy ) def select_columns_by_name(self, names: list[str]) -> PandasDataFrameXchg: # type: ignore[override] # noqa: E501 @@ -93,9 +88,7 @@ def select_columns_by_name(self, names: list[str]) -> PandasDataFrameXchg: # ty if not isinstance(names, list): names = list(names) - return PandasDataFrameXchg( - self._df.loc[:, names], self._nan_as_null, self._allow_copy - ) + return PandasDataFrameXchg(self._df.loc[:, names], allow_copy=self._allow_copy) def get_chunks(self, n_chunks: int | None = None) -> Iterable[PandasDataFrameXchg]: """ @@ -109,8 +102,7 @@ def get_chunks(self, n_chunks: int | None = None) -> Iterable[PandasDataFrameXch for start in range(0, step * n_chunks, step): yield PandasDataFrameXchg( self._df.iloc[start : start + step, :], - self._nan_as_null, - self._allow_copy, + allow_copy=self._allow_copy, ) else: yield self
No one was using it yet and it seemed easier to clean it up from libraries than to ask everyone to add support for it - see https://github.com/data-apis/dataframe-api/issues/125.
https://api.github.com/repos/pandas-dev/pandas/pulls/54846
2023-08-29T12:53:10Z
2023-11-17T17:02:57Z
2023-11-17T17:02:57Z
2023-11-17T17:02:57Z
ENH: Bring `devcontainer` closer to GitHub CI environment, improve `vscode` setup
diff --git a/.devcontainer.json b/.devcontainer.json deleted file mode 100644 index 7c5d009260c64..0000000000000 --- a/.devcontainer.json +++ /dev/null @@ -1,29 +0,0 @@ -// For format details, see https://aka.ms/vscode-remote/devcontainer.json or the definition README at -// https://github.com/microsoft/vscode-dev-containers/tree/master/containers/python-3-miniconda -{ - "name": "pandas", - "context": ".", - "dockerFile": "Dockerfile", - - // Use 'settings' to set *default* container specific settings.json values on container create. - // You can edit these settings after create using File > Preferences > Settings > Remote. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash", - "python.pythonPath": "/usr/local/bin/python", - "python.formatting.provider": "black", - "python.linting.enabled": true, - "python.linting.flake8Enabled": true, - "python.linting.pylintEnabled": false, - "python.linting.mypyEnabled": true, - "python.testing.pytestEnabled": true, - "python.testing.pytestArgs": [ - "pandas" - ] - }, - - // Add the IDs of extensions you want installed when the container is created in the array below. - "extensions": [ - "ms-python.python", - "ms-vscode.cpptools" - ] -} diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000000000..f0a249cf396fd --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,64 @@ +// For format details, see https://aka.ms/vscode-remote/devcontainer.json or the definition README at +// https://github.com/microsoft/vscode-dev-containers/tree/master/containers/python-3-miniconda +{ + "name": "pandas", + "containerUser": "pandas-dev", + "context": "..", + "dockerFile": "../Dockerfile", + "postCreateCommand": "./.devcontainer/postCreateCommand.sh", + // Use `customizations/vscode/settings` to set *default* container specific + // settings.json values on container create. You can edit these settings + // after create using File > Preferences > Settings > Remote. + "customizations": { + "vscode": { + // Add the IDs of extensions you want installed when the + // container is created in the array below. + "extensions": [ + "ms-python.python", + "ms-python.black-formatter", + "ms-python.flake8", + "ms-python.mypy-type-checker", + "ms-python.pylint", + "ms-vscode.cpptools", + "ms-azuretools.vscode-docker", + "GitHub.vscode-github-actions" + ], + "settings": { + // Editor configuration: + "editor.detectIndentation": false, + "editor.formatOnSave": true, + "editor.insertSpaces": true, + "editor.rulers": [ + 88 + ], + "editor.tabSize": 4, + "files.insertFinalNewline": true, + // Python tooling: + "black-formatter.importStrategy": "fromEnvironment", + "flake8.args": [ + "--max-line-length=88" + ], + "flake8.importStrategy": "fromEnvironment", + "mypy-type-checker.importStrategy": "fromEnvironment", + "mypy-type-checker.showNotifications": "always", + "pylint.args": [ + "--load-plugins=pylint.extensions.redefined_loop_name" + ], + "pylint.importStrategy": "fromEnvironment", + "[python]": { + "editor.defaultFormatter": "ms-python.black-formatter" + }, + "python.analysis.typeCheckingMode": "basic", + "python.linting.mypyEnabled": true, // Deprecated, but seemingly required to get VSCode to display mypy diagnostics + "python.testing.pytestArgs": [ + "pandas" + ], + "python.testing.pytestEnabled": true, + // Environment and terminal configuration: + "python.defaultInterpreterPath": "/home/pandas-dev/micromamba/envs/test/bin/python", + "python.terminal.activateEnvironment": false, + "terminal.integrated.defaultProfile.linux": "bash" + } + } + } +} diff --git a/.devcontainer/postCreateCommand.sh b/.devcontainer/postCreateCommand.sh new file mode 100755 index 0000000000000..8fc0ed07a8194 --- /dev/null +++ b/.devcontainer/postCreateCommand.sh @@ -0,0 +1,45 @@ +#! /usr/bin/env bash + +set -e + +~/micromamba-bin/micromamba \ + create \ + -y \ + -r ~/micromamba \ + -f environment.yml \ + -n test \ + --rc-file ci/condarc.yml + +mv ~/.bashrc ~/.bashrc.orig +~/micromamba-bin/micromamba shell init --shell bash --root-prefix=~/micromamba +mv ~/.bashrc ~/.mamba-bashrc +cp ~/.bashrc.orig ~/.bashrc +echo micromamba activate test >> ~/.mamba-bashrc +cat ~/.mamba-bashrc >> ~/.bashrc +cat ~/.mamba-bashrc >> ~/.bash_profile +source ~/.mamba-bashrc + + +if [[ $(git tag | wc -c) -eq 0 ]] +then + echo -e '\n\nERROR:' + echo Your repository has been cloned without tags. + echo To fix this, add the original pandas GitHub repository as an upstream + echo reference, e.g., via the following: + echo git remote add upstream https://github.com/pandas-dev/pandas.git + echo Then, run + echo git fetch --tags upstream + echo to get the main repository\'s tags, and optionally run + echo git push --tags + echo to upload the tags to your GitHub fork. + echo + echo Finally, rebuild the devcontainer. + exit 1 +fi + +pip install black + +pip uninstall -y pandas +pip install -e . --no-build-isolation -v + +pre-commit install diff --git a/Dockerfile b/Dockerfile index 7230dcab20f6e..a32c09f4b1995 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,7 +7,21 @@ RUN apt-get install -y build-essential # hdf5 needed for pytables installation RUN apt-get install -y libhdf5-dev -RUN python -m pip install --upgrade pip -RUN python -m pip install \ - -r https://raw.githubusercontent.com/pandas-dev/pandas/main/requirements-dev.txt +RUN apt-get install -y vim less + +ARG USERNAME=pandas-dev +ARG USER_UID=1000 +ARG USER_GID=$USER_UID +RUN groupadd --gid $USER_GID $USERNAME \ + && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME -s /bin/bash \ + && apt-get install -y sudo \ + && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \ + && chmod 0440 /etc/sudoers.d/$USERNAME + +RUN apt-get install -y curl bzip2 && sudo -u $USERNAME bash -c \ + "mkdir ~/bin && \ + curl -Ls https://micro.mamba.pm/api/micromamba/linux-64/latest | \ + tar -C ~ -xj bin/micromamba \ + && mv ~/bin ~/micromamba-bin" + CMD ["/bin/bash"] diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index 0cc1fe2629e46..9b09810397d3d 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -184,7 +184,7 @@ Run Container:: **Visual Studio Code** You can use the DockerFile to launch a remote session with Visual Studio Code, -a popular free IDE, using the ``.devcontainer.json`` file. +a popular free IDE, using the ``.devcontainer`` directory. See https://code.visualstudio.com/docs/remote/containers for details. **PyCharm (Professional)**
- [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. This PR serves two purposes: 1. **Harmonizing devcontainer with the CI environment in GitHub Actions** GitHub Actions use `micromamba` for Python environment management, while the old devcontainer setup used to use `pip` (with a list of dependencies fetched from `requirements-dev.txt` once at container image creation). As I was trying to reproduce an unrelated issue locally, I was unsure whether deviations from the CI reults may have been caused by different Python environments. This change should reduce uncertainties in this regard. 2. **Modernizing the Visual Studio Code setup** This PR attempts to produce a devcontainer that has high utility out of the box (e.g., installation and configuration of extensions for `mypy`, `flake8`, `black`, etc.) Furthermore, it replaces deprecated configuration options with the preferred ones. If you like this PR, please let me know which `whatsnew` file this should be mentioned in (`v2.1.0.rst` I presume?) Also, do you need me to open an issue for this?
https://api.github.com/repos/pandas-dev/pandas/pulls/54845
2023-08-29T12:38:32Z
2023-08-30T16:59:24Z
null
2023-08-30T16:59:25Z
BUG: ArrowExtensionArray.to_numpy avoid object dtype when na_value provided
diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index e815b8292b0cc..4d887ecd1510f 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -29,12 +29,12 @@ from pandas.util._decorators import doc from pandas.util._validators import validate_fillna_kwargs +from pandas.core.dtypes.cast import can_hold_element from pandas.core.dtypes.common import ( is_array_like, is_bool_dtype, is_integer, is_list_like, - is_object_dtype, is_scalar, ) from pandas.core.dtypes.dtypes import DatetimeTZDtype @@ -1240,46 +1240,50 @@ def to_numpy( ) -> np.ndarray: if dtype is not None: dtype = np.dtype(dtype) - elif self._hasna: - dtype = np.dtype(object) if na_value is lib.no_default: na_value = self.dtype.na_value pa_type = self._pa_array.type + if not self._hasna or isna(na_value) or pa.types.is_null(pa_type): + data = self + else: + data = self.fillna(na_value) + copy = False + if pa.types.is_timestamp(pa_type) or pa.types.is_duration(pa_type): - result = self._maybe_convert_datelike_array() + result = data._maybe_convert_datelike_array() if dtype is None or dtype.kind == "O": result = result.to_numpy(dtype=object, na_value=na_value) else: result = result.to_numpy(dtype=dtype) - return result elif pa.types.is_time(pa_type) or pa.types.is_date(pa_type): # convert to list of python datetime.time objects before # wrapping in ndarray - result = np.array(list(self), dtype=dtype) - elif is_object_dtype(dtype) and self._hasna: - result = np.empty(len(self), dtype=object) - mask = ~self.isna() - result[mask] = np.asarray(self[mask]._pa_array) - elif pa.types.is_null(self._pa_array.type): - fill_value = None if isna(na_value) else na_value - return np.full(len(self), fill_value=fill_value, dtype=dtype) - elif self._hasna: - data = self.fillna(na_value) + result = np.array(list(data), dtype=dtype) + if data._hasna: + result[data.isna()] = na_value + elif pa.types.is_null(pa_type): + if dtype is not None and isna(na_value): + na_value = None + result = np.full(len(data), fill_value=na_value, dtype=dtype) + elif not data._hasna or (pa.types.is_floating(pa_type) and na_value is np.nan): result = data._pa_array.to_numpy() - if dtype is not None: - result = result.astype(dtype, copy=False) - return result - else: - result = self._pa_array.to_numpy() if dtype is not None: result = result.astype(dtype, copy=False) if copy: result = result.copy() - return result - if self._hasna: - result[self.isna()] = na_value + else: + if dtype is None: + empty = pa.array([], type=pa_type).to_numpy(zero_copy_only=False) + if can_hold_element(empty, na_value): + dtype = empty.dtype + else: + dtype = np.object_ + result = np.empty(len(data), dtype=dtype) + mask = data.isna() + result[mask] = na_value + result[~mask] = data[~mask]._pa_array.to_numpy() return result def unique(self) -> Self: diff --git a/pandas/tests/arrays/string_/test_string.py b/pandas/tests/arrays/string_/test_string.py index 24d8e43708b91..89cc31ec5ecc8 100644 --- a/pandas/tests/arrays/string_/test_string.py +++ b/pandas/tests/arrays/string_/test_string.py @@ -377,8 +377,16 @@ def test_astype_int(dtype): tm.assert_numpy_array_equal(result, expected) arr = pd.array(["1", pd.NA, "3"], dtype=dtype) - msg = r"int\(\) argument must be a string, a bytes-like object or a( real)? number" - with pytest.raises(TypeError, match=msg): + if dtype.storage == "pyarrow_numpy": + err = ValueError + msg = "cannot convert float NaN to integer" + else: + err = TypeError + msg = ( + r"int\(\) argument must be a string, a bytes-like " + r"object or a( real)? number" + ) + with pytest.raises(err, match=msg): arr.astype("int64") diff --git a/pandas/tests/extension/test_arrow.py b/pandas/tests/extension/test_arrow.py index 13d80329f4d51..5f1b16a44b8e9 100644 --- a/pandas/tests/extension/test_arrow.py +++ b/pandas/tests/extension/test_arrow.py @@ -1595,6 +1595,19 @@ def test_to_numpy_null_array_no_dtype(): tm.assert_numpy_array_equal(result, expected) +def test_to_numpy_without_dtype(): + # GH 54808 + arr = pd.array([True, pd.NA], dtype="boolean[pyarrow]") + result = arr.to_numpy(na_value=False) + expected = np.array([True, False], dtype=np.bool_) + tm.assert_numpy_array_equal(result, expected) + + arr = pd.array([1.0, pd.NA], dtype="float32[pyarrow]") + result = arr.to_numpy(na_value=0.0) + expected = np.array([1.0, 0.0], dtype=np.float32) + tm.assert_numpy_array_equal(result, expected) + + def test_setitem_null_slice(data): # GH50248 orig = data.copy()
- [x] closes #54808 - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions.
https://api.github.com/repos/pandas-dev/pandas/pulls/54843
2023-08-29T11:24:18Z
2023-09-01T16:55:50Z
2023-09-01T16:55:50Z
2023-09-06T00:53:47Z
remove unnecessary conditional from equals method
diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b87772594cfbf..ec0e62582f0ba 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -1459,7 +1459,7 @@ def equals(self, other: object) -> bool_t: >>> df.equals(different_data_type) False """ - if not (isinstance(other, type(self)) or isinstance(self, type(other))): + if not (isinstance(other, type(self)): return False other = cast(NDFrame, other) return self._mgr.equals(other._mgr)
- [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. Currently, the `equals` method has two conditional expressions. The second conditional expression is not only a duplicate of the first one, but because it does not have the "not" operator in front of it like the first conditional expression does, it causes incorrect behavior of the equals function.
https://api.github.com/repos/pandas-dev/pandas/pulls/54842
2023-08-29T09:41:44Z
2023-08-29T09:58:05Z
null
2023-08-29T09:58:06Z
DOC: Added missing git instruction to docs on how to update environment
diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 247f5cb0cb62d..82af8122a6bbd 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -311,6 +311,7 @@ If using :ref:`mamba <contributing.mamba>`, run: .. code-block:: shell git checkout main + git fetch upstream git merge upstream/main mamba activate pandas-dev mamba env update -f environment.yml --prune @@ -320,6 +321,7 @@ If using :ref:`pip <contributing.pip>` , do: .. code-block:: shell git checkout main + git fetch upstream git merge upstream/main # activate the virtual environment based on your platform python -m pip install --upgrade -r requirements-dev.txt
- [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). I think a `git fetch` instruction is missing from [Updating the development environment](https://pandas.pydata.org/docs/dev/development/contributing.html#updating-the-development-environment)
https://api.github.com/repos/pandas-dev/pandas/pulls/54841
2023-08-29T09:33:42Z
2023-08-29T10:54:56Z
2023-08-29T10:54:56Z
2023-08-29T10:54:57Z
Shinyp
diff --git a/pandas/__init__.py b/pandas/__init__.py index d11a429987ac4..4d3ce42ca4cc8 100644 --- a/pandas/__init__.py +++ b/pandas/__init__.py @@ -2,7 +2,7 @@ __docformat__ = "restructuredtext" -# Let users know if they're missing any of our hard dependencies +# Ensure users are informed if they lack any essential dependencies required for our software to function correctly. _hard_dependencies = ("numpy", "pytz", "dateutil") _missing_dependencies = [] @@ -350,4 +350,4 @@ "unique", "value_counts", "wide_to_long", -] +] \ No newline at end of file
- DOC: Rewrite a sentence for a better understanding of users. - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54840
2023-08-29T09:04:00Z
2023-08-29T09:56:16Z
null
2023-08-29T11:51:10Z
Backport PR #54794 on branch 2.1.x (Infer string storage based on infer_string option)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 8f2667d69a322..7aea1fa99f655 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -39,11 +39,15 @@ We are collecting feedback on this decision `here <https://github.com/pandas-dev Avoid NumPy object dtype for strings by default ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Previously, all strings were stored in columns with NumPy object dtype. +Previously, all strings were stored in columns with NumPy object dtype by default. This release introduces an option ``future.infer_string`` that infers all strings as PyArrow backed strings with dtype ``"string[pyarrow_numpy]"`` instead. This is a new string dtype implementation that follows NumPy semantics in comparison operations and will return ``np.nan`` as the missing value indicator. +Setting the option will also infer the dtype ``"string"`` as a :class:`StringDtype` with +storage set to ``"pyarrow_numpy"``, ignoring the value behind the option +``mode.string_storage``. + This option only works if PyArrow is installed. PyArrow backed strings have a significantly reduced memory footprint and provide a big performance improvement compared to NumPy object (:issue:`54430`). diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index 3af63c781d499..84a85b9e56aff 100644 --- a/pandas/core/arrays/string_.py +++ b/pandas/core/arrays/string_.py @@ -112,7 +112,11 @@ def na_value(self) -> libmissing.NAType | float: # type: ignore[override] def __init__(self, storage=None) -> None: if storage is None: - storage = get_option("mode.string_storage") + infer_string = get_option("future.infer_string") + if infer_string: + storage = "pyarrow_numpy" + else: + storage = get_option("mode.string_storage") if storage not in {"python", "pyarrow", "pyarrow_numpy"}: raise ValueError( f"Storage must be 'python' or 'pyarrow'. Got {storage} instead." diff --git a/pandas/core/config_init.py b/pandas/core/config_init.py index 745689ab1fcc8..765b24fbc7868 100644 --- a/pandas/core/config_init.py +++ b/pandas/core/config_init.py @@ -492,7 +492,8 @@ def use_inf_as_na_cb(key) -> None: string_storage_doc = """ : string - The default storage for StringDtype. + The default storage for StringDtype. This option is ignored if + ``future.infer_string`` is set to True. """ with cf.config_prefix("mode"): diff --git a/pandas/tests/series/test_constructors.py b/pandas/tests/series/test_constructors.py index ef734e9664844..2c3fdf627788a 100644 --- a/pandas/tests/series/test_constructors.py +++ b/pandas/tests/series/test_constructors.py @@ -2115,6 +2115,14 @@ def test_series_string_inference_array_string_dtype(self): ser = Series(np.array(["a", "b"])) tm.assert_series_equal(ser, expected) + def test_series_string_inference_storage_definition(self): + # GH#54793 + pytest.importorskip("pyarrow") + expected = Series(["a", "b"], dtype="string[pyarrow_numpy]") + with pd.option_context("future.infer_string", True): + result = Series(["a", "b"], dtype="string") + tm.assert_series_equal(result, expected) + class TestSeriesConstructorIndexCoercion: def test_series_constructor_datetimelike_index_coercion(self):
Backport PR #54794: Infer string storage based on infer_string option
https://api.github.com/repos/pandas-dev/pandas/pulls/54839
2023-08-29T08:37:25Z
2023-08-29T11:14:20Z
2023-08-29T11:14:20Z
2023-08-29T11:14:20Z
Don't expose EA.pad_or_backfill to users + switch to DeprecationWarning
diff --git a/doc/source/reference/extensions.rst b/doc/source/reference/extensions.rst index eb2529716b55e..e177e2b1d87d5 100644 --- a/doc/source/reference/extensions.rst +++ b/doc/source/reference/extensions.rst @@ -39,6 +39,7 @@ objects. api.extensions.ExtensionArray._from_sequence api.extensions.ExtensionArray._from_sequence_of_strings api.extensions.ExtensionArray._hash_pandas_object + api.extensions.ExtensionArray._pad_or_backfill api.extensions.ExtensionArray._reduce api.extensions.ExtensionArray._values_for_argsort api.extensions.ExtensionArray._values_for_factorize @@ -54,7 +55,6 @@ objects. api.extensions.ExtensionArray.interpolate api.extensions.ExtensionArray.isin api.extensions.ExtensionArray.isna - api.extensions.ExtensionArray.pad_or_backfill api.extensions.ExtensionArray.ravel api.extensions.ExtensionArray.repeat api.extensions.ExtensionArray.searchsorted diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 8f2667d69a322..84b50ac98a759 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -579,7 +579,7 @@ Other Deprecations - Deprecated positional indexing on :class:`Series` with :meth:`Series.__getitem__` and :meth:`Series.__setitem__`, in a future version ``ser[item]`` will *always* interpret ``item`` as a label, not a position (:issue:`50617`) - Deprecated replacing builtin and NumPy functions in ``.agg``, ``.apply``, and ``.transform``; use the corresponding string alias (e.g. ``"sum"`` for ``sum`` or ``np.sum``) instead (:issue:`53425`) - Deprecated strings ``T``, ``t``, ``L`` and ``l`` denoting units in :func:`to_timedelta` (:issue:`52536`) -- Deprecated the "method" and "limit" keywords in ``.ExtensionArray.fillna``, implement and use ``pad_or_backfill`` instead (:issue:`53621`) +- Deprecated the "method" and "limit" keywords in ``.ExtensionArray.fillna``, implement ``_pad_or_backfill`` instead (:issue:`53621`) - Deprecated the ``method`` and ``limit`` keywords in :meth:`DataFrame.replace` and :meth:`Series.replace` (:issue:`33302`) - Deprecated the ``method`` and ``limit`` keywords on :meth:`Series.fillna`, :meth:`DataFrame.fillna`, :meth:`.SeriesGroupBy.fillna`, :meth:`.DataFrameGroupBy.fillna`, and :meth:`.Resampler.fillna`, use ``obj.bfill()`` or ``obj.ffill()`` instead (:issue:`53394`) - Deprecated the behavior of :meth:`Series.__getitem__`, :meth:`Series.__setitem__`, :meth:`DataFrame.__getitem__`, :meth:`DataFrame.__setitem__` with an integer slice on objects with a floating-dtype index, in a future version this will be treated as *positional* indexing (:issue:`49612`) diff --git a/pandas/core/arrays/_mixins.py b/pandas/core/arrays/_mixins.py index 359e0161e763c..6d21f4a1ac8a2 100644 --- a/pandas/core/arrays/_mixins.py +++ b/pandas/core/arrays/_mixins.py @@ -296,13 +296,8 @@ def _fill_mask_inplace( func = missing.get_fill_func(method, ndim=self.ndim) func(self._ndarray.T, limit=limit, mask=mask.T) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: mask = self.isna() if mask.any(): diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index 70c59e94f6d27..19443e2069270 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -924,19 +924,14 @@ def dropna(self) -> Self: """ return type(self)(pc.drop_null(self._pa_array)) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: if not self._hasna: # TODO(CoW): Not necessary anymore when CoW is the default return self.copy() - if limit is not None and limit_area is not None: + if limit is None: method = missing.clean_fill_method(method) try: if method == "pad": @@ -952,9 +947,7 @@ def pad_or_backfill( # TODO(3.0): after EA.fillna 'method' deprecation is enforced, we can remove # this method entirely. - return super().pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + return super()._pad_or_backfill(method=method, limit=limit, copy=copy) @doc(ExtensionArray.fillna) def fillna( @@ -974,7 +967,7 @@ def fillna( return super().fillna(value=value, method=method, limit=limit, copy=copy) if method is not None: - return super().pad_or_backfill(method=method, limit=limit, copy=copy) + return super().fillna(method=method, limit=limit, copy=copy) if isinstance(value, (np.ndarray, ExtensionArray)): # Similar to check_value_size, but we do not mask here since we may diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index 3827b5b5d40b2..f3bb7323c7d5f 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -132,7 +132,6 @@ class ExtensionArray: interpolate isin isna - pad_or_backfill ravel repeat searchsorted @@ -148,6 +147,7 @@ class ExtensionArray: _from_sequence _from_sequence_of_strings _hash_pandas_object + _pad_or_backfill _reduce _values_for_argsort _values_for_factorize @@ -183,7 +183,7 @@ class ExtensionArray: methods: * fillna - * pad_or_backfill + * _pad_or_backfill * dropna * unique * factorize / _values_for_factorize @@ -918,13 +918,8 @@ def interpolate( f"{type(self).__name__} does not implement interpolate" ) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: """ Pad or backfill values, used by Series/DataFrame ffill and bfill. @@ -960,26 +955,26 @@ def pad_or_backfill( Examples -------- >>> arr = pd.array([np.nan, np.nan, 2, 3, np.nan, np.nan]) - >>> arr.pad_or_backfill(method="backfill", limit=1) + >>> arr._pad_or_backfill(method="backfill", limit=1) <IntegerArray> [<NA>, 2, 2, 3, <NA>, <NA>] Length: 6, dtype: Int64 """ # If a 3rd-party EA has implemented this functionality in fillna, - # we warn that they need to implement pad_or_backfill instead. + # we warn that they need to implement _pad_or_backfill instead. if ( type(self).fillna is not ExtensionArray.fillna - and type(self).pad_or_backfill is ExtensionArray.pad_or_backfill + and type(self)._pad_or_backfill is ExtensionArray._pad_or_backfill ): - # Check for pad_or_backfill here allows us to call - # super().pad_or_backfill without getting this warning + # Check for _pad_or_backfill here allows us to call + # super()._pad_or_backfill without getting this warning warnings.warn( "ExtensionArray.fillna 'method' keyword is deprecated. " - "In a future version. arr.pad_or_backfill will be called " + "In a future version. arr._pad_or_backfill will be called " "instead. 3rd-party ExtensionArray authors need to implement " - "pad_or_backfill.", - FutureWarning, + "_pad_or_backfill.", + DeprecationWarning, stacklevel=find_stack_level(), ) return self.fillna(method=method, limit=limit) @@ -1063,8 +1058,7 @@ def fillna( if method is not None: warnings.warn( f"The 'method' keyword in {type(self).__name__}.fillna is " - "deprecated and will be removed in a future version. " - "Use pad_or_backfill instead.", + "deprecated and will be removed in a future version.", FutureWarning, stacklevel=find_stack_level(), ) diff --git a/pandas/core/arrays/interval.py b/pandas/core/arrays/interval.py index 6875ab434a5f8..73d4f6f38f102 100644 --- a/pandas/core/arrays/interval.py +++ b/pandas/core/arrays/interval.py @@ -890,19 +890,12 @@ def max(self, *, axis: AxisInt | None = None, skipna: bool = True) -> IntervalOr indexer = obj.argsort()[-1] return obj[indexer] - def pad_or_backfill( # pylint: disable=useless-parent-delegation - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( # pylint: disable=useless-parent-delegation + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: # TODO(3.0): after EA.fillna 'method' deprecation is enforced, we can remove # this method entirely. - return super().pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + return super()._pad_or_backfill(method=method, limit=limit, copy=copy) def fillna( self, value=None, method=None, limit: int | None = None, copy: bool = True diff --git a/pandas/core/arrays/masked.py b/pandas/core/arrays/masked.py index bec875f2bbfa1..2cf28c28427ab 100644 --- a/pandas/core/arrays/masked.py +++ b/pandas/core/arrays/masked.py @@ -190,13 +190,8 @@ def __getitem__(self, item: PositionalIndexer) -> Self | Any: return self._simple_new(self._data[item], newmask) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: mask = self._mask diff --git a/pandas/core/arrays/numpy_.py b/pandas/core/arrays/numpy_.py index 99a3586871d10..efe0c0df45e00 100644 --- a/pandas/core/arrays/numpy_.py +++ b/pandas/core/arrays/numpy_.py @@ -240,7 +240,10 @@ def _values_for_factorize(self) -> tuple[np.ndarray, float | None]: fv = np.nan return self._ndarray, fv - def pad_or_backfill( + # Base EA class (and all other EA classes) don't have limit_area keyword + # This can be removed here as well when the interpolate ffill/bfill method + # deprecation is enforced + def _pad_or_backfill( self, *, method: FillnaOptions, diff --git a/pandas/core/arrays/period.py b/pandas/core/arrays/period.py index 024cd6d4aad14..a2e4b595c42aa 100644 --- a/pandas/core/arrays/period.py +++ b/pandas/core/arrays/period.py @@ -791,20 +791,13 @@ def searchsorted( m8arr = self._ndarray.view("M8[ns]") return m8arr.searchsorted(npvalue, side=side, sorter=sorter) - def pad_or_backfill( - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: # view as dt64 so we get treated as timelike in core.missing, # similar to dtl._period_dispatch dta = self.view("M8[ns]") - result = dta.pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + result = dta._pad_or_backfill(method=method, limit=limit, copy=copy) if copy: return cast("Self", result.view(self.dtype)) else: diff --git a/pandas/core/arrays/sparse/array.py b/pandas/core/arrays/sparse/array.py index d32c98535d7cb..e38fa0a3bdae5 100644 --- a/pandas/core/arrays/sparse/array.py +++ b/pandas/core/arrays/sparse/array.py @@ -712,19 +712,12 @@ def isna(self): mask[self.sp_index.indices] = isna(self.sp_values) return type(self)(mask, fill_value=False, dtype=dtype) - def pad_or_backfill( # pylint: disable=useless-parent-delegation - self, - *, - method: FillnaOptions, - limit: int | None = None, - limit_area: Literal["inside", "outside"] | None = None, - copy: bool = True, + def _pad_or_backfill( # pylint: disable=useless-parent-delegation + self, *, method: FillnaOptions, limit: int | None = None, copy: bool = True ) -> Self: # TODO(3.0): We can remove this method once deprecation for fillna method # keyword is enforced. - return super().pad_or_backfill( - method=method, limit=limit, limit_area=limit_area, copy=copy - ) + return super()._pad_or_backfill(method=method, limit=limit, copy=copy) def fillna( self, diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index 3b27f7e2eb80c..43f4f527afc3a 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -1451,7 +1451,7 @@ def pad_or_backfill( vals = cast(NumpyExtensionArray, self.array_values) if axis == 1: vals = vals.T - new_values = vals.pad_or_backfill( + new_values = vals._pad_or_backfill( method=method, limit=limit, limit_area=limit_area, @@ -1948,9 +1948,9 @@ def pad_or_backfill( if values.ndim == 2 and axis == 1: # NDArrayBackedExtensionArray.fillna assumes axis=0 - new_values = values.T.pad_or_backfill(method=method, limit=limit).T + new_values = values.T._pad_or_backfill(method=method, limit=limit).T else: - new_values = values.pad_or_backfill(method=method, limit=limit) + new_values = values._pad_or_backfill(method=method, limit=limit) return [self.make_block_same_class(new_values)] diff --git a/pandas/tests/arrays/test_datetimelike.py b/pandas/tests/arrays/test_datetimelike.py index 20530e37116f2..96aab94b24ddd 100644 --- a/pandas/tests/arrays/test_datetimelike.py +++ b/pandas/tests/arrays/test_datetimelike.py @@ -258,7 +258,7 @@ def test_fillna_method_doesnt_change_orig(self, method): fill_value = arr[3] if method == "pad" else arr[5] - result = arr.pad_or_backfill(method=method) + result = arr._pad_or_backfill(method=method) assert result[4] == fill_value # check that the original was not changed diff --git a/pandas/tests/arrays/test_datetimes.py b/pandas/tests/arrays/test_datetimes.py index 8e38a8c741b8d..c2d68a79f32d4 100644 --- a/pandas/tests/arrays/test_datetimes.py +++ b/pandas/tests/arrays/test_datetimes.py @@ -497,7 +497,7 @@ def test_fillna_preserves_tz(self, method): dtype=DatetimeTZDtype(tz="US/Central"), ) - result = arr.pad_or_backfill(method=method) + result = arr._pad_or_backfill(method=method) tm.assert_extension_array_equal(result, expected) # assert that arr and dti were not modified in-place @@ -510,12 +510,12 @@ def test_fillna_2d(self): dta[0, 1] = pd.NaT dta[1, 0] = pd.NaT - res1 = dta.pad_or_backfill(method="pad") + res1 = dta._pad_or_backfill(method="pad") expected1 = dta.copy() expected1[1, 0] = dta[0, 0] tm.assert_extension_array_equal(res1, expected1) - res2 = dta.pad_or_backfill(method="backfill") + res2 = dta._pad_or_backfill(method="backfill") expected2 = dta.copy() expected2 = dta.copy() expected2[1, 0] = dta[2, 0] @@ -529,10 +529,10 @@ def test_fillna_2d(self): assert not dta2._ndarray.flags["C_CONTIGUOUS"] tm.assert_extension_array_equal(dta, dta2) - res3 = dta2.pad_or_backfill(method="pad") + res3 = dta2._pad_or_backfill(method="pad") tm.assert_extension_array_equal(res3, expected1) - res4 = dta2.pad_or_backfill(method="backfill") + res4 = dta2._pad_or_backfill(method="backfill") tm.assert_extension_array_equal(res4, expected2) # test the DataFrame method while we're here diff --git a/pandas/tests/extension/base/dim2.py b/pandas/tests/extension/base/dim2.py index a0c24ee068e81..f1d787041d10b 100644 --- a/pandas/tests/extension/base/dim2.py +++ b/pandas/tests/extension/base/dim2.py @@ -160,9 +160,9 @@ def test_fillna_2d_method(self, data_missing, method): assert arr[0].isna().all() assert not arr[1].isna().any() - result = arr.pad_or_backfill(method=method, limit=None) + result = arr._pad_or_backfill(method=method, limit=None) - expected = data_missing.pad_or_backfill(method=method).repeat(2).reshape(2, 2) + expected = data_missing._pad_or_backfill(method=method).repeat(2).reshape(2, 2) tm.assert_extension_array_equal(result, expected) # Reverse so that backfill is not a no-op. @@ -170,10 +170,10 @@ def test_fillna_2d_method(self, data_missing, method): assert not arr2[0].isna().any() assert arr2[1].isna().all() - result2 = arr2.pad_or_backfill(method=method, limit=None) + result2 = arr2._pad_or_backfill(method=method, limit=None) expected2 = ( - data_missing[::-1].pad_or_backfill(method=method).repeat(2).reshape(2, 2) + data_missing[::-1]._pad_or_backfill(method=method).repeat(2).reshape(2, 2) ) tm.assert_extension_array_equal(result2, expected2) diff --git a/pandas/tests/extension/base/missing.py b/pandas/tests/extension/base/missing.py index 2a0bd0770dc07..40cc952d44200 100644 --- a/pandas/tests/extension/base/missing.py +++ b/pandas/tests/extension/base/missing.py @@ -94,7 +94,7 @@ def test_fillna_no_op_returns_copy(self, data): assert result is not data tm.assert_extension_array_equal(result, data) - result = data.pad_or_backfill(method="backfill") + result = data._pad_or_backfill(method="backfill") assert result is not data tm.assert_extension_array_equal(result, data) diff --git a/pandas/tests/extension/decimal/array.py b/pandas/tests/extension/decimal/array.py index d2c3cb395ed44..9ce7ac309b6d3 100644 --- a/pandas/tests/extension/decimal/array.py +++ b/pandas/tests/extension/decimal/array.py @@ -285,7 +285,7 @@ def value_counts(self, dropna: bool = True): return value_counts(self.to_numpy(), dropna=dropna) # We override fillna here to simulate a 3rd party EA that has done so. This - # lets us test the deprecation telling authors to implement pad_or_backfill + # lets us test the deprecation telling authors to implement _pad_or_backfill # Simulate a 3rd-party EA that has not yet updated to include a "copy" # keyword in its fillna method. # error: Signature of "fillna" incompatible with supertype "ExtensionArray" diff --git a/pandas/tests/extension/decimal/test_decimal.py b/pandas/tests/extension/decimal/test_decimal.py index acc82ecd9301a..8dbd1c4c511d0 100644 --- a/pandas/tests/extension/decimal/test_decimal.py +++ b/pandas/tests/extension/decimal/test_decimal.py @@ -140,26 +140,59 @@ def test_fillna_frame(self, data_missing): def test_fillna_limit_pad(self, data_missing): msg = "ExtensionArray.fillna 'method' keyword is deprecated" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, + ): + super().test_fillna_limit_pad(data_missing) + + msg = "The 'method' keyword in DecimalArray.fillna is deprecated" + with tm.assert_produces_warning( + FutureWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, ): super().test_fillna_limit_pad(data_missing) def test_fillna_limit_backfill(self, data_missing): - msg = "|".join( - [ - "ExtensionArray.fillna added a 'copy' keyword", - "Series.fillna with 'method' is deprecated", - ] - ) + msg = "Series.fillna with 'method' is deprecated" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + FutureWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, ): super().test_fillna_limit_backfill(data_missing) - def test_fillna_no_op_returns_copy(self, data): msg = "ExtensionArray.fillna 'method' keyword is deprecated" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, + ): + super().test_fillna_limit_backfill(data_missing) + + msg = "The 'method' keyword in DecimalArray.fillna is deprecated" + with tm.assert_produces_warning( + FutureWarning, + match=msg, + check_stacklevel=False, + raise_on_extra_warnings=False, + ): + super().test_fillna_limit_backfill(data_missing) + + def test_fillna_no_op_returns_copy(self, data): + msg = "|".join( + [ + "ExtensionArray.fillna 'method' keyword is deprecated", + "The 'method' keyword in DecimalArray.fillna is deprecated", + ] + ) + with tm.assert_produces_warning( + (FutureWarning, DeprecationWarning), match=msg, check_stacklevel=False ): super().test_fillna_no_op_returns_copy(data) @@ -171,9 +204,14 @@ def test_fillna_series(self, data_missing): super().test_fillna_series(data_missing) def test_fillna_series_method(self, data_missing, fillna_method): - msg = "ExtensionArray.fillna 'method' keyword is deprecated" + msg = "|".join( + [ + "ExtensionArray.fillna 'method' keyword is deprecated", + "The 'method' keyword in DecimalArray.fillna is deprecated", + ] + ) with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + (FutureWarning, DeprecationWarning), match=msg, check_stacklevel=False ): super().test_fillna_series_method(data_missing, fillna_method)
Closes #54831 This does: - Rename `ExtensionArray.pad_or_backfill` to `ExtensionArray._pad_or_backfill` (added underscore -> this is only a method that needs to be implemented by developers (EA authors), and not be called by or visible to users) - Changed the warning in `_pad_or_backfill` for when the EA still only has `fillna` with method to a DeprecationWarning, since this is targetting EA authors, we can avoid that initially users see the warning - Removed `limit_area` keyword from `ExtensionArray._pad_or_backfill` signature, since it is unused (for all EAs except for numy dtypes). Removing it now because otherwise removing it later can give compatibility problems with third party EAs (and then it would need to be deprecated) - Fixed a bug in the Arrow array implementation
https://api.github.com/repos/pandas-dev/pandas/pulls/54838
2023-08-29T08:28:39Z
2023-08-29T15:52:21Z
2023-08-29T15:52:21Z
2023-08-30T13:26:34Z
TST: added test for missing categories for `value_counts`
diff --git a/pandas/tests/frame/methods/test_value_counts.py b/pandas/tests/frame/methods/test_value_counts.py index c05a929360478..f30db91f82b60 100644 --- a/pandas/tests/frame/methods/test_value_counts.py +++ b/pandas/tests/frame/methods/test_value_counts.py @@ -189,3 +189,17 @@ def test_value_counts_categorical_future_warning(): name="count", ) tm.assert_series_equal(result, expected) + + +def test_value_counts_with_missing_category(): + # GH-54836 + df = pd.DataFrame({"a": pd.Categorical([1, 2, 4], categories=[1, 2, 3, 4])}) + result = df.value_counts() + expected = pd.Series( + [1, 1, 1, 0], + index=pd.MultiIndex.from_arrays( + [pd.CategoricalIndex([1, 2, 4, 3], categories=[1, 2, 3, 4], name="a")] + ), + name="count", + ) + tm.assert_series_equal(result, expected)
- [x] closes #54836 - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit).
https://api.github.com/repos/pandas-dev/pandas/pulls/54837
2023-08-29T06:55:12Z
2023-08-31T20:58:07Z
2023-08-31T20:58:07Z
2023-09-01T04:33:56Z
PERF: lexsort_indexer (MultiIndex / multi-column sorting)
diff --git a/asv_bench/benchmarks/frame_methods.py b/asv_bench/benchmarks/frame_methods.py index 96fe90ce08c5f..8e0bffd7b8ece 100644 --- a/asv_bench/benchmarks/frame_methods.py +++ b/asv_bench/benchmarks/frame_methods.py @@ -693,20 +693,24 @@ def time_frame_sort_values(self, ascending): self.df.sort_values(by="A", ascending=ascending) -class SortIndexByColumns: +class SortMultiKey: def setup(self): N = 10000 K = 10 - self.df = DataFrame( + self.df_by_columns = DataFrame( { "key1": tm.makeStringIndex(N).values.repeat(K), "key2": tm.makeStringIndex(N).values.repeat(K), "value": np.random.randn(N * K), } ) + self.df_by_index = self.df_by_columns.set_index(["key1", "key2"]) + + def time_sort_values(self): + self.df_by_columns.sort_values(by=["key1", "key2"]) - def time_frame_sort_values_by_columns(self): - self.df.sort_values(by=["key1", "key2"]) + def time_sort_index(self): + self.df_by_index.sort_index() class Quantile: diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst index e49436c4ed549..621c9159a5fe8 100644 --- a/doc/source/whatsnew/v2.2.0.rst +++ b/doc/source/whatsnew/v2.2.0.rst @@ -157,6 +157,7 @@ Deprecations Performance improvements ~~~~~~~~~~~~~~~~~~~~~~~~ +- Performance improvement in :meth:`DataFrame.sort_index` and :meth:`Series.sort_index` when indexed by a :class:`MultiIndex` (:issue:`54835`) - Performance improvement when indexing with more than 4 keys (:issue:`54550`) - diff --git a/pandas/core/indexes/multi.py b/pandas/core/indexes/multi.py index ae0ab66dd5f3e..bcb1392b5e7a7 100644 --- a/pandas/core/indexes/multi.py +++ b/pandas/core/indexes/multi.py @@ -2208,17 +2208,9 @@ def append(self, other): def argsort( self, *args, na_position: str = "last", **kwargs ) -> npt.NDArray[np.intp]: - if len(args) == 0 and len(kwargs) == 0: - # lexsort is significantly faster than self._values.argsort() - target = self._sort_levels_monotonic(raise_if_incomparable=True) - return lexsort_indexer( - # error: Argument 1 to "lexsort_indexer" has incompatible type - # "List[Categorical]"; expected "Union[List[Union[ExtensionArray, - # ndarray[Any, Any]]], List[Series]]" - target._get_codes_for_sorting(), # type: ignore[arg-type] - na_position=na_position, - ) - return self._values.argsort(*args, **kwargs) + target = self._sort_levels_monotonic(raise_if_incomparable=True) + keys = [lev.codes for lev in target._get_codes_for_sorting()] + return lexsort_indexer(keys, na_position=na_position, codes_given=True) @Appender(_index_shared_docs["repeat"] % _index_doc_kwargs) def repeat(self, repeats: int, axis=None) -> MultiIndex: diff --git a/pandas/core/sorting.py b/pandas/core/sorting.py index bc6e29c3c7fbf..485644339414f 100644 --- a/pandas/core/sorting.py +++ b/pandas/core/sorting.py @@ -99,8 +99,9 @@ def get_indexer_indexer( na_position=na_position, ) elif isinstance(target, ABCMultiIndex): + codes = [lev.codes for lev in target._get_codes_for_sorting()] indexer = lexsort_indexer( - target.codes, orders=ascending, na_position=na_position, codes_given=True + codes, orders=ascending, na_position=na_position, codes_given=True ) else: # Check monotonic-ness before sort an index (GH 11080) @@ -298,22 +299,8 @@ def decons_obs_group_ids( return [lab[indexer].astype(np.intp, subok=False, copy=True) for lab in labels] -def indexer_from_factorized( - labels, shape: Shape, compress: bool = True -) -> npt.NDArray[np.intp]: - ids = get_group_index(labels, shape, sort=True, xnull=False) - - if not compress: - ngroups = (ids.size and ids.max()) + 1 - else: - ids, obs = compress_group_index(ids, sort=True) - ngroups = len(obs) - - return get_group_index_sorter(ids, ngroups) - - def lexsort_indexer( - keys: list[ArrayLike] | list[Series], + keys: Sequence[ArrayLike | Index | Series], orders=None, na_position: str = "last", key: Callable | None = None, @@ -324,9 +311,9 @@ def lexsort_indexer( Parameters ---------- - keys : list[ArrayLike] | list[Series] - Sequence of ndarrays to be sorted by the indexer - list[Series] is only if key is not None. + keys : Sequence[ArrayLike | Index | Series] + Sequence of arrays to be sorted by the indexer + Sequence[Series] is only if key is not None. orders : bool or list of booleans, optional Determines the sorting order for each element in keys. If a list, it must be the same length as keys. This determines whether the @@ -346,83 +333,38 @@ def lexsort_indexer( """ from pandas.core.arrays import Categorical - labels = [] - shape = [] + if na_position not in ["last", "first"]: + raise ValueError(f"invalid na_position: {na_position}") + if isinstance(orders, bool): orders = [orders] * len(keys) elif orders is None: orders = [True] * len(keys) - # error: Incompatible types in assignment (expression has type - # "List[Union[ExtensionArray, ndarray[Any, Any], Index, Series]]", variable - # has type "Union[List[Union[ExtensionArray, ndarray[Any, Any]]], List[Series]]") - keys = [ensure_key_mapped(k, key) for k in keys] # type: ignore[assignment] + labels = [] for k, order in zip(keys, orders): - if na_position not in ["last", "first"]: - raise ValueError(f"invalid na_position: {na_position}") - + k = ensure_key_mapped(k, key) if codes_given: - mask = k == -1 - codes = k.copy() - n = len(codes) - mask_n = n - # error: Item "ExtensionArray" of "Union[Any, ExtensionArray, - # ndarray[Any, Any]]" has no attribute "any" - if mask.any(): # type: ignore[union-attr] - n -= 1 - + codes = cast(np.ndarray, k) + n = codes.max() + 1 if len(codes) else 0 else: cat = Categorical(k, ordered=True) + codes = cat.codes n = len(cat.categories) - codes = cat.codes.copy() - mask = cat.codes == -1 - if mask.any(): - mask_n = n + 1 - else: - mask_n = n - - if order: # ascending - if na_position == "last": - # error: Argument 1 to "where" has incompatible type "Union[Any, - # ExtensionArray, ndarray[Any, Any]]"; expected - # "Union[_SupportsArray[dtype[Any]], - # _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, - # complex, str, bytes, _NestedSequence[Union[bool, int, float, - # complex, str, bytes]]]" - codes = np.where(mask, n, codes) # type: ignore[arg-type] - elif na_position == "first": - # error: Incompatible types in assignment (expression has type - # "Union[Any, int, ndarray[Any, dtype[signedinteger[Any]]]]", - # variable has type "Union[Series, ExtensionArray, ndarray[Any, Any]]") - # error: Unsupported operand types for + ("ExtensionArray" and "int") - codes += 1 # type: ignore[operator,assignment] - else: # not order means descending - if na_position == "last": - # error: Unsupported operand types for - ("int" and "ExtensionArray") - # error: Argument 1 to "where" has incompatible type "Union[Any, - # ExtensionArray, ndarray[Any, Any]]"; expected - # "Union[_SupportsArray[dtype[Any]], - # _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, - # complex, str, bytes, _NestedSequence[Union[bool, int, float, - # complex, str, bytes]]]" - codes = np.where( - mask, n, n - codes - 1 # type: ignore[operator,arg-type] - ) - elif na_position == "first": - # error: Unsupported operand types for - ("int" and "ExtensionArray") - # error: Argument 1 to "where" has incompatible type "Union[Any, - # ExtensionArray, ndarray[Any, Any]]"; expected - # "Union[_SupportsArray[dtype[Any]], - # _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, - # complex, str, bytes, _NestedSequence[Union[bool, int, float, - # complex, str, bytes]]]" - codes = np.where(mask, 0, n - codes) # type: ignore[operator,arg-type] - - shape.append(mask_n) + + mask = codes == -1 + + if na_position == "last" and mask.any(): + codes = np.where(mask, n, codes) + + # not order means descending + if not order: + codes = np.where(mask, codes, n - codes - 1) + labels.append(codes) - return indexer_from_factorized(labels, tuple(shape)) + return np.lexsort(labels[::-1]) def nargsort(
- [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/v2.2.0.rst` file if fixing a bug or adding a new feature. Improves performance for `MultiIndex` and multi-column sorting. frame_methods.SortMultiKey: ``` before after ratio - 51.1±0.7ms 45.0±0.5ms 0.88 frame_methods.SortMultiKey.time_sort_values - 11.6±1ms 6.38±0.3ms 0.55 frame_methods.SortMultiKey.time_sort_index ``` multiindex_object.SetOperations: ``` before after ratio - 29.4±2ms 19.5±0.2ms 0.66 multiindex_object.SetOperations.time_operation('monotonic', 'ea_int', 'intersection', None) - 42.4±2ms 26.8±2ms 0.63 multiindex_object.SetOperations.time_operation('non_monotonic', 'int', 'intersection', None) - 30.8±1ms 19.4±2ms 0.63 multiindex_object.SetOperations.time_operation('non_monotonic', 'int', 'union', None) - 32.4±2ms 20.2±2ms 0.63 multiindex_object.SetOperations.time_operation('non_monotonic', 'ea_int', 'union', None) - 30.5±1ms 18.7±0.4ms 0.61 multiindex_object.SetOperations.time_operation('monotonic', 'int', 'intersection', None) - 34.8±4ms 19.4±2ms 0.56 multiindex_object.SetOperations.time_operation('non_monotonic', 'datetime', 'union', None) - 25.4±3ms 14.1±0.7ms 0.56 multiindex_object.SetOperations.time_operation('monotonic', 'datetime', 'union', None) - 33.7±1ms 17.2±1ms 0.51 multiindex_object.SetOperations.time_operation('non_monotonic', 'string', 'union', None) - 35.2±3ms 16.5±0.8ms 0.47 multiindex_object.SetOperations.time_operation('monotonic', 'string', 'union', None) - 41.3±1ms 18.4±2ms 0.45 multiindex_object.SetOperations.time_operation('non_monotonic', 'string', 'intersection', None) - 40.8±2ms 18.1±0.6ms 0.44 multiindex_object.SetOperations.time_operation('non_monotonic', 'datetime', 'intersection', None) - 48.6±4ms 19.8±2ms 0.41 multiindex_object.SetOperations.time_operation('non_monotonic', 'ea_int', 'intersection', None) - 45.1±5ms 17.9±2ms 0.40 multiindex_object.SetOperations.time_operation('monotonic', 'string', 'intersection', None) ``` multiindex_object.Difference: ``` before after ratio - 6.55±0.5ms 3.88±0.2ms 0.59 multiindex_object.Difference.time_difference('string') - 5.42±0.7ms 3.10±0.3ms 0.57 multiindex_object.Difference.time_difference('ea_int') ```
https://api.github.com/repos/pandas-dev/pandas/pulls/54835
2023-08-29T02:12:34Z
2023-08-30T17:02:18Z
2023-08-30T17:02:18Z
2023-09-06T00:53:58Z
ENH: add `ExtensionArray._explode` method; adjust pyarrow extension for use of new interface
diff --git a/doc/source/reference/extensions.rst b/doc/source/reference/extensions.rst index e177e2b1d87d5..83f830bb11198 100644 --- a/doc/source/reference/extensions.rst +++ b/doc/source/reference/extensions.rst @@ -34,6 +34,7 @@ objects. api.extensions.ExtensionArray._accumulate api.extensions.ExtensionArray._concat_same_type + api.extensions.ExtensionArray._explode api.extensions.ExtensionArray._formatter api.extensions.ExtensionArray._from_factorized api.extensions.ExtensionArray._from_sequence diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst index 55a3419e95703..0fc4afc95a2ce 100644 --- a/doc/source/whatsnew/v2.2.0.rst +++ b/doc/source/whatsnew/v2.2.0.rst @@ -73,6 +73,7 @@ enhancement2 Other enhancements ^^^^^^^^^^^^^^^^^^ +- :meth:`ExtensionArray._explode` interface method added to allow extension type implementations of the ``explode`` method (:issue:`54833`) - DataFrame.apply now allows the usage of numba (via ``engine="numba"``) to JIT compile the passed function, allowing for potential speedups (:issue:`54666`) - diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index a329c37c77449..e67b7035822cc 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -1609,6 +1609,10 @@ def _explode(self): """ See Series.explode.__doc__. """ + # child class explode method supports only list types; return + # default implementation for non list types. + if not pa.types.is_list(self.dtype.pyarrow_dtype): + return super()._explode() values = self counts = pa.compute.list_value_length(values._pa_array) counts = counts.fill_null(1).to_numpy() diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py index f3bb7323c7d5f..933944dbd4632 100644 --- a/pandas/core/arrays/base.py +++ b/pandas/core/arrays/base.py @@ -142,6 +142,7 @@ class ExtensionArray: view _accumulate _concat_same_type + _explode _formatter _from_factorized _from_sequence @@ -1924,6 +1925,41 @@ def _hash_pandas_object( values, encoding=encoding, hash_key=hash_key, categorize=categorize ) + def _explode(self) -> tuple[Self, npt.NDArray[np.uint64]]: + """ + Transform each element of list-like to a row. + + For arrays that do not contain list-like elements the default + implementation of this method just returns a copy and an array + of ones (unchanged index). + + Returns + ------- + ExtensionArray + Array with the exploded values. + np.ndarray[uint64] + The original lengths of each list-like for determining the + resulting index. + + See Also + -------- + Series.explode : The method on the ``Series`` object that this + extension array method is meant to support. + + Examples + -------- + >>> import pyarrow as pa + >>> a = pd.array([[1, 2, 3], [4], [5, 6]], + ... dtype=pd.ArrowDtype(pa.list_(pa.int64()))) + >>> a._explode() + (<ArrowExtensionArray> + [1, 2, 3, 4, 5, 6] + Length: 6, dtype: int64[pyarrow], array([3, 1, 2], dtype=int32)) + """ + values = self.copy() + counts = np.ones(shape=(len(self),), dtype=np.uint64) + return values, counts + def tolist(self) -> list: """ Return a list of the values. diff --git a/pandas/core/series.py b/pandas/core/series.py index e0e27581ef7e2..78ec1554198df 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -76,10 +76,7 @@ pandas_dtype, validate_all_hashable, ) -from pandas.core.dtypes.dtypes import ( - ArrowDtype, - ExtensionDtype, -) +from pandas.core.dtypes.dtypes import ExtensionDtype from pandas.core.dtypes.generic import ABCDataFrame from pandas.core.dtypes.inference import is_hashable from pandas.core.dtypes.missing import ( @@ -4390,7 +4387,7 @@ def explode(self, ignore_index: bool = False) -> Series: 3 4 dtype: object """ - if isinstance(self.dtype, ArrowDtype) and self.dtype.type == list: + if isinstance(self.dtype, ExtensionDtype): values, counts = self._values._explode() elif len(self) and is_object_dtype(self.dtype): values, counts = reshape.explode(np.asarray(self._values)) diff --git a/pandas/tests/series/methods/test_explode.py b/pandas/tests/series/methods/test_explode.py index c8a9eb6f89fde..5a0188585ef30 100644 --- a/pandas/tests/series/methods/test_explode.py +++ b/pandas/tests/series/methods/test_explode.py @@ -163,3 +163,13 @@ def test_explode_pyarrow_list_type(ignore_index): dtype=pd.ArrowDtype(pa.int64()), ) tm.assert_series_equal(result, expected) + + +@pytest.mark.parametrize("ignore_index", [True, False]) +def test_explode_pyarrow_non_list_type(ignore_index): + pa = pytest.importorskip("pyarrow") + data = [1, 2, 3] + ser = pd.Series(data, dtype=pd.ArrowDtype(pa.int64())) + result = ser.explode(ignore_index=ignore_index) + expected = pd.Series([1, 2, 3], dtype="int64[pyarrow]", index=[0, 1, 2]) + tm.assert_series_equal(result, expected)
- [x] closes #54833 - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54834
2023-08-29T01:28:31Z
2023-09-18T21:37:33Z
2023-09-18T21:37:33Z
2023-09-19T00:37:36Z
ENH: allow EADtype to specify _supports_2d
diff --git a/pandas/core/dtypes/base.py b/pandas/core/dtypes/base.py index a055afe6ec0ae..6567ca7155b0d 100644 --- a/pandas/core/dtypes/base.py +++ b/pandas/core/dtypes/base.py @@ -418,6 +418,33 @@ def index_class(self) -> type_t[Index]: return Index + @property + def _supports_2d(self) -> bool: + """ + Do ExtensionArrays with this dtype support 2D arrays? + + Historically ExtensionArrays were limited to 1D. By returning True here, + authors can indicate that their arrays support 2D instances. This can + improve performance in some cases, particularly operations with `axis=1`. + + Arrays that support 2D values should: + + - implement Array.reshape + - subclass the Dim2CompatTests in tests.extension.base + - _concat_same_type should support `axis` keyword + - _reduce and reductions should support `axis` keyword + """ + return False + + @property + def _can_fast_transpose(self) -> bool: + """ + Is transposing an array with this dtype zero-copy? + + Only relevant for cases where _supports_2d is True. + """ + return False + class StorageExtensionDtype(ExtensionDtype): """ExtensionDtype that may be backed by more than one implementation.""" diff --git a/pandas/core/dtypes/common.py b/pandas/core/dtypes/common.py index 3db36fc50e343..63c59297f454a 100644 --- a/pandas/core/dtypes/common.py +++ b/pandas/core/dtypes/common.py @@ -1256,13 +1256,7 @@ def is_1d_only_ea_dtype(dtype: DtypeObj | None) -> bool: """ Analogue to is_extension_array_dtype but excluding DatetimeTZDtype. """ - # Note: if other EA dtypes are ever held in HybridBlock, exclude those - # here too. - # NB: need to check DatetimeTZDtype and not is_datetime64tz_dtype - # to exclude ArrowTimestampUSDtype - return isinstance(dtype, ExtensionDtype) and not isinstance( - dtype, (DatetimeTZDtype, PeriodDtype) - ) + return isinstance(dtype, ExtensionDtype) and not dtype._supports_2d def is_extension_array_dtype(arr_or_dtype) -> bool: diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py index f43865465cb28..8ab002445633e 100644 --- a/pandas/core/dtypes/dtypes.py +++ b/pandas/core/dtypes/dtypes.py @@ -210,6 +210,8 @@ class CategoricalDtype(PandasExtensionDtype, ExtensionDtype): base = np.dtype("O") _metadata = ("categories", "ordered") _cache_dtypes: dict[str_type, PandasExtensionDtype] = {} + _supports_2d = False + _can_fast_transpose = False def __init__(self, categories=None, ordered: Ordered = False) -> None: self._finalize(categories, ordered, fastpath=False) @@ -727,6 +729,8 @@ class DatetimeTZDtype(PandasExtensionDtype): _metadata = ("unit", "tz") _match = re.compile(r"(datetime64|M8)\[(?P<unit>.+), (?P<tz>.+)\]") _cache_dtypes: dict[str_type, PandasExtensionDtype] = {} + _supports_2d = True + _can_fast_transpose = True @property def na_value(self) -> NaTType: @@ -970,6 +974,8 @@ class PeriodDtype(PeriodDtypeBase, PandasExtensionDtype): _cache_dtypes: dict[BaseOffset, int] = {} # type: ignore[assignment] __hash__ = PeriodDtypeBase.__hash__ _freq: BaseOffset + _supports_2d = True + _can_fast_transpose = True def __new__(cls, freq): """ @@ -1432,6 +1438,8 @@ class NumpyEADtype(ExtensionDtype): """ _metadata = ("_dtype",) + _supports_2d = False + _can_fast_transpose = False def __init__(self, dtype: npt.DTypeLike | NumpyEADtype | None) -> None: if isinstance(dtype, NumpyEADtype): diff --git a/pandas/tests/extension/base/__init__.py b/pandas/tests/extension/base/__init__.py index 82b61722f5e96..6efaa95aef1b5 100644 --- a/pandas/tests/extension/base/__init__.py +++ b/pandas/tests/extension/base/__init__.py @@ -85,6 +85,7 @@ class ExtensionTests( BaseReduceTests, BaseReshapingTests, BaseSetitemTests, + Dim2CompatTests, ): pass diff --git a/pandas/tests/extension/base/dim2.py b/pandas/tests/extension/base/dim2.py index a0c24ee068e81..85b3dd2d2b267 100644 --- a/pandas/tests/extension/base/dim2.py +++ b/pandas/tests/extension/base/dim2.py @@ -20,6 +20,17 @@ class Dim2CompatTests: # Note: these are ONLY for ExtensionArray subclasses that support 2D arrays. # i.e. not for pyarrow-backed EAs. + @pytest.fixture(autouse=True) + def skip_if_doesnt_support_2d(self, dtype, request): + if not dtype._supports_2d: + node = request.node + # In cases where we are mixed in to ExtensionTests, we only want to + # skip tests that are defined in Dim2CompatTests + test_func = node._obj + if test_func.__qualname__.startswith("Dim2CompatTests"): + # TODO: is there a less hacky way of checking this? + pytest.skip("Test is only for EAs that support 2D.") + def test_transpose(self, data): arr2d = data.repeat(2).reshape(-1, 2) shape = arr2d.shape
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. The can_fast_transpose bit isn't used but is future-proofing for a time when we have e.g. pyarrow tables backing a 2D EA where transposing isn't cheap. If asked, I'll revert that bit until it is necessary.
https://api.github.com/repos/pandas-dev/pandas/pulls/54832
2023-08-28T23:12:17Z
2023-09-01T00:18:31Z
2023-09-01T00:18:31Z
2023-09-01T01:18:27Z
Shift
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 8f2667d69a322..e7fc83c35f56d 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -587,6 +587,7 @@ Other Deprecations - Deprecated values ``"pad"``, ``"ffill"``, ``"bfill"``, ``"backfill"`` for :meth:`Series.interpolate` and :meth:`DataFrame.interpolate`, use ``obj.ffill()`` or ``obj.bfill()`` instead (:issue:`53581`) - Deprecated the behavior of :meth:`Index.argmax`, :meth:`Index.argmin`, :meth:`Series.argmax`, :meth:`Series.argmin` with either all-NAs and ``skipna=True`` or any-NAs and ``skipna=False`` returning -1; in a future version this will raise ``ValueError`` (:issue:`33941`, :issue:`33942`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_sql` except ``name`` and ``con`` (:issue:`54229`) +- Deprecated silently ignoring ``fill_value`` when passing both ``freq`` and ``fill_value`` to :meth:`DataFrame.shift`, :meth:`Series.shift` and :meth:`.DataFrameGroupBy.shift`; in a future version this will raise ``ValueError`` (:issue:`53832`) .. --------------------------------------------------------------------------- .. _whatsnew_210.performance: @@ -871,7 +872,6 @@ Other - Bug in :meth:`.DataFrameGroupBy.first`, :meth:`.DataFrameGroupBy.last`, :meth:`.SeriesGroupBy.first`, and :meth:`.SeriesGroupBy.last` where an empty group would return ``np.nan`` instead of the corresponding :class:`.ExtensionArray` NA value (:issue:`39098`) - Bug in :meth:`DataFrame.pivot_table` with casting the mean of ints back to an int (:issue:`16676`) - Bug in :meth:`DataFrame.reindex` with a ``fill_value`` that should be inferred with a :class:`ExtensionDtype` incorrectly inferring ``object`` dtype (:issue:`52586`) -- Bug in :meth:`DataFrame.shift` and :meth:`Series.shift` and :meth:`.DataFrameGroupBy.shift` when passing both ``freq`` and ``fill_value`` silently ignoring ``fill_value`` instead of raising ``ValueError`` (:issue:`53832`) - Bug in :meth:`DataFrame.shift` with ``axis=1`` on a :class:`DataFrame` with a single :class:`ExtensionDtype` column giving incorrect results (:issue:`53832`) - Bug in :meth:`Index.sort_values` when a ``key`` is passed (:issue:`52764`) - Bug in :meth:`Series.align`, :meth:`DataFrame.align`, :meth:`Series.reindex`, :meth:`DataFrame.reindex`, :meth:`Series.interpolate`, :meth:`DataFrame.interpolate`, incorrectly failing to raise with method="asfreq" (:issue:`53620`) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 018059ce2784f..997e13e3f0503 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -5636,10 +5636,14 @@ def shift( ) -> DataFrame: if freq is not None and fill_value is not lib.no_default: # GH#53832 - raise ValueError( - "Cannot pass both 'freq' and 'fill_value' to " - f"{type(self).__name__}.shift" + warnings.warn( + "Passing a 'freq' together with a 'fill_value' silently ignores " + "the fill_value and is deprecated. This will raise in a future " + "version.", + FutureWarning, + stacklevel=find_stack_level(), ) + fill_value = lib.no_default axis = self._get_axis_number(axis) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b87772594cfbf..d6ee8ad2cd347 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -10822,10 +10822,14 @@ def shift( if freq is not None and fill_value is not lib.no_default: # GH#53832 - raise ValueError( - "Cannot pass both 'freq' and 'fill_value' to " - f"{type(self).__name__}.shift" + warnings.warn( + "Passing a 'freq' together with a 'fill_value' silently ignores " + "the fill_value and is deprecated. This will raise in a future " + "version.", + FutureWarning, + stacklevel=find_stack_level(), ) + fill_value = lib.no_default if periods == 0: return self.copy(deep=None) diff --git a/pandas/tests/frame/methods/test_shift.py b/pandas/tests/frame/methods/test_shift.py index 808f0cff2485c..54249f3db509c 100644 --- a/pandas/tests/frame/methods/test_shift.py +++ b/pandas/tests/frame/methods/test_shift.py @@ -32,19 +32,23 @@ def test_shift_axis1_with_valid_fill_value_one_array(self): expected2 = DataFrame([12345] * 5, dtype="Float64") tm.assert_frame_equal(res2, expected2) - def test_shift_disallow_freq_and_fill_value(self, frame_or_series): + def test_shift_deprecate_freq_and_fill_value(self, frame_or_series): # Can't pass both! obj = frame_or_series( np.random.default_rng(2).standard_normal(5), index=date_range("1/1/2000", periods=5, freq="H"), ) - msg = "Cannot pass both 'freq' and 'fill_value' to (Series|DataFrame).shift" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the " + "fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): obj.shift(1, fill_value=1, freq="H") if frame_or_series is DataFrame: - with pytest.raises(ValueError, match=msg): + frame_or_series.columns = date_range("1/1/2000", periods=1, freq="H") + with tm.assert_produces_warning(FutureWarning, match=msg): obj.shift(1, axis=1, fill_value=1, freq="H") @pytest.mark.parametrize( diff --git a/pandas/tests/groupby/test_groupby_shift_diff.py b/pandas/tests/groupby/test_groupby_shift_diff.py index 495f3fcd359c7..21a030ca276d4 100644 --- a/pandas/tests/groupby/test_groupby_shift_diff.py +++ b/pandas/tests/groupby/test_groupby_shift_diff.py @@ -166,12 +166,14 @@ def test_shift_periods_freq(): tm.assert_frame_equal(result, expected) -def test_shift_disallow_freq_and_fill_value(): +def test_shift_deprecate_freq_and_fill_value(): # GH 53832 data = {"a": [1, 2, 3, 4, 5, 6], "b": [0, 0, 0, 1, 1, 1]} df = DataFrame(data, index=date_range(start="20100101", periods=6)) - msg = "Cannot pass both 'freq' and 'fill_value' to (Series|DataFrame).shift" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): df.groupby(df.index).shift(periods=-2, freq="D", fill_value="1")
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54830
2023-08-28T21:08:05Z
2023-08-28T22:29:24Z
null
2023-08-28T22:29:24Z
Backport PR #54823 on branch 2.1.x (REGR: clip raising for list-bound)
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index c34df3e0e865c..cdd0545f0a3ec 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -7929,6 +7929,7 @@ def to_series(right): ) elif isinstance(right, Series): # axis=1 is default for DataFrame-with-Series op + axis = axis if axis is not None else 1 if not flex: if not left.axes[axis].equals(right.index): raise ValueError( diff --git a/pandas/tests/frame/methods/test_clip.py b/pandas/tests/frame/methods/test_clip.py index 9bd032a0aefc4..f7b221d84ab78 100644 --- a/pandas/tests/frame/methods/test_clip.py +++ b/pandas/tests/frame/methods/test_clip.py @@ -177,3 +177,14 @@ def test_clip_int_data_with_float_bound(self): result = df.clip(lower=1.5) expected = DataFrame({"a": [1.5, 2.0, 3.0]}) tm.assert_frame_equal(result, expected) + + def test_clip_with_list_bound(self): + # GH#54817 + df = DataFrame([1, 5]) + expected = DataFrame([3, 5]) + result = df.clip([3]) + tm.assert_frame_equal(result, expected) + + expected = DataFrame([1, 3]) + result = df.clip(upper=[3]) + tm.assert_frame_equal(result, expected)
Backport PR #54823: REGR: clip raising for list-bound
https://api.github.com/repos/pandas-dev/pandas/pulls/54829
2023-08-28T21:01:48Z
2023-08-28T22:39:49Z
2023-08-28T22:39:49Z
2023-08-28T22:39:49Z
DOC: update information of parameter value_name of pandas.melt
diff --git a/pandas/core/shared_docs.py b/pandas/core/shared_docs.py index 7579f816d0ace..1fc63dd503467 100644 --- a/pandas/core/shared_docs.py +++ b/pandas/core/shared_docs.py @@ -213,7 +213,7 @@ Name to use for the 'variable' column. If None it uses ``frame.columns.name`` or 'variable'. value_name : scalar, default 'value' - Name to use for the 'value' column. + Name to use for the 'value' column, can't be an existing column label. col_level : int or str, optional If columns are a MultiIndex then use this level to melt. ignore_index : bool, default True
- [x] closes #54715 - [x] *Pre-commit* and *python3 scripts/validate_docstrings.py pandas.melt* were executed with no mistakes The update developed was to add the information of no repeating an already existing column name.
https://api.github.com/repos/pandas-dev/pandas/pulls/54828
2023-08-28T20:58:24Z
2023-08-30T16:47:04Z
2023-08-30T16:47:04Z
2023-09-22T22:03:19Z
Backport PR #54820 on branch 2.1.x (REF: Dispatch ArrowExtensionArray.fillna methods to pad_or_backfill)
diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index 528b085bd5236..70c59e94f6d27 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -40,7 +40,10 @@ from pandas.core.dtypes.dtypes import DatetimeTZDtype from pandas.core.dtypes.missing import isna -from pandas.core import roperator +from pandas.core import ( + missing, + roperator, +) from pandas.core.arraylike import OpsMixin from pandas.core.arrays._arrow_string_mixins import ArrowStringArrayMixin from pandas.core.arrays.base import ( @@ -933,6 +936,20 @@ def pad_or_backfill( # TODO(CoW): Not necessary anymore when CoW is the default return self.copy() + if limit is not None and limit_area is not None: + method = missing.clean_fill_method(method) + try: + if method == "pad": + return type(self)(pc.fill_null_forward(self._pa_array)) + elif method == "backfill": + return type(self)(pc.fill_null_backward(self._pa_array)) + except pa.ArrowNotImplementedError: + # ArrowNotImplementedError: Function 'coalesce' has no kernel + # matching input types (duration[ns], duration[ns]) + # TODO: remove try/except wrapper if/when pyarrow implements + # a kernel for duration types. + pass + # TODO(3.0): after EA.fillna 'method' deprecation is enforced, we can remove # this method entirely. return super().pad_or_backfill( @@ -953,9 +970,12 @@ def fillna( # TODO(CoW): Not necessary anymore when CoW is the default return self.copy() - if limit is not None or method is not None: + if limit is not None: return super().fillna(value=value, method=method, limit=limit, copy=copy) + if method is not None: + return super().pad_or_backfill(method=method, limit=limit, copy=copy) + if isinstance(value, (np.ndarray, ExtensionArray)): # Similar to check_value_size, but we do not mask here since we may # end up passing it to the super() method. @@ -972,12 +992,7 @@ def fillna( raise TypeError(msg) from err try: - if method is None: - return type(self)(pc.fill_null(self._pa_array, fill_value=fill_value)) - elif method == "pad": - return type(self)(pc.fill_null_forward(self._pa_array)) - elif method == "backfill": - return type(self)(pc.fill_null_backward(self._pa_array)) + return type(self)(pc.fill_null(self._pa_array, fill_value=fill_value)) except pa.ArrowNotImplementedError: # ArrowNotImplementedError: Function 'coalesce' has no kernel # matching input types (duration[ns], duration[ns])
Backport PR #54820: REF: Dispatch ArrowExtensionArray.fillna methods to pad_or_backfill
https://api.github.com/repos/pandas-dev/pandas/pulls/54827
2023-08-28T19:56:59Z
2023-08-28T22:29:33Z
2023-08-28T22:29:33Z
2023-08-28T22:29:33Z
Infer large_string type as pyarrow_numpy strings
diff --git a/pandas/core/arrays/string_arrow.py b/pandas/core/arrays/string_arrow.py index cc3bc5900c4c2..769d04bbc02c7 100644 --- a/pandas/core/arrays/string_arrow.py +++ b/pandas/core/arrays/string_arrow.py @@ -448,6 +448,15 @@ def _str_rstrip(self, to_strip=None): class ArrowStringArrayNumpySemantics(ArrowStringArray): _storage = "pyarrow_numpy" + def __init__(self, values) -> None: + _chk_pyarrow_available() + + if isinstance(values, (pa.Array, pa.ChunkedArray)) and pa.types.is_large_string( + values.type + ): + values = pc.cast(values, pa.string()) + super().__init__(values) + @classmethod def _result_converter(cls, values, na=None): if not isna(na): diff --git a/pandas/io/_util.py b/pandas/io/_util.py index 915595833468d..3b2ae5daffdba 100644 --- a/pandas/io/_util.py +++ b/pandas/io/_util.py @@ -28,4 +28,7 @@ def _arrow_dtype_mapping() -> dict: def arrow_string_types_mapper() -> Callable: pa = import_optional_dependency("pyarrow") - return {pa.string(): pd.StringDtype(storage="pyarrow_numpy")}.get + return { + pa.string(): pd.StringDtype(storage="pyarrow_numpy"), + pa.large_string(): pd.StringDtype(storage="pyarrow_numpy"), + }.get diff --git a/pandas/tests/arrays/string_/test_string_arrow.py b/pandas/tests/arrays/string_/test_string_arrow.py index 1ab628f186b47..09f9f788dc3e4 100644 --- a/pandas/tests/arrays/string_/test_string_arrow.py +++ b/pandas/tests/arrays/string_/test_string_arrow.py @@ -12,7 +12,10 @@ StringArray, StringDtype, ) -from pandas.core.arrays.string_arrow import ArrowStringArray +from pandas.core.arrays.string_arrow import ( + ArrowStringArray, + ArrowStringArrayNumpySemantics, +) skip_if_no_pyarrow = pytest.mark.skipif( pa_version_under7p0, @@ -166,6 +169,9 @@ def test_pyarrow_not_installed_raises(): with pytest.raises(ImportError, match=msg): ArrowStringArray([]) + with pytest.raises(ImportError, match=msg): + ArrowStringArrayNumpySemantics([]) + with pytest.raises(ImportError, match=msg): ArrowStringArray._from_sequence(["a", None, "b"]) diff --git a/pandas/tests/io/test_parquet.py b/pandas/tests/io/test_parquet.py index 7c4176fa92361..d8c92c81699cf 100644 --- a/pandas/tests/io/test_parquet.py +++ b/pandas/tests/io/test_parquet.py @@ -1139,6 +1139,25 @@ def test_roundtrip_decimal(self, tmp_path, pa): expected = pd.DataFrame({"a": ["123"]}, dtype="string[python]") tm.assert_frame_equal(result, expected) + def test_infer_string_large_string_type(self, tmp_path, pa): + # GH#54798 + import pyarrow as pa + import pyarrow.parquet as pq + + path = tmp_path / "large_string.p" + + table = pa.table({"a": pa.array([None, "b", "c"], pa.large_string())}) + pq.write_table(table, path) + + with pd.option_context("future.infer_string", True): + result = read_parquet(path) + expected = pd.DataFrame( + data={"a": [None, "b", "c"]}, + dtype="string[pyarrow_numpy]", + columns=pd.Index(["a"], dtype="string[pyarrow_numpy]"), + ) + tm.assert_frame_equal(result, expected) + class TestParquetFastParquet(Base): def test_basic(self, fp, df_full):
- [ ] ref #54798 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. this covers the case where we don't overflow
https://api.github.com/repos/pandas-dev/pandas/pulls/54826
2023-08-28T19:20:47Z
2023-09-02T18:15:52Z
2023-09-02T18:15:52Z
2023-09-02T18:15:55Z
CLN: Remove unused parameter
diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b87772594cfbf..99ca298e292cb 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -10704,7 +10704,6 @@ def shift( freq=None, axis: Axis = 0, fill_value: Hashable = lib.no_default, - suffix: str | None = None, ) -> Self | DataFrame: """ Shift index by desired number of periods with an optional time `freq`. @@ -10741,9 +10740,6 @@ def shift( For numeric data, ``np.nan`` is used. For datetime, timedelta, or period data, etc. :attr:`NaT` is used. For extension dtypes, ``self.dtype.na_value`` is used. - suffix : str, optional - If str and periods is an iterable, this is added after the column - name and before the shift value for each shifted column name. Returns -------
- [ ] closes #54806 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. not urgent, that's not public anyway
https://api.github.com/repos/pandas-dev/pandas/pulls/54825
2023-08-28T19:10:59Z
2023-10-12T16:52:27Z
null
2023-10-12T16:52:27Z
#50990 Increase to_dict('list') performance
diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst index bc66335d74f9b..3c9810598331e 100644 --- a/doc/source/whatsnew/v2.2.0.rst +++ b/doc/source/whatsnew/v2.2.0.rst @@ -157,9 +157,9 @@ Deprecations Performance improvements ~~~~~~~~~~~~~~~~~~~~~~~~ -- Performance improvement in :meth:`DataFrame.sort_index` and :meth:`Series.sort_index` when indexed by a :class:`MultiIndex` (:issue:`54835`, :issue:`54883`) +- Performance improvement in :func:`to_dict` on converting DataFrame to dictionary (:issue:`50990`) +- Performance improvement in :meth:`DataFrame.sort_index` and :meth:`Series.sort_index` when indexed by a :class:`MultiIndex` (:issue:`54835`) - Performance improvement when indexing with more than 4 keys (:issue:`54550`) -- .. --------------------------------------------------------------------------- .. _whatsnew_220.bug_fixes: diff --git a/pandas/core/methods/to_dict.py b/pandas/core/methods/to_dict.py index e89f641e17296..f4e0dcddcd34a 100644 --- a/pandas/core/methods/to_dict.py +++ b/pandas/core/methods/to_dict.py @@ -106,13 +106,13 @@ def to_dict( return into_c((k, v.to_dict(into)) for k, v in df.items()) elif orient == "list": - object_dtype_indices_as_set = set(box_native_indices) + object_dtype_indices_as_set: set[int] = set(box_native_indices) return into_c( ( k, - list(map(maybe_box_native, v.tolist())) + list(map(maybe_box_native, v.to_numpy().tolist())) if i in object_dtype_indices_as_set - else v.tolist(), + else v.to_numpy().tolist(), ) for i, (k, v) in enumerate(df.items()) ) diff --git a/pandas/tests/frame/methods/test_to_dict.py b/pandas/tests/frame/methods/test_to_dict.py index 7bb9518f9b0f9..61f0ad30b4519 100644 --- a/pandas/tests/frame/methods/test_to_dict.py +++ b/pandas/tests/frame/methods/test_to_dict.py @@ -166,6 +166,21 @@ def test_to_dict_not_unique_warning(self): with tm.assert_produces_warning(UserWarning): df.to_dict() + @pytest.mark.filterwarnings("ignore::UserWarning") + @pytest.mark.parametrize( + "orient,expected", + [ + ("list", {"A": [2, 5], "B": [3, 6]}), + ("dict", {"A": {0: 2, 1: 5}, "B": {0: 3, 1: 6}}), + ], + ) + def test_to_dict_not_unique(self, orient, expected): + # GH#54824: This is to make sure that dataframes with non-unique column + # would have uniform behavior throughout different orients + df = DataFrame([[1, 2, 3], [4, 5, 6]], columns=["A", "A", "B"]) + result = df.to_dict(orient) + assert result == expected + # orient - orient argument to to_dict function # item_getter - function for extracting value from # the resulting dict using column name and index
- [x] closes #50990 - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/v2.1.0.rst` file if fixing a bug or adding a new feature. `25.8±2ms 1.61±0.4ms 0.06 frame_methods.ToDict.time_to_dict_datetimelike('list')`
https://api.github.com/repos/pandas-dev/pandas/pulls/54824
2023-08-28T19:07:00Z
2023-09-01T16:55:06Z
2023-09-01T16:55:06Z
2023-09-01T16:55:13Z
REGR: clip raising for list-bound
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 018059ce2784f..3a4e8fdd91362 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -7948,6 +7948,7 @@ def to_series(right): ) elif isinstance(right, Series): # axis=1 is default for DataFrame-with-Series op + axis = axis if axis is not None else 1 if not flex: if not left.axes[axis].equals(right.index): raise ValueError( diff --git a/pandas/tests/frame/methods/test_clip.py b/pandas/tests/frame/methods/test_clip.py index 9bd032a0aefc4..f7b221d84ab78 100644 --- a/pandas/tests/frame/methods/test_clip.py +++ b/pandas/tests/frame/methods/test_clip.py @@ -177,3 +177,14 @@ def test_clip_int_data_with_float_bound(self): result = df.clip(lower=1.5) expected = DataFrame({"a": [1.5, 2.0, 3.0]}) tm.assert_frame_equal(result, expected) + + def test_clip_with_list_bound(self): + # GH#54817 + df = DataFrame([1, 5]) + expected = DataFrame([3, 5]) + result = df.clip([3]) + tm.assert_frame_equal(result, expected) + + expected = DataFrame([1, 3]) + result = df.clip(upper=[3]) + tm.assert_frame_equal(result, expected)
- [ ] closes #54817 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54823
2023-08-28T19:05:29Z
2023-08-28T21:01:39Z
2023-08-28T21:01:39Z
2023-08-28T21:01:42Z
DOC: Removing repeated NA
diff --git a/doc/source/reference/arrays.rst b/doc/source/reference/arrays.rst index 41ddbd048e6c5..fe65364896f54 100644 --- a/doc/source/reference/arrays.rst +++ b/doc/source/reference/arrays.rst @@ -134,11 +134,6 @@ is the missing value for datetime data. Timestamp -.. autosummary:: - :toctree: api/ - - NaT - Properties ~~~~~~~~~~ .. autosummary:: @@ -257,11 +252,6 @@ is the missing value for timedelta data. Timedelta -.. autosummary:: - :toctree: api/ - - NaT - Properties ~~~~~~~~~~ .. autosummary:: @@ -465,7 +455,6 @@ pandas provides this through :class:`arrays.IntegerArray`. UInt16Dtype UInt32Dtype UInt64Dtype - NA .. _api.arrays.float_na: @@ -484,7 +473,6 @@ Nullable float Float32Dtype Float64Dtype - NA .. _api.arrays.categorical: @@ -621,7 +609,6 @@ with a bool :class:`numpy.ndarray`. :template: autosummary/class_without_autosummary.rst BooleanDtype - NA .. Dtype attributes which are manually listed in their docstrings: including diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 6d3ce3d31f005..7da02f7958416 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -53,6 +53,7 @@ are mentioned in the documentation. options extensions testing + missing_value .. This is to prevent warnings in the doc build. We don't want to encourage .. these methods. diff --git a/doc/source/reference/missing_value.rst b/doc/source/reference/missing_value.rst new file mode 100644 index 0000000000000..3bf22aef765d1 --- /dev/null +++ b/doc/source/reference/missing_value.rst @@ -0,0 +1,24 @@ +{{ header }} + +.. _api.missing_value: + +============== +Missing values +============== +.. currentmodule:: pandas + +NA is the way to represent missing values for nullable dtypes (see below): + +.. autosummary:: + :toctree: api/ + :template: autosummary/class_without_autosummary.rst + + NA + +NaT is the missing value for timedelta and datetime data (see below): + +.. autosummary:: + :toctree: api/ + :template: autosummary/class_without_autosummary.rst + + NaT
- [x] closes #53404 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54821
2023-08-28T17:54:29Z
2023-09-29T16:34:43Z
2023-09-29T16:34:43Z
2023-09-29T16:34:44Z
REF: Dispatch ArrowExtensionArray.fillna methods to pad_or_backfill
diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index 528b085bd5236..70c59e94f6d27 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -40,7 +40,10 @@ from pandas.core.dtypes.dtypes import DatetimeTZDtype from pandas.core.dtypes.missing import isna -from pandas.core import roperator +from pandas.core import ( + missing, + roperator, +) from pandas.core.arraylike import OpsMixin from pandas.core.arrays._arrow_string_mixins import ArrowStringArrayMixin from pandas.core.arrays.base import ( @@ -933,6 +936,20 @@ def pad_or_backfill( # TODO(CoW): Not necessary anymore when CoW is the default return self.copy() + if limit is not None and limit_area is not None: + method = missing.clean_fill_method(method) + try: + if method == "pad": + return type(self)(pc.fill_null_forward(self._pa_array)) + elif method == "backfill": + return type(self)(pc.fill_null_backward(self._pa_array)) + except pa.ArrowNotImplementedError: + # ArrowNotImplementedError: Function 'coalesce' has no kernel + # matching input types (duration[ns], duration[ns]) + # TODO: remove try/except wrapper if/when pyarrow implements + # a kernel for duration types. + pass + # TODO(3.0): after EA.fillna 'method' deprecation is enforced, we can remove # this method entirely. return super().pad_or_backfill( @@ -953,9 +970,12 @@ def fillna( # TODO(CoW): Not necessary anymore when CoW is the default return self.copy() - if limit is not None or method is not None: + if limit is not None: return super().fillna(value=value, method=method, limit=limit, copy=copy) + if method is not None: + return super().pad_or_backfill(method=method, limit=limit, copy=copy) + if isinstance(value, (np.ndarray, ExtensionArray)): # Similar to check_value_size, but we do not mask here since we may # end up passing it to the super() method. @@ -972,12 +992,7 @@ def fillna( raise TypeError(msg) from err try: - if method is None: - return type(self)(pc.fill_null(self._pa_array, fill_value=fill_value)) - elif method == "pad": - return type(self)(pc.fill_null_forward(self._pa_array)) - elif method == "backfill": - return type(self)(pc.fill_null_backward(self._pa_array)) + return type(self)(pc.fill_null(self._pa_array, fill_value=fill_value)) except pa.ArrowNotImplementedError: # ArrowNotImplementedError: Function 'coalesce' has no kernel # matching input types (duration[ns], duration[ns])
null
https://api.github.com/repos/pandas-dev/pandas/pulls/54820
2023-08-28T17:38:02Z
2023-08-28T19:56:52Z
2023-08-28T19:56:52Z
2023-08-28T20:08:26Z
Backport PR #54801 on branch 2.1.x (BUG: repr aligning left for string dtype columns)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 19a8500928ab7..8f2667d69a322 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -717,6 +717,7 @@ Conversion Strings ^^^^^^^ - Bug in :meth:`Series.str` that did not raise a ``TypeError`` when iterated (:issue:`54173`) +- Bug in ``repr`` for :class:`DataFrame`` with string-dtype columns (:issue:`54797`) Interval ^^^^^^^^ diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 0db0a3608a1f0..aa306da017d34 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1419,8 +1419,8 @@ def _format_with_header(self, header: list[str_t], na_rep: str_t) -> list[str_t] values = self._values - if is_object_dtype(values.dtype): - values = cast(np.ndarray, values) + if is_object_dtype(values.dtype) or is_string_dtype(values.dtype): + values = np.asarray(values) values = lib.maybe_convert_objects(values, safe=True) result = [pprint_thing(x, escape_chars=("\t", "\r", "\n")) for x in values] diff --git a/pandas/tests/frame/test_repr_info.py b/pandas/tests/frame/test_repr_info.py index 49375658abfee..64d516e484991 100644 --- a/pandas/tests/frame/test_repr_info.py +++ b/pandas/tests/frame/test_repr_info.py @@ -455,3 +455,14 @@ def test_masked_ea_with_formatter(self): 0 0.12 1.00 1 1.12 2.00""" assert result == expected + + def test_repr_ea_columns(self, any_string_dtype): + # GH#54797 + pytest.importorskip("pyarrow") + df = DataFrame({"long_column_name": [1, 2, 3], "col2": [4, 5, 6]}) + df.columns = df.columns.astype(any_string_dtype) + expected = """ long_column_name col2 +0 1 4 +1 2 5 +2 3 6""" + assert repr(df) == expected
Backport PR #54801: BUG: repr aligning left for string dtype columns
https://api.github.com/repos/pandas-dev/pandas/pulls/54819
2023-08-28T17:35:23Z
2023-08-28T19:36:41Z
2023-08-28T19:36:41Z
2023-08-28T19:36:41Z
DEP: Deprecate passing fill_value and freq to shift
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 8f2667d69a322..e7fc83c35f56d 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -587,6 +587,7 @@ Other Deprecations - Deprecated values ``"pad"``, ``"ffill"``, ``"bfill"``, ``"backfill"`` for :meth:`Series.interpolate` and :meth:`DataFrame.interpolate`, use ``obj.ffill()`` or ``obj.bfill()`` instead (:issue:`53581`) - Deprecated the behavior of :meth:`Index.argmax`, :meth:`Index.argmin`, :meth:`Series.argmax`, :meth:`Series.argmin` with either all-NAs and ``skipna=True`` or any-NAs and ``skipna=False`` returning -1; in a future version this will raise ``ValueError`` (:issue:`33941`, :issue:`33942`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_sql` except ``name`` and ``con`` (:issue:`54229`) +- Deprecated silently ignoring ``fill_value`` when passing both ``freq`` and ``fill_value`` to :meth:`DataFrame.shift`, :meth:`Series.shift` and :meth:`.DataFrameGroupBy.shift`; in a future version this will raise ``ValueError`` (:issue:`53832`) .. --------------------------------------------------------------------------- .. _whatsnew_210.performance: @@ -871,7 +872,6 @@ Other - Bug in :meth:`.DataFrameGroupBy.first`, :meth:`.DataFrameGroupBy.last`, :meth:`.SeriesGroupBy.first`, and :meth:`.SeriesGroupBy.last` where an empty group would return ``np.nan`` instead of the corresponding :class:`.ExtensionArray` NA value (:issue:`39098`) - Bug in :meth:`DataFrame.pivot_table` with casting the mean of ints back to an int (:issue:`16676`) - Bug in :meth:`DataFrame.reindex` with a ``fill_value`` that should be inferred with a :class:`ExtensionDtype` incorrectly inferring ``object`` dtype (:issue:`52586`) -- Bug in :meth:`DataFrame.shift` and :meth:`Series.shift` and :meth:`.DataFrameGroupBy.shift` when passing both ``freq`` and ``fill_value`` silently ignoring ``fill_value`` instead of raising ``ValueError`` (:issue:`53832`) - Bug in :meth:`DataFrame.shift` with ``axis=1`` on a :class:`DataFrame` with a single :class:`ExtensionDtype` column giving incorrect results (:issue:`53832`) - Bug in :meth:`Index.sort_values` when a ``key`` is passed (:issue:`52764`) - Bug in :meth:`Series.align`, :meth:`DataFrame.align`, :meth:`Series.reindex`, :meth:`DataFrame.reindex`, :meth:`Series.interpolate`, :meth:`DataFrame.interpolate`, incorrectly failing to raise with method="asfreq" (:issue:`53620`) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 018059ce2784f..997e13e3f0503 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -5636,10 +5636,14 @@ def shift( ) -> DataFrame: if freq is not None and fill_value is not lib.no_default: # GH#53832 - raise ValueError( - "Cannot pass both 'freq' and 'fill_value' to " - f"{type(self).__name__}.shift" + warnings.warn( + "Passing a 'freq' together with a 'fill_value' silently ignores " + "the fill_value and is deprecated. This will raise in a future " + "version.", + FutureWarning, + stacklevel=find_stack_level(), ) + fill_value = lib.no_default axis = self._get_axis_number(axis) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b87772594cfbf..d6ee8ad2cd347 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -10822,10 +10822,14 @@ def shift( if freq is not None and fill_value is not lib.no_default: # GH#53832 - raise ValueError( - "Cannot pass both 'freq' and 'fill_value' to " - f"{type(self).__name__}.shift" + warnings.warn( + "Passing a 'freq' together with a 'fill_value' silently ignores " + "the fill_value and is deprecated. This will raise in a future " + "version.", + FutureWarning, + stacklevel=find_stack_level(), ) + fill_value = lib.no_default if periods == 0: return self.copy(deep=None) diff --git a/pandas/tests/frame/methods/test_shift.py b/pandas/tests/frame/methods/test_shift.py index 808f0cff2485c..1e88152137b1f 100644 --- a/pandas/tests/frame/methods/test_shift.py +++ b/pandas/tests/frame/methods/test_shift.py @@ -32,19 +32,23 @@ def test_shift_axis1_with_valid_fill_value_one_array(self): expected2 = DataFrame([12345] * 5, dtype="Float64") tm.assert_frame_equal(res2, expected2) - def test_shift_disallow_freq_and_fill_value(self, frame_or_series): + def test_shift_deprecate_freq_and_fill_value(self, frame_or_series): # Can't pass both! obj = frame_or_series( np.random.default_rng(2).standard_normal(5), index=date_range("1/1/2000", periods=5, freq="H"), ) - msg = "Cannot pass both 'freq' and 'fill_value' to (Series|DataFrame).shift" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the " + "fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): obj.shift(1, fill_value=1, freq="H") if frame_or_series is DataFrame: - with pytest.raises(ValueError, match=msg): + obj.columns = date_range("1/1/2000", periods=1, freq="H") + with tm.assert_produces_warning(FutureWarning, match=msg): obj.shift(1, axis=1, fill_value=1, freq="H") @pytest.mark.parametrize( @@ -716,8 +720,11 @@ def test_shift_with_iterable_freq_and_fill_value(self): df.shift(1, freq="H"), ) - msg = r"Cannot pass both 'freq' and 'fill_value' to.*" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the " + "fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): df.shift([1, 2], fill_value=1, freq="H") def test_shift_with_iterable_check_other_arguments(self): diff --git a/pandas/tests/groupby/test_groupby_shift_diff.py b/pandas/tests/groupby/test_groupby_shift_diff.py index 495f3fcd359c7..bb4b9aa866ac9 100644 --- a/pandas/tests/groupby/test_groupby_shift_diff.py +++ b/pandas/tests/groupby/test_groupby_shift_diff.py @@ -166,12 +166,14 @@ def test_shift_periods_freq(): tm.assert_frame_equal(result, expected) -def test_shift_disallow_freq_and_fill_value(): +def test_shift_deprecate_freq_and_fill_value(): # GH 53832 data = {"a": [1, 2, 3, 4, 5, 6], "b": [0, 0, 0, 1, 1, 1]} df = DataFrame(data, index=date_range(start="20100101", periods=6)) - msg = "Cannot pass both 'freq' and 'fill_value' to (Series|DataFrame).shift" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): df.groupby(df.index).shift(periods=-2, freq="D", fill_value="1") @@ -238,12 +240,15 @@ def test_group_shift_with_multiple_periods_and_fill_value(): tm.assert_frame_equal(shifted_df, expected_df) -def test_group_shift_with_multiple_periods_and_both_fill_and_freq_fails(): +def test_group_shift_with_multiple_periods_and_both_fill_and_freq_deprecated(): # GH#44424 df = DataFrame( {"a": [1, 2, 3, 4, 5], "b": [True, True, False, False, True]}, index=date_range("1/1/2000", periods=5, freq="H"), ) - msg = r"Cannot pass both 'freq' and 'fill_value' to.*" - with pytest.raises(ValueError, match=msg): + msg = ( + "Passing a 'freq' together with a 'fill_value' silently ignores the " + "fill_value" + ) + with tm.assert_produces_warning(FutureWarning, match=msg): df.groupby("b")[["a"]].shift([1, 2], fill_value=1, freq="H")
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. see #53832
https://api.github.com/repos/pandas-dev/pandas/pulls/54818
2023-08-28T17:34:18Z
2023-08-29T14:44:02Z
2023-08-29T14:44:02Z
2023-08-29T14:44:05Z
Fix minor cython warning
diff --git a/pandas/_libs/writers.pyx b/pandas/_libs/writers.pyx index bd5c0290b2879..48eedd1fd1af6 100644 --- a/pandas/_libs/writers.pyx +++ b/pandas/_libs/writers.pyx @@ -1,4 +1,5 @@ cimport cython +from cython cimport Py_ssize_t import numpy as np from cpython cimport (
Fixes ``` 2023-08-26T19:21:26.6203637Z warning: /home/runner/work/pandas/pandas/pandas/_libs/writers.pyx:123:50: Unknown type declaration 'Py_ssize_t' in annotation, ignoring 2023-08-26T19:21:26.6253780Z warning: /home/runner/work/pandas/pandas/pandas/_libs/writers.pyx:123:50: Unknown type declaration 'Py_ssize_t' in annotation, ignoring 2023-08-26T19:21:26.6254699Z warning: /home/runner/work/pandas/pandas/pandas/_libs/writers.pyx:123:50: Unknown type declaration 'Py_ssize_t' in annotation, ignoring ```
https://api.github.com/repos/pandas-dev/pandas/pulls/54816
2023-08-28T16:10:42Z
2023-08-28T19:35:34Z
2023-08-28T19:35:34Z
2023-08-28T19:35:37Z
DOC: added docstring for `storage_options` in `read_html`
diff --git a/pandas/io/html.py b/pandas/io/html.py index 8a73c786825e3..10701be4f7e0b 100644 --- a/pandas/io/html.py +++ b/pandas/io/html.py @@ -23,6 +23,7 @@ AbstractMethodError, EmptyDataError, ) +from pandas.util._decorators import doc from pandas.util._exceptions import find_stack_level from pandas.util._validators import check_dtype_backend @@ -32,6 +33,7 @@ from pandas.core.indexes.base import Index from pandas.core.indexes.multi import MultiIndex from pandas.core.series import Series +from pandas.core.shared_docs import _shared_docs from pandas.io.common import ( file_exists, @@ -363,13 +365,13 @@ def _parse_tfoot_tr(self, table): """ raise AbstractMethodError(self) - def _parse_tables(self, doc, match, attrs): + def _parse_tables(self, document, match, attrs): """ Return all tables from the parsed DOM. Parameters ---------- - doc : the DOM from which to parse the table element. + document : the DOM from which to parse the table element. match : str or regular expression The text to search for in the DOM tree. @@ -594,9 +596,9 @@ def __init__(self, *args, **kwargs) -> None: self._strainer = SoupStrainer("table") - def _parse_tables(self, doc, match, attrs): + def _parse_tables(self, document, match, attrs): element_name = self._strainer.name - tables = doc.find_all(element_name, attrs=attrs) + tables = document.find_all(element_name, attrs=attrs) if not tables: raise ValueError("No tables found") @@ -726,7 +728,7 @@ def _parse_td(self, row): # <thead> or <tfoot> (see _parse_thead_tr). return row.xpath("./td|./th") - def _parse_tables(self, doc, match, kwargs): + def _parse_tables(self, document, match, kwargs): pattern = match.pattern # 1. check all descendants for the given pattern and only search tables @@ -738,7 +740,7 @@ def _parse_tables(self, doc, match, kwargs): if kwargs: xpath_expr += _build_xpath_expr(kwargs) - tables = doc.xpath(xpath_expr, namespaces=_re_namespace) + tables = document.xpath(xpath_expr, namespaces=_re_namespace) tables = self._handle_hidden_tables(tables, "attrib") if self.displayed_only: @@ -1026,6 +1028,7 @@ def _parse( return ret +@doc(storage_options=_shared_docs["storage_options"]) def read_html( io: FilePath | ReadBuffer[str], *, @@ -1096,13 +1099,13 @@ def read_html( passed to lxml or Beautiful Soup. However, these attributes must be valid HTML table attributes to work correctly. For example, :: - attrs = {'id': 'table'} + attrs = {{'id': 'table'}} is a valid attribute dictionary because the 'id' HTML tag attribute is a valid HTML attribute for *any* HTML tag as per `this document <https://html.spec.whatwg.org/multipage/dom.html#global-attributes>`__. :: - attrs = {'asdf': 'table'} + attrs = {{'asdf': 'table'}} is *not* a valid attribute dictionary because 'asdf' is not a valid HTML attribute even if it is a valid XML attribute. Valid HTML 4.01 @@ -1144,13 +1147,13 @@ def read_html( displayed_only : bool, default True Whether elements with "display: none" should be parsed. - extract_links : {None, "all", "header", "body", "footer"} + extract_links : {{None, "all", "header", "body", "footer"}} Table elements in the specified section(s) with <a> tags will have their href extracted. .. versionadded:: 1.5.0 - dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable' + dtype_backend : {{'numpy_nullable', 'pyarrow'}}, default 'numpy_nullable' Back-end data type applied to the resultant :class:`DataFrame` (still experimental). Behaviour is as follows: @@ -1161,6 +1164,10 @@ def read_html( .. versionadded:: 2.0 + {storage_options} + + .. versionadded:: 2.1.0 + Returns ------- dfs
- [x] closes #54772 - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions.
https://api.github.com/repos/pandas-dev/pandas/pulls/54815
2023-08-28T15:32:10Z
2023-08-29T16:06:40Z
2023-08-29T16:06:40Z
2023-08-29T16:06:47Z
Backport PR #54803 on branch 2.1.x (DOC: update docstrings for ffill and bfill (no longer aliases for fillna with method))
diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b4281f6959997..fce9b35aa5c49 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7079,6 +7079,8 @@ def fillna( See Also -------- + ffill : Fill values by propagating the last valid observation to next valid. + bfill : Fill values by using the next valid observation to fill the gap. interpolate : Fill NaN values using interpolation. reindex : Conform object to new index. asfreq : Convert TimeSeries to specified frequency. @@ -7338,7 +7340,10 @@ def ffill( ... @final - @doc(klass=_shared_doc_kwargs["klass"]) + @doc( + klass=_shared_doc_kwargs["klass"], + axes_single_arg=_shared_doc_kwargs["axes_single_arg"], + ) def ffill( self, *, @@ -7350,6 +7355,27 @@ def ffill( """ Fill NA/NaN values by propagating the last valid observation to next valid. + Parameters + ---------- + axis : {axes_single_arg} + Axis along which to fill missing values. For `Series` + this parameter is unused and defaults to 0. + inplace : bool, default False + If True, fill in-place. Note: this will modify any + other views on this object (e.g., a no-copy slice for a column in a + DataFrame). + limit : int, default None + If method is specified, this is the maximum number of consecutive + NaN values to forward/backward fill. In other words, if there is + a gap with more than this number of consecutive NaNs, it will only + be partially filled. If method is not specified, this is the + maximum number of entries along the entire axis where NaNs will be + filled. Must be greater than 0 if not None. + downcast : dict, default is None + A dict of item->dtype of what to downcast if possible, + or the string 'infer' which will try to downcast to an appropriate + equal type (e.g. float64 to int64 if possible). + Returns ------- {klass} or None @@ -7417,7 +7443,7 @@ def pad( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='ffill'``. + Fill NA/NaN values by propagating the last valid observation to next valid. .. deprecated:: 2.0 @@ -7474,7 +7500,10 @@ def bfill( ... @final - @doc(klass=_shared_doc_kwargs["klass"]) + @doc( + klass=_shared_doc_kwargs["klass"], + axes_single_arg=_shared_doc_kwargs["axes_single_arg"], + ) def bfill( self, *, @@ -7484,7 +7513,28 @@ def bfill( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='bfill'``. + Fill NA/NaN values by using the next valid observation to fill the gap. + + Parameters + ---------- + axis : {axes_single_arg} + Axis along which to fill missing values. For `Series` + this parameter is unused and defaults to 0. + inplace : bool, default False + If True, fill in-place. Note: this will modify any + other views on this object (e.g., a no-copy slice for a column in a + DataFrame). + limit : int, default None + If method is specified, this is the maximum number of consecutive + NaN values to forward/backward fill. In other words, if there is + a gap with more than this number of consecutive NaNs, it will only + be partially filled. If method is not specified, this is the + maximum number of entries along the entire axis where NaNs will be + filled. Must be greater than 0 if not None. + downcast : dict, default is None + A dict of item->dtype of what to downcast if possible, + or the string 'infer' which will try to downcast to an appropriate + equal type (e.g. float64 to int64 if possible). Returns ------- @@ -7563,7 +7613,7 @@ def backfill( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='bfill'``. + Fill NA/NaN values by using the next valid observation to fill the gap. .. deprecated:: 2.0
Backport PR #54803: DOC: update docstrings for ffill and bfill (no longer aliases for fillna with method)
https://api.github.com/repos/pandas-dev/pandas/pulls/54814
2023-08-28T15:25:51Z
2023-08-28T17:26:21Z
2023-08-28T17:26:21Z
2023-08-28T17:26:21Z
Backport PR #54778 on branch 2.1.x (REGR: Index.union loses python string dtype)
diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 1f15a4ad84755..0db0a3608a1f0 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -5204,7 +5204,7 @@ def _from_join_target(self, result: np.ndarray) -> ArrayLike: """ if isinstance(self.values, BaseMaskedArray): return type(self.values)(result, np.zeros(result.shape, dtype=np.bool_)) - elif isinstance(self.values, ArrowExtensionArray): + elif isinstance(self.values, (ArrowExtensionArray, StringArray)): return type(self.values)._from_sequence(result) return result diff --git a/pandas/tests/indexes/test_setops.py b/pandas/tests/indexes/test_setops.py index 2fd203dbc77ed..a64994efec85a 100644 --- a/pandas/tests/indexes/test_setops.py +++ b/pandas/tests/indexes/test_setops.py @@ -899,3 +899,10 @@ def test_union_ea_dtypes(self, any_numeric_ea_and_arrow_dtype): result = idx.union(idx2) expected = Index([1, 2, 3, 4, 5], dtype=any_numeric_ea_and_arrow_dtype) tm.assert_index_equal(result, expected) + + def test_union_string_array(self, any_string_dtype): + idx1 = Index(["a"], dtype=any_string_dtype) + idx2 = Index(["b"], dtype=any_string_dtype) + result = idx1.union(idx2) + expected = Index(["a", "b"], dtype=any_string_dtype) + tm.assert_index_equal(result, expected)
Backport PR #54778: REGR: Index.union loses python string dtype
https://api.github.com/repos/pandas-dev/pandas/pulls/54813
2023-08-28T15:16:48Z
2023-08-28T17:25:59Z
2023-08-28T17:25:59Z
2023-08-28T17:26:00Z
Backport PR #54800 on branch 2.1.x (ExtensionArray.fillna: start with DeprecationWarning about added copy keyword)
diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index 7e647426e9726..a33c5d9303421 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -2015,7 +2015,7 @@ def fillna( "need to implement this keyword or an exception will be " "raised. In the interim, the keyword is ignored by " f"{type(self.values).__name__}.", - FutureWarning, + DeprecationWarning, stacklevel=find_stack_level(), ) diff --git a/pandas/tests/extension/decimal/test_decimal.py b/pandas/tests/extension/decimal/test_decimal.py index baa056550624f..17dfc4e801ca0 100644 --- a/pandas/tests/extension/decimal/test_decimal.py +++ b/pandas/tests/extension/decimal/test_decimal.py @@ -133,7 +133,7 @@ def test_arith_series_with_array(self, data, all_arithmetic_operators): def test_fillna_frame(self, data_missing): msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, match=msg, check_stacklevel=False ): super().test_fillna_frame(data_missing) @@ -166,7 +166,7 @@ def test_fillna_no_op_returns_copy(self, data): def test_fillna_series(self, data_missing): msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, match=msg, check_stacklevel=False ): super().test_fillna_series(data_missing) @@ -178,13 +178,13 @@ def test_fillna_series_method(self, data_missing, fillna_method): super().test_fillna_series_method(data_missing, fillna_method) def test_fillna_copy_frame(self, data_missing, using_copy_on_write): - warn = FutureWarning if not using_copy_on_write else None + warn = DeprecationWarning if not using_copy_on_write else None msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning(warn, match=msg, check_stacklevel=False): super().test_fillna_copy_frame(data_missing) def test_fillna_copy_series(self, data_missing, using_copy_on_write): - warn = FutureWarning if not using_copy_on_write else None + warn = DeprecationWarning if not using_copy_on_write else None msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning(warn, match=msg, check_stacklevel=False): super().test_fillna_copy_series(data_missing)
Backport PR #54800: ExtensionArray.fillna: start with DeprecationWarning about added copy keyword
https://api.github.com/repos/pandas-dev/pandas/pulls/54812
2023-08-28T15:10:43Z
2023-08-28T17:25:37Z
2023-08-28T17:25:37Z
2023-08-28T17:25:37Z
ERR: improve setitem error message for DatetimeArray
diff --git a/pandas/core/arrays/datetimelike.py b/pandas/core/arrays/datetimelike.py index c3b8d1c0e79e8..61946caa3c142 100644 --- a/pandas/core/arrays/datetimelike.py +++ b/pandas/core/arrays/datetimelike.py @@ -625,15 +625,19 @@ def _validation_error_message(self, value, allow_listlike: bool = False) -> str: ------- str """ + if hasattr(value, "dtype") and getattr(value, "ndim", 0) > 0: + msg_got = f"{value.dtype} array" + else: + msg_got = f"'{type(value).__name__}'" if allow_listlike: msg = ( f"value should be a '{self._scalar_type.__name__}', 'NaT', " - f"or array of those. Got '{type(value).__name__}' instead." + f"or array of those. Got {msg_got} instead." ) else: msg = ( f"value should be a '{self._scalar_type.__name__}' or 'NaT'. " - f"Got '{type(value).__name__}' instead." + f"Got {msg_got} instead." ) return msg diff --git a/pandas/tests/arrays/test_datetimelike.py b/pandas/tests/arrays/test_datetimelike.py index 20530e37116f2..bd03e0698d667 100644 --- a/pandas/tests/arrays/test_datetimelike.py +++ b/pandas/tests/arrays/test_datetimelike.py @@ -324,19 +324,12 @@ def test_searchsorted_castable_strings(self, arr1d, box, string_storage): ): arr.searchsorted("foo") - if string_storage == "python": - arr_type = "StringArray" - elif string_storage == "pyarrow": - arr_type = "ArrowStringArray" - else: - arr_type = "ArrowStringArrayNumpySemantics" - with pd.option_context("string_storage", string_storage): with pytest.raises( TypeError, match=re.escape( f"value should be a '{arr1d._scalar_type.__name__}', 'NaT', " - f"or array of those. Got '{arr_type}' instead." + "or array of those. Got string array instead." ), ): arr.searchsorted([str(arr[1]), "baz"])
This is a small detail, but currently we see this kind of error message: ```python >>> ser = pd.Series(pd.arrays.DatetimeArray(np.arange(10, dtype="i8") * 24 * 3600 * 10**9)) >>> ser.searchsorted(["foo", "baz"]) TypeError: value should be a 'Timestamp', 'NaT', or array of those. Got 'StringArray' instead. >>> ser.searchsorted(np.array([1, 2, 3])) TypeError: value should be a 'Timestamp', 'NaT', or array of those. Got 'IntegerArray' instead. >>> pd.options.mode.string_storage = "pyarrow_numpy" >>> ser.searchsorted(["foo", "baz"]) TypeError: value should be a 'Timestamp', 'NaT', or array of those. Got 'ArrowStringArrayNumpySemantics' instead. ``` (and same error message is used for the array's `__setitem__`) I personally don't like that the error message uses the array class names (those are not exactly private, but still not something users typically have to work with directly), and I think in general we should try to write our messages in a more generic, user-friendly way (what the user wants to know here is that they provided data of a wrong data type). With this small PR, the above message become the following, respectively: ``` TypeError: value should be a 'Timestamp', 'NaT', or array of those. Got string array instead. TypeError: value should be a 'Timestamp', 'NaT', or array of those. Got Int64 array instead. TypeError: value should be a 'Timestamp', 'NaT', or array of those. Got string array instead. ``` (and as a bonus, the testing actually became easier)
https://api.github.com/repos/pandas-dev/pandas/pulls/54809
2023-08-28T13:38:57Z
2023-08-29T16:08:19Z
2023-08-29T16:08:19Z
2023-08-29T16:08:25Z
Removed whitespace in README.md
diff --git a/README.md b/README.md index 6fa20d237babe..52d2e134e18a2 100644 --- a/README.md +++ b/README.md @@ -167,9 +167,7 @@ There are also frequent [community meetings](https://pandas.pydata.org/docs/dev/ Additional information on the communication channels can be found on the [contributor community](https://pandas.pydata.org/docs/development/community.html) page. ## Contributing to pandas - [![Open Source Helpers](https://www.codetriage.com/pandas-dev/pandas/badges/users.svg)](https://www.codetriage.com/pandas-dev/pandas) - All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. A detailed overview on how to contribute can be found in the **[contributing guide](https://pandas.pydata.org/docs/dev/development/contributing.html)**.
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54804
2023-08-28T12:29:56Z
2023-08-28T12:33:23Z
null
2023-08-28T12:33:23Z
DOC: update docstrings for ffill and bfill (no longer aliases for fillna with method)
diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 021725899a1bb..b87772594cfbf 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7099,6 +7099,8 @@ def fillna( See Also -------- + ffill : Fill values by propagating the last valid observation to next valid. + bfill : Fill values by using the next valid observation to fill the gap. interpolate : Fill NaN values using interpolation. reindex : Conform object to new index. asfreq : Convert TimeSeries to specified frequency. @@ -7358,7 +7360,10 @@ def ffill( ... @final - @doc(klass=_shared_doc_kwargs["klass"]) + @doc( + klass=_shared_doc_kwargs["klass"], + axes_single_arg=_shared_doc_kwargs["axes_single_arg"], + ) def ffill( self, *, @@ -7370,6 +7375,27 @@ def ffill( """ Fill NA/NaN values by propagating the last valid observation to next valid. + Parameters + ---------- + axis : {axes_single_arg} + Axis along which to fill missing values. For `Series` + this parameter is unused and defaults to 0. + inplace : bool, default False + If True, fill in-place. Note: this will modify any + other views on this object (e.g., a no-copy slice for a column in a + DataFrame). + limit : int, default None + If method is specified, this is the maximum number of consecutive + NaN values to forward/backward fill. In other words, if there is + a gap with more than this number of consecutive NaNs, it will only + be partially filled. If method is not specified, this is the + maximum number of entries along the entire axis where NaNs will be + filled. Must be greater than 0 if not None. + downcast : dict, default is None + A dict of item->dtype of what to downcast if possible, + or the string 'infer' which will try to downcast to an appropriate + equal type (e.g. float64 to int64 if possible). + Returns ------- {klass} or None @@ -7437,7 +7463,7 @@ def pad( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='ffill'``. + Fill NA/NaN values by propagating the last valid observation to next valid. .. deprecated:: 2.0 @@ -7494,7 +7520,10 @@ def bfill( ... @final - @doc(klass=_shared_doc_kwargs["klass"]) + @doc( + klass=_shared_doc_kwargs["klass"], + axes_single_arg=_shared_doc_kwargs["axes_single_arg"], + ) def bfill( self, *, @@ -7504,7 +7533,28 @@ def bfill( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='bfill'``. + Fill NA/NaN values by using the next valid observation to fill the gap. + + Parameters + ---------- + axis : {axes_single_arg} + Axis along which to fill missing values. For `Series` + this parameter is unused and defaults to 0. + inplace : bool, default False + If True, fill in-place. Note: this will modify any + other views on this object (e.g., a no-copy slice for a column in a + DataFrame). + limit : int, default None + If method is specified, this is the maximum number of consecutive + NaN values to forward/backward fill. In other words, if there is + a gap with more than this number of consecutive NaNs, it will only + be partially filled. If method is not specified, this is the + maximum number of entries along the entire axis where NaNs will be + filled. Must be greater than 0 if not None. + downcast : dict, default is None + A dict of item->dtype of what to downcast if possible, + or the string 'infer' which will try to downcast to an appropriate + equal type (e.g. float64 to int64 if possible). Returns ------- @@ -7583,7 +7633,7 @@ def backfill( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='bfill'``. + Fill NA/NaN values by using the next valid observation to fill the gap. .. deprecated:: 2.0
Follow-up on https://github.com/pandas-dev/pandas/pull/54728 to do the same for `bfill`, and also updated both `ffill` and `bfill` to include the parameter section (now that only lived in fillna)
https://api.github.com/repos/pandas-dev/pandas/pulls/54803
2023-08-28T12:16:37Z
2023-08-28T15:25:43Z
2023-08-28T15:25:43Z
2023-08-28T15:26:41Z
Revert "MAINT: small simplification of meson.build following best practices"
diff --git a/meson.build b/meson.build index e16f565d491fe..09a1494135af4 100644 --- a/meson.build +++ b/meson.build @@ -2,7 +2,7 @@ project( 'pandas', 'c', 'cpp', 'cython', - version: run_command(['python3', 'generate_version.py', '--print'], check: true).stdout().strip(), + version: run_command(['python', 'generate_version.py', '--print'], check: true).stdout().strip(), license: 'BSD-3', meson_version: '>=1.0.1', default_options: [
Reverts pandas-dev/pandas#54737 cc @lithomas1
https://api.github.com/repos/pandas-dev/pandas/pulls/54802
2023-08-28T12:13:49Z
2023-08-28T17:36:01Z
2023-08-28T17:36:01Z
2023-08-28T17:36:07Z
BUG: repr aligning left for string dtype columns
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 19a8500928ab7..8f2667d69a322 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -717,6 +717,7 @@ Conversion Strings ^^^^^^^ - Bug in :meth:`Series.str` that did not raise a ``TypeError`` when iterated (:issue:`54173`) +- Bug in ``repr`` for :class:`DataFrame`` with string-dtype columns (:issue:`54797`) Interval ^^^^^^^^ diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index a49db84450bb3..4e037cc3e8626 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1396,8 +1396,8 @@ def _format_with_header(self, header: list[str_t], na_rep: str_t) -> list[str_t] values = self._values - if is_object_dtype(values.dtype): - values = cast(np.ndarray, values) + if is_object_dtype(values.dtype) or is_string_dtype(values.dtype): + values = np.asarray(values) values = lib.maybe_convert_objects(values, safe=True) result = [pprint_thing(x, escape_chars=("\t", "\r", "\n")) for x in values] diff --git a/pandas/tests/frame/test_repr_info.py b/pandas/tests/frame/test_repr_info.py index 49375658abfee..64d516e484991 100644 --- a/pandas/tests/frame/test_repr_info.py +++ b/pandas/tests/frame/test_repr_info.py @@ -455,3 +455,14 @@ def test_masked_ea_with_formatter(self): 0 0.12 1.00 1 1.12 2.00""" assert result == expected + + def test_repr_ea_columns(self, any_string_dtype): + # GH#54797 + pytest.importorskip("pyarrow") + df = DataFrame({"long_column_name": [1, 2, 3], "col2": [4, 5, 6]}) + df.columns = df.columns.astype(any_string_dtype) + expected = """ long_column_name col2 +0 1 4 +1 2 5 +2 3 6""" + assert repr(df) == expected
- [ ] closes #54797 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. cc @jorisvandenbossche this is a bit hacky, but changing format_array breaks index-related stuff. Don't feel comfortable to do this now, can be a follow up (we are casting to object anyway, so this does not impact performance)
https://api.github.com/repos/pandas-dev/pandas/pulls/54801
2023-08-28T12:09:21Z
2023-08-28T17:35:15Z
2023-08-28T17:35:15Z
2023-08-28T17:35:18Z
ExtensionArray.fillna: start with DeprecationWarning about added copy keyword
diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index 12380752c198e..3b27f7e2eb80c 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -2008,7 +2008,7 @@ def fillna( "need to implement this keyword or an exception will be " "raised. In the interim, the keyword is ignored by " f"{type(self.values).__name__}.", - FutureWarning, + DeprecationWarning, stacklevel=find_stack_level(), ) diff --git a/pandas/tests/extension/decimal/test_decimal.py b/pandas/tests/extension/decimal/test_decimal.py index 2f274354f0da0..acc82ecd9301a 100644 --- a/pandas/tests/extension/decimal/test_decimal.py +++ b/pandas/tests/extension/decimal/test_decimal.py @@ -133,7 +133,7 @@ def test_arith_series_with_array(self, data, all_arithmetic_operators): def test_fillna_frame(self, data_missing): msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, match=msg, check_stacklevel=False ): super().test_fillna_frame(data_missing) @@ -166,7 +166,7 @@ def test_fillna_no_op_returns_copy(self, data): def test_fillna_series(self, data_missing): msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning( - FutureWarning, match=msg, check_stacklevel=False + DeprecationWarning, match=msg, check_stacklevel=False ): super().test_fillna_series(data_missing) @@ -178,13 +178,13 @@ def test_fillna_series_method(self, data_missing, fillna_method): super().test_fillna_series_method(data_missing, fillna_method) def test_fillna_copy_frame(self, data_missing, using_copy_on_write): - warn = FutureWarning if not using_copy_on_write else None + warn = DeprecationWarning if not using_copy_on_write else None msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning(warn, match=msg, check_stacklevel=False): super().test_fillna_copy_frame(data_missing) def test_fillna_copy_series(self, data_missing, using_copy_on_write): - warn = FutureWarning if not using_copy_on_write else None + warn = DeprecationWarning if not using_copy_on_write else None msg = "ExtensionArray.fillna added a 'copy' keyword" with tm.assert_produces_warning(warn, match=msg, check_stacklevel=False): super().test_fillna_copy_series(data_missing)
Follow-up on https://github.com/pandas-dev/pandas/pull/53728, changing the FutureWarning to DeprecationWarning. This warning is targetting EA authors, not end users, and thus we should start with a DeprecationWarning.
https://api.github.com/repos/pandas-dev/pandas/pulls/54800
2023-08-28T11:57:56Z
2023-08-28T15:10:35Z
2023-08-28T15:10:35Z
2023-08-28T15:10:38Z
Backport PR #54737 on branch 2.1.x (MAINT: small simplification of meson.build following best practices)
diff --git a/meson.build b/meson.build index a927b59abeaf9..09a1494135af4 100644 --- a/meson.build +++ b/meson.build @@ -6,9 +6,6 @@ project( license: 'BSD-3', meson_version: '>=1.0.1', default_options: [ - # TODO: investigate, does meson try to compile against debug Python - # when buildtype = debug, this seems to be causing problems on CI - # where provided Python is not compiled in debug mode 'buildtype=release', # TODO: Reactivate werror, some warnings on Windows #'werror=true', @@ -16,10 +13,8 @@ project( ] ) -py_mod = import('python') fs = import('fs') -py = py_mod.find_installation('python') -py_dep = py.dependency() +py = import('python').find_installation() tempita = files('generate_pxi.py') versioneer = files('generate_version.py') diff --git a/pandas/_libs/window/meson.build b/pandas/_libs/window/meson.build index b83d8730f9447..85aa060a26406 100644 --- a/pandas/_libs/window/meson.build +++ b/pandas/_libs/window/meson.build @@ -3,7 +3,6 @@ py.extension_module( ['aggregations.pyx'], cython_args: ['-X always_allow_keywords=true'], include_directories: [inc_np, inc_pd], - dependencies: [py_dep], subdir: 'pandas/_libs/window', override_options : ['cython_language=cpp'], install: true @@ -14,7 +13,6 @@ py.extension_module( ['indexers.pyx'], cython_args: ['-X always_allow_keywords=true'], include_directories: [inc_np, inc_pd], - dependencies: [py_dep], subdir: 'pandas/_libs/window', install: true )
Backport PR #54737: MAINT: small simplification of meson.build following best practices
https://api.github.com/repos/pandas-dev/pandas/pulls/54799
2023-08-28T11:45:43Z
2023-08-28T19:43:07Z
2023-08-28T19:43:07Z
2023-08-28T19:43:07Z
Backport PR #54591 on branch 2.1.x (Implement any and all for pyarrow numpy strings)
diff --git a/pandas/core/arrays/string_arrow.py b/pandas/core/arrays/string_arrow.py index bc1d7cb52e196..87dd48b3569d8 100644 --- a/pandas/core/arrays/string_arrow.py +++ b/pandas/core/arrays/string_arrow.py @@ -554,3 +554,16 @@ def value_counts(self, dropna: bool = True): return Series( result._values.to_numpy(), index=result.index, name=result.name, copy=False ) + + def _reduce( + self, name: str, *, skipna: bool = True, keepdims: bool = False, **kwargs + ): + if name in ["any", "all"]: + arr = pc.and_kleene( + pc.invert(pc.is_null(self._pa_array)), pc.not_equal(self._pa_array, "") + ) + return ArrowExtensionArray(arr)._reduce( + name, skipna=skipna, keepdims=keepdims, **kwargs + ) + else: + return super()._reduce(name, skipna=skipna, keepdims=keepdims, **kwargs) diff --git a/pandas/tests/extension/base/reduce.py b/pandas/tests/extension/base/reduce.py index a6532a6190467..43b2df4290eed 100644 --- a/pandas/tests/extension/base/reduce.py +++ b/pandas/tests/extension/base/reduce.py @@ -25,7 +25,7 @@ def check_reduce(self, s, op_name, skipna): try: alt = s.astype("float64") - except TypeError: + except (TypeError, ValueError): # e.g. Interval can't cast, so let's cast to object and do # the reduction pointwise alt = s.astype(object) diff --git a/pandas/tests/extension/test_string.py b/pandas/tests/extension/test_string.py index 069d53aeb248f..5176289994033 100644 --- a/pandas/tests/extension/test_string.py +++ b/pandas/tests/extension/test_string.py @@ -157,6 +157,12 @@ def test_fillna_no_op_returns_copy(self, data): class TestReduce(base.BaseReduceTests): + def _supports_reduction(self, ser: pd.Series, op_name: str) -> bool: + return ( + ser.dtype.storage == "pyarrow_numpy" # type: ignore[union-attr] + and op_name in ("any", "all") + ) + @pytest.mark.parametrize("skipna", [True, False]) def test_reduce_series_numeric(self, data, all_numeric_reductions, skipna): op_name = all_numeric_reductions diff --git a/pandas/tests/reductions/test_reductions.py b/pandas/tests/reductions/test_reductions.py index 87892a81cef3d..021252500e814 100644 --- a/pandas/tests/reductions/test_reductions.py +++ b/pandas/tests/reductions/test_reductions.py @@ -1078,6 +1078,25 @@ def test_any_all_datetimelike(self): assert df.any().all() assert not df.all().any() + def test_any_all_pyarrow_string(self): + # GH#54591 + pytest.importorskip("pyarrow") + ser = Series(["", "a"], dtype="string[pyarrow_numpy]") + assert ser.any() + assert not ser.all() + + ser = Series([None, "a"], dtype="string[pyarrow_numpy]") + assert ser.any() + assert not ser.all() + + ser = Series([None, ""], dtype="string[pyarrow_numpy]") + assert not ser.any() + assert not ser.all() + + ser = Series(["a", "b"], dtype="string[pyarrow_numpy]") + assert ser.any() + assert ser.all() + def test_timedelta64_analytics(self): # index min/max dti = date_range("2012-1-1", periods=3, freq="D")
#54591
https://api.github.com/repos/pandas-dev/pandas/pulls/54796
2023-08-28T11:21:56Z
2023-08-28T15:05:31Z
2023-08-28T15:05:31Z
2023-08-28T15:05:39Z
Backport PR #54789 on branch 2.1.x (WARN: Remove non-actionable warning in value_counts)
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 56e1b82c992c3..c34df3e0e865c 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -7260,7 +7260,7 @@ def value_counts( subset = self.columns.tolist() name = "proportion" if normalize else "count" - counts = self.groupby(subset, dropna=dropna).grouper.size() + counts = self.groupby(subset, dropna=dropna, observed=False).grouper.size() counts.name = name if sort: diff --git a/pandas/tests/frame/methods/test_value_counts.py b/pandas/tests/frame/methods/test_value_counts.py index 355f05cd5156c..c05a929360478 100644 --- a/pandas/tests/frame/methods/test_value_counts.py +++ b/pandas/tests/frame/methods/test_value_counts.py @@ -175,3 +175,17 @@ def test_data_frame_value_counts_subset(nulls_fixture, columns): ) tm.assert_series_equal(result, expected) + + +def test_value_counts_categorical_future_warning(): + # GH#54775 + df = pd.DataFrame({"a": [1, 2, 3]}, dtype="category") + result = df.value_counts() + expected = pd.Series( + 1, + index=pd.MultiIndex.from_arrays( + [pd.Index([1, 2, 3], name="a", dtype="category")] + ), + name="count", + ) + tm.assert_series_equal(result, expected)
Backport PR #54789: WARN: Remove non-actionable warning in value_counts
https://api.github.com/repos/pandas-dev/pandas/pulls/54795
2023-08-28T10:35:06Z
2023-08-28T12:30:58Z
2023-08-28T12:30:58Z
2023-08-28T12:30:58Z
Infer string storage based on infer_string option
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 19a8500928ab7..7e5be1fdde71b 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -39,11 +39,15 @@ We are collecting feedback on this decision `here <https://github.com/pandas-dev Avoid NumPy object dtype for strings by default ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Previously, all strings were stored in columns with NumPy object dtype. +Previously, all strings were stored in columns with NumPy object dtype by default. This release introduces an option ``future.infer_string`` that infers all strings as PyArrow backed strings with dtype ``"string[pyarrow_numpy]"`` instead. This is a new string dtype implementation that follows NumPy semantics in comparison operations and will return ``np.nan`` as the missing value indicator. +Setting the option will also infer the dtype ``"string"`` as a :class:`StringDtype` with +storage set to ``"pyarrow_numpy"``, ignoring the value behind the option +``mode.string_storage``. + This option only works if PyArrow is installed. PyArrow backed strings have a significantly reduced memory footprint and provide a big performance improvement compared to NumPy object (:issue:`54430`). diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index 1eaae0807fee1..72ba95e5fa258 100644 --- a/pandas/core/arrays/string_.py +++ b/pandas/core/arrays/string_.py @@ -115,7 +115,11 @@ def na_value(self) -> libmissing.NAType | float: # type: ignore[override] def __init__(self, storage=None) -> None: if storage is None: - storage = get_option("mode.string_storage") + infer_string = get_option("future.infer_string") + if infer_string: + storage = "pyarrow_numpy" + else: + storage = get_option("mode.string_storage") if storage not in {"python", "pyarrow", "pyarrow_numpy"}: raise ValueError( f"Storage must be 'python' or 'pyarrow'. Got {storage} instead." diff --git a/pandas/core/config_init.py b/pandas/core/config_init.py index d425a378b8d5b..645ed81c16ed3 100644 --- a/pandas/core/config_init.py +++ b/pandas/core/config_init.py @@ -493,7 +493,8 @@ def use_inf_as_na_cb(key) -> None: string_storage_doc = """ : string - The default storage for StringDtype. + The default storage for StringDtype. This option is ignored if + ``future.infer_string`` is set to True. """ with cf.config_prefix("mode"): diff --git a/pandas/tests/series/test_constructors.py b/pandas/tests/series/test_constructors.py index ef734e9664844..2c3fdf627788a 100644 --- a/pandas/tests/series/test_constructors.py +++ b/pandas/tests/series/test_constructors.py @@ -2115,6 +2115,14 @@ def test_series_string_inference_array_string_dtype(self): ser = Series(np.array(["a", "b"])) tm.assert_series_equal(ser, expected) + def test_series_string_inference_storage_definition(self): + # GH#54793 + pytest.importorskip("pyarrow") + expected = Series(["a", "b"], dtype="string[pyarrow_numpy]") + with pd.option_context("future.infer_string", True): + result = Series(["a", "b"], dtype="string") + tm.assert_series_equal(result, expected) + class TestSeriesConstructorIndexCoercion: def test_series_constructor_datetimelike_index_coercion(self):
- [x] closes #54793 - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54794
2023-08-28T10:32:36Z
2023-08-29T08:36:21Z
2023-08-29T08:36:21Z
2023-08-29T22:07:57Z
Backport PR #54527 on branch 2.1.x (BUG: Special-case setting nan into integer series)
diff --git a/pandas/_libs/lib.pyi b/pandas/_libs/lib.pyi index 32641319a6b96..15bd5a7379105 100644 --- a/pandas/_libs/lib.pyi +++ b/pandas/_libs/lib.pyi @@ -195,6 +195,7 @@ def array_equivalent_object( right: npt.NDArray[np.object_], ) -> bool: ... def has_infs(arr: np.ndarray) -> bool: ... # const floating[:] +def has_only_ints_or_nan(arr: np.ndarray) -> bool: ... # const floating[:] def get_reverse_indexer( indexer: np.ndarray, # const intp_t[:] length: int, diff --git a/pandas/_libs/lib.pyx b/pandas/_libs/lib.pyx index 859cb8e5ebead..0c0610f72044e 100644 --- a/pandas/_libs/lib.pyx +++ b/pandas/_libs/lib.pyx @@ -530,6 +530,22 @@ def has_infs(floating[:] arr) -> bool: return ret +@cython.boundscheck(False) +@cython.wraparound(False) +def has_only_ints_or_nan(floating[:] arr) -> bool: + cdef: + floating val + intp_t i + + for i in range(len(arr)): + val = arr[i] + if (val != val) or (val == <int64_t>val): + continue + else: + return False + return True + + def maybe_indices_to_slice(ndarray[intp_t, ndim=1] indices, int max_len): cdef: Py_ssize_t i, n = len(indices) diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index 6df90eece3cc8..7e647426e9726 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -18,6 +18,7 @@ from pandas._config import using_copy_on_write from pandas._libs import ( + NaT, internals as libinternals, lib, writers, @@ -60,7 +61,10 @@ from pandas.core.dtypes.common import ( ensure_platform_int, is_1d_only_ea_dtype, + is_float_dtype, + is_integer_dtype, is_list_like, + is_scalar, is_string_dtype, ) from pandas.core.dtypes.dtypes import ( @@ -454,6 +458,25 @@ def coerce_to_target_dtype(self, other, warn_on_upcast: bool = False) -> Block: and will receive the same block """ new_dtype = find_result_type(self.values.dtype, other) + + # In a future version of pandas, the default will be that + # setting `nan` into an integer series won't raise. + if ( + is_scalar(other) + and is_integer_dtype(self.values.dtype) + and isna(other) + and other is not NaT + ): + warn_on_upcast = False + elif ( + isinstance(other, np.ndarray) + and other.ndim == 1 + and is_integer_dtype(self.values.dtype) + and is_float_dtype(other.dtype) + and lib.has_only_ints_or_nan(other) + ): + warn_on_upcast = False + if warn_on_upcast: warnings.warn( f"Setting an item of incompatible dtype is deprecated " diff --git a/pandas/tests/frame/indexing/test_indexing.py b/pandas/tests/frame/indexing/test_indexing.py index 288aa1af746b6..b324291bab31e 100644 --- a/pandas/tests/frame/indexing/test_indexing.py +++ b/pandas/tests/frame/indexing/test_indexing.py @@ -337,18 +337,12 @@ def test_setitem(self, float_frame, using_copy_on_write): def test_setitem2(self): # dtype changing GH4204 df = DataFrame([[0, 0]]) - with tm.assert_produces_warning( - FutureWarning, match="Setting an item of incompatible dtype" - ): - df.iloc[0] = np.nan + df.iloc[0] = np.nan expected = DataFrame([[np.nan, np.nan]]) tm.assert_frame_equal(df, expected) df = DataFrame([[0, 0]]) - with tm.assert_produces_warning( - FutureWarning, match="Setting an item of incompatible dtype" - ): - df.loc[0] = np.nan + df.loc[0] = np.nan tm.assert_frame_equal(df, expected) def test_setitem_boolean(self, float_frame): @@ -1579,9 +1573,7 @@ def test_setitem(self, uint64_frame): # With NaN: because uint64 has no NaN element, # the column should be cast to object. df2 = df.copy() - with tm.assert_produces_warning( - FutureWarning, match="Setting an item of incompatible dtype" - ): + with tm.assert_produces_warning(FutureWarning, match="incompatible dtype"): df2.iloc[1, 1] = pd.NaT df2.iloc[1, 2] = pd.NaT result = df2["B"] @@ -1901,19 +1893,19 @@ def test_setitem_dict_and_set_disallowed_multiindex(self, key): class TestSetitemValidation: # This is adapted from pandas/tests/arrays/masked/test_indexing.py # but checks for warnings instead of errors. - def _check_setitem_invalid(self, df, invalid, indexer): + def _check_setitem_invalid(self, df, invalid, indexer, warn): msg = "Setting an item of incompatible dtype is deprecated" msg = re.escape(msg) orig_df = df.copy() # iloc - with tm.assert_produces_warning(FutureWarning, match=msg): + with tm.assert_produces_warning(warn, match=msg): df.iloc[indexer, 0] = invalid df = orig_df.copy() # loc - with tm.assert_produces_warning(FutureWarning, match=msg): + with tm.assert_produces_warning(warn, match=msg): df.loc[indexer, "a"] = invalid df = orig_df.copy() @@ -1934,16 +1926,20 @@ def _check_setitem_invalid(self, df, invalid, indexer): @pytest.mark.parametrize("indexer", _indexers) def test_setitem_validation_scalar_bool(self, invalid, indexer): df = DataFrame({"a": [True, False, False]}, dtype="bool") - self._check_setitem_invalid(df, invalid, indexer) + self._check_setitem_invalid(df, invalid, indexer, FutureWarning) @pytest.mark.parametrize("invalid", _invalid_scalars + [True, 1.5, np.float64(1.5)]) @pytest.mark.parametrize("indexer", _indexers) def test_setitem_validation_scalar_int(self, invalid, any_int_numpy_dtype, indexer): df = DataFrame({"a": [1, 2, 3]}, dtype=any_int_numpy_dtype) - self._check_setitem_invalid(df, invalid, indexer) + if isna(invalid) and invalid is not pd.NaT: + warn = None + else: + warn = FutureWarning + self._check_setitem_invalid(df, invalid, indexer, warn) @pytest.mark.parametrize("invalid", _invalid_scalars + [True]) @pytest.mark.parametrize("indexer", _indexers) def test_setitem_validation_scalar_float(self, invalid, float_numpy_dtype, indexer): df = DataFrame({"a": [1, 2, None]}, dtype=float_numpy_dtype) - self._check_setitem_invalid(df, invalid, indexer) + self._check_setitem_invalid(df, invalid, indexer, FutureWarning) diff --git a/pandas/tests/indexing/test_indexing.py b/pandas/tests/indexing/test_indexing.py index 224555399ff8f..54e204c43dadd 100644 --- a/pandas/tests/indexing/test_indexing.py +++ b/pandas/tests/indexing/test_indexing.py @@ -830,8 +830,7 @@ def test_coercion_with_loc(self, expected): start_data, expected_result, warn = expected start_dataframe = DataFrame({"foo": start_data}) - with tm.assert_produces_warning(warn, match="incompatible dtype"): - start_dataframe.loc[0, ["foo"]] = None + start_dataframe.loc[0, ["foo"]] = None expected_dataframe = DataFrame({"foo": expected_result}) tm.assert_frame_equal(start_dataframe, expected_dataframe) @@ -841,8 +840,7 @@ def test_coercion_with_setitem_and_dataframe(self, expected): start_data, expected_result, warn = expected start_dataframe = DataFrame({"foo": start_data}) - with tm.assert_produces_warning(warn, match="incompatible dtype"): - start_dataframe[start_dataframe["foo"] == start_dataframe["foo"][0]] = None + start_dataframe[start_dataframe["foo"] == start_dataframe["foo"][0]] = None expected_dataframe = DataFrame({"foo": expected_result}) tm.assert_frame_equal(start_dataframe, expected_dataframe) @@ -852,10 +850,7 @@ def test_none_coercion_loc_and_dataframe(self, expected): start_data, expected_result, warn = expected start_dataframe = DataFrame({"foo": start_data}) - with tm.assert_produces_warning(warn, match="incompatible dtype"): - start_dataframe.loc[ - start_dataframe["foo"] == start_dataframe["foo"][0] - ] = None + start_dataframe.loc[start_dataframe["foo"] == start_dataframe["foo"][0]] = None expected_dataframe = DataFrame({"foo": expected_result}) tm.assert_frame_equal(start_dataframe, expected_dataframe) @@ -869,10 +864,7 @@ def test_none_coercion_mixed_dtypes(self): "d": ["a", "b", "c"], } ) - with tm.assert_produces_warning( - FutureWarning, match="item of incompatible dtype" - ): - start_dataframe.iloc[0] = None + start_dataframe.iloc[0] = None exp = DataFrame( { diff --git a/pandas/tests/series/indexing/test_indexing.py b/pandas/tests/series/indexing/test_indexing.py index 7b857a487db78..0fa28920d41bd 100644 --- a/pandas/tests/series/indexing/test_indexing.py +++ b/pandas/tests/series/indexing/test_indexing.py @@ -19,6 +19,7 @@ Timestamp, concat, date_range, + isna, period_range, timedelta_range, ) @@ -456,25 +457,25 @@ def test_setitem_dict_and_set_disallowed_multiindex(self, key): class TestSetitemValidation: # This is adapted from pandas/tests/arrays/masked/test_indexing.py # but checks for warnings instead of errors. - def _check_setitem_invalid(self, ser, invalid, indexer): + def _check_setitem_invalid(self, ser, invalid, indexer, warn): msg = "Setting an item of incompatible dtype is deprecated" msg = re.escape(msg) orig_ser = ser.copy() - with tm.assert_produces_warning(FutureWarning, match=msg): + with tm.assert_produces_warning(warn, match=msg): ser[indexer] = invalid ser = orig_ser.copy() - with tm.assert_produces_warning(FutureWarning, match=msg): + with tm.assert_produces_warning(warn, match=msg): ser.iloc[indexer] = invalid ser = orig_ser.copy() - with tm.assert_produces_warning(FutureWarning, match=msg): + with tm.assert_produces_warning(warn, match=msg): ser.loc[indexer] = invalid ser = orig_ser.copy() - with tm.assert_produces_warning(FutureWarning, match=msg): + with tm.assert_produces_warning(warn, match=msg): ser[:] = invalid _invalid_scalars = [ @@ -494,16 +495,20 @@ def _check_setitem_invalid(self, ser, invalid, indexer): @pytest.mark.parametrize("indexer", _indexers) def test_setitem_validation_scalar_bool(self, invalid, indexer): ser = Series([True, False, False], dtype="bool") - self._check_setitem_invalid(ser, invalid, indexer) + self._check_setitem_invalid(ser, invalid, indexer, FutureWarning) @pytest.mark.parametrize("invalid", _invalid_scalars + [True, 1.5, np.float64(1.5)]) @pytest.mark.parametrize("indexer", _indexers) def test_setitem_validation_scalar_int(self, invalid, any_int_numpy_dtype, indexer): ser = Series([1, 2, 3], dtype=any_int_numpy_dtype) - self._check_setitem_invalid(ser, invalid, indexer) + if isna(invalid) and invalid is not NaT: + warn = None + else: + warn = FutureWarning + self._check_setitem_invalid(ser, invalid, indexer, warn) @pytest.mark.parametrize("invalid", _invalid_scalars + [True]) @pytest.mark.parametrize("indexer", _indexers) def test_setitem_validation_scalar_float(self, invalid, float_numpy_dtype, indexer): ser = Series([1, 2, None], dtype=float_numpy_dtype) - self._check_setitem_invalid(ser, invalid, indexer) + self._check_setitem_invalid(ser, invalid, indexer, FutureWarning) diff --git a/pandas/tests/series/indexing/test_setitem.py b/pandas/tests/series/indexing/test_setitem.py index bc596fb0a3abe..d42e884c1ac78 100644 --- a/pandas/tests/series/indexing/test_setitem.py +++ b/pandas/tests/series/indexing/test_setitem.py @@ -191,14 +191,11 @@ def test_setitem_series_object_dtype(self, indexer, ser_index): expected = Series([Series([42], index=[ser_index]), 0], dtype="object") tm.assert_series_equal(ser, expected) - @pytest.mark.parametrize( - "index, exp_value, warn", [(0, 42, None), (1, np.nan, FutureWarning)] - ) - def test_setitem_series(self, index, exp_value, warn): + @pytest.mark.parametrize("index, exp_value", [(0, 42), (1, np.nan)]) + def test_setitem_series(self, index, exp_value): # GH#38303 ser = Series([0, 0]) - with tm.assert_produces_warning(warn, match="item of incompatible dtype"): - ser.loc[0] = Series([42], index=[index]) + ser.loc[0] = Series([42], index=[index]) expected = Series([exp_value, 0]) tm.assert_series_equal(ser, expected) @@ -575,7 +572,7 @@ def test_setitem_keep_precision(self, any_numeric_ea_dtype): [ (NA, NA, "Int64", "Int64", 1, None), (NA, NA, "Int64", "Int64", 2, None), - (NA, np.nan, "int64", "float64", 1, FutureWarning), + (NA, np.nan, "int64", "float64", 1, None), (NA, np.nan, "int64", "float64", 2, None), (NaT, NaT, "int64", "object", 1, FutureWarning), (NaT, NaT, "int64", "object", 2, None), @@ -583,7 +580,7 @@ def test_setitem_keep_precision(self, any_numeric_ea_dtype): (np.nan, NA, "Int64", "Int64", 2, None), (np.nan, NA, "Float64", "Float64", 1, None), (np.nan, NA, "Float64", "Float64", 2, None), - (np.nan, np.nan, "int64", "float64", 1, FutureWarning), + (np.nan, np.nan, "int64", "float64", 1, None), (np.nan, np.nan, "int64", "float64", 2, None), ], ) @@ -592,7 +589,7 @@ def test_setitem_enlarge_with_na( ): # GH#32346 ser = Series([1, 2], dtype=dtype) - with tm.assert_produces_warning(warn, match="item of incompatible dtype"): + with tm.assert_produces_warning(warn, match="incompatible dtype"): ser[indexer] = na expected_values = [1, target_na] if indexer == 1 else [1, 2, target_na] expected = Series(expected_values, dtype=target_dtype) @@ -884,7 +881,7 @@ def test_index_putmask(self, obj, key, expected, warn, val): Series([2, 3, 4, 5, 6, 7, 8, 9, 10]), Series([np.nan, 3, np.nan, 5, np.nan, 7, np.nan, 9, np.nan]), slice(None, None, 2), - FutureWarning, + None, id="int_series_slice_key_step", ), pytest.param( @@ -899,7 +896,7 @@ def test_index_putmask(self, obj, key, expected, warn, val): Series(np.arange(10)), Series([np.nan, np.nan, np.nan, np.nan, np.nan, 5, 6, 7, 8, 9]), slice(None, 5), - FutureWarning, + None, id="int_series_slice_key", ), pytest.param( @@ -907,7 +904,7 @@ def test_index_putmask(self, obj, key, expected, warn, val): Series([1, 2, 3]), Series([np.nan, 2, 3]), 0, - FutureWarning, + None, id="int_series_int_key", ), pytest.param( @@ -1134,7 +1131,7 @@ def warn(self): "obj,expected,warn", [ # For numeric series, we should coerce to NaN. - (Series([1, 2, 3]), Series([np.nan, 2, 3]), FutureWarning), + (Series([1, 2, 3]), Series([np.nan, 2, 3]), None), (Series([1.0, 2.0, 3.0]), Series([np.nan, 2.0, 3.0]), None), # For datetime series, we should coerce to NaT. ( @@ -1584,13 +1581,11 @@ def test_20643_comment(): expected = Series([np.nan, 1, 2], index=["a", "b", "c"]) ser = orig.copy() - with tm.assert_produces_warning(FutureWarning, match="incompatible dtype"): - ser.iat[0] = None + ser.iat[0] = None tm.assert_series_equal(ser, expected) ser = orig.copy() - with tm.assert_produces_warning(FutureWarning, match="incompatible dtype"): - ser.iloc[0] = None + ser.iloc[0] = None tm.assert_series_equal(ser, expected) diff --git a/pandas/tests/series/methods/test_convert_dtypes.py b/pandas/tests/series/methods/test_convert_dtypes.py index 9cd0ce250b5df..d1c79d0f00365 100644 --- a/pandas/tests/series/methods/test_convert_dtypes.py +++ b/pandas/tests/series/methods/test_convert_dtypes.py @@ -206,17 +206,7 @@ def test_convert_dtypes( # Test that it is a copy copy = series.copy(deep=True) - if result.notna().sum() > 0 and result.dtype in [ - "int8", - "uint8", - "int16", - "uint16", - "int32", - "uint32", - "int64", - "uint64", - "interval[int64, right]", - ]: + if result.notna().sum() > 0 and result.dtype in ["interval[int64, right]"]: with tm.assert_produces_warning(FutureWarning, match="incompatible dtype"): result[result.notna()] = np.nan else:
Backport PR #54527: BUG: Special-case setting nan into integer series
https://api.github.com/repos/pandas-dev/pandas/pulls/54791
2023-08-28T09:37:29Z
2023-08-28T12:31:28Z
2023-08-28T12:31:28Z
2023-08-28T12:31:29Z
WARN: Remove non-actionable warning in value_counts
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 53ab03696551e..018059ce2784f 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -7279,7 +7279,7 @@ def value_counts( subset = self.columns.tolist() name = "proportion" if normalize else "count" - counts = self.groupby(subset, dropna=dropna).grouper.size() + counts = self.groupby(subset, dropna=dropna, observed=False).grouper.size() counts.name = name if sort: diff --git a/pandas/tests/frame/methods/test_value_counts.py b/pandas/tests/frame/methods/test_value_counts.py index 355f05cd5156c..c05a929360478 100644 --- a/pandas/tests/frame/methods/test_value_counts.py +++ b/pandas/tests/frame/methods/test_value_counts.py @@ -175,3 +175,17 @@ def test_data_frame_value_counts_subset(nulls_fixture, columns): ) tm.assert_series_equal(result, expected) + + +def test_value_counts_categorical_future_warning(): + # GH#54775 + df = pd.DataFrame({"a": [1, 2, 3]}, dtype="category") + result = df.value_counts() + expected = pd.Series( + 1, + index=pd.MultiIndex.from_arrays( + [pd.Index([1, 2, 3], name="a", dtype="category")] + ), + name="count", + ) + tm.assert_series_equal(result, expected)
- [x] closes #54775 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. cc @rhshadrach maybe?
https://api.github.com/repos/pandas-dev/pandas/pulls/54789
2023-08-28T08:41:04Z
2023-08-28T10:34:59Z
2023-08-28T10:34:58Z
2023-08-29T05:19:35Z
BUG: creating dataframe from masked numpy array turns missing string …
diff --git a/pandas/_libs/testing.pyx b/pandas/_libs/testing.pyx index 4ba7bce51ed64..9ebab9a45a1d3 100644 --- a/pandas/_libs/testing.pyx +++ b/pandas/_libs/testing.pyx @@ -2,6 +2,7 @@ import cmath import math import warnings +warnings.simplefilter(action="ignore", category=FutureWarning) import numpy as np from numpy cimport import_array @@ -18,7 +19,7 @@ from pandas._libs.util cimport ( is_real_number_object, ) -from pandas.util._exceptions import find_stack_level +# from pandas.util._exceptions import find_stack_level from pandas.core.dtypes.missing import array_equivalent @@ -187,15 +188,6 @@ cpdef assert_almost_equal(a, b, if is_matching_na(a, b, nan_matches_none=False): return True elif checknull(b): - # GH#18463 - warnings.warn( - f"Mismatched null-like values {a} and {b} found. In a future " - "version, pandas equality-testing functions " - "(e.g. assert_frame_equal) will consider these not-matching " - "and raise.", - FutureWarning, - stacklevel=find_stack_level(), - ) return True raise AssertionError(f"{a} != {b}") elif checknull(b): diff --git a/pandas/core/construction.py b/pandas/core/construction.py index aaac0dc73486f..b7cf398931e94 100644 --- a/pandas/core/construction.py +++ b/pandas/core/construction.py @@ -505,7 +505,11 @@ def sanitize_masked_array(data: ma.MaskedArray) -> np.ndarray: """ mask = ma.getmaskarray(data) if mask.any(): - dtype, fill_value = maybe_promote(data.dtype, np.nan) + dtype, fill_value = maybe_promote(data.dtype, None) + # If array is masked then fill value has to be None + # BUG:numpy masked array of dtype=object produces NaN instead of None. #51872 + if np.isnan(fill_value): + fill_value = None dtype = cast(np.dtype, dtype) data = ma.asarray(data.astype(dtype, copy=True)) data.soften_mask() # set hardmask False if it was True diff --git a/pandas/tests/dtypes/cast/test_promote.py b/pandas/tests/dtypes/cast/test_promote.py index 1becf3b9843b7..bd0e9c2cdd6f3 100644 --- a/pandas/tests/dtypes/cast/test_promote.py +++ b/pandas/tests/dtypes/cast/test_promote.py @@ -181,6 +181,7 @@ def _assert_match(result_fill_value, expected_fill_value): ("uint64", np.iinfo("int16").min - 1, "object"), ("uint64", np.iinfo("int32").min - 1, "object"), ("uint64", np.iinfo("int64").min - 1, "object"), + ("<U1", np.nan, "O"), ], ) def test_maybe_promote_int_with_int(dtype, fill_value, expected_dtype):
…values into NaN - [x] closes #54706 (Replace xxxx with the GitHub issue number) - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54787
2023-08-28T02:49:05Z
2023-10-09T18:34:00Z
null
2023-10-09T18:34:00Z
TYP: simple return types
diff --git a/pandas/_testing/_io.py b/pandas/_testing/_io.py index edbba9452b50a..95977edb600ad 100644 --- a/pandas/_testing/_io.py +++ b/pandas/_testing/_io.py @@ -118,7 +118,7 @@ def round_trip_localpath(writer, reader, path: str | None = None): return obj -def write_to_compressed(compression, path, data, dest: str = "test"): +def write_to_compressed(compression, path, data, dest: str = "test") -> None: """ Write data to a compressed file. diff --git a/pandas/arrays/__init__.py b/pandas/arrays/__init__.py index 32e2afc0eef52..a11755275d00e 100644 --- a/pandas/arrays/__init__.py +++ b/pandas/arrays/__init__.py @@ -36,7 +36,7 @@ ] -def __getattr__(name: str): +def __getattr__(name: str) -> type[NumpyExtensionArray]: if name == "PandasArray": # GH#53694 import warnings diff --git a/pandas/compat/pickle_compat.py b/pandas/compat/pickle_compat.py index 8282ec25c1d58..4f067d958b799 100644 --- a/pandas/compat/pickle_compat.py +++ b/pandas/compat/pickle_compat.py @@ -26,7 +26,7 @@ from collections.abc import Generator -def load_reduce(self): +def load_reduce(self) -> None: stack = self.stack args = stack.pop() func = stack[-1] diff --git a/pandas/conftest.py b/pandas/conftest.py index 10826f50d1fe1..ea59bbfd088a9 100644 --- a/pandas/conftest.py +++ b/pandas/conftest.py @@ -491,7 +491,7 @@ def box_with_array(request): @pytest.fixture -def dict_subclass(): +def dict_subclass() -> type[dict]: """ Fixture for a dictionary subclass. """ @@ -504,7 +504,7 @@ def __init__(self, *args, **kwargs) -> None: @pytest.fixture -def non_dict_mapping_subclass(): +def non_dict_mapping_subclass() -> type[abc.Mapping]: """ Fixture for a non-mapping dictionary subclass. """ diff --git a/pandas/core/apply.py b/pandas/core/apply.py index 6ab2f958b8730..4d6dd8f4fd577 100644 --- a/pandas/core/apply.py +++ b/pandas/core/apply.py @@ -54,9 +54,9 @@ if TYPE_CHECKING: from collections.abc import ( + Generator, Hashable, Iterable, - Iterator, Sequence, ) @@ -253,7 +253,7 @@ def transform(self) -> DataFrame | Series: return result - def transform_dict_like(self, func): + def transform_dict_like(self, func) -> DataFrame: """ Compute transform in the case of a dict-like func """ @@ -315,7 +315,7 @@ def compute_list_like( op_name: Literal["agg", "apply"], selected_obj: Series | DataFrame, kwargs: dict[str, Any], - ) -> tuple[list[Hashable], list[Any]]: + ) -> tuple[list[Hashable] | Index, list[Any]]: """ Compute agg/apply results for like-like input. @@ -330,7 +330,7 @@ def compute_list_like( Returns ------- - keys : list[hashable] + keys : list[Hashable] or Index Index labels for result. results : list Data for result. When aggregating with a Series, this can contain any @@ -370,12 +370,14 @@ def compute_list_like( new_res = getattr(colg, op_name)(func, *args, **kwargs) results.append(new_res) indices.append(index) - keys = selected_obj.columns.take(indices) + # error: Incompatible types in assignment (expression has type "Any | + # Index", variable has type "list[Any | Callable[..., Any] | str]") + keys = selected_obj.columns.take(indices) # type: ignore[assignment] return keys, results def wrap_results_list_like( - self, keys: list[Hashable], results: list[Series | DataFrame] + self, keys: Iterable[Hashable], results: list[Series | DataFrame] ): from pandas.core.reshape.concat import concat @@ -772,7 +774,7 @@ def result_columns(self) -> Index: @property @abc.abstractmethod - def series_generator(self) -> Iterator[Series]: + def series_generator(self) -> Generator[Series, None, None]: pass @abc.abstractmethod @@ -1014,7 +1016,7 @@ class FrameRowApply(FrameApply): axis: AxisInt = 0 @property - def series_generator(self): + def series_generator(self) -> Generator[Series, None, None]: return (self.obj._ixs(i, axis=1) for i in range(len(self.columns))) @property @@ -1075,7 +1077,7 @@ def apply_broadcast(self, target: DataFrame) -> DataFrame: return result.T @property - def series_generator(self): + def series_generator(self) -> Generator[Series, None, None]: values = self.values values = ensure_wrapped_if_datetimelike(values) assert len(values) > 0 diff --git a/pandas/core/arrays/arrow/extension_types.py b/pandas/core/arrays/arrow/extension_types.py index 3249c1c829546..7814a77a1cdc5 100644 --- a/pandas/core/arrays/arrow/extension_types.py +++ b/pandas/core/arrays/arrow/extension_types.py @@ -48,7 +48,7 @@ def __ne__(self, other) -> bool: def __hash__(self) -> int: return hash((str(self), self.freq)) - def to_pandas_dtype(self): + def to_pandas_dtype(self) -> PeriodDtype: return PeriodDtype(freq=self.freq) @@ -105,7 +105,7 @@ def __ne__(self, other) -> bool: def __hash__(self) -> int: return hash((str(self), str(self.subtype), self.closed)) - def to_pandas_dtype(self): + def to_pandas_dtype(self) -> IntervalDtype: return IntervalDtype(self.subtype.to_pandas_dtype(), self.closed) diff --git a/pandas/core/arrays/categorical.py b/pandas/core/arrays/categorical.py index dae0fb7782791..9f63d1f97c54f 100644 --- a/pandas/core/arrays/categorical.py +++ b/pandas/core/arrays/categorical.py @@ -2410,7 +2410,7 @@ def _mode(self, dropna: bool = True) -> Categorical: # ------------------------------------------------------------------ # ExtensionArray Interface - def unique(self): + def unique(self) -> Self: """ Return the ``Categorical`` which ``categories`` and ``codes`` are unique. diff --git a/pandas/core/arrays/interval.py b/pandas/core/arrays/interval.py index 73d4f6f38f102..58ade1ee935ec 100644 --- a/pandas/core/arrays/interval.py +++ b/pandas/core/arrays/interval.py @@ -110,7 +110,7 @@ ) -IntervalSideT = Union[TimeArrayLike, np.ndarray] +IntervalSide = Union[TimeArrayLike, np.ndarray] IntervalOrNA = Union[Interval, float] _interval_shared_docs: dict[str, str] = {} @@ -219,8 +219,8 @@ def ndim(self) -> Literal[1]: return 1 # To make mypy recognize the fields - _left: IntervalSideT - _right: IntervalSideT + _left: IntervalSide + _right: IntervalSide _dtype: IntervalDtype # --------------------------------------------------------------------- @@ -237,8 +237,8 @@ def __new__( data = extract_array(data, extract_numpy=True) if isinstance(data, cls): - left: IntervalSideT = data._left - right: IntervalSideT = data._right + left: IntervalSide = data._left + right: IntervalSide = data._right closed = closed or data.closed dtype = IntervalDtype(left.dtype, closed=closed) else: @@ -280,8 +280,8 @@ def __new__( @classmethod def _simple_new( cls, - left: IntervalSideT, - right: IntervalSideT, + left: IntervalSide, + right: IntervalSide, dtype: IntervalDtype, ) -> Self: result = IntervalMixin.__new__(cls) @@ -299,7 +299,7 @@ def _ensure_simple_new_inputs( closed: IntervalClosedType | None = None, copy: bool = False, dtype: Dtype | None = None, - ) -> tuple[IntervalSideT, IntervalSideT, IntervalDtype]: + ) -> tuple[IntervalSide, IntervalSide, IntervalDtype]: """Ensure correctness of input parameters for cls._simple_new.""" from pandas.core.indexes.base import ensure_index @@ -1031,8 +1031,8 @@ def _concat_same_type(cls, to_concat: Sequence[IntervalArray]) -> Self: raise ValueError("Intervals must all be closed on the same side.") closed = closed_set.pop() - left = np.concatenate([interval.left for interval in to_concat]) - right = np.concatenate([interval.right for interval in to_concat]) + left: IntervalSide = np.concatenate([interval.left for interval in to_concat]) + right: IntervalSide = np.concatenate([interval.right for interval in to_concat]) left, right, dtype = cls._ensure_simple_new_inputs(left, right, closed=closed) @@ -1283,7 +1283,7 @@ def _format_space(self) -> str: # Vectorized Interval Properties/Attributes @property - def left(self): + def left(self) -> Index: """ Return the left endpoints of each Interval in the IntervalArray as an Index. @@ -1303,7 +1303,7 @@ def left(self): return Index(self._left, copy=False) @property - def right(self): + def right(self) -> Index: """ Return the right endpoints of each Interval in the IntervalArray as an Index. @@ -1855,11 +1855,17 @@ def isin(self, values) -> npt.NDArray[np.bool_]: return isin(self.astype(object), values.astype(object)) @property - def _combined(self) -> IntervalSideT: - left = self.left._values.reshape(-1, 1) - right = self.right._values.reshape(-1, 1) + def _combined(self) -> IntervalSide: + # error: Item "ExtensionArray" of "ExtensionArray | ndarray[Any, Any]" + # has no attribute "reshape" [union-attr] + left = self.left._values.reshape(-1, 1) # type: ignore[union-attr] + right = self.right._values.reshape(-1, 1) # type: ignore[union-attr] if needs_i8_conversion(left.dtype): - comb = left._concat_same_type([left, right], axis=1) + # error: Item "ndarray[Any, Any]" of "Any | ndarray[Any, Any]" has + # no attribute "_concat_same_type" + comb = left._concat_same_type( # type: ignore[union-attr] + [left, right], axis=1 + ) else: comb = np.concatenate([left, right], axis=1) return comb diff --git a/pandas/core/arrays/period.py b/pandas/core/arrays/period.py index a2e4b595c42aa..eeede0ad9e6d2 100644 --- a/pandas/core/arrays/period.py +++ b/pandas/core/arrays/period.py @@ -948,7 +948,7 @@ def _check_timedeltalike_freq_compat(self, other): return lib.item_from_zerodim(delta) -def raise_on_incompatible(left, right): +def raise_on_incompatible(left, right) -> IncompatibleFrequency: """ Helper function to render a consistent error message when raising IncompatibleFrequency. @@ -1089,7 +1089,7 @@ def validate_dtype_freq(dtype, freq: timedelta | str | None) -> BaseOffset: def validate_dtype_freq( - dtype, freq: BaseOffsetT | timedelta | str | None + dtype, freq: BaseOffsetT | BaseOffset | timedelta | str | None ) -> BaseOffsetT: """ If both a dtype and a freq are available, ensure they match. If only @@ -1110,10 +1110,7 @@ def validate_dtype_freq( IncompatibleFrequency : mismatch between dtype and freq """ if freq is not None: - # error: Incompatible types in assignment (expression has type - # "BaseOffset", variable has type "Union[BaseOffsetT, timedelta, - # str, None]") - freq = to_offset(freq) # type: ignore[assignment] + freq = to_offset(freq) if dtype is not None: dtype = pandas_dtype(dtype) diff --git a/pandas/core/arrays/sparse/array.py b/pandas/core/arrays/sparse/array.py index e38fa0a3bdae5..00cbe1286c195 100644 --- a/pandas/core/arrays/sparse/array.py +++ b/pandas/core/arrays/sparse/array.py @@ -702,7 +702,9 @@ def npoints(self) -> int: """ return self.sp_index.npoints - def isna(self): + # error: Return type "SparseArray" of "isna" incompatible with return type + # "ndarray[Any, Any] | ExtensionArraySupportsAnyAll" in supertype "ExtensionArray" + def isna(self) -> Self: # type: ignore[override] # If null fill value, we want SparseDtype[bool, true] # to preserve the same memory usage. dtype = SparseDtype(bool, self._null_fill_value) @@ -1421,7 +1423,7 @@ def all(self, axis=None, *args, **kwargs): return values.all() - def any(self, axis: AxisInt = 0, *args, **kwargs): + def any(self, axis: AxisInt = 0, *args, **kwargs) -> bool: """ Tests whether at least one of elements evaluate True diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index 72ba95e5fa258..c90127c0e9812 100644 --- a/pandas/core/arrays/string_.py +++ b/pandas/core/arrays/string_.py @@ -59,6 +59,7 @@ NumpySorter, NumpyValueArrayLike, Scalar, + Self, npt, type_t, ) @@ -135,7 +136,7 @@ def type(self) -> type[str]: return str @classmethod - def construct_from_string(cls, string): + def construct_from_string(cls, string) -> Self: """ Construct a StringDtype from a string. diff --git a/pandas/core/arrays/string_arrow.py b/pandas/core/arrays/string_arrow.py index cc3bc5900c4c2..f438f75707265 100644 --- a/pandas/core/arrays/string_arrow.py +++ b/pandas/core/arrays/string_arrow.py @@ -53,6 +53,8 @@ npt, ) + from pandas import Series + ArrowStringScalarOrNAT = Union[str, libmissing.NAType] @@ -547,7 +549,7 @@ def _cmp_method(self, other, op): result = super()._cmp_method(other, op) return result.to_numpy(np.bool_, na_value=False) - def value_counts(self, dropna: bool = True): + def value_counts(self, dropna: bool = True) -> Series: from pandas import Series result = super().value_counts(dropna) diff --git a/pandas/core/computation/expr.py b/pandas/core/computation/expr.py index 2f94856702465..4770f403b1bdb 100644 --- a/pandas/core/computation/expr.py +++ b/pandas/core/computation/expr.py @@ -12,6 +12,7 @@ import tokenize from typing import ( Callable, + ClassVar, TypeVar, ) @@ -349,8 +350,8 @@ class BaseExprVisitor(ast.NodeVisitor): preparser : callable """ - const_type: type[Term] = Constant - term_type = Term + const_type: ClassVar[type[Term]] = Constant + term_type: ClassVar[type[Term]] = Term binary_ops = CMP_OPS_SYMS + BOOL_OPS_SYMS + ARITH_OPS_SYMS binary_op_nodes = ( @@ -540,7 +541,7 @@ def visit_UnaryOp(self, node, **kwargs): operand = self.visit(node.operand) return op(operand) - def visit_Name(self, node, **kwargs): + def visit_Name(self, node, **kwargs) -> Term: return self.term_type(node.id, self.env, **kwargs) # TODO(py314): deprecated since Python 3.8. Remove after Python 3.14 is min @@ -555,11 +556,11 @@ def visit_Constant(self, node, **kwargs) -> Term: return self.const_type(node.value, self.env) # TODO(py314): deprecated since Python 3.8. Remove after Python 3.14 is min - def visit_Str(self, node, **kwargs): + def visit_Str(self, node, **kwargs) -> Term: name = self.env.add_tmp(node.s) return self.term_type(name, self.env) - def visit_List(self, node, **kwargs): + def visit_List(self, node, **kwargs) -> Term: name = self.env.add_tmp([self.visit(e)(self.env) for e in node.elts]) return self.term_type(name, self.env) @@ -569,7 +570,7 @@ def visit_Index(self, node, **kwargs): """df.index[4]""" return self.visit(node.value) - def visit_Subscript(self, node, **kwargs): + def visit_Subscript(self, node, **kwargs) -> Term: from pandas import eval as pd_eval value = self.visit(node.value) @@ -589,7 +590,7 @@ def visit_Subscript(self, node, **kwargs): name = self.env.add_tmp(v) return self.term_type(name, env=self.env) - def visit_Slice(self, node, **kwargs): + def visit_Slice(self, node, **kwargs) -> slice: """df.index[slice(4,6)]""" lower = node.lower if lower is not None: diff --git a/pandas/core/computation/ops.py b/pandas/core/computation/ops.py index 852bfae1cc79a..95ac20ba39edc 100644 --- a/pandas/core/computation/ops.py +++ b/pandas/core/computation/ops.py @@ -617,5 +617,5 @@ def __init__(self, name: str) -> None: self.name = name self.func = getattr(np, name) - def __call__(self, *args): + def __call__(self, *args) -> MathCall: return MathCall(self, args) diff --git a/pandas/core/computation/pytables.py b/pandas/core/computation/pytables.py index 77d8d79506258..138a3ee42f686 100644 --- a/pandas/core/computation/pytables.py +++ b/pandas/core/computation/pytables.py @@ -10,6 +10,7 @@ from typing import ( TYPE_CHECKING, Any, + ClassVar, ) import numpy as np @@ -40,7 +41,10 @@ ) if TYPE_CHECKING: - from pandas._typing import npt + from pandas._typing import ( + Self, + npt, + ) class PyTablesScope(_scope.Scope): @@ -283,7 +287,7 @@ def __repr__(self) -> str: return "Filter: Not Initialized" return pprint_thing(f"[Filter : [{self.filter[0]}] -> [{self.filter[1]}]") - def invert(self): + def invert(self) -> Self: """invert the filter""" if self.filter is not None: self.filter = ( @@ -297,7 +301,8 @@ def format(self): """return the actual filter format""" return [self.filter] - def evaluate(self): + # error: Signature of "evaluate" incompatible with supertype "BinOp" + def evaluate(self) -> Self | None: # type: ignore[override] if not self.is_valid: raise ValueError(f"query term is not valid [{self}]") @@ -336,7 +341,8 @@ class JointFilterBinOp(FilterBinOp): def format(self): raise NotImplementedError("unable to collapse Joint Filters") - def evaluate(self): + # error: Signature of "evaluate" incompatible with supertype "BinOp" + def evaluate(self) -> Self: # type: ignore[override] return self @@ -357,7 +363,8 @@ def format(self): """return the actual ne format""" return self.condition - def evaluate(self): + # error: Signature of "evaluate" incompatible with supertype "BinOp" + def evaluate(self) -> Self | None: # type: ignore[override] if not self.is_valid: raise ValueError(f"query term is not valid [{self}]") @@ -385,7 +392,8 @@ def evaluate(self): class JointConditionBinOp(ConditionBinOp): - def evaluate(self): + # error: Signature of "evaluate" incompatible with supertype "BinOp" + def evaluate(self) -> Self: # type: ignore[override] self.condition = f"({self.lhs.condition} {self.op} {self.rhs.condition})" return self @@ -410,8 +418,8 @@ def prune(self, klass): class PyTablesExprVisitor(BaseExprVisitor): - const_type = Constant - term_type = Term + const_type: ClassVar[type[ops.Term]] = Constant + term_type: ClassVar[type[Term]] = Term def __init__(self, env, engine, parser, **kwargs) -> None: super().__init__(env, engine, parser) @@ -423,13 +431,15 @@ def __init__(self, env, engine, parser, **kwargs) -> None: lambda node, bin_op=bin_op: partial(BinOp, bin_op, **kwargs), ) - def visit_UnaryOp(self, node, **kwargs): + def visit_UnaryOp(self, node, **kwargs) -> ops.Term | UnaryOp | None: if isinstance(node.op, (ast.Not, ast.Invert)): return UnaryOp("~", self.visit(node.operand)) elif isinstance(node.op, ast.USub): return self.const_type(-self.visit(node.operand).value, self.env) elif isinstance(node.op, ast.UAdd): raise NotImplementedError("Unary addition not supported") + # TODO: return None might never be reached + return None def visit_Index(self, node, **kwargs): return self.visit(node.value).value @@ -440,7 +450,7 @@ def visit_Assign(self, node, **kwargs): ) return self.visit(cmpr) - def visit_Subscript(self, node, **kwargs): + def visit_Subscript(self, node, **kwargs) -> ops.Term: # only allow simple subscripts value = self.visit(node.value) diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py index e3e38961a200b..66f00a7e9a805 100644 --- a/pandas/core/dtypes/dtypes.py +++ b/pandas/core/dtypes/dtypes.py @@ -77,6 +77,7 @@ DtypeObj, IntervalClosedType, Ordered, + Self, npt, type_t, ) @@ -973,7 +974,7 @@ class PeriodDtype(PeriodDtypeBase, PandasExtensionDtype): __hash__ = PeriodDtypeBase.__hash__ _freq: BaseOffset - def __new__(cls, freq): + def __new__(cls, freq) -> PeriodDtype: # noqa: PYI034 """ Parameters ---------- @@ -1004,11 +1005,11 @@ def __new__(cls, freq): u._freq = freq return u - def __reduce__(self): + def __reduce__(self) -> tuple[type_t[Self], tuple[str_type]]: return type(self), (self.name,) @property - def freq(self): + def freq(self) -> BaseOffset: """ The frequency object of this PeriodDtype. @@ -1729,7 +1730,7 @@ def fill_value(self): """ return self._fill_value - def _check_fill_value(self): + def _check_fill_value(self) -> None: if not lib.is_scalar(self._fill_value): raise ValueError( f"fill_value must be a scalar. Got {self._fill_value} instead" diff --git a/pandas/core/dtypes/inference.py b/pandas/core/dtypes/inference.py index 9c04e57be36fc..f551716772f61 100644 --- a/pandas/core/dtypes/inference.py +++ b/pandas/core/dtypes/inference.py @@ -401,7 +401,7 @@ def is_sequence(obj) -> bool: return False -def is_dataclass(item): +def is_dataclass(item) -> bool: """ Checks if the object is a data-class instance diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 282ecdcf31939..bd2a07afad688 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -12247,8 +12247,7 @@ def _to_dict_of_blocks(self, copy: bool = True): """ mgr = self._mgr # convert to BlockManager if needed -> this way support ArrayManager as well - mgr = mgr_to_mgr(mgr, "block") - mgr = cast(BlockManager, mgr) + mgr = cast(BlockManager, mgr_to_mgr(mgr, "block")) return { k: self._constructor_from_mgr(v, axes=v.axes).__finalize__(self) for k, v, in mgr.to_dict(copy=copy).items() diff --git a/pandas/core/groupby/generic.py b/pandas/core/groupby/generic.py index 8bef167b747e2..dbabd04a87c36 100644 --- a/pandas/core/groupby/generic.py +++ b/pandas/core/groupby/generic.py @@ -721,8 +721,10 @@ def nunique(self, dropna: bool = True) -> Series | DataFrame: return self._reindex_output(result, fill_value=0) @doc(Series.describe) - def describe(self, **kwargs): - return super().describe(**kwargs) + def describe(self, percentiles=None, include=None, exclude=None) -> Series: + return super().describe( + percentiles=percentiles, include=include, exclude=exclude + ) def value_counts( self, @@ -770,6 +772,7 @@ def value_counts( mask = ids != -1 ids, val = ids[mask], val[mask] + lab: Index | np.ndarray if bins is None: lab, lev = algorithms.factorize(val, sort=True) llab = lambda lab, inc: lab[inc] @@ -1152,7 +1155,7 @@ def alt(obj): @property @doc(Series.plot.__doc__) - def plot(self): + def plot(self) -> GroupByPlot: result = GroupByPlot(self) return result diff --git a/pandas/core/groupby/groupby.py b/pandas/core/groupby/groupby.py index 7f77c0c4826fb..11c97e30ab5cd 100644 --- a/pandas/core/groupby/groupby.py +++ b/pandas/core/groupby/groupby.py @@ -143,6 +143,7 @@ class providing the base-class of operations. if TYPE_CHECKING: from typing import Any + from pandas.core.resample import Resampler from pandas.core.window import ( ExpandingGroupby, ExponentialMovingWindowGroupby, @@ -2094,7 +2095,7 @@ def _obj_1d_constructor(self) -> Callable: @final @Substitution(name="groupby") @Substitution(see_also=_common_see_also) - def any(self, skipna: bool = True): + def any(self, skipna: bool = True) -> NDFrameT: """ Return True if any value in the group is truthful, else False. @@ -2150,7 +2151,7 @@ def any(self, skipna: bool = True): @final @Substitution(name="groupby") @Substitution(see_also=_common_see_also) - def all(self, skipna: bool = True): + def all(self, skipna: bool = True) -> NDFrameT: """ Return True if all values in the group are truthful, else False. @@ -2399,7 +2400,7 @@ def mean( return result.__finalize__(self.obj, method="groupby") @final - def median(self, numeric_only: bool = False): + def median(self, numeric_only: bool = False) -> NDFrameT: """ Compute median of groups, excluding missing values. @@ -2828,7 +2829,7 @@ def _value_counts( return result.__finalize__(self.obj, method="value_counts") @final - def sem(self, ddof: int = 1, numeric_only: bool = False): + def sem(self, ddof: int = 1, numeric_only: bool = False) -> NDFrameT: """ Compute standard error of the mean of groups, excluding missing values. @@ -3119,7 +3120,7 @@ def sum( 2 30 72""" ), ) - def prod(self, numeric_only: bool = False, min_count: int = 0): + def prod(self, numeric_only: bool = False, min_count: int = 0) -> NDFrameT: return self._agg_general( numeric_only=numeric_only, min_count=min_count, alias="prod", npfunc=np.prod ) @@ -3261,7 +3262,7 @@ def max( ) @final - def first(self, numeric_only: bool = False, min_count: int = -1): + def first(self, numeric_only: bool = False, min_count: int = -1) -> NDFrameT: """ Compute the first non-null entry of each column. @@ -3331,7 +3332,7 @@ def first(x: Series): ) @final - def last(self, numeric_only: bool = False, min_count: int = -1): + def last(self, numeric_only: bool = False, min_count: int = -1) -> NDFrameT: """ Compute the last non-null entry of each column. @@ -3518,7 +3519,7 @@ def describe( return result @final - def resample(self, rule, *args, **kwargs): + def resample(self, rule, *args, **kwargs) -> Resampler: """ Provide resampling when using a TimeGrouper. diff --git a/pandas/core/groupby/grouper.py b/pandas/core/groupby/grouper.py index add6c3ac4ec20..c51c17e04796a 100644 --- a/pandas/core/groupby/grouper.py +++ b/pandas/core/groupby/grouper.py @@ -289,12 +289,12 @@ def __init__( self.dropna = dropna self._grouper_deprecated = None - self._indexer_deprecated = None + self._indexer_deprecated: npt.NDArray[np.intp] | None = None self._obj_deprecated = None self._gpr_index = None self.binner = None self._grouper = None - self._indexer = None + self._indexer: npt.NDArray[np.intp] | None = None def _get_grouper( self, obj: NDFrameT, validate: bool = True @@ -329,8 +329,8 @@ def _get_grouper( @final def _set_grouper( - self, obj: NDFrame, sort: bool = False, *, gpr_index: Index | None = None - ): + self, obj: NDFrameT, sort: bool = False, *, gpr_index: Index | None = None + ) -> tuple[NDFrameT, Index, npt.NDArray[np.intp] | None]: """ given an object and the specifications, setup the internal grouper for this particular specification @@ -350,8 +350,6 @@ def _set_grouper( """ assert obj is not None - indexer = None - if self.key is not None and self.level is not None: raise ValueError("The Grouper cannot specify both a key and a level!") @@ -398,6 +396,7 @@ def _set_grouper( raise ValueError(f"The level {level} is not valid") # possibly sort + indexer: npt.NDArray[np.intp] | None = None if (self.sort or sort) and not ax.is_monotonic_increasing: # use stable sort to support first, last, nth # TODO: why does putting na_position="first" fix datetimelike cases? diff --git a/pandas/core/groupby/ops.py b/pandas/core/groupby/ops.py index 71525c8c1a223..607059e5183ec 100644 --- a/pandas/core/groupby/ops.py +++ b/pandas/core/groupby/ops.py @@ -77,7 +77,7 @@ from pandas.core.generic import NDFrame -def check_result_array(obj, dtype): +def check_result_array(obj, dtype) -> None: # Our operation is supposed to be an aggregation/reduction. If # it returns an ndarray, this likely means an invalid operation has # been passed. See test_apply_without_aggregation, test_agg_must_agg diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index 5134c506b8c61..af8fa441f8b3f 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -227,7 +227,7 @@ def to_pydatetime(self): ) return cast(ArrowExtensionArray, self._parent.array)._dt_to_pydatetime() - def isocalendar(self): + def isocalendar(self) -> DataFrame: from pandas import DataFrame result = ( diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index da16c3c54995a..6a397862712de 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1121,7 +1121,7 @@ def take( allow_fill: bool = True, fill_value=None, **kwargs, - ): + ) -> Self: if kwargs: nv.validate_take((), kwargs) if is_scalar(indices): @@ -1206,7 +1206,7 @@ def _maybe_disallow_fill(self, allow_fill: bool, fill_value, indices) -> bool: """ @Appender(_index_shared_docs["repeat"] % _index_doc_kwargs) - def repeat(self, repeats, axis: None = None): + def repeat(self, repeats, axis: None = None) -> Self: repeats = ensure_platform_int(repeats) nv.validate_repeat((), {"axis": axis}) res_values = self._values.repeat(repeats) @@ -3527,7 +3527,7 @@ def _intersection_via_get_indexer( Returns ------- - np.ndarray or ExtensionArray + np.ndarray or ExtensionArray or MultiIndex The returned array will be unique. """ left_unique = self.unique() @@ -3544,6 +3544,7 @@ def _intersection_via_get_indexer( # unnecessary in the case with sort=None bc we will sort later taker = np.sort(taker) + result: MultiIndex | ExtensionArray | np.ndarray if isinstance(left_unique, ABCMultiIndex): result = left_unique.take(taker) else: @@ -4445,7 +4446,7 @@ def _reindex_non_unique( indexer, missing = self.get_indexer_non_unique(target) check = indexer != -1 - new_labels = self.take(indexer[check]) + new_labels: Index | np.ndarray = self.take(indexer[check]) new_indexer = None if len(missing): @@ -5005,7 +5006,7 @@ def _wrap_joined_index( # expected "Self") mask = lidx == -1 join_idx = self.take(lidx) - right = other.take(ridx) + right = cast("MultiIndex", other.take(ridx)) join_index = join_idx.putmask(mask, right)._sort_levels_monotonic() return join_index.set_names(name) # type: ignore[return-value] else: @@ -6990,7 +6991,7 @@ def infer_objects(self, copy: bool = True) -> Index: result._references.add_index_reference(result) return result - def diff(self, periods: int = 1): + def diff(self, periods: int = 1) -> Self: """ Computes the difference between consecutive values in the Index object. @@ -7018,7 +7019,7 @@ def diff(self, periods: int = 1): """ return self._constructor(self.to_series().diff(periods)) - def round(self, decimals: int = 0): + def round(self, decimals: int = 0) -> Self: """ Round each value in the Index to the given number of decimals. diff --git a/pandas/core/indexes/frozen.py b/pandas/core/indexes/frozen.py index 2d1d2a81a8a71..9d528d34e3684 100644 --- a/pandas/core/indexes/frozen.py +++ b/pandas/core/indexes/frozen.py @@ -8,12 +8,18 @@ """ from __future__ import annotations -from typing import NoReturn +from typing import ( + TYPE_CHECKING, + NoReturn, +) from pandas.core.base import PandasObject from pandas.io.formats.printing import pprint_thing +if TYPE_CHECKING: + from pandas._typing import Self + class FrozenList(PandasObject, list): """ @@ -72,7 +78,7 @@ def __getitem__(self, n): return type(self)(super().__getitem__(n)) return super().__getitem__(n) - def __radd__(self, other): + def __radd__(self, other) -> Self: if isinstance(other, tuple): other = list(other) return type(self)(other + list(self)) @@ -84,7 +90,7 @@ def __eq__(self, other: object) -> bool: __req__ = __eq__ - def __mul__(self, other): + def __mul__(self, other) -> Self: return type(self)(super().__mul__(other)) __imul__ = __mul__ diff --git a/pandas/core/indexes/multi.py b/pandas/core/indexes/multi.py index ae0ab66dd5f3e..86d198059ea95 100644 --- a/pandas/core/indexes/multi.py +++ b/pandas/core/indexes/multi.py @@ -1030,7 +1030,7 @@ def levshape(self) -> Shape: # Codes Methods @property - def codes(self): + def codes(self) -> FrozenList: return self._codes def _set_codes( @@ -1074,7 +1074,9 @@ def _set_codes( self._reset_cache() - def set_codes(self, codes, *, level=None, verify_integrity: bool = True): + def set_codes( + self, codes, *, level=None, verify_integrity: bool = True + ) -> MultiIndex: """ Set new codes on MultiIndex. Defaults to returning new index. @@ -1199,7 +1201,7 @@ def copy( # type: ignore[override] names=None, deep: bool = False, name=None, - ): + ) -> Self: """ Make a copy of this object. @@ -1262,7 +1264,7 @@ def __array__(self, dtype=None) -> np.ndarray: """the array interface, return my values""" return self.values - def view(self, cls=None): + def view(self, cls=None) -> Self: """this is defined as a copy with the same identity""" result = self.copy() result._id = self._id @@ -1659,7 +1661,8 @@ def _get_level_values(self, level: int, unique: bool = False) -> Index: filled = algos.take_nd(lev._values, level_codes, fill_value=lev._na_value) return lev._shallow_copy(filled, name=name) - def get_level_values(self, level): + # error: Signature of "get_level_values" incompatible with supertype "Index" + def get_level_values(self, level) -> Index: # type: ignore[override] """ Return vector of label values for requested level. @@ -3304,7 +3307,7 @@ def convert_indexer(start, stop, step, indexer=indexer, codes=level_codes): raise KeyError(key) return slice(start, end) - def get_locs(self, seq): + def get_locs(self, seq) -> npt.NDArray[np.intp]: """ Get location for a sequence of labels. diff --git a/pandas/core/indexes/range.py b/pandas/core/indexes/range.py index 9576997af6641..aeb7bb1813fef 100644 --- a/pandas/core/indexes/range.py +++ b/pandas/core/indexes/range.py @@ -407,7 +407,7 @@ def inferred_type(self) -> str: # Indexing Methods @doc(Index.get_loc) - def get_loc(self, key): + def get_loc(self, key) -> int: if is_integer(key) or (is_float(key) and key.is_integer()): new_key = int(key) try: @@ -1107,14 +1107,16 @@ def _arith_method(self, other, op): # test_arithmetic_explicit_conversions return super()._arith_method(other, op) - def take( + # error: Return type "Index" of "take" incompatible with return type + # "RangeIndex" in supertype "Index" + def take( # type: ignore[override] self, indices, axis: Axis = 0, allow_fill: bool = True, fill_value=None, **kwargs, - ): + ) -> Index: if kwargs: nv.validate_take((), kwargs) if is_scalar(indices): diff --git a/pandas/core/indexing.py b/pandas/core/indexing.py index 97578e3f1668b..871e5817fdf0d 100644 --- a/pandas/core/indexing.py +++ b/pandas/core/indexing.py @@ -82,6 +82,7 @@ Axis, AxisInt, Self, + npt, ) from pandas import ( @@ -1384,7 +1385,7 @@ def _getitem_axis(self, key, axis: AxisInt): # nested tuple slicing if is_nested_tuple(key, labels): locs = labels.get_locs(key) - indexer = [slice(None)] * self.ndim + indexer: list[slice | npt.NDArray[np.intp]] = [slice(None)] * self.ndim indexer[axis] = locs return self.obj.iloc[tuple(indexer)] diff --git a/pandas/core/internals/array_manager.py b/pandas/core/internals/array_manager.py index 14969425e75a7..b4e3fdb78b77b 100644 --- a/pandas/core/internals/array_manager.py +++ b/pandas/core/internals/array_manager.py @@ -1103,7 +1103,7 @@ def _verify_integrity(self) -> None: def _normalize_axis(axis): return axis - def make_empty(self, axes=None) -> SingleArrayManager: + def make_empty(self, axes=None) -> Self: """Return an empty ArrayManager with index/array of length 0""" if axes is None: axes = [Index([], dtype=object)] diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index 43f4f527afc3a..61aa8549a6790 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -2126,8 +2126,9 @@ def is_view(self) -> bool: """Extension arrays are never treated as views.""" return False + # error: Cannot override writeable attribute with read-only property @cache_readonly - def is_numeric(self): + def is_numeric(self) -> bool: # type: ignore[override] return self.values.dtype._is_numeric def _slice( diff --git a/pandas/core/internals/construction.py b/pandas/core/internals/construction.py index 5c8873d4324e0..aeadd75b22b33 100644 --- a/pandas/core/internals/construction.py +++ b/pandas/core/internals/construction.py @@ -193,7 +193,7 @@ def rec_array_to_mgr( return mgr -def mgr_to_mgr(mgr, typ: str, copy: bool = True): +def mgr_to_mgr(mgr, typ: str, copy: bool = True) -> Manager: """ Convert to specific type of Manager. Does not copy if the type is already correct. Does not guarantee a copy otherwise. `copy` keyword only controls diff --git a/pandas/core/internals/managers.py b/pandas/core/internals/managers.py index b315a318a9a0a..4cb7b610074ba 100644 --- a/pandas/core/internals/managers.py +++ b/pandas/core/internals/managers.py @@ -93,6 +93,8 @@ npt, ) + from pandas.api.extensions import ExtensionArray + class BaseBlockManager(DataManager): """ @@ -1046,7 +1048,7 @@ def iset( value: ArrayLike, inplace: bool = False, refs: BlockValuesRefs | None = None, - ): + ) -> None: """ Set new item in-place. Does not consolidate. Adds new Block if not contained in the current set of items @@ -1870,7 +1872,7 @@ def __getstate__(self): # compatibility with 0.13.1. return axes_array, block_values, block_items, extra_state - def __setstate__(self, state): + def __setstate__(self, state) -> None: def unpickle_block(values, mgr_locs, ndim: int) -> Block: # TODO(EA2D): ndim would be unnecessary with 2D EAs # older pickles may store e.g. DatetimeIndex instead of DatetimeArray @@ -1959,7 +1961,7 @@ def internal_values(self): """The array that Series._values returns""" return self._block.values - def array_values(self): + def array_values(self) -> ExtensionArray: """The array that Series.array returns""" return self._block.array_values diff --git a/pandas/core/missing.py b/pandas/core/missing.py index 58b0e2907b8ce..d275445983b6f 100644 --- a/pandas/core/missing.py +++ b/pandas/core/missing.py @@ -12,6 +12,7 @@ Any, Literal, cast, + overload, ) import numpy as np @@ -124,9 +125,33 @@ def mask_missing(arr: ArrayLike, values_to_mask) -> npt.NDArray[np.bool_]: return mask -def clean_fill_method(method: str, allow_nearest: bool = False): +@overload +def clean_fill_method( + method: Literal["ffill", "pad", "bfill", "backfill"], + *, + allow_nearest: Literal[False] = ..., +) -> Literal["pad", "backfill"]: + ... + + +@overload +def clean_fill_method( + method: Literal["ffill", "pad", "bfill", "backfill", "nearest"], + *, + allow_nearest: Literal[True], +) -> Literal["pad", "backfill", "nearest"]: + ... + + +def clean_fill_method( + method: Literal["ffill", "pad", "bfill", "backfill", "nearest"], + *, + allow_nearest: bool = False, +) -> Literal["pad", "backfill", "nearest"]: if isinstance(method, str): - method = method.lower() + # error: Incompatible types in assignment (expression has type "str", variable + # has type "Literal['ffill', 'pad', 'bfill', 'backfill', 'nearest']") + method = method.lower() # type: ignore[assignment] if method == "ffill": method = "pad" elif method == "bfill": @@ -252,7 +277,9 @@ def validate_limit_area(limit_area: str | None) -> Literal["inside", "outside"] return limit_area # type: ignore[return-value] -def infer_limit_direction(limit_direction, method): +def infer_limit_direction( + limit_direction: Literal["backward", "forward", "both"] | None, method: str +) -> Literal["backward", "forward", "both"]: # Set `limit_direction` depending on `method` if limit_direction is None: if method in ("backfill", "bfill"): diff --git a/pandas/core/resample.py b/pandas/core/resample.py index e45cff0b0679f..5ff18d8a25e36 100644 --- a/pandas/core/resample.py +++ b/pandas/core/resample.py @@ -1676,6 +1676,8 @@ def _gotitem(self, key, ndim, subset=None): class DatetimeIndexResampler(Resampler): + ax: DatetimeIndex + @property def _resampler_for_grouping(self): return DatetimeIndexResamplerGroupby @@ -1807,7 +1809,11 @@ def _wrap_result(self, result): return result -class DatetimeIndexResamplerGroupby(_GroupByMixin, DatetimeIndexResampler): +# error: Definition of "ax" in base class "_GroupByMixin" is incompatible +# with definition in base class "DatetimeIndexResampler" +class DatetimeIndexResamplerGroupby( # type: ignore[misc] + _GroupByMixin, DatetimeIndexResampler +): """ Provides a resample of a groupby implementation """ @@ -1818,6 +1824,10 @@ def _resampler_cls(self): class PeriodIndexResampler(DatetimeIndexResampler): + # error: Incompatible types in assignment (expression has type "PeriodIndex", base + # class "DatetimeIndexResampler" defined the type as "DatetimeIndex") + ax: PeriodIndex # type: ignore[assignment] + @property def _resampler_for_grouping(self): return PeriodIndexResamplerGroupby @@ -1924,7 +1934,11 @@ def _upsample(self, method, limit: int | None = None, fill_value=None): return self._wrap_result(new_obj) -class PeriodIndexResamplerGroupby(_GroupByMixin, PeriodIndexResampler): +# error: Definition of "ax" in base class "_GroupByMixin" is incompatible with +# definition in base class "PeriodIndexResampler" +class PeriodIndexResamplerGroupby( # type: ignore[misc] + _GroupByMixin, PeriodIndexResampler +): """ Provides a resample of a groupby implementation. """ @@ -1935,6 +1949,10 @@ def _resampler_cls(self): class TimedeltaIndexResampler(DatetimeIndexResampler): + # error: Incompatible types in assignment (expression has type "TimedeltaIndex", + # base class "DatetimeIndexResampler" defined the type as "DatetimeIndex") + ax: TimedeltaIndex # type: ignore[assignment] + @property def _resampler_for_grouping(self): return TimedeltaIndexResamplerGroupby @@ -1952,7 +1970,11 @@ def _adjust_binner_for_upsample(self, binner): return binner -class TimedeltaIndexResamplerGroupby(_GroupByMixin, TimedeltaIndexResampler): +# error: Definition of "ax" in base class "_GroupByMixin" is incompatible with +# definition in base class "DatetimeIndexResampler" +class TimedeltaIndexResamplerGroupby( # type: ignore[misc] + _GroupByMixin, TimedeltaIndexResampler +): """ Provides a resample of a groupby implementation. """ diff --git a/pandas/core/reshape/concat.py b/pandas/core/reshape/concat.py index ffa7199921298..1bc548de91f01 100644 --- a/pandas/core/reshape/concat.py +++ b/pandas/core/reshape/concat.py @@ -76,7 +76,7 @@ def concat( axis: Literal[0, "index"] = ..., join: str = ..., ignore_index: bool = ..., - keys=..., + keys: Iterable[Hashable] | None = ..., levels=..., names: list[HashableT] | None = ..., verify_integrity: bool = ..., @@ -93,7 +93,7 @@ def concat( axis: Literal[0, "index"] = ..., join: str = ..., ignore_index: bool = ..., - keys=..., + keys: Iterable[Hashable] | None = ..., levels=..., names: list[HashableT] | None = ..., verify_integrity: bool = ..., @@ -110,7 +110,7 @@ def concat( axis: Literal[0, "index"] = ..., join: str = ..., ignore_index: bool = ..., - keys=..., + keys: Iterable[Hashable] | None = ..., levels=..., names: list[HashableT] | None = ..., verify_integrity: bool = ..., @@ -127,7 +127,7 @@ def concat( axis: Literal[1, "columns"], join: str = ..., ignore_index: bool = ..., - keys=..., + keys: Iterable[Hashable] | None = ..., levels=..., names: list[HashableT] | None = ..., verify_integrity: bool = ..., @@ -144,7 +144,7 @@ def concat( axis: Axis = ..., join: str = ..., ignore_index: bool = ..., - keys=..., + keys: Iterable[Hashable] | None = ..., levels=..., names: list[HashableT] | None = ..., verify_integrity: bool = ..., @@ -160,7 +160,7 @@ def concat( axis: Axis = 0, join: str = "outer", ignore_index: bool = False, - keys=None, + keys: Iterable[Hashable] | None = None, levels=None, names: list[HashableT] | None = None, verify_integrity: bool = False, @@ -405,7 +405,7 @@ def __init__( objs: Iterable[Series | DataFrame] | Mapping[HashableT, Series | DataFrame], axis: Axis = 0, join: str = "outer", - keys=None, + keys: Iterable[Hashable] | None = None, levels=None, names: list[HashableT] | None = None, ignore_index: bool = False, diff --git a/pandas/core/reshape/merge.py b/pandas/core/reshape/merge.py index 13bc1008698b2..f3695fb87ea78 100644 --- a/pandas/core/reshape/merge.py +++ b/pandas/core/reshape/merge.py @@ -105,6 +105,7 @@ from pandas import DataFrame from pandas.core import groupby from pandas.core.arrays import DatetimeArray + from pandas.core.indexes.frozen import FrozenList _factorizers = { np.int64: libhashtable.Int64Factorizer, @@ -1738,7 +1739,7 @@ def restore_dropped_levels_multijoin( join_index: Index, lindexer: npt.NDArray[np.intp], rindexer: npt.NDArray[np.intp], -) -> tuple[list[Index], npt.NDArray[np.intp], list[Hashable]]: +) -> tuple[FrozenList, FrozenList, FrozenList]: """ *this is an internal non-public method* @@ -1814,7 +1815,7 @@ def _convert_to_multiindex(index: Index) -> MultiIndex: # error: Cannot determine type of "__add__" join_levels = join_levels + [restore_levels] # type: ignore[has-type] - join_codes = join_codes + [restore_codes] + join_codes = join_codes + [restore_codes] # type: ignore[has-type] join_names = join_names + [dropped_level_name] return join_levels, join_codes, join_names diff --git a/pandas/core/reshape/pivot.py b/pandas/core/reshape/pivot.py index 71e3ea5b2588e..924b56f7a14d5 100644 --- a/pandas/core/reshape/pivot.py +++ b/pandas/core/reshape/pivot.py @@ -522,6 +522,7 @@ def pivot( cols + columns_listlike, append=append # type: ignore[operator] ) else: + index_list: list[Index] | list[Series] if index is lib.no_default: if isinstance(data.index, MultiIndex): # GH 23955 diff --git a/pandas/core/series.py b/pandas/core/series.py index a44f6bc01328d..9b5c8829fd5ff 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -4398,7 +4398,7 @@ def explode(self, ignore_index: bool = False) -> Series: return result.reset_index(drop=True) if ignore_index else result if ignore_index: - index = default_index(len(values)) + index: Index = default_index(len(values)) else: index = self.index.repeat(counts) diff --git a/pandas/core/strings/accessor.py b/pandas/core/strings/accessor.py index 124ca546c4583..71d6f9c58e2c2 100644 --- a/pandas/core/strings/accessor.py +++ b/pandas/core/strings/accessor.py @@ -372,7 +372,7 @@ def cons_row(x): if expand: result = list(result) - out = MultiIndex.from_tuples(result, names=name) + out: Index = MultiIndex.from_tuples(result, names=name) if out.nlevels == 1: # We had all tuples of length-one, which are # better represented as a regular Index. diff --git a/pandas/io/pytables.py b/pandas/io/pytables.py index fb0354ef9df6c..c0a27ecfec803 100644 --- a/pandas/io/pytables.py +++ b/pandas/io/pytables.py @@ -2823,7 +2823,7 @@ def read( "cannot read on an abstract storer: subclasses should implement" ) - def write(self, **kwargs): + def write(self, obj, **kwargs) -> None: raise NotImplementedError( "cannot write on an abstract storer: subclasses should implement" ) @@ -2937,8 +2937,7 @@ def get_attrs(self) -> None: for n in self.attributes: setattr(self, n, _ensure_decoded(getattr(self.attrs, n, None))) - # error: Signature of "write" incompatible with supertype "Fixed" - def write(self, obj, **kwargs) -> None: # type: ignore[override] + def write(self, obj, **kwargs) -> None: self.set_attrs() def read_array(self, key: str, start: int | None = None, stop: int | None = None): @@ -3226,8 +3225,7 @@ def read( result = result.astype("string[pyarrow_numpy]") return result - # error: Signature of "write" incompatible with supertype "Fixed" - def write(self, obj, **kwargs) -> None: # type: ignore[override] + def write(self, obj, **kwargs) -> None: super().write(obj, **kwargs) self.write_index("index", obj.index) self.write_array("values", obj) @@ -3303,8 +3301,7 @@ def read( return DataFrame(columns=axes[0], index=axes[1]) - # error: Signature of "write" incompatible with supertype "Fixed" - def write(self, obj, **kwargs) -> None: # type: ignore[override] + def write(self, obj, **kwargs) -> None: super().write(obj, **kwargs) # TODO(ArrayManager) HDFStore relies on accessing the blocks @@ -4355,7 +4352,7 @@ def read( """ raise NotImplementedError("WORMTable needs to implement read") - def write(self, **kwargs) -> None: + def write(self, obj, **kwargs) -> None: """ write in a format that we can search later on (but cannot append to): write out the indices and the values using _write_array @@ -4712,12 +4709,13 @@ def is_transposed(self) -> bool: def get_object(cls, obj, transposed: bool): return obj - def write(self, obj, data_columns=None, **kwargs): + # error: Signature of "write" incompatible with supertype "Fixed" + def write(self, obj, data_columns=None, **kwargs) -> None: # type: ignore[override] """we are going to write this as a frame table""" if not isinstance(obj, DataFrame): name = obj.name or "values" obj = obj.to_frame(name) - return super().write(obj=obj, data_columns=obj.columns.tolist(), **kwargs) + super().write(obj=obj, data_columns=obj.columns.tolist(), **kwargs) def read( self, @@ -4750,7 +4748,8 @@ class AppendableMultiSeriesTable(AppendableSeriesTable): pandas_kind = "series_table" table_type = "appendable_multiseries" - def write(self, obj, **kwargs): + # error: Signature of "write" incompatible with supertype "Fixed" + def write(self, obj, **kwargs) -> None: # type: ignore[override] """we are going to write this as a frame table""" name = obj.name or "values" newobj, self.levels = self.validate_multiindex(obj) @@ -4758,7 +4757,7 @@ def write(self, obj, **kwargs): cols = list(self.levels) cols.append(name) newobj.columns = Index(cols) - return super().write(obj=newobj, **kwargs) + super().write(obj=newobj, **kwargs) class GenericTable(AppendableFrameTable): @@ -4823,7 +4822,8 @@ def indexables(self): return _indexables - def write(self, **kwargs): + # error: Signature of "write" incompatible with supertype "AppendableTable" + def write(self, **kwargs) -> None: # type: ignore[override] raise NotImplementedError("cannot write on an generic table") @@ -4839,7 +4839,8 @@ class AppendableMultiFrameTable(AppendableFrameTable): def table_type_short(self) -> str: return "appendable_multi" - def write(self, obj, data_columns=None, **kwargs): + # error: Signature of "write" incompatible with supertype "Fixed" + def write(self, obj, data_columns=None, **kwargs) -> None: # type: ignore[override] if data_columns is None: data_columns = [] elif data_columns is True: @@ -4849,7 +4850,7 @@ def write(self, obj, data_columns=None, **kwargs): for n in self.levels: if n not in data_columns: data_columns.insert(0, n) - return super().write(obj=obj, data_columns=data_columns, **kwargs) + super().write(obj=obj, data_columns=data_columns, **kwargs) def read( self,
"simple" meaning, non-unions and non-overload return types (at least in most cases). xref #47521 edit: sorry for changes in many files - I grep'ed for missing return types inferred by pyright and then fixed the resulting type errors.
https://api.github.com/repos/pandas-dev/pandas/pulls/54786
2023-08-28T00:20:20Z
2023-08-31T17:52:56Z
2023-08-31T17:52:56Z
2023-09-19T15:24:48Z
Backport PR #54783 on branch 2.1.x (CI: Remove strict option)
diff --git a/.github/workflows/code-checks.yml b/.github/workflows/code-checks.yml index 9daa1a67bc2c1..f87aef5385898 100644 --- a/.github/workflows/code-checks.yml +++ b/.github/workflows/code-checks.yml @@ -124,7 +124,7 @@ jobs: run: | cd asv_bench asv machine --yes - asv run --quick --dry-run --strict --durations=30 --python=same + asv run --quick --dry-run --durations=30 --python=same build_docker_dev_environment: name: Build Docker Dev Environment
Backport PR #54783: CI: Remove strict option
https://api.github.com/repos/pandas-dev/pandas/pulls/54785
2023-08-27T23:38:00Z
2023-08-28T05:01:15Z
2023-08-28T05:01:15Z
2023-08-28T05:01:16Z
CI: Unpin Cython
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 6410f2edd6175..1445e5e822017 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -233,8 +233,8 @@ jobs: run: | /opt/python/cp311-cp311/bin/python -m venv ~/virtualenvs/pandas-dev . ~/virtualenvs/pandas-dev/bin/activate - python -m pip install --no-cache-dir -U pip wheel setuptools meson[ninja]==1.0.1 meson-python==0.13.1 - python -m pip install --no-cache-dir versioneer[toml] "cython<3.0.1" numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 + python -m pip install --no-cache-dir -U pip wheel setuptools meson[ninja]==1.2.1 meson-python==0.13.1 + python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 python -m pip install --no-cache-dir --no-build-isolation -e . python -m pip list --no-cache-dir export PANDAS_CI=1 @@ -271,8 +271,8 @@ jobs: run: | /opt/python/cp311-cp311/bin/python -m venv ~/virtualenvs/pandas-dev . ~/virtualenvs/pandas-dev/bin/activate - python -m pip install --no-cache-dir -U pip wheel setuptools meson-python==0.13.1 meson[ninja]==1.0.1 - python -m pip install --no-cache-dir versioneer[toml] "cython<3.0.1" numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 + python -m pip install --no-cache-dir -U pip wheel setuptools meson-python==0.13.1 meson[ninja]==1.2.1 + python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 python -m pip install --no-cache-dir --no-build-isolation -e . python -m pip list --no-cache-dir @@ -342,10 +342,10 @@ jobs: - name: Build Environment run: | python --version - python -m pip install --upgrade pip setuptools wheel meson[ninja]==1.0.1 meson-python==0.13.1 + python -m pip install --upgrade pip setuptools wheel meson[ninja]==1.2.1 meson-python==0.13.1 python -m pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy python -m pip install versioneer[toml] - python -m pip install python-dateutil pytz tzdata "cython<3.0.1" hypothesis>=6.46.1 pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-cov pytest-asyncio>=0.17 + python -m pip install python-dateutil pytz tzdata cython hypothesis>=6.46.1 pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-cov pytest-asyncio>=0.17 python -m pip install -ve . --no-build-isolation --no-index python -m pip list diff --git a/ci/deps/actions-310.yaml b/ci/deps/actions-310.yaml index 2190136220c6c..edd48604dbfda 100644 --- a/ci/deps/actions-310.yaml +++ b/ci/deps/actions-310.yaml @@ -6,8 +6,8 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33, <3.0.1 - - meson[ninja]=1.0.1 + - cython>=0.29.33 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-311-downstream_compat.yaml b/ci/deps/actions-311-downstream_compat.yaml index cf85345cb0cc2..2fb6072314b1e 100644 --- a/ci/deps/actions-311-downstream_compat.yaml +++ b/ci/deps/actions-311-downstream_compat.yaml @@ -7,8 +7,8 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33, <3.0.1 - - meson[ninja]=1.0.1 + - cython>=0.29.33 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-311-numpydev.yaml b/ci/deps/actions-311-numpydev.yaml index acf94fce5288b..7fd3a65ec91f8 100644 --- a/ci/deps/actions-311-numpydev.yaml +++ b/ci/deps/actions-311-numpydev.yaml @@ -6,8 +6,9 @@ dependencies: # build dependencies - versioneer[toml] - - meson[ninja]=1.0.1 + - meson[ninja]=1.2.1 - meson-python=0.13.1 + - cython>=0.29.33 # test dependencies - pytest>=7.3.2 @@ -25,7 +26,6 @@ dependencies: - pip - pip: - - "cython<3.0.1" - "--extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple" - "--pre" - "numpy" diff --git a/ci/deps/actions-311-pyarrownightly.yaml b/ci/deps/actions-311-pyarrownightly.yaml index e850f69f945c5..893341350f4ef 100644 --- a/ci/deps/actions-311-pyarrownightly.yaml +++ b/ci/deps/actions-311-pyarrownightly.yaml @@ -6,8 +6,8 @@ dependencies: # build dependencies - versioneer[toml] - - meson[ninja]=1.0.1 - - cython>=0.29.33, <3.0.1 + - meson[ninja]=1.2.1 + - cython>=0.29.33 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-311.yaml b/ci/deps/actions-311.yaml index 3c1630714a041..029312202bcaa 100644 --- a/ci/deps/actions-311.yaml +++ b/ci/deps/actions-311.yaml @@ -6,8 +6,8 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33, <3.0.1 - - meson[ninja]=1.0.1 + - cython>=0.29.33 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-39-minimum_versions.yaml b/ci/deps/actions-39-minimum_versions.yaml index b1cea49e22d15..2a7312cefe619 100644 --- a/ci/deps/actions-39-minimum_versions.yaml +++ b/ci/deps/actions-39-minimum_versions.yaml @@ -8,8 +8,8 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33, <3.0.1 - - meson[ninja]=1.0.1 + - cython>=0.29.33 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-39.yaml b/ci/deps/actions-39.yaml index b8a119ece4b03..12893698b5534 100644 --- a/ci/deps/actions-39.yaml +++ b/ci/deps/actions-39.yaml @@ -6,8 +6,8 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33, <3.0.1 - - meson[ninja]=1.0.1 + - cython>=0.29.33 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-pypy-39.yaml b/ci/deps/actions-pypy-39.yaml index 23c3706f43dad..4923c94ab08f3 100644 --- a/ci/deps/actions-pypy-39.yaml +++ b/ci/deps/actions-pypy-39.yaml @@ -9,8 +9,8 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33, <3.0.1 - - meson[ninja]=1.0.1 + - cython>=0.29.33 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/circle-310-arm64.yaml b/ci/deps/circle-310-arm64.yaml index 71686837451b4..a945dbfe2ca20 100644 --- a/ci/deps/circle-310-arm64.yaml +++ b/ci/deps/circle-310-arm64.yaml @@ -6,8 +6,8 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33, <3.0.1 - - meson[ninja]=1.0.1 + - cython>=0.29.33 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/environment.yml b/environment.yml index 1a9dffb55bca7..d194b11df7195 100644 --- a/environment.yml +++ b/environment.yml @@ -9,7 +9,7 @@ dependencies: # build dependencies - versioneer[toml] - cython=0.29.33 - - meson[ninja]=1.0.1 + - meson[ninja]=1.2.1 - meson-python=0.13.1 # test dependencies diff --git a/meson.build b/meson.build index 09a1494135af4..ddaf642f974c9 100644 --- a/meson.build +++ b/meson.build @@ -4,7 +4,7 @@ project( 'c', 'cpp', 'cython', version: run_command(['python', 'generate_version.py', '--print'], check: true).stdout().strip(), license: 'BSD-3', - meson_version: '>=1.0.1', + meson_version: '>=1.2.1', default_options: [ 'buildtype=release', # TODO: Reactivate werror, some warnings on Windows diff --git a/pyproject.toml b/pyproject.toml index 74d6aaee286a9..ccb21a5f36ded 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ # See https://github.com/scipy/scipy/pull/12940 for the AIX issue. requires = [ "meson-python==0.13.1", - "meson==1.0.1", + "meson==1.2.1", "wheel", "Cython>=0.29.33,<3", # Note: sync with setup.py, environment.yml and asv.conf.json # Note: numpy 1.25 has a backwards compatible C API by default diff --git a/requirements-dev.txt b/requirements-dev.txt index be02007a36333..0177016806b0e 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -4,7 +4,7 @@ pip versioneer[toml] cython==0.29.33 -meson[ninja]==1.0.1 +meson[ninja]==1.2.1 meson-python==0.13.1 pytest>=7.3.2 pytest-cov
- [ ] closes #54756 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54784
2023-08-27T21:52:58Z
2023-09-16T02:03:22Z
2023-09-16T02:03:22Z
2023-09-16T13:37:46Z
CI: Remove strict option
diff --git a/.github/workflows/code-checks.yml b/.github/workflows/code-checks.yml index 9daa1a67bc2c1..f87aef5385898 100644 --- a/.github/workflows/code-checks.yml +++ b/.github/workflows/code-checks.yml @@ -124,7 +124,7 @@ jobs: run: | cd asv_bench asv machine --yes - asv run --quick --dry-run --strict --durations=30 --python=same + asv run --quick --dry-run --durations=30 --python=same build_docker_dev_environment: name: Build Docker Dev Environment
It is there by default in asv > 0.6.0 - [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54783
2023-08-27T21:42:06Z
2023-08-27T23:36:38Z
2023-08-27T23:36:38Z
2023-08-28T01:16:33Z
ENH: 54714 repeated sampling improvement
diff --git a/doc/source/user_guide/indexing.rst b/doc/source/user_guide/indexing.rst index 52bc43f52b1d3..04c37c572e37e 100644 --- a/doc/source/user_guide/indexing.rst +++ b/doc/source/user_guide/indexing.rst @@ -719,8 +719,7 @@ as a string. df3 = pd.DataFrame({'col1': [1, 2, 3], 'col2': [2, 3, 4]}) df3.sample(n=1, axis=1) - -Finally, one can also set a seed for ``sample``'s random number generator using the ``random_state`` argument, which will accept either an integer (as a seed) or a NumPy RandomState object. +One can also set a seed for ``sample``'s random number generator using the ``random_state`` argument, which will accept either an integer (as a seed) or a NumPy RandomState object. .. ipython:: python @@ -730,6 +729,18 @@ Finally, one can also set a seed for ``sample``'s random number generator using df4.sample(n=2, random_state=2) df4.sample(n=2, random_state=2) +Finally, random selection of ``n_samples`` count of samples each with ``n`` rows or columns from a Series or DataFrame. Accepts ``n_samples`` count of different samples, and accepts a specific number of rows/columns to return, or a fraction of rows. + +.. ipython:: python + + df5 = pd.Series([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]) + df5.sample(n=2, n_samples=2) + + # Selecting 3 samples of 4 size with replacement: + df5.sample(n=4, n_samples=3, replace = True) + + # Selecting 2 samples of 3 size without replacement: + df5.sample(n=3, n_samples=2, replace = False) Setting with enlargement diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 8f2667d69a322..c47b312b06b75 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -14,6 +14,19 @@ including other versions of pandas. Enhancements ~~~~~~~~~~~~ +.. _whatsnew_210.enhancements.sampling_improvements: + +Sample methods in DataFrame and Groupby will now include a ``n_sampling`` parameter +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Addition of ``n_sampling`` parameter to :meth:`DataFrame.sample` and :meth:`Groupby.sample`. (:issue:`54714`) + +Currently, there is no way to take repeated samples to create a sampling distribution using pandas alone. +One would need to create a list comprehension to perform the same, and numpy.random.choice has been preferred for the same, +as it takes ~700ms compared to the pandas sample method taking ~25s for 1M values. + +The new proposed method takes ~ 25ms for the same and performs the task 1000x faster than the current sample feature. + .. _whatsnew_210.enhancements.pyarrow_dependency: PyArrow will become a required dependency with pandas 3.0 diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b87772594cfbf..631333c0904f0 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -5905,13 +5905,14 @@ def sample( n: int | None = None, frac: float | None = None, replace: bool_t = False, + n_samples: int | None = None, weights=None, random_state: RandomState | None = None, axis: Axis | None = None, ignore_index: bool_t = False, ) -> Self: """ - Return a random sample of items from an axis of object. + Return a random sample or array of samples of items from an axis of object. You can use `random_state` for reproducibility. @@ -5924,6 +5925,8 @@ def sample( Fraction of axis items to return. Cannot be used with `n`. replace : bool, default False Allow or disallow sampling of the same row more than once. + n_samples : int, optional + Number of samples to be picked. Each sample will contain `n` rows or `frac` * len(`df`) rows. weights : str or ndarray-like, optional Default 'None' results in equal probability weighting. If passed a Series, will align with target object on index. Index @@ -6002,19 +6005,19 @@ def sample( dog 4 0 2 fish 0 0 8 + Sampling 3 times with a random sample of 2 elements each time, of the ``DataFrame`` with replacement: + An upsample sample of the ``DataFrame`` with replacement: Note that `replace` parameter has to be `True` for `frac` parameter > 1. - >>> df.sample(frac=2, replace=True, random_state=1) - num_legs num_wings num_specimen_seen - dog 4 0 2 - fish 0 0 8 - falcon 2 2 10 - falcon 2 2 10 - fish 0 0 8 - dog 4 0 2 - fish 0 0 8 - dog 4 0 2 + >>> df.sample(n = 2,n_samples=3, replace=True, random_state=1) + num_legs num_wings num_specimen_seen sample_no + dog 4 0 2 0 + fish 0 0 8 0 + falcon 2 2 10 1 + falcon 2 2 10 1 + fish 0 0 8 2 + dog 4 0 2 2 Using a DataFrame column as weights. Rows with larger value in the `num_specimen_seen` column are more likely to be sampled. @@ -6027,6 +6030,10 @@ def sample( if axis is None: axis = 0 + # if n_samples is None, set the number of samples to 1 + if n_samples is None: + n_samples = 1 + axis = self._get_axis_number(axis) obj_len = self.shape[axis] @@ -6041,9 +6048,23 @@ def sample( if weights is not None: weights = sample.preprocess_weights(self, weights, axis) - sampled_indices = sample.sample(obj_len, size, replace, weights, rs) + sampled_indices = sample.sample( + obj_len=obj_len, + size=size, + replace=replace, + n_samples=n_samples, + weights=weights, + random_state=rs, + ) result = self.take(sampled_indices, axis=axis) + if n_samples > 1: + sample_no = np.repeat(np.arange(n_samples), size) + + sampled_indices = np.reshape(sampled_indices, (n_samples, size)) + + result = result.assign(sample_no=sample_no) + if ignore_index: result.index = default_index(len(result)) diff --git a/pandas/core/groupby/groupby.py b/pandas/core/groupby/groupby.py index f0d73811227fa..92008073f682f 100644 --- a/pandas/core/groupby/groupby.py +++ b/pandas/core/groupby/groupby.py @@ -5541,6 +5541,7 @@ def sample( n: int | None = None, frac: float | None = None, replace: bool = False, + n_samples: int | None = None, weights: Sequence | Series | None = None, random_state: RandomState | None = None, ): @@ -5559,6 +5560,8 @@ def sample( Fraction of items to return. Cannot be used with `n`. replace : bool, default False Allow or disallow sampling of the same row more than once. + n_samples : int, optional + Number of samples to be picked. Each sample will contain `n` rows or `frac` * len(`df`) rows. weights : list-like, optional Default None results in equal probability weighting. If passed a list-like then values must have the same length as @@ -5628,7 +5631,24 @@ def sample( 5 black 5 2 blue 2 0 red 0 + + >>> df.groupby("a").sample( + ... n=1, + ... n_samples = 2, + ... random_state=1 + ... ) + a b + 4 black 4 + 5 black 5 + 2 blue 2 + 3 blue 3 + 1 red 1 + 0 red 0 """ # noqa: E501 + # if n_samples is None, set the number of samples to 1 + if n_samples is None: + n_samples = 1 + if self._selected_obj.empty: # GH48459 prevent ValueError when object is empty return self._selected_obj @@ -5656,6 +5676,7 @@ def sample( group_size, size=sample_size, replace=replace, + n_samples=n_samples, weights=None if weights is None else weights_arr[grp_indices], random_state=random_state, ) diff --git a/pandas/core/sample.py b/pandas/core/sample.py index eebbed3512c4e..33a78cd46266d 100644 --- a/pandas/core/sample.py +++ b/pandas/core/sample.py @@ -118,11 +118,12 @@ def sample( obj_len: int, size: int, replace: bool, + n_samples: int, weights: np.ndarray | None, random_state: np.random.RandomState | np.random.Generator, ) -> np.ndarray: """ - Randomly sample `size` indices in `np.arange(obj_len)` + Randomly sample `size` indices in `np.arange(obj_len)` once or `n_samples` times Parameters ---------- @@ -132,6 +133,8 @@ def sample( The number of values to choose replace : bool Allow or disallow sampling of the same row more than once. + n_samples : int + Number of samples to pick from the vector space weights : np.ndarray[np.float64] or None If None, equal probability weighting, otherwise weights according to the vector normalized @@ -140,8 +143,12 @@ def sample( Returns ------- - np.ndarray[np.intp] + np.ndarray[np.intp,np.intp] """ + if n_samples is None: + n_samples = 1 + + # GH 54714 if weights is not None: weight_sum = weights.sum() if weight_sum != 0: @@ -149,6 +156,8 @@ def sample( else: raise ValueError("Invalid weights: weights sum to zero") - return random_state.choice(obj_len, size=size, replace=replace, p=weights).astype( - np.intp, copy=False - ) + total_size = size * n_samples + + return random_state.choice( + obj_len, size=total_size, replace=replace, p=weights + ).astype(np.intp, copy=False) diff --git a/pandas/tests/groupby/test_sample.py b/pandas/tests/groupby/test_sample.py index 4dd474741740d..30dcef4360ceb 100644 --- a/pandas/tests/groupby/test_sample.py +++ b/pandas/tests/groupby/test_sample.py @@ -145,10 +145,21 @@ def test_groupby_sample_with_selections(): def test_groupby_sample_with_empty_inputs(): - # GH48459 + # GH 48459 df = DataFrame({"a": [], "b": []}) groupby_df = df.groupby("a") result = groupby_df.sample() expected = df tm.assert_frame_equal(result, expected) + + +def test_groupby_sample_with_n_samples(): + # GH 54714 + values = [1] * 10 + [2] * 10 + df = DataFrame({"a": values, "b": values, "c": values}) + groupby_df = df.groupby("a") + + result = groupby_df.sample(n_samples=2) + expected = df + tm.assert_frame_equal(result, expected)
This PR contains enhanced functionality for df.sample() and df.groupby().sample(), with the addition of n_samples. Currently, there is no way to take repeated samples to create a sampling distribution using pandas alone. Currently, one would need to create a list comprehension to perform the same, and numpy.random.choice has been preferred for the same as it takes ~700ms compared to the pandas sample method taking ~25s for 1M values. The new proposed method takes ~ 25ms for the same and performs the task 1000x faster than the current sample feature. <img width="982" alt="Screenshot 2023-08-27 at 1 40 11 PM" src="https://github.com/pandas-dev/pandas/assets/25490130/206d07e7-0f9d-4e6f-864d-34ea96e5d780"> - [x] closes #54714 - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54780
2023-08-27T17:41:17Z
2023-09-18T16:58:37Z
null
2023-09-18T16:58:38Z
Backport PR #54755 on branch 2.1.x (BUG: merge raising for ea int and numpy float)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index f5758a079b1b5..19a8500928ab7 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -816,6 +816,7 @@ Reshaping - Bug in :func:`merge_asof` raising ``KeyError`` for extension dtypes (:issue:`52904`) - Bug in :func:`merge_asof` raising ``ValueError`` for data backed by read-only ndarrays (:issue:`53513`) - Bug in :func:`merge_asof` with ``left_index=True`` or ``right_index=True`` with mismatched index dtypes giving incorrect results in some cases instead of raising ``MergeError`` (:issue:`53870`) +- Bug in :func:`merge` when merging on integer ``ExtensionDtype`` and float NumPy dtype raising ``TypeError`` (:issue:`46178`) - Bug in :meth:`DataFrame.agg` and :meth:`Series.agg` on non-unique columns would return incorrect type when dist-like argument passed in (:issue:`51099`) - Bug in :meth:`DataFrame.combine_first` ignoring other's columns if ``other`` is empty (:issue:`53792`) - Bug in :meth:`DataFrame.idxmin` and :meth:`DataFrame.idxmax`, where the axis dtype would be lost for empty frames (:issue:`53265`) diff --git a/pandas/core/reshape/merge.py b/pandas/core/reshape/merge.py index c2cb9d643ca87..d811c53909fde 100644 --- a/pandas/core/reshape/merge.py +++ b/pandas/core/reshape/merge.py @@ -53,6 +53,7 @@ ensure_object, is_bool, is_bool_dtype, + is_extension_array_dtype, is_float_dtype, is_integer, is_integer_dtype, @@ -1385,6 +1386,21 @@ def _maybe_coerce_merge_keys(self) -> None: if lk.dtype.kind == rk.dtype.kind: continue + if is_extension_array_dtype(lk.dtype) and not is_extension_array_dtype( + rk.dtype + ): + ct = find_common_type([lk.dtype, rk.dtype]) + if is_extension_array_dtype(ct): + rk = ct.construct_array_type()._from_sequence(rk) # type: ignore[union-attr] # noqa: E501 + else: + rk = rk.astype(ct) # type: ignore[arg-type] + elif is_extension_array_dtype(rk.dtype): + ct = find_common_type([lk.dtype, rk.dtype]) + if is_extension_array_dtype(ct): + lk = ct.construct_array_type()._from_sequence(lk) # type: ignore[union-attr] # noqa: E501 + else: + lk = lk.astype(ct) # type: ignore[arg-type] + # check whether ints and floats if is_integer_dtype(rk.dtype) and is_float_dtype(lk.dtype): # GH 47391 numpy > 1.24 will raise a RuntimeError for nan -> int diff --git a/pandas/tests/reshape/merge/test_merge.py b/pandas/tests/reshape/merge/test_merge.py index 91510fae0a9b1..98db24530833b 100644 --- a/pandas/tests/reshape/merge/test_merge.py +++ b/pandas/tests/reshape/merge/test_merge.py @@ -2847,3 +2847,26 @@ def test_merge_multiindex_single_level(): result = df.merge(df2, left_on=["col"], right_index=True, how="left") tm.assert_frame_equal(result, expected) + + +def test_merge_ea_int_and_float_numpy(): + # GH#46178 + df1 = DataFrame([1.0, np.nan], dtype=pd.Int64Dtype()) + df2 = DataFrame([1.5]) + expected = DataFrame(columns=[0], dtype="Int64") + + with tm.assert_produces_warning(UserWarning, match="You are merging"): + result = df1.merge(df2) + tm.assert_frame_equal(result, expected) + + with tm.assert_produces_warning(UserWarning, match="You are merging"): + result = df2.merge(df1) + tm.assert_frame_equal(result, expected.astype("float64")) + + df2 = DataFrame([1.0]) + expected = DataFrame([1], columns=[0], dtype="Int64") + result = df1.merge(df2) + tm.assert_frame_equal(result, expected) + + result = df2.merge(df1) + tm.assert_frame_equal(result, expected.astype("float64"))
#54755
https://api.github.com/repos/pandas-dev/pandas/pulls/54779
2023-08-27T14:58:24Z
2023-08-27T21:45:15Z
2023-08-27T21:45:15Z
2023-09-01T11:17:08Z
REGR: Index.union loses python string dtype
diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index a49db84450bb3..4fa8eb0cce2a2 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -5194,7 +5194,7 @@ def _from_join_target(self, result: np.ndarray) -> ArrayLike: """ if isinstance(self.values, BaseMaskedArray): return type(self.values)(result, np.zeros(result.shape, dtype=np.bool_)) - elif isinstance(self.values, ArrowExtensionArray): + elif isinstance(self.values, (ArrowExtensionArray, StringArray)): return type(self.values)._from_sequence(result) return result diff --git a/pandas/tests/indexes/test_setops.py b/pandas/tests/indexes/test_setops.py index 2fd203dbc77ed..a64994efec85a 100644 --- a/pandas/tests/indexes/test_setops.py +++ b/pandas/tests/indexes/test_setops.py @@ -899,3 +899,10 @@ def test_union_ea_dtypes(self, any_numeric_ea_and_arrow_dtype): result = idx.union(idx2) expected = Index([1, 2, 3, 4, 5], dtype=any_numeric_ea_and_arrow_dtype) tm.assert_index_equal(result, expected) + + def test_union_string_array(self, any_string_dtype): + idx1 = Index(["a"], dtype=any_string_dtype) + idx2 = Index(["b"], dtype=any_string_dtype) + result = idx1.union(idx2) + expected = Index(["a", "b"], dtype=any_string_dtype) + tm.assert_index_equal(result, expected)
- [x] closes #54745 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. cc @mroeschke
https://api.github.com/repos/pandas-dev/pandas/pulls/54778
2023-08-27T14:49:11Z
2023-08-28T15:16:40Z
2023-08-28T15:16:40Z
2023-08-28T15:17:39Z
BUG: pd.SparseDtype('int', 0) == pd.SparseDtype('int', pd.NA) returns pd.NA
diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py index f76163cbbd0a1..cfe19125ed717 100644 --- a/pandas/core/dtypes/dtypes.py +++ b/pandas/core/dtypes/dtypes.py @@ -1697,7 +1697,7 @@ def __eq__(self, other: object) -> bool: if isinstance(other, type(self)): subtype = self.subtype == other.subtype - if self._is_na_fill_value: + if self._is_na_fill_value or other._is_na_fill_value: # this case is complicated by two things: # SparseDtype(float, float(nan)) == SparseDtype(float, np.nan) # SparseDtype(float, np.nan) != SparseDtype(float, pd.NaT)
BUG: pd.SparseDtype('int', 0) == pd.SparseDtype('int', pd.NA) returns pd.NA - [X] closes #54770(Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54776
2023-08-26T22:27:15Z
2023-09-25T20:45:21Z
null
2023-09-25T20:45:22Z
TST: remove redundant catch_warnings
diff --git a/pandas/tests/arrays/test_datetimelike.py b/pandas/tests/arrays/test_datetimelike.py index 20530e37116f2..f230221c3ba62 100644 --- a/pandas/tests/arrays/test_datetimelike.py +++ b/pandas/tests/arrays/test_datetimelike.py @@ -1,7 +1,6 @@ from __future__ import annotations import re -import warnings import numpy as np import pytest @@ -47,12 +46,7 @@ def period_index(freqstr): the PeriodIndex behavior. """ # TODO: non-monotone indexes; NaTs, different start dates - with warnings.catch_warnings(): - # suppress deprecation of Period[B] - warnings.filterwarnings( - "ignore", message="Period with BDay freq", category=FutureWarning - ) - pi = pd.period_range(start=Timestamp("2000-01-01"), periods=100, freq=freqstr) + pi = pd.period_range(start=Timestamp("2000-01-01"), periods=100, freq=freqstr) return pi
xref #52064 removed redundant catch_warnings in pandas/tests/arrays/test_datetimelike.py
https://api.github.com/repos/pandas-dev/pandas/pulls/54774
2023-08-26T19:54:37Z
2023-09-18T22:04:51Z
null
2023-09-18T22:04:51Z
Backport PR #54768 on branch 2.1.x (Fix roundtripping with pyarrow schema)
diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index e3656b6ff4bcc..3af63c781d499 100644 --- a/pandas/core/arrays/string_.py +++ b/pandas/core/arrays/string_.py @@ -14,6 +14,7 @@ missing as libmissing, ) from pandas._libs.arrays import NDArrayBacked +from pandas._libs.lib import ensure_string_array from pandas.compat import pa_version_under7p0 from pandas.compat.numpy import function as nv from pandas.util._decorators import doc @@ -221,7 +222,7 @@ def __from_arrow__( arr = np.array([], dtype=object) else: arr = pyarrow.concat_arrays(chunks).to_numpy(zero_copy_only=False) - arr = lib.convert_nans_to_NA(arr) + arr = ensure_string_array(arr, na_value=libmissing.NA) # Bypass validation inside StringArray constructor, see GH#47781 new_string_array = StringArray.__new__(StringArray) NDArrayBacked.__init__( diff --git a/pandas/tests/io/test_parquet.py b/pandas/tests/io/test_parquet.py index ccba44b7f8fe4..b2d6e958020be 100644 --- a/pandas/tests/io/test_parquet.py +++ b/pandas/tests/io/test_parquet.py @@ -1,5 +1,6 @@ """ test parquet compat """ import datetime +from decimal import Decimal from io import BytesIO import os import pathlib @@ -16,6 +17,7 @@ from pandas.compat.pyarrow import ( pa_version_under7p0, pa_version_under8p0, + pa_version_under11p0, pa_version_under13p0, ) @@ -1111,6 +1113,18 @@ def test_string_inference(self, tmp_path, pa): ) tm.assert_frame_equal(result, expected) + @pytest.mark.skipif(pa_version_under11p0, reason="not supported before 11.0") + def test_roundtrip_decimal(self, tmp_path, pa): + # GH#54768 + import pyarrow as pa + + path = tmp_path / "decimal.p" + df = pd.DataFrame({"a": [Decimal("123.00")]}, dtype="string[pyarrow]") + df.to_parquet(path, schema=pa.schema([("a", pa.decimal128(5))])) + result = read_parquet(path) + expected = pd.DataFrame({"a": ["123"]}, dtype="string[python]") + tm.assert_frame_equal(result, expected) + class TestParquetFastParquet(Base): def test_basic(self, fp, df_full):
Backport PR #54768: Fix roundtripping with pyarrow schema
https://api.github.com/repos/pandas-dev/pandas/pulls/54773
2023-08-26T19:07:36Z
2023-08-27T05:45:08Z
2023-08-27T05:45:08Z
2023-08-27T05:45:08Z
Fix roundtripping with pyarrow schema
diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index 2394b9af2015e..1eaae0807fee1 100644 --- a/pandas/core/arrays/string_.py +++ b/pandas/core/arrays/string_.py @@ -15,6 +15,7 @@ missing as libmissing, ) from pandas._libs.arrays import NDArrayBacked +from pandas._libs.lib import ensure_string_array from pandas.compat import pa_version_under7p0 from pandas.compat.numpy import function as nv from pandas.util._decorators import doc @@ -224,7 +225,7 @@ def __from_arrow__( arr = np.array([], dtype=object) else: arr = pyarrow.concat_arrays(chunks).to_numpy(zero_copy_only=False) - arr = lib.convert_nans_to_NA(arr) + arr = ensure_string_array(arr, na_value=libmissing.NA) # Bypass validation inside StringArray constructor, see GH#47781 new_string_array = StringArray.__new__(StringArray) NDArrayBacked.__init__( diff --git a/pandas/tests/io/test_parquet.py b/pandas/tests/io/test_parquet.py index 6ca71b9507322..7c4176fa92361 100644 --- a/pandas/tests/io/test_parquet.py +++ b/pandas/tests/io/test_parquet.py @@ -1,5 +1,6 @@ """ test parquet compat """ import datetime +from decimal import Decimal from io import BytesIO import os import pathlib @@ -16,6 +17,7 @@ from pandas.compat.pyarrow import ( pa_version_under7p0, pa_version_under8p0, + pa_version_under11p0, pa_version_under13p0, ) @@ -1125,6 +1127,18 @@ def test_string_inference(self, tmp_path, pa): ) tm.assert_frame_equal(result, expected) + @pytest.mark.skipif(pa_version_under11p0, reason="not supported before 11.0") + def test_roundtrip_decimal(self, tmp_path, pa): + # GH#54768 + import pyarrow as pa + + path = tmp_path / "decimal.p" + df = pd.DataFrame({"a": [Decimal("123.00")]}, dtype="string[pyarrow]") + df.to_parquet(path, schema=pa.schema([("a", pa.decimal128(5))])) + result = read_parquet(path) + expected = pd.DataFrame({"a": ["123"]}, dtype="string[python]") + tm.assert_frame_equal(result, expected) + class TestParquetFastParquet(Base): def test_basic(self, fp, df_full):
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. that's a regression on main as well, it's currently returning NA cc @mroeschke
https://api.github.com/repos/pandas-dev/pandas/pulls/54768
2023-08-26T11:02:11Z
2023-08-26T19:07:28Z
2023-08-26T19:07:28Z
2023-08-28T15:25:26Z
Backport PR #54585 on branch 2.1.x (Use NaN as na_value for new pyarrow_numpy StringDtype)
diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index 1e285f90e9fea..e3656b6ff4bcc 100644 --- a/pandas/core/arrays/string_.py +++ b/pandas/core/arrays/string_.py @@ -98,10 +98,14 @@ class StringDtype(StorageExtensionDtype): name = "string" - #: StringDtype().na_value uses pandas.NA + #: StringDtype().na_value uses pandas.NA except the implementation that + # follows NumPy semantics, which uses nan. @property - def na_value(self) -> libmissing.NAType: - return libmissing.NA + def na_value(self) -> libmissing.NAType | float: # type: ignore[override] + if self.storage == "pyarrow_numpy": + return np.nan + else: + return libmissing.NA _metadata = ("storage",) diff --git a/pandas/tests/arrays/string_/test_string.py b/pandas/tests/arrays/string_/test_string.py index e29a72e1a5338..68b2b01ddcaf3 100644 --- a/pandas/tests/arrays/string_/test_string.py +++ b/pandas/tests/arrays/string_/test_string.py @@ -17,6 +17,13 @@ ) +def na_val(dtype): + if dtype.storage == "pyarrow_numpy": + return np.nan + else: + return pd.NA + + @pytest.fixture def dtype(string_storage): """Fixture giving StringDtype from parametrized 'string_storage'""" @@ -31,26 +38,34 @@ def cls(dtype): def test_repr(dtype): df = pd.DataFrame({"A": pd.array(["a", pd.NA, "b"], dtype=dtype)}) - expected = " A\n0 a\n1 <NA>\n2 b" + if dtype.storage == "pyarrow_numpy": + expected = " A\n0 a\n1 NaN\n2 b" + else: + expected = " A\n0 a\n1 <NA>\n2 b" assert repr(df) == expected - expected = "0 a\n1 <NA>\n2 b\nName: A, dtype: string" + if dtype.storage == "pyarrow_numpy": + expected = "0 a\n1 NaN\n2 b\nName: A, dtype: string" + else: + expected = "0 a\n1 <NA>\n2 b\nName: A, dtype: string" assert repr(df.A) == expected if dtype.storage == "pyarrow": arr_name = "ArrowStringArray" + expected = f"<{arr_name}>\n['a', <NA>, 'b']\nLength: 3, dtype: string" elif dtype.storage == "pyarrow_numpy": arr_name = "ArrowStringArrayNumpySemantics" + expected = f"<{arr_name}>\n['a', nan, 'b']\nLength: 3, dtype: string" else: arr_name = "StringArray" - expected = f"<{arr_name}>\n['a', <NA>, 'b']\nLength: 3, dtype: string" + expected = f"<{arr_name}>\n['a', <NA>, 'b']\nLength: 3, dtype: string" assert repr(df.A.array) == expected def test_none_to_nan(cls): a = cls._from_sequence(["a", None, "b"]) assert a[1] is not None - assert a[1] is pd.NA + assert a[1] is na_val(a.dtype) def test_setitem_validates(cls): @@ -205,13 +220,9 @@ def test_comparison_methods_scalar(comparison_op, dtype): other = "a" result = getattr(a, op_name)(other) if dtype.storage == "pyarrow_numpy": - expected = np.array([getattr(item, op_name)(other) for item in a], dtype=object) - expected = ( - pd.array(expected, dtype="boolean") - .to_numpy(na_value=False) - .astype(np.bool_) - ) - tm.assert_numpy_array_equal(result, expected) + expected = np.array([getattr(item, op_name)(other) for item in a]) + expected[1] = False + tm.assert_numpy_array_equal(result, expected.astype(np.bool_)) else: expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" expected = np.array([getattr(item, op_name)(other) for item in a], dtype=object) @@ -407,7 +418,7 @@ def test_min_max(method, skipna, dtype, request): expected = "a" if method == "min" else "c" assert result == expected else: - assert result is pd.NA + assert result is na_val(arr.dtype) @pytest.mark.parametrize("method", ["min", "max"]) @@ -475,7 +486,7 @@ def test_arrow_roundtrip(dtype, string_storage2): expected = df.astype(f"string[{string_storage2}]") tm.assert_frame_equal(result, expected) # ensure the missing value is represented by NA and not np.nan or None - assert result.loc[2, "a"] is pd.NA + assert result.loc[2, "a"] is na_val(result["a"].dtype) def test_arrow_load_from_zero_chunks(dtype, string_storage2): @@ -573,7 +584,7 @@ def test_astype_from_float_dtype(float_dtype, dtype): def test_to_numpy_returns_pdna_default(dtype): arr = pd.array(["a", pd.NA, "b"], dtype=dtype) result = np.array(arr) - expected = np.array(["a", pd.NA, "b"], dtype=object) + expected = np.array(["a", na_val(dtype), "b"], dtype=object) tm.assert_numpy_array_equal(result, expected) @@ -613,7 +624,7 @@ def test_setitem_scalar_with_mask_validation(dtype): mask = np.array([False, True, False]) ser[mask] = None - assert ser.array[1] is pd.NA + assert ser.array[1] is na_val(ser.dtype) # for other non-string we should also raise an error ser = pd.Series(["a", "b", "c"], dtype=dtype) diff --git a/pandas/tests/strings/__init__.py b/pandas/tests/strings/__init__.py index bf119f2721ed4..01b49b5e5b633 100644 --- a/pandas/tests/strings/__init__.py +++ b/pandas/tests/strings/__init__.py @@ -1,4 +1,4 @@ -# Needed for new arrow string dtype +import numpy as np import pandas as pd @@ -7,6 +7,9 @@ def _convert_na_value(ser, expected): if ser.dtype != object: - # GH#18463 - expected = expected.fillna(pd.NA) + if ser.dtype.storage == "pyarrow_numpy": + expected = expected.fillna(np.nan) + else: + # GH#18463 + expected = expected.fillna(pd.NA) return expected diff --git a/pandas/tests/strings/test_split_partition.py b/pandas/tests/strings/test_split_partition.py index 7fabe238d2b86..0a7d409773dd6 100644 --- a/pandas/tests/strings/test_split_partition.py +++ b/pandas/tests/strings/test_split_partition.py @@ -12,7 +12,10 @@ Series, _testing as tm, ) -from pandas.tests.strings import _convert_na_value +from pandas.tests.strings import ( + _convert_na_value, + object_pyarrow_numpy, +) @pytest.mark.parametrize("method", ["split", "rsplit"]) @@ -113,8 +116,8 @@ def test_split_object_mixed(expand, method): def test_split_n(any_string_dtype, method, n): s = Series(["a b", pd.NA, "b c"], dtype=any_string_dtype) expected = Series([["a", "b"], pd.NA, ["b", "c"]]) - result = getattr(s.str, method)(" ", n=n) + expected = _convert_na_value(s, expected) tm.assert_series_equal(result, expected) @@ -381,7 +384,7 @@ def test_split_nan_expand(any_string_dtype): # check that these are actually np.nan/pd.NA and not None # TODO see GH 18463 # tm.assert_frame_equal does not differentiate - if any_string_dtype == "object": + if any_string_dtype in object_pyarrow_numpy: assert all(np.isnan(x) for x in result.iloc[1]) else: assert all(x is pd.NA for x in result.iloc[1])
Backport PR #54585: Use NaN as na_value for new pyarrow_numpy StringDtype
https://api.github.com/repos/pandas-dev/pandas/pulls/54767
2023-08-26T10:41:39Z
2023-08-26T13:14:49Z
2023-08-26T13:14:49Z
2023-08-26T13:14:49Z
Backport PR #54750 on branch 2.1.x (Revert deprecation of con as keyword only arg)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index e3f18067e354d..f5758a079b1b5 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -586,7 +586,7 @@ Other Deprecations - Deprecated the use of non-supported datetime64 and timedelta64 resolutions with :func:`pandas.array`. Supported resolutions are: "s", "ms", "us", "ns" resolutions (:issue:`53058`) - Deprecated values ``"pad"``, ``"ffill"``, ``"bfill"``, ``"backfill"`` for :meth:`Series.interpolate` and :meth:`DataFrame.interpolate`, use ``obj.ffill()`` or ``obj.bfill()`` instead (:issue:`53581`) - Deprecated the behavior of :meth:`Index.argmax`, :meth:`Index.argmin`, :meth:`Series.argmax`, :meth:`Series.argmin` with either all-NAs and ``skipna=True`` or any-NAs and ``skipna=False`` returning -1; in a future version this will raise ``ValueError`` (:issue:`33941`, :issue:`33942`) -- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_sql` except ``name`` (:issue:`54229`) +- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_sql` except ``name`` and ``con`` (:issue:`54229`) .. --------------------------------------------------------------------------- .. _whatsnew_210.performance: diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 09ebd9387220f..b4281f6959997 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2796,7 +2796,7 @@ def to_hdf( @final @deprecate_nonkeyword_arguments( - version="3.0", allowed_args=["self", "name"], name="to_sql" + version="3.0", allowed_args=["self", "name", "con"], name="to_sql" ) def to_sql( self, diff --git a/pandas/tests/io/test_sql.py b/pandas/tests/io/test_sql.py index 2f446e6b8c81d..9ec0ba0b12a76 100644 --- a/pandas/tests/io/test_sql.py +++ b/pandas/tests/io/test_sql.py @@ -2849,13 +2849,14 @@ def setup_driver(cls): def test_keyword_deprecation(self): # GH 54397 msg = ( - "tarting with pandas version 3.0 all arguments of to_sql except for the " - "argument 'name' will be keyword-only." + "Starting with pandas version 3.0 all arguments of to_sql except for the " + "arguments 'name' and 'con' will be keyword-only." ) df = DataFrame([{"A": 1, "B": 2, "C": 3}, {"A": 1, "B": 2, "C": 3}]) + df.to_sql("example", self.conn) with tm.assert_produces_warning(FutureWarning, match=msg): - df.to_sql("example", self.conn) + df.to_sql("example", self.conn, None, if_exists="replace") def test_default_type_conversion(self): df = sql.read_sql_table("types", self.conn)
Backport PR #54750: Revert deprecation of con as keyword only arg
https://api.github.com/repos/pandas-dev/pandas/pulls/54766
2023-08-26T07:57:48Z
2023-08-26T10:40:15Z
2023-08-26T10:40:15Z
2023-08-26T10:40:16Z
PERF: skip libjoin fastpath for MultiIndex
diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index a49db84450bb3..1fbf4381cb64e 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -124,6 +124,7 @@ from pandas.core.dtypes.generic import ( ABCDataFrame, ABCDatetimeIndex, + ABCIntervalIndex, ABCMultiIndex, ABCPeriodIndex, ABCSeries, @@ -3492,8 +3493,6 @@ def _intersection(self, other: Index, sort: bool = False): and other.is_monotonic_increasing and self._can_use_libjoin and other._can_use_libjoin - and not isinstance(self, ABCMultiIndex) - and not isinstance(other, ABCMultiIndex) ): try: res_indexer, indexer, _ = self._inner_indexer(other) @@ -4632,28 +4631,13 @@ def join( _validate_join_method(how) - if not self.is_unique and not other.is_unique: - return self._join_non_unique(other, how=how, sort=sort) - elif not self.is_unique or not other.is_unique: - if self.is_monotonic_increasing and other.is_monotonic_increasing: - # Note: 2023-08-15 we *do* have tests that get here with - # Categorical, string[python] (can use libjoin) - # and Interval (cannot) - if self._can_use_libjoin and other._can_use_libjoin: - # otherwise we will fall through to _join_via_get_indexer - # GH#39133 - # go through object dtype for ea till engine is supported properly - return self._join_monotonic(other, how=how) - else: - return self._join_non_unique(other, how=how, sort=sort) - elif ( - # GH48504: exclude MultiIndex to avoid going through MultiIndex._values - self.is_monotonic_increasing + if ( + not isinstance(self.dtype, CategoricalDtype) + and self.is_monotonic_increasing and other.is_monotonic_increasing and self._can_use_libjoin and other._can_use_libjoin - and not isinstance(self, ABCMultiIndex) - and not isinstance(self.dtype, CategoricalDtype) + and (self.is_unique or other.is_unique) ): # Categorical is monotonic if data are ordered as categories, but join can # not handle this in case of not lexicographically monotonic GH#38502 @@ -4662,6 +4646,8 @@ def join( except TypeError: # object dtype; non-comparable objects pass + elif not self.is_unique or not other.is_unique: + return self._join_non_unique(other, how=how, sort=sort) return self._join_via_get_indexer(other, how, sort) @@ -4797,6 +4783,9 @@ def _join_non_unique( join_idx = self.take(left_idx) right = other.take(right_idx) join_index = join_idx.putmask(mask, right) + if isinstance(join_index, ABCMultiIndex) and how == "outer": + # test_join_index_levels + join_index = join_index._sort_levels_monotonic() return join_index, left_idx, right_idx @final @@ -5042,10 +5031,10 @@ def _can_use_libjoin(self) -> bool: or isinstance(self._values, (ArrowExtensionArray, BaseMaskedArray)) or self.dtype == "string[python]" ) - # For IntervalIndex, the conversion to numpy converts - # to object dtype, which negates the performance benefit of libjoin - # TODO: exclude RangeIndex and MultiIndex as these also make copies? - return not isinstance(self.dtype, IntervalDtype) + # Exclude index types where the conversion to numpy converts to object dtype, + # which negates the performance benefit of libjoin + # TODO: exclude RangeIndex? Seems to break test_concat_datetime_timezone + return not isinstance(self, (ABCIntervalIndex, ABCMultiIndex)) # -------------------------------------------------------------------- # Uncategorized Methods @@ -5180,8 +5169,7 @@ def _get_join_target(self) -> np.ndarray: # present return self._values.to_numpy() - # TODO: exclude ABCRangeIndex, ABCMultiIndex cases here as those create - # copies. + # TODO: exclude ABCRangeIndex case here as it copies target = self._get_engine_target() if not isinstance(target, np.ndarray): raise ValueError("_can_use_libjoin should return False.")
- [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. Addresses #54646 for `MultiIndex` but leaves `RangeIndex` as is. The `RangeIndex` case seems to have a few side effects - I'll add comments separately to #54646 for `RangeIndex`. Also, simplifies the logic in `Index.join` which improves perf for a few `MultiIndex` and non-`MultiIndex` cases. `multiindex_object` benchmarks: ``` before after ratio - 18.7±0.2ms 16.6±0.4ms 0.89 multiindex_object.SetOperations.time_operation('monotonic', 'ea_int', 'symmetric_difference', False) - 19.0±0.7ms 16.5±0.2ms 0.87 multiindex_object.SetOperations.time_operation('monotonic', 'int', 'intersection', False) - 60.6±10ms 49.8±1ms 0.82 multiindex_object.SetOperations.time_operation('monotonic', 'string', 'intersection', None) - 40.1±1ms 32.2±0.4ms 0.80 multiindex_object.SetOperations.time_operation('monotonic', 'ea_int', 'intersection', None) ``` `join_merge` benchmarks: ``` before after ratio - 9.98±0.2ms 8.99±0.1ms 0.90 join_merge.ConcatIndexDtype.time_concat_series('Int64', 'has_na', 1, True) - 12.2±0.3ms 10.5±0.05ms 0.86 join_merge.ConcatIndexDtype.time_concat_series('int64[pyarrow]', 'has_na', 1, True) - 13.9±2ms 11.8±0.2ms 0.85 join_merge.ConcatIndexDtype.time_concat_series('datetime64[ns]', 'has_na', 1, False) - 26.3±3ms 22.3±0.05ms 0.85 join_merge.ConcatIndexDtype.time_concat_series('string[python]', 'monotonic', 1, False) - 6.50±1ms 5.19±0.05ms 0.80 join_merge.ConcatIndexDtype.time_concat_series('datetime64[ns]', 'monotonic', 1, False) - 133±2ms 51.1±2ms 0.38 join_merge.Align.time_series_align_int64_index - 105±0.9ms 23.7±0.5ms 0.22 join_merge.Align.time_series_align_left_monotonic ```
https://api.github.com/repos/pandas-dev/pandas/pulls/54765
2023-08-26T01:45:57Z
2023-08-28T15:34:18Z
2023-08-28T15:34:18Z
2023-09-06T00:53:59Z
Backport PR #54759 on branch 2.1.x (CI: Pin more cython)
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 030c9546fecca..6410f2edd6175 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -234,7 +234,7 @@ jobs: /opt/python/cp311-cp311/bin/python -m venv ~/virtualenvs/pandas-dev . ~/virtualenvs/pandas-dev/bin/activate python -m pip install --no-cache-dir -U pip wheel setuptools meson[ninja]==1.0.1 meson-python==0.13.1 - python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 + python -m pip install --no-cache-dir versioneer[toml] "cython<3.0.1" numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 python -m pip install --no-cache-dir --no-build-isolation -e . python -m pip list --no-cache-dir export PANDAS_CI=1 @@ -272,7 +272,7 @@ jobs: /opt/python/cp311-cp311/bin/python -m venv ~/virtualenvs/pandas-dev . ~/virtualenvs/pandas-dev/bin/activate python -m pip install --no-cache-dir -U pip wheel setuptools meson-python==0.13.1 meson[ninja]==1.0.1 - python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 + python -m pip install --no-cache-dir versioneer[toml] "cython<3.0.1" numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 python -m pip install --no-cache-dir --no-build-isolation -e . python -m pip list --no-cache-dir @@ -345,7 +345,7 @@ jobs: python -m pip install --upgrade pip setuptools wheel meson[ninja]==1.0.1 meson-python==0.13.1 python -m pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy python -m pip install versioneer[toml] - python -m pip install python-dateutil pytz tzdata cython hypothesis>=6.46.1 pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-cov pytest-asyncio>=0.17 + python -m pip install python-dateutil pytz tzdata "cython<3.0.1" hypothesis>=6.46.1 pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-cov pytest-asyncio>=0.17 python -m pip install -ve . --no-build-isolation --no-index python -m pip list diff --git a/ci/deps/actions-311-numpydev.yaml b/ci/deps/actions-311-numpydev.yaml index 1766721459ed2..acf94fce5288b 100644 --- a/ci/deps/actions-311-numpydev.yaml +++ b/ci/deps/actions-311-numpydev.yaml @@ -25,7 +25,7 @@ dependencies: - pip - pip: - - "cython<=3.0.1" + - "cython<3.0.1" - "--extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple" - "--pre" - "numpy"
Backport PR #54759: CI: Pin more cython
https://api.github.com/repos/pandas-dev/pandas/pulls/54764
2023-08-26T00:46:51Z
2023-08-26T07:57:20Z
2023-08-26T07:57:20Z
2023-08-26T07:57:20Z
Backport PR #54752 on branch 2.1.x (REGR: groupby.count returning string dtype instead of numeric for string input)
diff --git a/pandas/core/groupby/groupby.py b/pandas/core/groupby/groupby.py index 5a7f42a535951..dd0c995e6acca 100644 --- a/pandas/core/groupby/groupby.py +++ b/pandas/core/groupby/groupby.py @@ -107,6 +107,7 @@ class providing the base-class of operations. IntegerArray, SparseArray, ) +from pandas.core.arrays.string_ import StringDtype from pandas.core.base import ( PandasObject, SelectionMixin, @@ -2261,7 +2262,9 @@ def hfunc(bvalues: ArrayLike) -> ArrayLike: return IntegerArray( counted[0], mask=np.zeros(counted.shape[1], dtype=np.bool_) ) - elif isinstance(bvalues, ArrowExtensionArray): + elif isinstance(bvalues, ArrowExtensionArray) and not isinstance( + bvalues.dtype, StringDtype + ): return type(bvalues)._from_sequence(counted[0]) if is_series: assert counted.ndim == 2 diff --git a/pandas/tests/groupby/test_counting.py b/pandas/tests/groupby/test_counting.py index 6c27344ce3110..885e7848b76cb 100644 --- a/pandas/tests/groupby/test_counting.py +++ b/pandas/tests/groupby/test_counting.py @@ -379,3 +379,14 @@ def __eq__(self, other): result = df.groupby("grp").count() expected = DataFrame({"a": [2, 2]}, index=Index(list("ab"), name="grp")) tm.assert_frame_equal(result, expected) + + +def test_count_arrow_string_array(any_string_dtype): + # GH#54751 + pytest.importorskip("pyarrow") + df = DataFrame( + {"a": [1, 2, 3], "b": Series(["a", "b", "a"], dtype=any_string_dtype)} + ) + result = df.groupby("a").count() + expected = DataFrame({"b": 1}, index=Index([1, 2, 3], name="a")) + tm.assert_frame_equal(result, expected)
Backport PR #54752: REGR: groupby.count returning string dtype instead of numeric for string input
https://api.github.com/repos/pandas-dev/pandas/pulls/54762
2023-08-25T18:59:26Z
2023-08-25T20:59:11Z
2023-08-25T20:59:11Z
2023-08-25T20:59:11Z
Backport PR #54699 on branch 2.1.x (BUG: setitem with object type inserting Series maintains Series)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index fabe910261c3d..e3f18067e354d 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -729,6 +729,7 @@ Indexing - Bug in :meth:`DataFrame.__setitem__` losing dtype when setting a :class:`DataFrame` into duplicated columns (:issue:`53143`) - Bug in :meth:`DataFrame.__setitem__` with a boolean mask and :meth:`DataFrame.putmask` with mixed non-numeric dtypes and a value other than ``NaN`` incorrectly raising ``TypeError`` (:issue:`53291`) - Bug in :meth:`DataFrame.iloc` when using ``nan`` as the only element (:issue:`52234`) +- Bug in :meth:`Series.loc` casting :class:`Series` to ``np.dnarray`` when assigning :class:`Series` at predefined index of ``object`` dtype :class:`Series` (:issue:`48933`) Missing ^^^^^^^ diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index ecb9cd47d7995..6df90eece3cc8 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -1133,7 +1133,9 @@ def setitem(self, indexer, value, using_cow: bool = False) -> Block: # length checking check_setitem_lengths(indexer, value, values) - value = extract_array(value, extract_numpy=True) + if self.dtype != _dtype_obj: + # GH48933: extract_array would convert a pd.Series value to np.ndarray + value = extract_array(value, extract_numpy=True) try: casted = np_can_hold_element(values.dtype, value) except LossySetitemError: diff --git a/pandas/tests/indexing/test_indexing.py b/pandas/tests/indexing/test_indexing.py index d6d8a63797bb6..224555399ff8f 100644 --- a/pandas/tests/indexing/test_indexing.py +++ b/pandas/tests/indexing/test_indexing.py @@ -1132,3 +1132,19 @@ def test_scalar_setitem_series_with_nested_value_length1(value, indexer_sli): assert (ser.loc[0] == value).all() else: assert ser.loc[0] == value + + +def test_object_dtype_series_set_series_element(): + # GH 48933 + s1 = Series(dtype="O", index=["a", "b"]) + + s1["a"] = Series() + s1.loc["b"] = Series() + + tm.assert_series_equal(s1.loc["a"], Series()) + tm.assert_series_equal(s1.loc["b"], Series()) + + s2 = Series(dtype="O", index=["a", "b"]) + + s2.iloc[1] = Series() + tm.assert_series_equal(s2.iloc[1], Series())
Backport PR #54699: BUG: setitem with object type inserting Series maintains Series
https://api.github.com/repos/pandas-dev/pandas/pulls/54760
2023-08-25T18:01:53Z
2023-08-25T20:58:27Z
2023-08-25T20:58:27Z
2023-08-25T20:58:27Z
CI: Pin more cython
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 030c9546fecca..6410f2edd6175 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -234,7 +234,7 @@ jobs: /opt/python/cp311-cp311/bin/python -m venv ~/virtualenvs/pandas-dev . ~/virtualenvs/pandas-dev/bin/activate python -m pip install --no-cache-dir -U pip wheel setuptools meson[ninja]==1.0.1 meson-python==0.13.1 - python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 + python -m pip install --no-cache-dir versioneer[toml] "cython<3.0.1" numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 python -m pip install --no-cache-dir --no-build-isolation -e . python -m pip list --no-cache-dir export PANDAS_CI=1 @@ -272,7 +272,7 @@ jobs: /opt/python/cp311-cp311/bin/python -m venv ~/virtualenvs/pandas-dev . ~/virtualenvs/pandas-dev/bin/activate python -m pip install --no-cache-dir -U pip wheel setuptools meson-python==0.13.1 meson[ninja]==1.0.1 - python -m pip install --no-cache-dir versioneer[toml] cython numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 + python -m pip install --no-cache-dir versioneer[toml] "cython<3.0.1" numpy python-dateutil pytz pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-asyncio>=0.17 hypothesis>=6.46.1 python -m pip install --no-cache-dir --no-build-isolation -e . python -m pip list --no-cache-dir @@ -345,7 +345,7 @@ jobs: python -m pip install --upgrade pip setuptools wheel meson[ninja]==1.0.1 meson-python==0.13.1 python -m pip install --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy python -m pip install versioneer[toml] - python -m pip install python-dateutil pytz tzdata cython hypothesis>=6.46.1 pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-cov pytest-asyncio>=0.17 + python -m pip install python-dateutil pytz tzdata "cython<3.0.1" hypothesis>=6.46.1 pytest>=7.3.2 pytest-xdist>=2.2.0 pytest-cov pytest-asyncio>=0.17 python -m pip install -ve . --no-build-isolation --no-index python -m pip list diff --git a/ci/deps/actions-311-numpydev.yaml b/ci/deps/actions-311-numpydev.yaml index 1766721459ed2..acf94fce5288b 100644 --- a/ci/deps/actions-311-numpydev.yaml +++ b/ci/deps/actions-311-numpydev.yaml @@ -25,7 +25,7 @@ dependencies: - pip - pip: - - "cython<=3.0.1" + - "cython<3.0.1" - "--extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple" - "--pre" - "numpy"
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54759
2023-08-25T17:38:42Z
2023-08-26T00:36:20Z
2023-08-26T00:36:20Z
2023-08-26T00:45:48Z
Backport PR #54757 on branch 2.1.x (CI: Pin Cython on CI)
diff --git a/ci/deps/actions-310.yaml b/ci/deps/actions-310.yaml index 638aaedecf2b5..2190136220c6c 100644 --- a/ci/deps/actions-310.yaml +++ b/ci/deps/actions-310.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-311-downstream_compat.yaml b/ci/deps/actions-311-downstream_compat.yaml index 4d925786c22d6..cf85345cb0cc2 100644 --- a/ci/deps/actions-311-downstream_compat.yaml +++ b/ci/deps/actions-311-downstream_compat.yaml @@ -7,7 +7,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-311-numpydev.yaml b/ci/deps/actions-311-numpydev.yaml index 2cd4d5f3528f8..1766721459ed2 100644 --- a/ci/deps/actions-311-numpydev.yaml +++ b/ci/deps/actions-311-numpydev.yaml @@ -25,7 +25,7 @@ dependencies: - pip - pip: - - "cython" + - "cython<=3.0.1" - "--extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple" - "--pre" - "numpy" diff --git a/ci/deps/actions-311-pyarrownightly.yaml b/ci/deps/actions-311-pyarrownightly.yaml index f24e866af0439..e850f69f945c5 100644 --- a/ci/deps/actions-311-pyarrownightly.yaml +++ b/ci/deps/actions-311-pyarrownightly.yaml @@ -7,7 +7,7 @@ dependencies: # build dependencies - versioneer[toml] - meson[ninja]=1.0.1 - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-311.yaml b/ci/deps/actions-311.yaml index 698107341c26d..3c1630714a041 100644 --- a/ci/deps/actions-311.yaml +++ b/ci/deps/actions-311.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-39-minimum_versions.yaml b/ci/deps/actions-39-minimum_versions.yaml index a0aafb1d772a7..b1cea49e22d15 100644 --- a/ci/deps/actions-39-minimum_versions.yaml +++ b/ci/deps/actions-39-minimum_versions.yaml @@ -8,7 +8,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-39.yaml b/ci/deps/actions-39.yaml index 6c6b1de165496..b8a119ece4b03 100644 --- a/ci/deps/actions-39.yaml +++ b/ci/deps/actions-39.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-pypy-39.yaml b/ci/deps/actions-pypy-39.yaml index 035395d55eb3a..23c3706f43dad 100644 --- a/ci/deps/actions-pypy-39.yaml +++ b/ci/deps/actions-pypy-39.yaml @@ -9,7 +9,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/circle-310-arm64.yaml b/ci/deps/circle-310-arm64.yaml index d436e90fa6186..71686837451b4 100644 --- a/ci/deps/circle-310-arm64.yaml +++ b/ci/deps/circle-310-arm64.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1
Backport PR #54757: CI: Pin Cython on CI
https://api.github.com/repos/pandas-dev/pandas/pulls/54758
2023-08-25T17:07:52Z
2023-08-26T00:45:16Z
2023-08-26T00:45:15Z
2023-08-26T00:45:29Z
CI: Pin Cython on CI
diff --git a/ci/deps/actions-310.yaml b/ci/deps/actions-310.yaml index ffa7732c604a0..0534f54c42e9a 100644 --- a/ci/deps/actions-310.yaml +++ b/ci/deps/actions-310.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-311-downstream_compat.yaml b/ci/deps/actions-311-downstream_compat.yaml index 596f3476c9c4e..66daccb4827ba 100644 --- a/ci/deps/actions-311-downstream_compat.yaml +++ b/ci/deps/actions-311-downstream_compat.yaml @@ -7,7 +7,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-311-numpydev.yaml b/ci/deps/actions-311-numpydev.yaml index 2cd4d5f3528f8..1766721459ed2 100644 --- a/ci/deps/actions-311-numpydev.yaml +++ b/ci/deps/actions-311-numpydev.yaml @@ -25,7 +25,7 @@ dependencies: - pip - pip: - - "cython" + - "cython<=3.0.1" - "--extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple" - "--pre" - "numpy" diff --git a/ci/deps/actions-311-pyarrownightly.yaml b/ci/deps/actions-311-pyarrownightly.yaml index f24e866af0439..e850f69f945c5 100644 --- a/ci/deps/actions-311-pyarrownightly.yaml +++ b/ci/deps/actions-311-pyarrownightly.yaml @@ -7,7 +7,7 @@ dependencies: # build dependencies - versioneer[toml] - meson[ninja]=1.0.1 - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson-python=0.13.1 # test dependencies diff --git a/ci/deps/actions-311.yaml b/ci/deps/actions-311.yaml index 9d60d734db5b3..59f61196e7038 100644 --- a/ci/deps/actions-311.yaml +++ b/ci/deps/actions-311.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-39-minimum_versions.yaml b/ci/deps/actions-39-minimum_versions.yaml index 91961e4af2d1c..c418c9fbc9ffe 100644 --- a/ci/deps/actions-39-minimum_versions.yaml +++ b/ci/deps/actions-39-minimum_versions.yaml @@ -8,7 +8,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-39.yaml b/ci/deps/actions-39.yaml index 6ea0d41b947dc..ebe102af49e64 100644 --- a/ci/deps/actions-39.yaml +++ b/ci/deps/actions-39.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/actions-pypy-39.yaml b/ci/deps/actions-pypy-39.yaml index 035395d55eb3a..23c3706f43dad 100644 --- a/ci/deps/actions-pypy-39.yaml +++ b/ci/deps/actions-pypy-39.yaml @@ -9,7 +9,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1 diff --git a/ci/deps/circle-310-arm64.yaml b/ci/deps/circle-310-arm64.yaml index df4e8e285bd02..ba6b7f81501a0 100644 --- a/ci/deps/circle-310-arm64.yaml +++ b/ci/deps/circle-310-arm64.yaml @@ -6,7 +6,7 @@ dependencies: # build dependencies - versioneer[toml] - - cython>=0.29.33 + - cython>=0.29.33, <3.0.1 - meson[ninja]=1.0.1 - meson-python=0.13.1
- [ ] ref #54756 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54757
2023-08-25T14:48:41Z
2023-08-25T17:06:42Z
2023-08-25T17:06:42Z
2023-08-25T17:33:11Z
BUG: merge raising for ea int and numpy float
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index f5758a079b1b5..19a8500928ab7 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -816,6 +816,7 @@ Reshaping - Bug in :func:`merge_asof` raising ``KeyError`` for extension dtypes (:issue:`52904`) - Bug in :func:`merge_asof` raising ``ValueError`` for data backed by read-only ndarrays (:issue:`53513`) - Bug in :func:`merge_asof` with ``left_index=True`` or ``right_index=True`` with mismatched index dtypes giving incorrect results in some cases instead of raising ``MergeError`` (:issue:`53870`) +- Bug in :func:`merge` when merging on integer ``ExtensionDtype`` and float NumPy dtype raising ``TypeError`` (:issue:`46178`) - Bug in :meth:`DataFrame.agg` and :meth:`Series.agg` on non-unique columns would return incorrect type when dist-like argument passed in (:issue:`51099`) - Bug in :meth:`DataFrame.combine_first` ignoring other's columns if ``other`` is empty (:issue:`53792`) - Bug in :meth:`DataFrame.idxmin` and :meth:`DataFrame.idxmax`, where the axis dtype would be lost for empty frames (:issue:`53265`) diff --git a/pandas/core/reshape/merge.py b/pandas/core/reshape/merge.py index 140a3024a8684..13bc1008698b2 100644 --- a/pandas/core/reshape/merge.py +++ b/pandas/core/reshape/merge.py @@ -53,6 +53,7 @@ ensure_object, is_bool, is_bool_dtype, + is_extension_array_dtype, is_float_dtype, is_integer, is_integer_dtype, @@ -1385,6 +1386,21 @@ def _maybe_coerce_merge_keys(self) -> None: if lk.dtype.kind == rk.dtype.kind: continue + if is_extension_array_dtype(lk.dtype) and not is_extension_array_dtype( + rk.dtype + ): + ct = find_common_type([lk.dtype, rk.dtype]) + if is_extension_array_dtype(ct): + rk = ct.construct_array_type()._from_sequence(rk) # type: ignore[union-attr] # noqa: E501 + else: + rk = rk.astype(ct) # type: ignore[arg-type] + elif is_extension_array_dtype(rk.dtype): + ct = find_common_type([lk.dtype, rk.dtype]) + if is_extension_array_dtype(ct): + lk = ct.construct_array_type()._from_sequence(lk) # type: ignore[union-attr] # noqa: E501 + else: + lk = lk.astype(ct) # type: ignore[arg-type] + # check whether ints and floats if is_integer_dtype(rk.dtype) and is_float_dtype(lk.dtype): # GH 47391 numpy > 1.24 will raise a RuntimeError for nan -> int diff --git a/pandas/tests/reshape/merge/test_merge.py b/pandas/tests/reshape/merge/test_merge.py index 50a534ad36bcc..02d7e2059e8e1 100644 --- a/pandas/tests/reshape/merge/test_merge.py +++ b/pandas/tests/reshape/merge/test_merge.py @@ -2924,3 +2924,26 @@ def test_merge_combinations( expected = expected.reset_index(drop=True) tm.assert_frame_equal(result, expected) + + +def test_merge_ea_int_and_float_numpy(): + # GH#46178 + df1 = DataFrame([1.0, np.nan], dtype=pd.Int64Dtype()) + df2 = DataFrame([1.5]) + expected = DataFrame(columns=[0], dtype="Int64") + + with tm.assert_produces_warning(UserWarning, match="You are merging"): + result = df1.merge(df2) + tm.assert_frame_equal(result, expected) + + with tm.assert_produces_warning(UserWarning, match="You are merging"): + result = df2.merge(df1) + tm.assert_frame_equal(result, expected.astype("float64")) + + df2 = DataFrame([1.0]) + expected = DataFrame([1], columns=[0], dtype="Int64") + result = df1.merge(df2) + tm.assert_frame_equal(result, expected) + + result = df2.merge(df1) + tm.assert_frame_equal(result, expected.astype("float64"))
- [ ] closes #46178 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. Ideally I'd like to get this in, but not a blocker
https://api.github.com/repos/pandas-dev/pandas/pulls/54755
2023-08-25T14:29:41Z
2023-08-26T19:10:37Z
2023-08-26T19:10:37Z
2023-08-27T15:03:33Z
REGR: groupby.count returning string dtype instead of numeric for string input
diff --git a/pandas/core/groupby/groupby.py b/pandas/core/groupby/groupby.py index 49b47545d6297..f0d73811227fa 100644 --- a/pandas/core/groupby/groupby.py +++ b/pandas/core/groupby/groupby.py @@ -107,6 +107,7 @@ class providing the base-class of operations. IntegerArray, SparseArray, ) +from pandas.core.arrays.string_ import StringDtype from pandas.core.base import ( PandasObject, SelectionMixin, @@ -2281,7 +2282,9 @@ def hfunc(bvalues: ArrayLike) -> ArrayLike: return IntegerArray( counted[0], mask=np.zeros(counted.shape[1], dtype=np.bool_) ) - elif isinstance(bvalues, ArrowExtensionArray): + elif isinstance(bvalues, ArrowExtensionArray) and not isinstance( + bvalues.dtype, StringDtype + ): return type(bvalues)._from_sequence(counted[0]) if is_series: assert counted.ndim == 2 diff --git a/pandas/tests/groupby/test_counting.py b/pandas/tests/groupby/test_counting.py index 6c27344ce3110..885e7848b76cb 100644 --- a/pandas/tests/groupby/test_counting.py +++ b/pandas/tests/groupby/test_counting.py @@ -379,3 +379,14 @@ def __eq__(self, other): result = df.groupby("grp").count() expected = DataFrame({"a": [2, 2]}, index=Index(list("ab"), name="grp")) tm.assert_frame_equal(result, expected) + + +def test_count_arrow_string_array(any_string_dtype): + # GH#54751 + pytest.importorskip("pyarrow") + df = DataFrame( + {"a": [1, 2, 3], "b": Series(["a", "b", "a"], dtype=any_string_dtype)} + ) + result = df.groupby("a").count() + expected = DataFrame({"b": 1}, index=Index([1, 2, 3], name="a")) + tm.assert_frame_equal(result, expected)
- [ ] closes #54751 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54752
2023-08-25T09:43:36Z
2023-08-25T18:59:18Z
2023-08-25T18:59:18Z
2023-08-25T22:52:20Z
Revert deprecation of con as keyword only arg
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index e3f18067e354d..f5758a079b1b5 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -586,7 +586,7 @@ Other Deprecations - Deprecated the use of non-supported datetime64 and timedelta64 resolutions with :func:`pandas.array`. Supported resolutions are: "s", "ms", "us", "ns" resolutions (:issue:`53058`) - Deprecated values ``"pad"``, ``"ffill"``, ``"bfill"``, ``"backfill"`` for :meth:`Series.interpolate` and :meth:`DataFrame.interpolate`, use ``obj.ffill()`` or ``obj.bfill()`` instead (:issue:`53581`) - Deprecated the behavior of :meth:`Index.argmax`, :meth:`Index.argmin`, :meth:`Series.argmax`, :meth:`Series.argmin` with either all-NAs and ``skipna=True`` or any-NAs and ``skipna=False`` returning -1; in a future version this will raise ``ValueError`` (:issue:`33941`, :issue:`33942`) -- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_sql` except ``name`` (:issue:`54229`) +- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_sql` except ``name`` and ``con`` (:issue:`54229`) .. --------------------------------------------------------------------------- .. _whatsnew_210.performance: diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9682e5a864e2c..021725899a1bb 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2801,7 +2801,7 @@ def to_hdf( @final @deprecate_nonkeyword_arguments( - version="3.0", allowed_args=["self", "name"], name="to_sql" + version="3.0", allowed_args=["self", "name", "con"], name="to_sql" ) def to_sql( self, diff --git a/pandas/tests/io/test_sql.py b/pandas/tests/io/test_sql.py index 2f446e6b8c81d..9ec0ba0b12a76 100644 --- a/pandas/tests/io/test_sql.py +++ b/pandas/tests/io/test_sql.py @@ -2849,13 +2849,14 @@ def setup_driver(cls): def test_keyword_deprecation(self): # GH 54397 msg = ( - "tarting with pandas version 3.0 all arguments of to_sql except for the " - "argument 'name' will be keyword-only." + "Starting with pandas version 3.0 all arguments of to_sql except for the " + "arguments 'name' and 'con' will be keyword-only." ) df = DataFrame([{"A": 1, "B": 2, "C": 3}, {"A": 1, "B": 2, "C": 3}]) + df.to_sql("example", self.conn) with tm.assert_produces_warning(FutureWarning, match=msg): - df.to_sql("example", self.conn) + df.to_sql("example", self.conn, None, if_exists="replace") def test_default_type_conversion(self): df = sql.read_sql_table("types", self.conn)
- [x] closes #54749 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54750
2023-08-25T09:23:41Z
2023-08-26T07:57:40Z
2023-08-26T07:57:40Z
2023-08-26T07:57:44Z
PERF: Increase threashold for using binary search in IndexEngine
diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst index 01c43486f800f..604fd9256e10f 100644 --- a/doc/source/whatsnew/v2.2.0.rst +++ b/doc/source/whatsnew/v2.2.0.rst @@ -153,7 +153,7 @@ Deprecations Performance improvements ~~~~~~~~~~~~~~~~~~~~~~~~ -- +- Performance improvement when indexing with more than 4 keys (:issue:`54550`) - .. --------------------------------------------------------------------------- diff --git a/pandas/_libs/index.pyx b/pandas/_libs/index.pyx index e974b5d0eec46..5c7680bc6fb6c 100644 --- a/pandas/_libs/index.pyx +++ b/pandas/_libs/index.pyx @@ -375,7 +375,7 @@ cdef class IndexEngine: # map each starget to its position in the index if ( stargets and - len(stargets) < 5 and + len(stargets) < (n / (2 * n.bit_length())) and not na_in_stargets and self.is_monotonic_increasing ):
# Checklist - [x] closes #54550 (Replace xxxx with the GitHub issue number) - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. # Explanation So after a bit of research for #54550, I found that the source of the behavior is coming from PR #22826 at [this line](https://github.com/pandas-dev/pandas/blob/0f437949513225922d851e9581723d82120684a6/pandas/_libs/index.pyx#L361) and particularly this comment [here](https://github.com/pandas-dev/pandas/pull/22826#discussion_r220715797). In the comment, @rtlee9 makes an excellent explanation for the reason behind the threshold. The default behavior is a linear search (`O(n)`) in the pandas index and #22826 added a binary search optimization for monotonically increasing index which is in `O(m*log(n))` where `m` is the number of target indexes. # Proposed Solution I'm proposing we increase the limit, which was set conservatively to 5. We could at least increase it to n / (2 * log2[n]) which is derivable from m*log2[n]<n and dividing per 2 for keeping a certain margin. I'll open a PR for that. # New results of benchmarking + homemade script Here is a screenshot of `asv continuous -f 1.1 -E virtualenv upstream/main HEAD -b ^indexing.*Index*` output (done on Macbook Air m1, inside the docker container provided by pandas): ![Capture d’écran, le 2023-08-23 à 09 05 41](https://github.com/pandas-dev/pandas/assets/5565274/a5eda5c8-2d9a-4ebd-a337-c82f0f5094a0) Here is also a new output for the script use to demonstrate the problem in #54700: ``` With all at once: num_indexes=1 => 0.00048s With all at once: num_indexes=2 => 0.00045s With all at once: num_indexes=3 => 0.00038s With all at once: num_indexes=4 => 0.00035s With all at once: num_indexes=5 => 0.00035s With all at once: num_indexes=6 => 0.00045s With all at once: num_indexes=7 => 0.00042s With all at once: num_indexes=8 => 0.00066s With all at once: num_indexes=9 => 0.00049s With all at once: num_indexes=10 => 0.00048s ``` Thanks in advance for the review!
https://api.github.com/repos/pandas-dev/pandas/pulls/54746
2023-08-25T02:31:53Z
2023-08-26T19:12:09Z
2023-08-26T19:12:09Z
2023-08-26T21:49:54Z
50557
diff --git a/doc/source/user_guide/groupby.html b/doc/source/user_guide/groupby.html new file mode 100644 index 0000000000000..4630138cad90d --- /dev/null +++ b/doc/source/user_guide/groupby.html @@ -0,0 +1,2945 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" /> +<title>groupby.rst</title> +<style type="text/css"> + +/* +:Author: David Goodger (goodger@python.org) +:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +.subscript { + vertical-align: sub; + font-size: smaller } + +.superscript { + vertical-align: super; + font-size: smaller } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { + overflow: hidden; +} + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title, .code .error { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin: 0 0 0.5em 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left, .figure.align-left, object.align-left, table.align-left { + clear: left ; + float: left ; + margin-right: 1em } + +img.align-right, .figure.align-right, object.align-right, table.align-right { + clear: right ; + float: right ; + margin-left: 1em } + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left } + +.align-center { + clear: both ; + text-align: center } + +.align-right { + text-align: right } + +/* reset inner alignment in figures */ +div.align-right { + text-align: inherit } + +/* div.align-center * { */ +/* text-align: left } */ + +.align-top { + vertical-align: top } + +.align-middle { + vertical-align: middle } + +.align-bottom { + vertical-align: bottom } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font: inherit } + +pre.literal-block, pre.doctest-block, pre.math, pre.code { + margin-left: 2em ; + margin-right: 2em } + +pre.code .ln { color: grey; } /* line numbers */ +pre.code, code { background-color: #eeeeee } +pre.code .comment, code .comment { color: #5C6576 } +pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } +pre.code .literal.string, code .literal.string { color: #0C5404 } +pre.code .name.builtin, code .name.builtin { color: #352B84 } +pre.code .deleted, code .deleted { background-color: #DEB0A1} +pre.code .inserted, code .inserted { background-color: #A3D289} + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +/* "booktabs" style (no vertical lines) */ +table.docutils.booktabs { + border: 0px; + border-top: 2px solid; + border-bottom: 2px solid; + border-collapse: collapse; +} +table.docutils.booktabs * { + border: 0px; +} +table.docutils.booktabs th { + border-bottom: thin solid; + text-align: left; +} + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } + +</style> +</head> +<body> +<div class="document"> + + +<p id="groupby">{{ header }}</p> +<div class="section" id="group-by-split-apply-combine"> +<h1>Group by: split-apply-combine</h1> +<p>By &quot;group by&quot; we are referring to a process involving one or more of the following +steps:</p> +<ul class="simple"> +<li><strong>Splitting</strong> the data into groups based on some criteria.</li> +<li><strong>Applying</strong> a function to each group independently.</li> +<li><strong>Combining</strong> the results into a data structure.</li> +</ul> +<p>Out of these, the split step is the most straightforward. In fact, in many +situations we may wish to split the data set into groups and do something with +those groups. In the apply step, we might wish to do one of the +following:</p> +<ul> +<li><p class="first"><strong>Aggregation</strong>: compute a summary statistic (or statistics) for each +group. Some examples:</p> +<blockquote> +<ul class="simple"> +<li>Compute group sums or means.</li> +<li>Compute group sizes / counts.</li> +</ul> +</blockquote> +</li> +<li><p class="first"><strong>Transformation</strong>: perform some group-specific computations and return a +like-indexed object. Some examples:</p> +<blockquote> +<ul class="simple"> +<li>Standardize data (zscore) within a group.</li> +<li>Filling NAs within groups with a value derived from each group.</li> +</ul> +</blockquote> +</li> +<li><p class="first"><strong>Filtration</strong>: discard some groups, according to a group-wise computation +that evaluates to True or False. Some examples:</p> +<blockquote> +<ul class="simple"> +<li>Discard data that belong to groups with only a few members.</li> +<li>Filter out data based on the group sum or mean.</li> +</ul> +</blockquote> +</li> +</ul> +<p>Many of these operations are defined on GroupBy objects. These operations are similar +to those of the <a href="#system-message-1"><span class="problematic" id="problematic-1">:ref:`aggregating API &lt;basics.aggregate&gt;`</span></a>, +<a href="#system-message-2"><span class="problematic" id="problematic-2">:ref:`window API &lt;window.overview&gt;`</span></a>, and <a href="#system-message-3"><span class="problematic" id="problematic-3">:ref:`resample API &lt;timeseries.aggregate&gt;`</span></a>.</p> +<div class="system-message" id="system-message-1"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 39); <em><a href="#problematic-1">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="system-message" id="system-message-2"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 39); <em><a href="#problematic-2">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="system-message" id="system-message-3"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 39); <em><a href="#problematic-3">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<p>It is possible that a given operation does not fall into one of these categories or +is some combination of them. In such a case, it may be possible to compute the +operation using GroupBy's <tt class="docutils literal">apply</tt> method. This method will examine the results of the +apply step and try to sensibly combine them into a single result if it doesn't fit into either +of the above three categories.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">An operation that is split into multiple steps using built-in GroupBy operations +will be more efficient than using the <tt class="docutils literal">apply</tt> method with a user-defined Python +function.</p> +</div> +<p>Since the set of object instance methods on pandas data structures is generally +rich and expressive, we often simply want to invoke, say, a DataFrame function +on each group. The name GroupBy should be quite familiar to those who have used +a SQL-based tool (or <tt class="docutils literal">itertools</tt>), in which you can write code like:</p> +<pre class="code sql literal-block"> +SELECT Column1, Column2, mean(Column3), sum(Column4) +FROM SomeTable +GROUP BY Column1, Column2 +</pre> +<p>We aim to make operations like this natural and easy to express using +pandas. We'll address each area of GroupBy functionality then provide some +non-trivial examples / use cases.</p> +<p>See the <a href="#system-message-4"><span class="problematic" id="problematic-4">:ref:`cookbook&lt;cookbook.grouping&gt;`</span></a> for some advanced strategies.</p> +<div class="system-message" id="system-message-4"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 71); <em><a href="#problematic-4">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="section" id="splitting-an-object-into-groups"> +<span id="groupby-split"></span><h2>Splitting an object into groups</h2> +<p>The abstract definition of grouping is to provide a mapping of labels to +group names. To create a GroupBy object (more on what the GroupBy object is +later), you may do the following:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 82)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + speeds = pd.DataFrame( + [ + (&quot;bird&quot;, &quot;Falconiformes&quot;, 389.0), + (&quot;bird&quot;, &quot;Psittaciformes&quot;, 24.0), + (&quot;mammal&quot;, &quot;Carnivora&quot;, 80.2), + (&quot;mammal&quot;, &quot;Primates&quot;, np.nan), + (&quot;mammal&quot;, &quot;Carnivora&quot;, 58), + ], + index=[&quot;falcon&quot;, &quot;parrot&quot;, &quot;lion&quot;, &quot;monkey&quot;, &quot;leopard&quot;], + columns=(&quot;class&quot;, &quot;order&quot;, &quot;max_speed&quot;), + ) + speeds + + grouped = speeds.groupby(&quot;class&quot;) + grouped = speeds.groupby([&quot;class&quot;, &quot;order&quot;]) + +</pre> +</div> +<p>The mapping can be specified many different ways:</p> +<ul class="simple"> +<li>A Python function, to be called on each of the index labels.</li> +<li>A list or NumPy array of the same length as the index.</li> +<li>A dict or <tt class="docutils literal">Series</tt>, providing a <tt class="docutils literal">label <span class="pre">-&gt;</span> group name</tt> mapping.</li> +<li>For <tt class="docutils literal">DataFrame</tt> objects, a string indicating either a column name or +an index level name to be used to group.</li> +<li>A list of any of the above things.</li> +</ul> +<p>Collectively we refer to the grouping objects as the <strong>keys</strong>. For example, +consider the following <tt class="docutils literal">DataFrame</tt>:</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">A string passed to <tt class="docutils literal">groupby</tt> may refer to either a column or an index level. +If a string matches both a column name and an index level name, a +<tt class="docutils literal">ValueError</tt> will be raised.</p> +</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 118)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = pd.DataFrame( + { + &quot;A&quot;: [&quot;foo&quot;, &quot;bar&quot;, &quot;foo&quot;, &quot;bar&quot;, &quot;foo&quot;, &quot;bar&quot;, &quot;foo&quot;, &quot;foo&quot;], + &quot;B&quot;: [&quot;one&quot;, &quot;one&quot;, &quot;two&quot;, &quot;three&quot;, &quot;two&quot;, &quot;two&quot;, &quot;one&quot;, &quot;three&quot;], + &quot;C&quot;: np.random.randn(8), + &quot;D&quot;: np.random.randn(8), + } + ) + df + +</pre> +</div> +<p>On a DataFrame, we obtain a GroupBy object by calling <a href="#system-message-5"><span class="problematic" id="problematic-5">:meth:`~DataFrame.groupby`</span></a>. +This method returns a <tt class="docutils literal">pandas.api.typing.DataFrameGroupBy</tt> instance. +We could naturally group by either the <tt class="docutils literal">A</tt> or <tt class="docutils literal">B</tt> columns, or both:</p> +<div class="system-message" id="system-message-5"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 130); <em><a href="#problematic-5">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 134)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = df.groupby(&quot;A&quot;) + grouped = df.groupby([&quot;A&quot;, &quot;B&quot;]) + +</pre> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last"><tt class="docutils literal"><span class="pre">df.groupby('A')</span></tt> is just syntactic sugar for <tt class="docutils literal"><span class="pre">df.groupby(df['A'])</span></tt>.</p> +</div> +<p>If we also have a MultiIndex on columns <tt class="docutils literal">A</tt> and <tt class="docutils literal">B</tt>, we can group by all +the columns except the one we specify:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 146)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df2 = df.set_index([&quot;A&quot;, &quot;B&quot;]) + grouped = df2.groupby(level=df2.index.names.difference([&quot;B&quot;])) + grouped.sum() + +</pre> +</div> +<p>The above GroupBy will split the DataFrame on its index (rows). To split by columns, first do +a transpose:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 155)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: + + In [4]: def get_letter_type(letter): + ...: if letter.lower() in 'aeiou': + ...: return 'vowel' + ...: else: + ...: return 'consonant' + ...: + + In [5]: grouped = df.T.groupby(get_letter_type) + +</pre> +</div> +<p>pandas <a href="#system-message-6"><span class="problematic" id="problematic-6">:class:`~pandas.Index`</span></a> objects support duplicate values. If a +non-unique index is used as the group key in a groupby operation, all values +for the same index value will be considered to be in one group and thus the +output of aggregation functions will only contain unique index values:</p> +<div class="system-message" id="system-message-6"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 166); <em><a href="#problematic-6">backlink</a></em></p> +Unknown interpreted text role &quot;class&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 171)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + lst = [1, 2, 3, 1, 2, 3] + + s = pd.Series([1, 2, 3, 10, 20, 30], lst) + + grouped = s.groupby(level=0) + + grouped.first() + + grouped.last() + + grouped.sum() + +</pre> +</div> +<p>Note that <strong>no splitting occurs</strong> until it's needed. Creating the GroupBy object +only verifies that you've passed a valid mapping.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Many kinds of complicated data manipulations can be expressed in terms of +GroupBy operations (though it can't be guaranteed to be the most efficient implementation). +You can get quite creative with the label mapping functions.</p> +</div> +<div class="section" id="groupby-sorting-1"> +<span id="groupby-sorting"></span><h3>GroupBy sorting</h3> +<p>By default the group keys are sorted during the <tt class="docutils literal">groupby</tt> operation. You may however pass <tt class="docutils literal">sort=False</tt> for potential speedups. With <tt class="docutils literal">sort=False</tt> the order among group-keys follows the order of appearance of the keys in the original dataframe:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 201)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df2 = pd.DataFrame({&quot;X&quot;: [&quot;B&quot;, &quot;B&quot;, &quot;A&quot;, &quot;A&quot;], &quot;Y&quot;: [1, 2, 3, 4]}) + df2.groupby([&quot;X&quot;]).sum() + df2.groupby([&quot;X&quot;], sort=False).sum() + + +</pre> +</div> +<p>Note that <tt class="docutils literal">groupby</tt> will preserve the order in which <em>observations</em> are sorted <em>within</em> each group. +For example, the groups created by <tt class="docutils literal">groupby()</tt> below are in the order they appeared in the original <tt class="docutils literal">DataFrame</tt>:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 211)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df3 = pd.DataFrame({&quot;X&quot;: [&quot;A&quot;, &quot;B&quot;, &quot;A&quot;, &quot;B&quot;], &quot;Y&quot;: [1, 4, 3, 2]}) + df3.groupby([&quot;X&quot;]).get_group(&quot;A&quot;) + + df3.groupby([&quot;X&quot;]).get_group(&quot;B&quot;) + + +</pre> +</div> +<div class="section" id="groupby-dropna-1"> +<span id="groupby-dropna"></span><h4>GroupBy dropna</h4> +<p>By default <tt class="docutils literal">NA</tt> values are excluded from group keys during the <tt class="docutils literal">groupby</tt> operation. However, +in case you want to include <tt class="docutils literal">NA</tt> values in group keys, you could pass <tt class="docutils literal">dropna=False</tt> to achieve it.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 227)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df_list = [[1, 2, 3], [1, None, 4], [2, 1, 3], [1, 2, 2]] + df_dropna = pd.DataFrame(df_list, columns=[&quot;a&quot;, &quot;b&quot;, &quot;c&quot;]) + + df_dropna + +</pre> +</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 234)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + # Default ``dropna`` is set to True, which will exclude NaNs in keys + df_dropna.groupby(by=[&quot;b&quot;], dropna=True).sum() + + # In order to allow NaN in keys, set ``dropna`` to False + df_dropna.groupby(by=[&quot;b&quot;], dropna=False).sum() + +</pre> +</div> +<p>The default setting of <tt class="docutils literal">dropna</tt> argument is <tt class="docutils literal">True</tt> which means <tt class="docutils literal">NA</tt> are not included in group keys.</p> +</div> +</div> +<div class="section" id="groupby-object-attributes"> +<span id="groupby-attributes"></span><h3>GroupBy object attributes</h3> +<p>The <tt class="docutils literal">groups</tt> attribute is a dictionary whose keys are the computed unique groups +and corresponding values are the axis labels belonging to each group. In the +above example we have:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 254)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby(&quot;A&quot;).groups + df.T.groupby(get_letter_type).groups + +</pre> +</div> +<p>Calling the standard Python <tt class="docutils literal">len</tt> function on the GroupBy object just returns +the length of the <tt class="docutils literal">groups</tt> dict, so it is largely just a convenience:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 262)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = df.groupby([&quot;A&quot;, &quot;B&quot;]) + grouped.groups + len(grouped) + + +</pre> +</div> +<p id="groupby-tabcompletion"><tt class="docutils literal">GroupBy</tt> will tab complete column names (and other attributes):</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 273)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + n = 10 + weight = np.random.normal(166, 20, size=n) + height = np.random.normal(60, 10, size=n) + time = pd.date_range(&quot;1/1/2000&quot;, periods=n) + gender = np.random.choice([&quot;male&quot;, &quot;female&quot;], size=n) + df = pd.DataFrame( + {&quot;height&quot;: height, &quot;weight&quot;: weight, &quot;gender&quot;: gender}, index=time + ) + df + gb = df.groupby(&quot;gender&quot;) + + +</pre> +</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 287)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: + + &#64;verbatim + In [1]: gb.&lt;TAB&gt; # noqa: E225, E999 + gb.agg gb.boxplot gb.cummin gb.describe gb.filter gb.get_group gb.height gb.last gb.median gb.ngroups gb.plot gb.rank gb.std gb.transform + gb.aggregate gb.count gb.cumprod gb.dtype gb.first gb.groups gb.hist gb.max gb.min gb.nth gb.prod gb.resample gb.sum gb.var + gb.apply gb.cummax gb.cumsum gb.fillna gb.gender gb.head gb.indices gb.mean gb.name gb.ohlc gb.quantile gb.size gb.tail gb.weight + +</pre> +</div> +</div> +<div class="section" id="groupby-with-multiindex"> +<span id="groupby-multiindex"></span><h3>GroupBy with MultiIndex</h3> +<p>With <a href="#system-message-7"><span class="problematic" id="problematic-7">:ref:`hierarchically-indexed data &lt;advanced.hierarchical&gt;`</span></a>, it's quite +natural to group by one of the levels of the hierarchy.</p> +<div class="system-message" id="system-message-7"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 300); <em><a href="#problematic-7">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<p>Let's create a Series with a two-level <tt class="docutils literal">MultiIndex</tt>.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 305)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + + arrays = [ + [&quot;bar&quot;, &quot;bar&quot;, &quot;baz&quot;, &quot;baz&quot;, &quot;foo&quot;, &quot;foo&quot;, &quot;qux&quot;, &quot;qux&quot;], + [&quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;], + ] + index = pd.MultiIndex.from_arrays(arrays, names=[&quot;first&quot;, &quot;second&quot;]) + s = pd.Series(np.random.randn(8), index=index) + s + +</pre> +</div> +<p>We can then group by one of the levels in <tt class="docutils literal">s</tt>.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 318)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = s.groupby(level=0) + grouped.sum() + +</pre> +</div> +<p>If the MultiIndex has names specified, these can be passed instead of the level +number:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 326)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + s.groupby(level=&quot;second&quot;).sum() + +</pre> +</div> +<p>Grouping with multiple levels is supported.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 332)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + arrays = [ + [&quot;bar&quot;, &quot;bar&quot;, &quot;baz&quot;, &quot;baz&quot;, &quot;foo&quot;, &quot;foo&quot;, &quot;qux&quot;, &quot;qux&quot;], + [&quot;doo&quot;, &quot;doo&quot;, &quot;bee&quot;, &quot;bee&quot;, &quot;bop&quot;, &quot;bop&quot;, &quot;bop&quot;, &quot;bop&quot;], + [&quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;], + ] + index = pd.MultiIndex.from_arrays(arrays, names=[&quot;first&quot;, &quot;second&quot;, &quot;third&quot;]) + s = pd.Series(np.random.randn(8), index=index) + s + s.groupby(level=[&quot;first&quot;, &quot;second&quot;]).sum() + +</pre> +</div> +<p>Index level names may be supplied as keys.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 346)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + s.groupby([&quot;first&quot;, &quot;second&quot;]).sum() + +</pre> +</div> +<p>More on the <tt class="docutils literal">sum</tt> function and aggregation later.</p> +</div> +<div class="section" id="grouping-dataframe-with-index-levels-and-columns"> +<h3>Grouping DataFrame with Index levels and columns</h3> +<p>A DataFrame may be grouped by a combination of columns and index levels. You +can specify both column and index names, or use a <a href="#system-message-8"><span class="problematic" id="problematic-8">:class:`Grouper`</span></a>.</p> +<div class="system-message" id="system-message-8"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 354); <em><a href="#problematic-8">backlink</a></em></p> +Unknown interpreted text role &quot;class&quot;.</div> +<p>Let's first create a DataFrame with a MultiIndex:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 359)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + arrays = [ + [&quot;bar&quot;, &quot;bar&quot;, &quot;baz&quot;, &quot;baz&quot;, &quot;foo&quot;, &quot;foo&quot;, &quot;qux&quot;, &quot;qux&quot;], + [&quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;, &quot;one&quot;, &quot;two&quot;], + ] + + index = pd.MultiIndex.from_arrays(arrays, names=[&quot;first&quot;, &quot;second&quot;]) + + df = pd.DataFrame({&quot;A&quot;: [1, 1, 1, 1, 2, 2, 3, 3], &quot;B&quot;: np.arange(8)}, index=index) + + df + +</pre> +</div> +<p>Then we group <tt class="docutils literal">df</tt> by the <tt class="docutils literal">second</tt> index level and the <tt class="docutils literal">A</tt> column.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 374)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby([pd.Grouper(level=1), &quot;A&quot;]).sum() + +</pre> +</div> +<p>Index levels may also be specified by name.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 380)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby([pd.Grouper(level=&quot;second&quot;), &quot;A&quot;]).sum() + +</pre> +</div> +<p>Index level names may be specified as keys directly to <tt class="docutils literal">groupby</tt>.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 386)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby([&quot;second&quot;, &quot;A&quot;]).sum() + +</pre> +</div> +</div> +<div class="section" id="dataframe-column-selection-in-groupby"> +<h3>DataFrame column selection in GroupBy</h3> +<p>Once you have created the GroupBy object from a DataFrame, you might want to do +something different for each of the columns. Thus, by using <tt class="docutils literal">[]</tt> on the GroupBy +object in a similar way as the one used to get a column from a DataFrame, you can do:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 397)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = pd.DataFrame( + { + &quot;A&quot;: [&quot;foo&quot;, &quot;bar&quot;, &quot;foo&quot;, &quot;bar&quot;, &quot;foo&quot;, &quot;bar&quot;, &quot;foo&quot;, &quot;foo&quot;], + &quot;B&quot;: [&quot;one&quot;, &quot;one&quot;, &quot;two&quot;, &quot;three&quot;, &quot;two&quot;, &quot;two&quot;, &quot;one&quot;, &quot;three&quot;], + &quot;C&quot;: np.random.randn(8), + &quot;D&quot;: np.random.randn(8), + } + ) + + df + + grouped = df.groupby([&quot;A&quot;]) + grouped_C = grouped[&quot;C&quot;] + grouped_D = grouped[&quot;D&quot;] + +</pre> +</div> +<p>This is mainly syntactic sugar for the alternative, which is much more verbose:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 416)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df[&quot;C&quot;].groupby(df[&quot;A&quot;]) + +</pre> +</div> +<p>Additionally, this method avoids recomputing the internal grouping information +derived from the passed key.</p> +</div> +</div> +<div class="section" id="iterating-through-groups"> +<span id="groupby-iterating-label"></span><h2>Iterating through groups</h2> +<p>With the GroupBy object in hand, iterating through the grouped data is very +natural and functions similarly to <a href="#system-message-9"><span class="problematic" id="problematic-9">:py:func:`itertools.groupby`</span></a>:</p> +<div class="system-message" id="system-message-9"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 428); <em><a href="#problematic-9">backlink</a></em></p> +Unknown interpreted text role &quot;py:func&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 431)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: + + In [4]: grouped = df.groupby('A') + + In [5]: for name, group in grouped: + ...: print(name) + ...: print(group) + ...: + +</pre> +</div> +<p>In the case of grouping by multiple keys, the group name will be a tuple:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 442)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: + + In [5]: for name, group in df.groupby(['A', 'B']): + ...: print(name) + ...: print(group) + ...: + +</pre> +</div> +<p>See <a href="#system-message-10"><span class="problematic" id="problematic-10">:ref:`timeseries.iterating-label`</span></a>.</p> +<div class="system-message" id="system-message-10"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 449); <em><a href="#problematic-10">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +</div> +<div class="section" id="selecting-a-group"> +<h2>Selecting a group</h2> +<p>A single group can be selected using +<a href="#system-message-11"><span class="problematic" id="problematic-11">:meth:`~pandas.core.groupby.DataFrameGroupBy.get_group`</span></a>:</p> +<div class="system-message" id="system-message-11"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 454); <em><a href="#problematic-11">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 457)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped.get_group(&quot;bar&quot;) + +</pre> +</div> +<p>Or for an object grouped on multiple columns:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 463)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby([&quot;A&quot;, &quot;B&quot;]).get_group((&quot;bar&quot;, &quot;one&quot;)) + +</pre> +</div> +</div> +<div class="section" id="aggregation"> +<span id="groupby-aggregate"></span><h2>Aggregation</h2> +<p>An aggregation is a GroupBy operation that reduces the dimension of the grouping +object. The result of an aggregation is, or at least is treated as, +a scalar value for each column in a group. For example, producing the sum of each +column in a group of values.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 477)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + animals = pd.DataFrame( + { + &quot;kind&quot;: [&quot;cat&quot;, &quot;dog&quot;, &quot;cat&quot;, &quot;dog&quot;], + &quot;height&quot;: [9.1, 6.0, 9.5, 34.0], + &quot;weight&quot;: [7.9, 7.5, 9.9, 198.0], + } + ) + animals + animals.groupby(&quot;kind&quot;).sum() + +</pre> +</div> +<p>In the result, the keys of the groups appear in the index by default. They can be +instead included in the columns by passing <tt class="docutils literal">as_index=False</tt>.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 492)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + animals.groupby(&quot;kind&quot;, as_index=False).sum() + +</pre> +</div> +<div class="section" id="built-in-aggregation-methods"> +<span id="groupby-aggregate-builtin"></span><h3>Built-in aggregation methods</h3> +<p>Many common aggregations are built-in to GroupBy objects as methods. Of the methods +listed below, those with a <tt class="docutils literal">*</tt> do <em>not</em> have a Cython-optimized implementation.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="80%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Method</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><p class="first"><a href="#system-message-12"><span class="problematic" id="problematic-12">:meth:`~.DataFrameGroupBy.any`</span></a></p> +<div class="last system-message" id="system-message-12"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-12">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute whether any of the values in the groups are truthy</td> +</tr> +<tr><td><p class="first"><a href="#system-message-13"><span class="problematic" id="problematic-13">:meth:`~.DataFrameGroupBy.all`</span></a></p> +<div class="last system-message" id="system-message-13"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-13">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute whether all of the values in the groups are truthy</td> +</tr> +<tr><td><p class="first"><a href="#system-message-14"><span class="problematic" id="problematic-14">:meth:`~.DataFrameGroupBy.count`</span></a></p> +<div class="last system-message" id="system-message-14"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-14">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the number of non-NA values in the groups</td> +</tr> +<tr><td><p class="first"><a href="#system-message-15"><span class="problematic" id="problematic-15">:meth:`~.DataFrameGroupBy.cov`</span></a> *</p> +<div class="last system-message" id="system-message-15"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-15">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the covariance of the groups</td> +</tr> +<tr><td><p class="first"><a href="#system-message-16"><span class="problematic" id="problematic-16">:meth:`~.DataFrameGroupBy.first`</span></a></p> +<div class="last system-message" id="system-message-16"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-16">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the first occurring value in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-17"><span class="problematic" id="problematic-17">:meth:`~.DataFrameGroupBy.idxmax`</span></a> *</p> +<div class="last system-message" id="system-message-17"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-17">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the index of the maximum value in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-18"><span class="problematic" id="problematic-18">:meth:`~.DataFrameGroupBy.idxmin`</span></a> *</p> +<div class="last system-message" id="system-message-18"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-18">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the index of the minimum value in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-19"><span class="problematic" id="problematic-19">:meth:`~.DataFrameGroupBy.last`</span></a></p> +<div class="last system-message" id="system-message-19"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-19">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the last occurring value in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-20"><span class="problematic" id="problematic-20">:meth:`~.DataFrameGroupBy.max`</span></a></p> +<div class="last system-message" id="system-message-20"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-20">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the maximum value in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-21"><span class="problematic" id="problematic-21">:meth:`~.DataFrameGroupBy.mean`</span></a></p> +<div class="last system-message" id="system-message-21"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-21">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the mean of each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-22"><span class="problematic" id="problematic-22">:meth:`~.DataFrameGroupBy.median`</span></a></p> +<div class="last system-message" id="system-message-22"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-22">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the median of each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-23"><span class="problematic" id="problematic-23">:meth:`~.DataFrameGroupBy.min`</span></a></p> +<div class="last system-message" id="system-message-23"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-23">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the minimum value in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-24"><span class="problematic" id="problematic-24">:meth:`~.DataFrameGroupBy.nunique`</span></a></p> +<div class="last system-message" id="system-message-24"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-24">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the number of unique values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-25"><span class="problematic" id="problematic-25">:meth:`~.DataFrameGroupBy.prod`</span></a></p> +<div class="last system-message" id="system-message-25"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-25">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the product of the values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-26"><span class="problematic" id="problematic-26">:meth:`~.DataFrameGroupBy.quantile`</span></a></p> +<div class="last system-message" id="system-message-26"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-26">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute a given quantile of the values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-27"><span class="problematic" id="problematic-27">:meth:`~.DataFrameGroupBy.sem`</span></a></p> +<div class="last system-message" id="system-message-27"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-27">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the standard error of the mean of the values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-28"><span class="problematic" id="problematic-28">:meth:`~.DataFrameGroupBy.size`</span></a></p> +<div class="last system-message" id="system-message-28"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-28">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the number of values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-29"><span class="problematic" id="problematic-29">:meth:`~.DataFrameGroupBy.skew`</span></a> *</p> +<div class="last system-message" id="system-message-29"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-29">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the skew of the values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-30"><span class="problematic" id="problematic-30">:meth:`~.DataFrameGroupBy.std`</span></a></p> +<div class="last system-message" id="system-message-30"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-30">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the standard deviation of the values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-31"><span class="problematic" id="problematic-31">:meth:`~.DataFrameGroupBy.sum`</span></a></p> +<div class="last system-message" id="system-message-31"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-31">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the sum of the values in each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-32"><span class="problematic" id="problematic-32">:meth:`~.DataFrameGroupBy.var`</span></a></p> +<div class="last system-message" id="system-message-32"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 509); <em><a href="#problematic-32">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the variance of the values in each group</td> +</tr> +</tbody> +</table> +<p>Some examples:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 533)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby(&quot;A&quot;)[[&quot;C&quot;, &quot;D&quot;]].max() + df.groupby([&quot;A&quot;, &quot;B&quot;]).mean() + +</pre> +</div> +<p>Another simple aggregation example is to compute the size of each group. +This is included in GroupBy as the <tt class="docutils literal">size</tt> method. It returns a Series whose +index are the group names and whose values are the sizes of each group.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 542)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = df.groupby([&quot;A&quot;, &quot;B&quot;]) + grouped.size() + +</pre> +</div> +<p>While the <a href="#system-message-33"><span class="problematic" id="problematic-33">:meth:`~.DataFrameGroupBy.describe`</span></a> method is not itself a reducer, it +can be used to conveniently produce a collection of summary statistics about each of +the groups.</p> +<div class="system-message" id="system-message-33"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 547); <em><a href="#problematic-33">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 551)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped.describe() + +</pre> +</div> +<p>Another aggregation example is to compute the number of unique values of each group. +This is similar to the <tt class="docutils literal">value_counts</tt> function, except that it only counts the +number of unique values.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 559)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + ll = [['foo', 1], ['foo', 2], ['foo', 2], ['bar', 1], ['bar', 1]] + df4 = pd.DataFrame(ll, columns=[&quot;A&quot;, &quot;B&quot;]) + df4 + df4.groupby(&quot;A&quot;)[&quot;B&quot;].nunique() + +</pre> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>Aggregation functions <strong>will not</strong> return the groups that you are aggregating over +as named <em>columns</em>, when <tt class="docutils literal">as_index=True</tt>, the default. The grouped columns will +be the <strong>indices</strong> of the returned object.</p> +<p class="last">Passing <tt class="docutils literal">as_index=False</tt> <strong>will</strong> return the groups that you are aggregating over, if they are +named <strong>indices</strong> or <em>columns</em>.</p> +</div> +</div> +<div class="section" id="the-meth-dataframegroupby-aggregate-method"> +<span id="groupby-aggregate-agg"></span><h3>The <a href="#system-message-34"><span class="problematic" id="problematic-34">:meth:`~.DataFrameGroupBy.aggregate`</span></a> method</h3> +<div class="system-message" id="system-message-34"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 578); <em><a href="#problematic-34">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>The <a href="#system-message-35"><span class="problematic" id="problematic-35">:meth:`~.DataFrameGroupBy.aggregate`</span></a> method can accept many different types of +inputs. This section details using string aliases for various GroupBy methods; other +inputs are detailed in the sections below.</p> +<div class="last system-message" id="system-message-35"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 582); <em><a href="#problematic-35">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</div> +<p>Any reduction method that pandas implements can be passed as a string to +<a href="#system-message-36"><span class="problematic" id="problematic-36">:meth:`~.DataFrameGroupBy.aggregate`</span></a>. Users are encouraged to use the shorthand, +<tt class="docutils literal">agg</tt>. It will operate as if the corresponding method was called.</p> +<div class="system-message" id="system-message-36"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 586); <em><a href="#problematic-36">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 590)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = df.groupby(&quot;A&quot;) + grouped[[&quot;C&quot;, &quot;D&quot;]].aggregate(&quot;sum&quot;) + + grouped = df.groupby([&quot;A&quot;, &quot;B&quot;]) + grouped.agg(&quot;sum&quot;) + +</pre> +</div> +<p>The result of the aggregation will have the group names as the +new index along the grouped axis. In the case of multiple keys, the result is a +<a href="#system-message-37"><span class="problematic" id="problematic-37">:ref:`MultiIndex &lt;advanced.hierarchical&gt;`</span></a> by default. As mentioned above, this can be +changed by using the <tt class="docutils literal">as_index</tt> option:</p> +<div class="system-message" id="system-message-37"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 598); <em><a href="#problematic-37">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 603)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = df.groupby([&quot;A&quot;, &quot;B&quot;], as_index=False) + grouped.agg(&quot;sum&quot;) + + df.groupby(&quot;A&quot;, as_index=False)[[&quot;C&quot;, &quot;D&quot;]].agg(&quot;sum&quot;) + +</pre> +</div> +<p>Note that you could use the <a href="#system-message-38"><span class="problematic" id="problematic-38">:meth:`DataFrame.reset_index`</span></a> DataFrame function to achieve +the same result as the column names are stored in the resulting <tt class="docutils literal">MultiIndex</tt>, although +this will make an extra copy.</p> +<div class="system-message" id="system-message-38"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 610); <em><a href="#problematic-38">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 614)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby([&quot;A&quot;, &quot;B&quot;]).agg(&quot;sum&quot;).reset_index() + +</pre> +</div> +</div> +<div class="section" id="aggregation-with-user-defined-functions"> +<span id="groupby-aggregate-udf"></span><h3>Aggregation with User-Defined Functions</h3> +<p>Users can also provide their own User-Defined Functions (UDFs) for custom aggregations.</p> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p>When aggregating with a UDF, the UDF should not mutate the +provided <tt class="docutils literal">Series</tt>. See <a href="#system-message-39"><span class="problematic" id="problematic-39">:ref:`gotchas.udf-mutation`</span></a> for more information.</p> +<div class="last system-message" id="system-message-39"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 627); <em><a href="#problematic-39">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Aggregating with a UDF is often less performant than using +the pandas built-in methods on GroupBy. Consider breaking up a complex operation +into a chain of operations that utilize the built-in methods.</p> +</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 636)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + animals + animals.groupby(&quot;kind&quot;)[[&quot;height&quot;]].agg(lambda x: set(x)) + +</pre> +</div> +<p>The resulting dtype will reflect that of the aggregating function. If the results from different groups have +different dtypes, then a common dtype will be determined in the same way as <tt class="docutils literal">DataFrame</tt> construction.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 644)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + animals.groupby(&quot;kind&quot;)[[&quot;height&quot;]].agg(lambda x: x.astype(int).sum()) + +</pre> +</div> +</div> +<div class="section" id="applying-multiple-functions-at-once"> +<span id="groupby-aggregate-multifunc"></span><h3>Applying multiple functions at once</h3> +<p>With grouped <tt class="docutils literal">Series</tt> you can also pass a list or dict of functions to do +aggregation with, outputting a DataFrame:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 656)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = df.groupby(&quot;A&quot;) + grouped[&quot;C&quot;].agg([&quot;sum&quot;, &quot;mean&quot;, &quot;std&quot;]) + +</pre> +</div> +<p>On a grouped <tt class="docutils literal">DataFrame</tt>, you can pass a list of functions to apply to each +column, which produces an aggregated result with a hierarchical index:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 664)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped[[&quot;C&quot;, &quot;D&quot;]].agg([&quot;sum&quot;, &quot;mean&quot;, &quot;std&quot;]) + + +</pre> +</div> +<p>The resulting aggregations are named after the functions themselves. If you +need to rename, then you can add in a chained operation for a <tt class="docutils literal">Series</tt> like this:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 672)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + ( + grouped[&quot;C&quot;] + .agg([&quot;sum&quot;, &quot;mean&quot;, &quot;std&quot;]) + .rename(columns={&quot;sum&quot;: &quot;foo&quot;, &quot;mean&quot;: &quot;bar&quot;, &quot;std&quot;: &quot;baz&quot;}) + ) + +</pre> +</div> +<p>For a grouped <tt class="docutils literal">DataFrame</tt>, you can rename in a similar manner:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 682)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + ( + grouped[[&quot;C&quot;, &quot;D&quot;]].agg([&quot;sum&quot;, &quot;mean&quot;, &quot;std&quot;]).rename( + columns={&quot;sum&quot;: &quot;foo&quot;, &quot;mean&quot;: &quot;bar&quot;, &quot;std&quot;: &quot;baz&quot;} + ) + ) + +</pre> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>In general, the output column names should be unique, but pandas will allow +you apply to the same function (or two functions with the same name) to the same +column.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 696)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped[&quot;C&quot;].agg([&quot;sum&quot;, &quot;sum&quot;]) + + +</pre> +</div> +<p>pandas also allows you to provide multiple lambdas. In this case, pandas +will mangle the name of the (nameless) lambda functions, appending <tt class="docutils literal">_&lt;i&gt;</tt> +to each subsequent lambda.</p> +<div class="last system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 705)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped[&quot;C&quot;].agg([lambda x: x.max() - x.min(), lambda x: x.median() - x.mean()]) +</pre> +</div> +</div> +</div> +<div class="section" id="named-aggregation"> +<span id="groupby-aggregate-named"></span><h3>Named aggregation</h3> +<p>To support column-specific aggregation <em>with control over the output column names</em>, pandas +accepts the special syntax in <a href="#system-message-40"><span class="problematic" id="problematic-40">:meth:`.DataFrameGroupBy.agg`</span></a> and <a href="#system-message-41"><span class="problematic" id="problematic-41">:meth:`.SeriesGroupBy.agg`</span></a>, known as &quot;named aggregation&quot;, where</p> +<div class="system-message" id="system-message-40"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 715); <em><a href="#problematic-40">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message" id="system-message-41"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 715); <em><a href="#problematic-41">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<ul> +<li><p class="first">The keywords are the <em>output</em> column names</p> +</li> +<li><p class="first">The values are tuples whose first element is the column to select +and the second element is the aggregation to apply to that column. pandas +provides the <a href="#system-message-42"><span class="problematic" id="problematic-42">:class:`NamedAgg`</span></a> namedtuple with the fields <tt class="docutils literal">['column', 'aggfunc']</tt> +to make it clearer what the arguments are. As usual, the aggregation can +be a callable or a string alias.</p> +<div class="system-message" id="system-message-42"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 719); <em><a href="#problematic-42">backlink</a></em></p> +<p>Unknown interpreted text role &quot;class&quot;.</p> +</div> +</li> +</ul> +</div> +</div> +<div class="section" id="example"> +<h2>Example:</h2> +<p>Consider the following DataFrame <cite>animals</cite>:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 730)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + import pandas as pd + + animals = pd.DataFrame({ + 'kind': ['cat', 'dog', 'cat', 'dog'], + 'height': [9.1, 6.0, 9.5, 34.0], + 'weight': [7.9, 7.5, 9.9, 198.0] + }) + +</pre> +</div> +<p>To demonstrate &quot;named aggregation,&quot; let's group the DataFrame by the 'kind' column and apply different aggregations to the 'height' and 'weight' columns:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 742)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + result = animals.groupby('kind').agg( + min_height=pd.NamedAgg(column='height', aggfunc='min'), + max_height=pd.NamedAgg(column='height', aggfunc='max'), + average_weight=pd.NamedAgg(column='weight', aggfunc='mean') + ) + +</pre> +</div> +<p>In the above example, we used &quot;named aggregation&quot; to specify custom output column names (<cite>min_height</cite>, <cite>max_height</cite>, and <cite>average_weight</cite>) for each aggregation. The result will be a new DataFrame with the aggregated values, and the output column names will be as specified.</p> +<p>The resulting DataFrame will look like this:</p> +<pre class="code bash literal-block"> + min_height max_height average_weight +kind +cat 9.1 9.5 8.90 +dog 6.0 34.0 102.75 +</pre> +<p>In this example, the 'min_height' column contains the minimum height for each group, the 'max_height' column contains the maximum height, and the 'average_weight' column contains the average weight for each group.</p> +<p>By using &quot;named aggregation,&quot; you can easily control the output column names and have more descriptive results when performing aggregations with <cite>groupby.agg</cite>.</p> +<p><a href="#system-message-43"><span class="problematic" id="problematic-43">:class:`NamedAgg`</span></a> is just a <tt class="docutils literal">namedtuple</tt>. Plain tuples are allowed as well.</p> +<div class="system-message" id="system-message-43"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 765); <em><a href="#problematic-43">backlink</a></em></p> +Unknown interpreted text role &quot;class&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 767)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + animals.groupby(&quot;kind&quot;).agg( + min_height=(&quot;height&quot;, &quot;min&quot;), + max_height=(&quot;height&quot;, &quot;max&quot;), + average_weight=(&quot;weight&quot;, &quot;mean&quot;), + ) + + +</pre> +</div> +<p>If the column names you want are not valid Python keywords, construct a dictionary +and unpack the keyword arguments</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 779)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + animals.groupby(&quot;kind&quot;).agg( + **{ + &quot;total weight&quot;: pd.NamedAgg(column=&quot;weight&quot;, aggfunc=&quot;sum&quot;) + } + ) + +</pre> +</div> +<p>When using named aggregation, additional keyword arguments are not passed through +to the aggregation functions; only pairs +of <tt class="docutils literal">(column, aggfunc)</tt> should be passed as <tt class="docutils literal">**kwargs</tt>. If your aggregation functions +require additional arguments, apply them partially with <a href="#system-message-44"><span class="problematic" id="problematic-44">:meth:`functools.partial`</span></a>.</p> +<div class="system-message" id="system-message-44"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 787); <em><a href="#problematic-44">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<p>Named aggregation is also valid for Series groupby aggregations. In this case there's +no column selection, so the values are just the functions.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 795)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + animals.groupby(&quot;kind&quot;).height.agg( + min_height=&quot;min&quot;, + max_height=&quot;max&quot;, + ) + +</pre> +</div> +<div class="section" id="applying-different-functions-to-dataframe-columns"> +<h3>Applying different functions to DataFrame columns</h3> +<p>By passing a dict to <tt class="docutils literal">aggregate</tt> you can apply a different aggregation to the +columns of a DataFrame:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 808)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped.agg({&quot;C&quot;: &quot;sum&quot;, &quot;D&quot;: lambda x: np.std(x, ddof=1)}) + +</pre> +</div> +<p>The function names can also be strings. In order for a string to be valid it +must be implemented on GroupBy:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 815)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped.agg({&quot;C&quot;: &quot;sum&quot;, &quot;D&quot;: &quot;std&quot;}) + +</pre> +</div> +</div> +</div> +<div class="section" id="transformation"> +<span id="groupby-transform"></span><h2>Transformation</h2> +<p>A transformation is a GroupBy operation whose result is indexed the same +as the one being grouped. Common examples include <a href="#system-message-45"><span class="problematic" id="problematic-45">:meth:`~.DataFrameGroupBy.cumsum`</span></a> and +<a href="#system-message-46"><span class="problematic" id="problematic-46">:meth:`~.DataFrameGroupBy.diff`</span></a>.</p> +<div class="system-message" id="system-message-45"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 824); <em><a href="#problematic-45">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message" id="system-message-46"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 824); <em><a href="#problematic-46">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 828)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + speeds + grouped = speeds.groupby(&quot;class&quot;)[&quot;max_speed&quot;] + grouped.cumsum() + grouped.diff() + +</pre> +</div> +<p>Unlike aggregations, the groupings that are used to split +the original object are not included in the result.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>Since transformations do not include the groupings that are used to split the result, +the arguments <tt class="docutils literal">as_index</tt> and <tt class="docutils literal">sort</tt> in <a href="#system-message-47"><span class="problematic" id="problematic-47">:meth:`DataFrame.groupby`</span></a> and +<a href="#system-message-48"><span class="problematic" id="problematic-48">:meth:`Series.groupby`</span></a> have no effect.</p> +<div class="system-message" id="system-message-47"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 840); <em><a href="#problematic-47">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="last system-message" id="system-message-48"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 840); <em><a href="#problematic-48">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</div> +<p>A common use of a transformation is to add the result back into the original DataFrame.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 846)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + result = speeds.copy() + result[&quot;cumsum&quot;] = grouped.cumsum() + result[&quot;diff&quot;] = grouped.diff() + result + +</pre> +</div> +<div class="section" id="built-in-transformation-methods"> +<h3>Built-in transformation methods</h3> +<p>The following methods on GroupBy act as transformations. Of these methods, only +<tt class="docutils literal">fillna</tt> does not have a Cython-optimized implementation.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="80%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Method</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><p class="first"><a href="#system-message-49"><span class="problematic" id="problematic-49">:meth:`~.DataFrameGroupBy.bfill`</span></a></p> +<div class="last system-message" id="system-message-49"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-49">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Back fill NA values within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-50"><span class="problematic" id="problematic-50">:meth:`~.DataFrameGroupBy.cumcount`</span></a></p> +<div class="last system-message" id="system-message-50"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-50">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the cumulative count within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-51"><span class="problematic" id="problematic-51">:meth:`~.DataFrameGroupBy.cummax`</span></a></p> +<div class="last system-message" id="system-message-51"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-51">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the cumulative max within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-52"><span class="problematic" id="problematic-52">:meth:`~.DataFrameGroupBy.cummin`</span></a></p> +<div class="last system-message" id="system-message-52"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-52">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the cumulative min within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-53"><span class="problematic" id="problematic-53">:meth:`~.DataFrameGroupBy.cumprod`</span></a></p> +<div class="last system-message" id="system-message-53"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-53">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the cumulative product within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-54"><span class="problematic" id="problematic-54">:meth:`~.DataFrameGroupBy.cumsum`</span></a></p> +<div class="last system-message" id="system-message-54"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-54">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the cumulative sum within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-55"><span class="problematic" id="problematic-55">:meth:`~.DataFrameGroupBy.diff`</span></a></p> +<div class="last system-message" id="system-message-55"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-55">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the difference between adjacent values within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-56"><span class="problematic" id="problematic-56">:meth:`~.DataFrameGroupBy.ffill`</span></a></p> +<div class="last system-message" id="system-message-56"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-56">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Forward fill NA values within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-57"><span class="problematic" id="problematic-57">:meth:`~.DataFrameGroupBy.fillna`</span></a></p> +<div class="last system-message" id="system-message-57"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-57">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Fill NA values within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-58"><span class="problematic" id="problematic-58">:meth:`~.DataFrameGroupBy.pct_change`</span></a></p> +<div class="last system-message" id="system-message-58"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-58">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the percent change between adjacent values within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-59"><span class="problematic" id="problematic-59">:meth:`~.DataFrameGroupBy.rank`</span></a></p> +<div class="last system-message" id="system-message-59"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-59">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Compute the rank of each value within each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-60"><span class="problematic" id="problematic-60">:meth:`~.DataFrameGroupBy.shift`</span></a></p> +<div class="last system-message" id="system-message-60"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 864); <em><a href="#problematic-60">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Shift values up or down within each group</td> +</tr> +</tbody> +</table> +<p>In addition, passing any built-in aggregation method as a string to +<a href="#system-message-61"><span class="problematic" id="problematic-61">:meth:`~.DataFrameGroupBy.transform`</span></a> (see the next section) will broadcast the result +across the group, producing a transformed result. If the aggregation method is +Cython-optimized, this will be performant as well.</p> +<div class="system-message" id="system-message-61"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 877); <em><a href="#problematic-61">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</div> +<div class="section" id="the-meth-dataframegroupby-transform-method"> +<span id="groupby-transformation-transform"></span><h3>The <a href="#system-message-62"><span class="problematic" id="problematic-62">:meth:`~.DataFrameGroupBy.transform`</span></a> method</h3> +<div class="system-message" id="system-message-62"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 884); <em><a href="#problematic-62">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<p>Similar to the <a href="#system-message-63"><span class="problematic" id="problematic-63">:ref:`aggregation method &lt;groupby.aggregate.agg&gt;`</span></a>, the +<a href="#system-message-64"><span class="problematic" id="problematic-64">:meth:`~.DataFrameGroupBy.transform`</span></a> method can accept string aliases to the built-in +transformation methods in the previous section. It can <em>also</em> accept string aliases to +the built-in aggregation methods. When an aggregation method is provided, the result +will be broadcast across the group.</p> +<div class="system-message" id="system-message-63"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 887); <em><a href="#problematic-63">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="system-message" id="system-message-64"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 887); <em><a href="#problematic-64">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 893)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + speeds + grouped = speeds.groupby(&quot;class&quot;)[[&quot;max_speed&quot;]] + grouped.transform(&quot;cumsum&quot;) + grouped.transform(&quot;sum&quot;) + +</pre> +</div> +<p>In addition to string aliases, the <a href="#system-message-65"><span class="problematic" id="problematic-65">:meth:`~.DataFrameGroupBy.transform`</span></a> method can +also accept User-Defined Functions (UDFs). The UDF must:</p> +<div class="system-message" id="system-message-65"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 900); <em><a href="#problematic-65">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<ul> +<li><p class="first">Return a result that is either the same size as the group chunk or +broadcastable to the size of the group chunk (e.g., a scalar, +<tt class="docutils literal">grouped.transform(lambda x: <span class="pre">x.iloc[-1])</span></tt>).</p> +</li> +<li><p class="first">Operate column-by-column on the group chunk. The transform is applied to +the first group chunk using chunk.apply.</p> +</li> +<li><p class="first">Not perform in-place operations on the group chunk. Group chunks should +be treated as immutable, and changes to a group chunk may produce unexpected +results. See <a href="#system-message-66"><span class="problematic" id="problematic-66">:ref:`gotchas.udf-mutation`</span></a> for more information.</p> +<div class="system-message" id="system-message-66"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 908); <em><a href="#problematic-66">backlink</a></em></p> +<p>Unknown interpreted text role &quot;ref&quot;.</p> +</div> +</li> +<li><p class="first">(Optionally) operates on all columns of the entire group chunk at once. If this is +supported, a fast path is used starting from the <em>second</em> chunk.</p> +</li> +</ul> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>Transforming by supplying <tt class="docutils literal">transform</tt> with a UDF is +often less performant than using the built-in methods on GroupBy. +Consider breaking up a complex operation into a chain of operations that utilize +the built-in methods.</p> +<p>All of the examples in this section can be made more performant by calling +built-in methods instead of using <tt class="docutils literal">transform</tt>. +See <a href="#system-message-67"><span class="problematic" id="problematic-67">:ref:`below for examples &lt;groupby_efficient_transforms&gt;`</span></a>.</p> +<div class="last system-message" id="system-message-67"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 921); <em><a href="#problematic-67">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 925)</p> +<p>Unknown directive type &quot;versionchanged&quot;.</p> +<pre class="literal-block"> +.. versionchanged:: 2.0.0 + + When using ``.transform`` on a grouped DataFrame and the transformation function + returns a DataFrame, pandas now aligns the result's index + with the input's index. You can call ``.to_numpy()`` within the transformation + function to avoid alignment. + +</pre> +</div> +<p>Similar to <a href="#system-message-68"><span class="problematic" id="problematic-68">:ref:`groupby.aggregate.agg`</span></a>, the resulting dtype will reflect that of the +transformation function. If the results from different groups have different dtypes, then +a common dtype will be determined in the same way as <tt class="docutils literal">DataFrame</tt> construction.</p> +<div class="system-message" id="system-message-68"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 932); <em><a href="#problematic-68">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<p>Suppose we wish to standardize the data within each group:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 938)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + index = pd.date_range(&quot;10/1/1999&quot;, periods=1100) + ts = pd.Series(np.random.normal(0.5, 2, 1100), index) + ts = ts.rolling(window=100, min_periods=100).mean().dropna() + + ts.head() + ts.tail() + + transformed = ts.groupby(lambda x: x.year).transform( + lambda x: (x - x.mean()) / x.std() + ) + + +</pre> +</div> +<p>We would expect the result to now have mean 0 and standard deviation 1 within +each group, which we can easily check:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 955)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + # Original Data + grouped = ts.groupby(lambda x: x.year) + grouped.mean() + grouped.std() + + # Transformed Data + grouped_trans = transformed.groupby(lambda x: x.year) + grouped_trans.mean() + grouped_trans.std() + +</pre> +</div> +<p>We can also visually compare the original and transformed data sets.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 969)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + compare = pd.DataFrame({&quot;Original&quot;: ts, &quot;Transformed&quot;: transformed}) + + &#64;savefig groupby_transform_plot.png + compare.plot() + +</pre> +</div> +<p>Transformation functions that have lower dimension outputs are broadcast to +match the shape of the input array.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 979)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + ts.groupby(lambda x: x.year).transform(lambda x: x.max() - x.min()) + +</pre> +</div> +<p>Another common data transform is to replace missing data with the group mean.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 985)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + cols = [&quot;A&quot;, &quot;B&quot;, &quot;C&quot;] + values = np.random.randn(1000, 3) + values[np.random.randint(0, 1000, 100), 0] = np.nan + values[np.random.randint(0, 1000, 50), 1] = np.nan + values[np.random.randint(0, 1000, 200), 2] = np.nan + data_df = pd.DataFrame(values, columns=cols) + data_df + + countries = np.array([&quot;US&quot;, &quot;UK&quot;, &quot;GR&quot;, &quot;JP&quot;]) + key = countries[np.random.randint(0, 4, 1000)] + + grouped = data_df.groupby(key) + + # Non-NA count in each group + grouped.count() + + transformed = grouped.transform(lambda x: x.fillna(x.mean())) + +</pre> +</div> +<p>We can verify that the group means have not changed in the transformed data, +and that the transformed data contains no NAs.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1008)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped_trans = transformed.groupby(key) + + grouped.mean() # original group means + grouped_trans.mean() # transformation did not change group means + + grouped.count() # original has some missing data points + grouped_trans.count() # counts after transformation + grouped_trans.size() # Verify non-NA count equals group size + +</pre> +</div> +<p id="groupby-efficient-transforms">As mentioned in the note above, each of the examples in this section can be computed +more efficiently using built-in methods. In the code below, the inefficient way +using a UDF is commented out and the faster alternative appears below.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1025)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + # ts.groupby(lambda x: x.year).transform( + # lambda x: (x - x.mean()) / x.std() + # ) + grouped = ts.groupby(lambda x: x.year) + result = (ts - grouped.transform(&quot;mean&quot;)) / grouped.transform(&quot;std&quot;) + + # ts.groupby(lambda x: x.year).transform(lambda x: x.max() - x.min()) + grouped = ts.groupby(lambda x: x.year) + result = grouped.transform(&quot;max&quot;) - grouped.transform(&quot;min&quot;) + + # grouped = data_df.groupby(key) + # grouped.transform(lambda x: x.fillna(x.mean())) + grouped = data_df.groupby(key) + result = data_df.fillna(grouped.transform(&quot;mean&quot;)) + +</pre> +</div> +</div> +<div class="section" id="window-and-resample-operations"> +<span id="groupby-transform-window-resample"></span><h3>Window and resample operations</h3> +<p>It is possible to use <tt class="docutils literal">resample()</tt>, <tt class="docutils literal">expanding()</tt> and +<tt class="docutils literal">rolling()</tt> as methods on groupbys.</p> +<p>The example below will apply the <tt class="docutils literal">rolling()</tt> method on the samples of +the column B, based on the groups of column A.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1053)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df_re = pd.DataFrame({&quot;A&quot;: [1] * 10 + [5] * 10, &quot;B&quot;: np.arange(20)}) + df_re + + df_re.groupby(&quot;A&quot;).rolling(4).B.mean() + + +</pre> +</div> +<p>The <tt class="docutils literal">expanding()</tt> method will accumulate a given operation +(<tt class="docutils literal">sum()</tt> in the example) for all the members of each particular +group.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1065)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df_re.groupby(&quot;A&quot;).expanding().sum() + + +</pre> +</div> +<p>Suppose you want to use the <tt class="docutils literal">resample()</tt> method to get a daily +frequency in each group of your dataframe, and wish to complete the +missing values with the <tt class="docutils literal">ffill()</tt> method.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1074)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df_re = pd.DataFrame( + { + &quot;date&quot;: pd.date_range(start=&quot;2016-01-01&quot;, periods=4, freq=&quot;W&quot;), + &quot;group&quot;: [1, 1, 2, 2], + &quot;val&quot;: [5, 6, 7, 8], + } + ).set_index(&quot;date&quot;) + df_re + + df_re.groupby(&quot;group&quot;).resample(&quot;1D&quot;).ffill() + +</pre> +</div> +</div> +</div> +<div class="section" id="filtration"> +<span id="groupby-filter"></span><h2>Filtration</h2> +<p>A filtration is a GroupBy operation the subsets the original grouping object. It +may either filter out entire groups, part of groups, or both. Filtrations return +a filtered version of the calling object, including the grouping columns when provided. +In the following example, <tt class="docutils literal">class</tt> is included in the result.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1097)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + speeds + speeds.groupby(&quot;class&quot;).nth(1) + +</pre> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Unlike aggregations, filtrations do not add the group keys to the index of the +result. Because of this, passing <tt class="docutils literal">as_index=False</tt> or <tt class="docutils literal">sort=True</tt> will not +affect these methods.</p> +</div> +<p>Filtrations will respect subsetting the columns of the GroupBy object.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1110)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + speeds.groupby(&quot;class&quot;)[[&quot;order&quot;, &quot;max_speed&quot;]].nth(1) + +</pre> +</div> +<div class="section" id="built-in-filtrations"> +<h3>Built-in filtrations</h3> +<p>The following methods on GroupBy act as filtrations. All these methods have a +Cython-optimized implementation.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="80%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Method</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><p class="first"><a href="#system-message-69"><span class="problematic" id="problematic-69">:meth:`~.DataFrameGroupBy.head`</span></a></p> +<div class="last system-message" id="system-message-69"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1125); <em><a href="#problematic-69">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Select the top row(s) of each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-70"><span class="problematic" id="problematic-70">:meth:`~.DataFrameGroupBy.nth`</span></a></p> +<div class="last system-message" id="system-message-70"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1125); <em><a href="#problematic-70">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Select the nth row(s) of each group</td> +</tr> +<tr><td><p class="first"><a href="#system-message-71"><span class="problematic" id="problematic-71">:meth:`~.DataFrameGroupBy.tail`</span></a></p> +<div class="last system-message" id="system-message-71"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1125); <em><a href="#problematic-71">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +</td> +<td>Select the bottom row(s) of each group</td> +</tr> +</tbody> +</table> +<p>Users can also use transformations along with Boolean indexing to construct complex +filtrations within groups. For example, suppose we are given groups of products and +their volumes, and we wish to subset the data to only the largest products capturing no +more than 90% of the total volume within each group.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1134)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + product_volumes = pd.DataFrame( + { + &quot;group&quot;: list(&quot;xxxxyyy&quot;), + &quot;product&quot;: list(&quot;abcdefg&quot;), + &quot;volume&quot;: [10, 30, 20, 15, 40, 10, 20], + } + ) + product_volumes + + # Sort by volume to select the largest products first + product_volumes = product_volumes.sort_values(&quot;volume&quot;, ascending=False) + grouped = product_volumes.groupby(&quot;group&quot;)[&quot;volume&quot;] + cumpct = grouped.cumsum() / grouped.transform(&quot;sum&quot;) + cumpct + significant_products = product_volumes[cumpct &lt;= 0.9] + significant_products.sort_values([&quot;group&quot;, &quot;product&quot;]) + +</pre> +</div> +</div> +<div class="section" id="the-class-dataframegroupby-filter-method"> +<h3>The <a href="#system-message-72"><span class="problematic" id="problematic-72">:class:`~DataFrameGroupBy.filter`</span></a> method</h3> +<div class="system-message" id="system-message-72"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1153); <em><a href="#problematic-72">backlink</a></em></p> +Unknown interpreted text role &quot;class&quot;.</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Filtering by supplying <tt class="docutils literal">filter</tt> with a User-Defined Function (UDF) is +often less performant than using the built-in methods on GroupBy. +Consider breaking up a complex operation into a chain of operations that utilize +the built-in methods.</p> +</div> +<p>The <tt class="docutils literal">filter</tt> method takes a User-Defined Function (UDF) that, when applied to +an entire group, returns either <tt class="docutils literal">True</tt> or <tt class="docutils literal">False</tt>. The result of the <tt class="docutils literal">filter</tt> +method is then the subset of groups for which the UDF returned <tt class="docutils literal">True</tt>.</p> +<p>Suppose we want to take only elements that belong to groups with a group sum greater +than 2.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1170)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + sf = pd.Series([1, 1, 2, 3, 3, 3]) + sf.groupby(sf).filter(lambda x: x.sum() &gt; 2) + +</pre> +</div> +<p>Another useful operation is filtering out elements that belong to groups +with only a couple members.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1178)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + dff = pd.DataFrame({&quot;A&quot;: np.arange(8), &quot;B&quot;: list(&quot;aabbbbcc&quot;)}) + dff.groupby(&quot;B&quot;).filter(lambda x: len(x) &gt; 2) + +</pre> +</div> +<p>Alternatively, instead of dropping the offending groups, we can return a +like-indexed objects where the groups that do not pass the filter are filled +with NaNs.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1187)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + dff.groupby(&quot;B&quot;).filter(lambda x: len(x) &gt; 2, dropna=False) + +</pre> +</div> +<p>For DataFrames with multiple columns, filters should explicitly specify a column as the filter criterion.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1193)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + dff[&quot;C&quot;] = np.arange(8) + dff.groupby(&quot;B&quot;).filter(lambda x: len(x[&quot;C&quot;]) &gt; 2) + +</pre> +</div> +</div> +</div> +<div class="section" id="flexible-apply"> +<span id="groupby-apply"></span><h2>Flexible <tt class="docutils literal">apply</tt></h2> +<p>Some operations on the grouped data might not fit into the aggregation, +transformation, or filtration categories. For these, you can use the <tt class="docutils literal">apply</tt> +function.</p> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last"><tt class="docutils literal">apply</tt> has to try to infer from the result whether it should act as a reducer, +transformer, <em>or</em> filter, depending on exactly what is passed to it. Thus the +grouped column(s) may be included in the output or not. While +it tries to intelligently guess how to behave, it can sometimes guess wrong.</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">All of the examples in this section can be more reliably, and more efficiently, +computed using other pandas functionality.</p> +</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1219)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df + grouped = df.groupby(&quot;A&quot;) + + # could also just call .describe() + grouped[&quot;C&quot;].apply(lambda x: x.describe()) + +</pre> +</div> +<p>The dimension of the returned result can also change:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1229)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + grouped = df.groupby('A')['C'] + + def f(group): + return pd.DataFrame({'original': group, + 'demeaned': group - group.mean()}) + + grouped.apply(f) + +</pre> +</div> +<p>Similar to <a href="#system-message-73"><span class="problematic" id="problematic-73">:ref:`groupby.aggregate.agg`</span></a>, the resulting dtype will reflect that of the +apply function. If the results from different groups have different dtypes, then +a common dtype will be determined in the same way as <tt class="docutils literal">DataFrame</tt> construction.</p> +<div class="system-message" id="system-message-73"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1239); <em><a href="#problematic-73">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="section" id="control-grouped-column-s-placement-with-group-keys"> +<h3>Control grouped column(s) placement with <tt class="docutils literal">group_keys</tt></h3> +<p>To control whether the grouped column(s) are included in the indices, you can use +the argument <tt class="docutils literal">group_keys</tt> which defaults to <tt class="docutils literal">True</tt>. Compare</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1249)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby(&quot;A&quot;, group_keys=True).apply(lambda x: x) + +</pre> +</div> +<p>with</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1255)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby(&quot;A&quot;, group_keys=False).apply(lambda x: x) + + +</pre> +</div> +</div> +</div> +<div class="section" id="numba-accelerated-routines"> +<h2>Numba Accelerated Routines</h2> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1263)</p> +<p>Unknown directive type &quot;versionadded&quot;.</p> +<pre class="literal-block"> +.. versionadded:: 1.1 + +</pre> +</div> +<p>If <a class="reference external" href="https://numba.pydata.org/">Numba</a> is installed as an optional dependency, the <tt class="docutils literal">transform</tt> and +<tt class="docutils literal">aggregate</tt> methods support <tt class="docutils literal"><span class="pre">engine='numba'</span></tt> and <tt class="docutils literal">engine_kwargs</tt> arguments. +See <a href="#system-message-74"><span class="problematic" id="problematic-74">:ref:`enhancing performance with Numba &lt;enhancingperf.numba&gt;`</span></a> for general usage of the arguments +and performance considerations.</p> +<div class="system-message" id="system-message-74"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1265); <em><a href="#problematic-74">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<p>The function signature must start with <tt class="docutils literal">values, index</tt> <strong>exactly</strong> as the data belonging to each group +will be passed into <tt class="docutils literal">values</tt>, and the group index will be passed into <tt class="docutils literal">index</tt>.</p> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last">When using <tt class="docutils literal"><span class="pre">engine='numba'</span></tt>, there will be no &quot;fall back&quot; behavior internally. The group +data and group index will be passed as NumPy arrays to the JITed user defined function, and no +alternative execution attempts will be tried.</p> +</div> +</div> +<div class="section" id="other-useful-features"> +<h2>Other useful features</h2> +<div class="section" id="exclusion-of-nuisance-columns"> +<h3>Exclusion of &quot;nuisance&quot; columns</h3> +<p>Again consider the example DataFrame we've been looking at:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1287)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df + +</pre> +</div> +<p>Suppose we wish to compute the standard deviation grouped by the <tt class="docutils literal">A</tt> +column. There is a slight problem, namely that we don't care about the data in +column <tt class="docutils literal">B</tt> because it is not numeric. We refer to these non-numeric columns as +&quot;nuisance&quot; columns. You can avoid nuisance columns by specifying <tt class="docutils literal">numeric_only=True</tt>:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1296)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby(&quot;A&quot;).std(numeric_only=True) + +</pre> +</div> +<p>Note that <tt class="docutils literal"><span class="pre">df.groupby('A').colname.std().</span></tt> is more efficient than +<tt class="docutils literal"><span class="pre">df.groupby('A').std().colname</span></tt>. So if the result of an aggregation function +is only needed over one column (here <tt class="docutils literal">colname</tt>), it may be filtered +<em>before</em> applying the aggregation function.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1305)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + from decimal import Decimal + + df_dec = pd.DataFrame( + { + &quot;id&quot;: [1, 2, 1, 2], + &quot;int_column&quot;: [1, 2, 3, 4], + &quot;dec_column&quot;: [ + Decimal(&quot;0.50&quot;), + Decimal(&quot;0.15&quot;), + Decimal(&quot;0.25&quot;), + Decimal(&quot;0.40&quot;), + ], + } + ) + + # Decimal columns can be sum'd explicitly by themselves... + df_dec.groupby([&quot;id&quot;])[[&quot;dec_column&quot;]].sum() + + # ...but cannot be combined with standard data types or they will be excluded + df_dec.groupby([&quot;id&quot;])[[&quot;int_column&quot;, &quot;dec_column&quot;]].sum() + + # Use .agg function to aggregate over standard and &quot;nuisance&quot; data types + # at the same time + df_dec.groupby([&quot;id&quot;]).agg({&quot;int_column&quot;: &quot;sum&quot;, &quot;dec_column&quot;: &quot;sum&quot;}) + +</pre> +</div> +</div> +<div class="section" id="handling-of-un-observed-categorical-values"> +<span id="groupby-observed"></span><h3>Handling of (un)observed Categorical values</h3> +<p>When using a <tt class="docutils literal">Categorical</tt> grouper (as a single grouper, or as part of multiple groupers), the <tt class="docutils literal">observed</tt> keyword +controls whether to return a cartesian product of all possible groupers values (<tt class="docutils literal">observed=False</tt>) or only those +that are observed groupers (<tt class="docutils literal">observed=True</tt>).</p> +<p>Show all values:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1343)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + pd.Series([1, 1, 1]).groupby( + pd.Categorical([&quot;a&quot;, &quot;a&quot;, &quot;a&quot;], categories=[&quot;a&quot;, &quot;b&quot;]), observed=False + ).count() + +</pre> +</div> +<p>Show only the observed values:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1351)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + pd.Series([1, 1, 1]).groupby( + pd.Categorical([&quot;a&quot;, &quot;a&quot;, &quot;a&quot;], categories=[&quot;a&quot;, &quot;b&quot;]), observed=True + ).count() + +</pre> +</div> +<p>The returned dtype of the grouped will <em>always</em> include <em>all</em> of the categories that were grouped.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1359)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + s = ( + pd.Series([1, 1, 1]) + .groupby(pd.Categorical([&quot;a&quot;, &quot;a&quot;, &quot;a&quot;], categories=[&quot;a&quot;, &quot;b&quot;]), observed=False) + .count() + ) + s.index.dtype + +</pre> +</div> +</div> +<div class="section" id="na-and-nat-group-handling"> +<span id="groupby-missing"></span><h3>NA and NaT group handling</h3> +<p>If there are any NaN or NaT values in the grouping key, these will be +automatically excluded. In other words, there will never be an &quot;NA group&quot; or +&quot;NaT group&quot;. This was not the case in older versions of pandas, but users were +generally discarding the NA group anyway (and supporting it was an +implementation headache).</p> +</div> +<div class="section" id="grouping-with-ordered-factors"> +<h3>Grouping with ordered factors</h3> +<p>Categorical variables represented as instances of pandas's <tt class="docutils literal">Categorical</tt> class +can be used as group keys. If so, the order of the levels will be preserved:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1385)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + data = pd.Series(np.random.randn(100)) + + factor = pd.qcut(data, [0, 0.25, 0.5, 0.75, 1.0]) + + data.groupby(factor, observed=False).mean() + +</pre> +</div> +</div> +<div class="section" id="grouping-with-a-grouper-specification"> +<span id="groupby-specify"></span><h3>Grouping with a grouper specification</h3> +<p>You may need to specify a bit more data to properly group. You can +use the <tt class="docutils literal">pd.Grouper</tt> to provide this local control.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1401)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + import datetime + + df = pd.DataFrame( + { + &quot;Branch&quot;: &quot;A A A A A A A B&quot;.split(), + &quot;Buyer&quot;: &quot;Carl Mark Carl Carl Joe Joe Joe Carl&quot;.split(), + &quot;Quantity&quot;: [1, 3, 5, 1, 8, 1, 9, 3], + &quot;Date&quot;: [ + datetime.datetime(2013, 1, 1, 13, 0), + datetime.datetime(2013, 1, 1, 13, 5), + datetime.datetime(2013, 10, 1, 20, 0), + datetime.datetime(2013, 10, 2, 10, 0), + datetime.datetime(2013, 10, 1, 20, 0), + datetime.datetime(2013, 10, 2, 10, 0), + datetime.datetime(2013, 12, 2, 12, 0), + datetime.datetime(2013, 12, 2, 14, 0), + ], + } + ) + + df + +</pre> +</div> +<p>Groupby a specific column with the desired frequency. This is like resampling.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1427)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby([pd.Grouper(freq=&quot;1M&quot;, key=&quot;Date&quot;), &quot;Buyer&quot;])[[&quot;Quantity&quot;]].sum() + +</pre> +</div> +<p>When <tt class="docutils literal">freq</tt> is specified, the object returned by <tt class="docutils literal">pd.Grouper</tt> will be an +instance of <tt class="docutils literal">pandas.api.typing.TimeGrouper</tt>. You have an ambiguous specification +in that you have a named index and a column that could be potential groupers.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1435)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = df.set_index(&quot;Date&quot;) + df[&quot;Date&quot;] = df.index + pd.offsets.MonthEnd(2) + df.groupby([pd.Grouper(freq=&quot;6M&quot;, key=&quot;Date&quot;), &quot;Buyer&quot;])[[&quot;Quantity&quot;]].sum() + + df.groupby([pd.Grouper(freq=&quot;6M&quot;, level=&quot;Date&quot;), &quot;Buyer&quot;])[[&quot;Quantity&quot;]].sum() + + +</pre> +</div> +</div> +<div class="section" id="taking-the-first-rows-of-each-group"> +<h3>Taking the first rows of each group</h3> +<p>Just like for a DataFrame or Series you can call head and tail on a groupby:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1449)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = pd.DataFrame([[1, 2], [1, 4], [5, 6]], columns=[&quot;A&quot;, &quot;B&quot;]) + df + + g = df.groupby(&quot;A&quot;) + g.head(1) + + g.tail(1) + +</pre> +</div> +<p>This shows the first or last n rows from each group.</p> +</div> +<div class="section" id="taking-the-nth-row-of-each-group"> +<span id="groupby-nth"></span><h3>Taking the nth row of each group</h3> +<p>To select the nth item from each group, use <a href="#system-message-75"><span class="problematic" id="problematic-75">:meth:`.DataFrameGroupBy.nth`</span></a> or +<a href="#system-message-76"><span class="problematic" id="problematic-76">:meth:`.SeriesGroupBy.nth`</span></a>. Arguments supplied can be any integer, lists of integers, +slices, or lists of slices; see below for examples. When the nth element of a group +does not exist an error is <em>not</em> raised; instead no corresponding rows are returned.</p> +<div class="system-message" id="system-message-75"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1466); <em><a href="#problematic-75">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message" id="system-message-76"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1466); <em><a href="#problematic-76">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<p>In general this operation acts as a filtration. In certain cases it will also return +one row per group, making it also a reduction. However because in general it can +return zero or multiple rows per group, pandas treats it as a filtration in all cases.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1475)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = pd.DataFrame([[1, np.nan], [1, 4], [5, 6]], columns=[&quot;A&quot;, &quot;B&quot;]) + g = df.groupby(&quot;A&quot;) + + g.nth(0) + g.nth(-1) + g.nth(1) + +</pre> +</div> +<p>If the nth element of a group does not exist, then no corresponding row is included +in the result. In particular, if the specified <tt class="docutils literal">n</tt> is larger than any group, the +result will be an empty DataFrame.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1488)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + g.nth(5) + +</pre> +</div> +<p>If you want to select the nth not-null item, use the <tt class="docutils literal">dropna</tt> kwarg. For a DataFrame this should be either <tt class="docutils literal">'any'</tt> or <tt class="docutils literal">'all'</tt> just like you would pass to dropna:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1494)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + # nth(0) is the same as g.first() + g.nth(0, dropna=&quot;any&quot;) + g.first() + + # nth(-1) is the same as g.last() + g.nth(-1, dropna=&quot;any&quot;) + g.last() + + g.B.nth(0, dropna=&quot;all&quot;) + +</pre> +</div> +<p>You can also select multiple rows from each group by specifying multiple nth values as a list of ints.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1508)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + business_dates = pd.date_range(start=&quot;4/1/2014&quot;, end=&quot;6/30/2014&quot;, freq=&quot;B&quot;) + df = pd.DataFrame(1, index=business_dates, columns=[&quot;a&quot;, &quot;b&quot;]) + # get the first, 4th, and last date index for each month + df.groupby([df.index.year, df.index.month]).nth([0, 3, -1]) + +</pre> +</div> +<p>You may also use slices or lists of slices.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1517)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df.groupby([df.index.year, df.index.month]).nth[1:] + df.groupby([df.index.year, df.index.month]).nth[1:, :-1] + +</pre> +</div> +</div> +<div class="section" id="enumerate-group-items"> +<h3>Enumerate group items</h3> +<p>To see the order in which each row appears within its group, use the +<tt class="docutils literal">cumcount</tt> method:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1528)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + dfg = pd.DataFrame(list(&quot;aaabba&quot;), columns=[&quot;A&quot;]) + dfg + + dfg.groupby(&quot;A&quot;).cumcount() + + dfg.groupby(&quot;A&quot;).cumcount(ascending=False) + +</pre> +</div> +</div> +<div class="section" id="enumerate-groups"> +<span id="groupby-ngroup"></span><h3>Enumerate groups</h3> +<p>To see the ordering of the groups (as opposed to the order of rows +within a group given by <tt class="docutils literal">cumcount</tt>) you can use +<a href="#system-message-77"><span class="problematic" id="problematic-77">:meth:`~pandas.core.groupby.DataFrameGroupBy.ngroup`</span></a>.</p> +<div class="system-message" id="system-message-77"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1542); <em><a href="#problematic-77">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<p>Note that the numbers given to the groups match the order in which the +groups would be seen when iterating over the groupby object, not the +order they are first observed.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1552)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + dfg = pd.DataFrame(list(&quot;aaabba&quot;), columns=[&quot;A&quot;]) + dfg + + dfg.groupby(&quot;A&quot;).ngroup() + + dfg.groupby(&quot;A&quot;).ngroup(ascending=False) + +</pre> +</div> +</div> +<div class="section" id="plotting"> +<h3>Plotting</h3> +<p>Groupby also works with some plotting methods. In this case, suppose we +suspect that the values in column 1 are 3 times higher on average in group &quot;B&quot;.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1568)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + np.random.seed(1234) + df = pd.DataFrame(np.random.randn(50, 2)) + df[&quot;g&quot;] = np.random.choice([&quot;A&quot;, &quot;B&quot;], size=50) + df.loc[df[&quot;g&quot;] == &quot;B&quot;, 1] += 3 + +</pre> +</div> +<p>We can easily visualize this with a boxplot:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1577)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + :okwarning: + + &#64;savefig groupby_boxplot.png + df.groupby(&quot;g&quot;).boxplot() + +</pre> +</div> +<p>The result of calling <tt class="docutils literal">boxplot</tt> is a dictionary whose keys are the values +of our grouping column <tt class="docutils literal">g</tt> (&quot;A&quot; and &quot;B&quot;). The values of the resulting dictionary +can be controlled by the <tt class="docutils literal">return_type</tt> keyword of <tt class="docutils literal">boxplot</tt>. +See the <a href="#system-message-78"><span class="problematic" id="problematic-78">:ref:`visualization documentation&lt;visualization.box&gt;`</span></a> for more.</p> +<div class="system-message" id="system-message-78"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1583); <em><a href="#problematic-78">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p>For historical reasons, <tt class="docutils literal"><span class="pre">df.groupby(&quot;g&quot;).boxplot()</span></tt> is not equivalent +to <tt class="docutils literal"><span class="pre">df.boxplot(by=&quot;g&quot;)</span></tt>. See <a href="#system-message-79"><span class="problematic" id="problematic-79">:ref:`here&lt;visualization.box.return&gt;`</span></a> for +an explanation.</p> +<div class="last system-message" id="system-message-79"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1590); <em><a href="#problematic-79">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +</div> +</div> +<div class="section" id="piping-function-calls"> +<span id="groupby-pipe"></span><h3>Piping function calls</h3> +<p>Similar to the functionality provided by <tt class="docutils literal">DataFrame</tt> and <tt class="docutils literal">Series</tt>, functions +that take <tt class="docutils literal">GroupBy</tt> objects can be chained together using a <tt class="docutils literal">pipe</tt> method to +allow for a cleaner, more readable syntax. To read about <tt class="docutils literal">.pipe</tt> in general terms, +see <a href="#system-message-80"><span class="problematic" id="problematic-80">:ref:`here &lt;basics.pipe&gt;`</span></a>.</p> +<div class="system-message" id="system-message-80"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1599); <em><a href="#problematic-80">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<p>Combining <tt class="docutils literal">.groupby</tt> and <tt class="docutils literal">.pipe</tt> is often useful when you need to reuse +GroupBy objects.</p> +<p>As an example, imagine having a DataFrame with columns for stores, products, +revenue and quantity sold. We'd like to do a groupwise calculation of <em>prices</em> +(i.e. revenue/quantity) per store and per product. We could do this in a +multi-step operation, but expressing it in terms of piping can make the +code more readable. First we set the data:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1613)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + n = 1000 + df = pd.DataFrame( + { + &quot;Store&quot;: np.random.choice([&quot;Store_1&quot;, &quot;Store_2&quot;], n), + &quot;Product&quot;: np.random.choice([&quot;Product_1&quot;, &quot;Product_2&quot;], n), + &quot;Revenue&quot;: (np.random.random(n) * 50 + 10).round(2), + &quot;Quantity&quot;: np.random.randint(1, 10, size=n), + } + ) + df.head(2) + +</pre> +</div> +<p>Now, to find prices per store/product, we can simply do:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1628)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + ( + df.groupby([&quot;Store&quot;, &quot;Product&quot;]) + .pipe(lambda grp: grp.Revenue.sum() / grp.Quantity.sum()) + .unstack() + .round(2) + ) + +</pre> +</div> +<p>Piping can also be expressive when you want to deliver a grouped object to some +arbitrary function, for example:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1640)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + def mean(groupby): + return groupby.mean() + + + df.groupby([&quot;Store&quot;, &quot;Product&quot;]).pipe(mean) + +</pre> +</div> +<p>Here <tt class="docutils literal">mean</tt> takes a GroupBy object and finds the mean of the Revenue and Quantity +columns respectively for each Store-Product combination. The <tt class="docutils literal">mean</tt> function can +be any function that takes in a GroupBy object; the <tt class="docutils literal">.pipe</tt> will pass the GroupBy +object as a parameter into the function you specify.</p> +</div> +</div> +<div class="section" id="examples"> +<h2>Examples</h2> +<div class="section" id="regrouping-by-factor"> +<h3>Regrouping by factor</h3> +<p>Regroup columns of a DataFrame according to their sum, and sum the aggregated ones.</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1661)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = pd.DataFrame({&quot;a&quot;: [1, 0, 0], &quot;b&quot;: [0, 1, 0], &quot;c&quot;: [1, 0, 0], &quot;d&quot;: [2, 3, 4]}) + df + dft = df.T + dft.groupby(dft.sum()).sum() + +</pre> +</div> +</div> +<div class="section" id="multi-column-factorization"> +<span id="groupby-multicolumn-factorization"></span><h3>Multi-column factorization</h3> +<p>By using <a href="#system-message-81"><span class="problematic" id="problematic-81">:meth:`~pandas.core.groupby.DataFrameGroupBy.ngroup`</span></a>, we can extract +information about the groups in a way similar to <a href="#system-message-82"><span class="problematic" id="problematic-82">:func:`factorize`</span></a> (as described +further in the <a href="#system-message-83"><span class="problematic" id="problematic-83">:ref:`reshaping API &lt;reshaping.factorize&gt;`</span></a>) but which applies +naturally to multiple columns of mixed type and different +sources. This can be useful as an intermediate categorical-like step +in processing, when the relationships between the group rows are more +important than their content, or as input to an algorithm which only +accepts the integer encoding. (For more information about support in +pandas for full categorical data, see the <a href="#system-message-84"><span class="problematic" id="problematic-84">:ref:`Categorical +introduction &lt;categorical&gt;`</span></a> and the +<a href="#system-message-85"><span class="problematic" id="problematic-85">:ref:`API documentation &lt;api.arrays.categorical&gt;`</span></a>.)</p> +<div class="system-message" id="system-message-81"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1673); <em><a href="#problematic-81">backlink</a></em></p> +Unknown interpreted text role &quot;meth&quot;.</div> +<div class="system-message" id="system-message-82"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1673); <em><a href="#problematic-82">backlink</a></em></p> +Unknown interpreted text role &quot;func&quot;.</div> +<div class="system-message" id="system-message-83"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1673); <em><a href="#problematic-83">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="system-message" id="system-message-84"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1673); <em><a href="#problematic-84">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="system-message" id="system-message-85"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1673); <em><a href="#problematic-85">backlink</a></em></p> +Unknown interpreted text role &quot;ref&quot;.</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1685)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + dfg = pd.DataFrame({&quot;A&quot;: [1, 1, 2, 3, 2], &quot;B&quot;: list(&quot;aaaba&quot;)}) + + dfg + + dfg.groupby([&quot;A&quot;, &quot;B&quot;]).ngroup() + + dfg.groupby([&quot;A&quot;, [0, 0, 0, 1, 1]]).ngroup() + +</pre> +</div> +</div> +<div class="section" id="groupby-by-indexer-to-resample-data"> +<h3>Groupby by indexer to 'resample' data</h3> +<p>Resampling produces new hypothetical samples (resamples) from already existing observed data or from a model that generates data. These new samples are similar to the pre-existing samples.</p> +<p>In order for resample to work on indices that are non-datetimelike, the following procedure can be utilized.</p> +<p>In the following examples, <strong>df.index // 5</strong> returns a binary array which is used to determine what gets selected for the groupby operation.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The example below shows how we can downsample by consolidation of samples into fewer ones. +Here by using <strong>df.index // 5</strong>, we are aggregating the samples in bins. By applying <strong>std()</strong> +function, we aggregate the information contained in many samples into a small subset of values +which is their standard deviation thereby reducing the number of samples.</p> +</div> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1711)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = pd.DataFrame(np.random.randn(10, 2)) + df + df.index // 5 + df.groupby(df.index // 5).std() + +</pre> +</div> +</div> +<div class="section" id="returning-a-series-to-propagate-names"> +<h3>Returning a Series to propagate names</h3> +<p>Group DataFrame columns, compute a set of metrics and return a named Series. +The Series name is used as the name for the column index. This is especially +useful in conjunction with reshaping operations such as stacking, in which the +column index name will be used as the name of the inserted column:</p> +<div class="system-message"> +<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/immanuellaumoren/Two-Sigma/pandas/doc/source/user_guide/groupby.rst</tt>, line 1726)</p> +<p>Unknown directive type &quot;ipython&quot;.</p> +<pre class="literal-block"> +.. ipython:: python + + df = pd.DataFrame( + { + &quot;a&quot;: [0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2], + &quot;b&quot;: [0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 1, 1], + &quot;c&quot;: [1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0], + &quot;d&quot;: [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1], + } + ) + + def compute_metrics(x): + result = {&quot;b_sum&quot;: x[&quot;b&quot;].sum(), &quot;c_mean&quot;: x[&quot;c&quot;].mean()} + return pd.Series(result, name=&quot;metrics&quot;) + + result = df.groupby(&quot;a&quot;).apply(compute_metrics) + + result + + result.stack() +</pre> +</div> +</div> +</div> +</div> +</div> +</body> +</html> diff --git a/doc/source/user_guide/groupby.rst b/doc/source/user_guide/groupby.rst index 482e3fe91ca09..64331d84ce325 100644 --- a/doc/source/user_guide/groupby.rst +++ b/doc/source/user_guide/groupby.rst @@ -722,16 +722,45 @@ accepts the special syntax in :meth:`.DataFrameGroupBy.agg` and :meth:`.SeriesGr to make it clearer what the arguments are. As usual, the aggregation can be a callable or a string alias. +Example: +------- + +Consider the following DataFrame `animals`: + .. ipython:: python - animals + import pandas as pd - animals.groupby("kind").agg( - min_height=pd.NamedAgg(column="height", aggfunc="min"), - max_height=pd.NamedAgg(column="height", aggfunc="max"), - average_weight=pd.NamedAgg(column="weight", aggfunc="mean"), - ) + animals = pd.DataFrame({ + 'kind': ['cat', 'dog', 'cat', 'dog'], + 'height': [9.1, 6.0, 9.5, 34.0], + 'weight': [7.9, 7.5, 9.9, 198.0] + }) + +To demonstrate "named aggregation," let's group the DataFrame by the 'kind' column and apply different aggregations to the 'height' and 'weight' columns: + +.. ipython:: python + + result = animals.groupby('kind').agg( + min_height=pd.NamedAgg(column='height', aggfunc='min'), + max_height=pd.NamedAgg(column='height', aggfunc='max'), + average_weight=pd.NamedAgg(column='weight', aggfunc='mean') + ) + +In the above example, we used "named aggregation" to specify custom output column names (`min_height`, `max_height`, and `average_weight`) for each aggregation. The result will be a new DataFrame with the aggregated values, and the output column names will be as specified. + +The resulting DataFrame will look like this: + +.. code-block:: bash + + min_height max_height average_weight + kind + cat 9.1 9.5 8.90 + dog 6.0 34.0 102.75 +In this example, the 'min_height' column contains the minimum height for each group, the 'max_height' column contains the maximum height, and the 'average_weight' column contains the average weight for each group. + +By using "named aggregation," you can easily control the output column names and have more descriptive results when performing aggregations with `groupby.agg`. :class:`NamedAgg` is just a ``namedtuple``. Plain tuples are allowed as well. @@ -770,6 +799,76 @@ no column selection, so the values are just the functions. max_height="max", ) +Passing a List of Tuples +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Instead of a dictionary, you can also pass a list of tuples to the `agg` method to achieve similar results. Each tuple contains the output column name as the first element and the aggregation function as the second element. This approach is particularly useful for applying multiple aggregations on the same column. + +Example: +-------- + +Consider the following DataFrame `df`: + +.. ipython:: python + + import pandas as pd + import numpy as np + + df = pd.DataFrame({'key': ['a', 'a', 'b', 'b', 'a'], + 'data': np.random.randn(5)}) + +Suppose we want to group the DataFrame by the 'key' column and apply different aggregations to the 'data' column: + +.. ipython:: python + + result = df.groupby('key')['data'].agg([('foo', 'mean')]) + +In this example, the output column 'foo' contains the mean value of the 'data' column for each group. + +To apply multiple aggregations to the same column, you can pass a list of tuples: + +.. ipython:: python + + result = df.groupby('key')['data'].agg([('col1', 'mean'), ('col2', 'std')]) + +In this case, the resulting DataFrame will have two columns: 'col1' containing the mean and 'col2' containing the standard deviation of the 'data' column for each group. + +Similarly, you can extend this approach to include more aggregations: + +.. ipython:: python + + result = df.groupby('key')['data'].agg([('col1', 'mean'), ('col2', 'std'), ('col3', 'min')]) + +Here, the resulting DataFrame will have three columns: 'col1', 'col2', and 'col3', each containing the respective aggregation result for the 'data' column. + +In addition to the examples above, let's consider a scenario where we want to calculate both the mean and the median of the 'data' column for each group: + +.. ipython:: python + + result = df.groupby('key')['data'].agg([('mean_value', 'mean'), ('median_value', 'median')]) + +The resulting DataFrame will have two columns: 'mean_value' and 'median_value', each containing the corresponding aggregation results. + +Using a list of tuples provides a concise way to apply multiple aggregations to the same column while controlling the output column names. This approach is especially handy when you need to calculate various statistics on the same data within each group. + +For a copy-pastable example, consider the following DataFrame `df`: + +.. ipython:: python + + import pandas as pd + import numpy as np + + df = pd.DataFrame({'key': ['a', 'a', 'b', 'b', 'a'], + 'data': np.random.randn(5)}) + +You can then use the `agg` function with a list of tuples for aggregations: + +.. ipython:: python + + result = df.groupby('key')['data'].agg([('foo', 'mean')]) + +This will create a DataFrame with the mean values for each group under the 'foo' column. + Applying different functions to DataFrame columns ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 80b4bcc583fdb..36cbb8c796607 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -19,6 +19,7 @@ import warnings import numpy as np +import pandas as pd from pandas._config import ( get_option, @@ -3795,6 +3796,13 @@ def get_loc(self, key): ): raise InvalidIndexError(key) raise KeyError(key) from err + + except KeyError: + if not self.index.is_monotonic_increasing: + # Handle non-sorted index case + warnings.warn("The index is not sorted. Slicing may not behave as expected.") + return pd.DataFrame() # Return an empty DataFrame + except TypeError: # If we have a listlike key, _check_indexing_error will raise # InvalidIndexError. Otherwise we fall through and re-raise diff --git a/pandas/etc/profile.d/micromamba.sh b/pandas/etc/profile.d/micromamba.sh new file mode 100644 index 0000000000000..c0b515215e338 --- /dev/null +++ b/pandas/etc/profile.d/micromamba.sh @@ -0,0 +1,66 @@ +# Copyright (C) 2012 Anaconda, Inc +# SPDX-License-Identifier: BSD-3-Clause + +__mamba_exe() ( + "$MAMBA_EXE" "${@}" +) + +__mamba_hashr() { + if [ -n "${ZSH_VERSION:+x}" ]; then + \rehash + elif [ -n "${POSH_VERSION:+x}" ]; then + : # pass + else + \hash -r + fi +} + +__mamba_xctivate() { + \local ask_conda + ask_conda="$(PS1="${PS1:-}" __mamba_exe shell "${@}" --shell bash)" || \return + \eval "${ask_conda}" + __mamba_hashr +} + +micromamba() { + \local cmd="${1-__missing__}" + case "${cmd}" in + activate|reactivate|deactivate) + __mamba_xctivate "${@}" + ;; + install|update|upgrade|remove|uninstall) + __mamba_exe "${@}" || \return + __mamba_xctivate reactivate + ;; + self-update) + __mamba_exe "${@}" || \return + + # remove leftover backup file on Windows + if [ -f "$MAMBA_EXE.bkup" ]; then + rm -f "$MAMBA_EXE.bkup" + fi + ;; + *) + __mamba_exe "${@}" + ;; + esac +} + +if [ -z "${CONDA_SHLVL+x}" ]; then + \export CONDA_SHLVL=0 + # In dev-mode MAMBA_EXE is python.exe and on Windows + # it is in a different relative location to condabin. + if [ -n "${_CE_CONDA+x}" ] && [ -n "${WINDIR+x}" ]; then + PATH="${MAMBA_ROOT_PREFIX}/condabin:${PATH}" + else + PATH="${MAMBA_ROOT_PREFIX}/condabin:${PATH}" + fi + \export PATH + + # We're not allowing PS1 to be unbound. It must at least be set. + # However, we're not exporting it, which can cause problems when starting a second shell + # via a first shell (i.e. starting zsh from bash). + if [ -z "${PS1+x}" ]; then + PS1= + fi +fi
- [ ] closes #50557 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54744
2023-08-25T00:38:13Z
2023-09-18T17:09:00Z
null
2023-09-18T17:09:01Z
CLN: Update LICENCES and reference where used
diff --git a/LICENSES/BOTTLENECK_LICENCE b/LICENSES/BOTTLENECK_LICENCE new file mode 100644 index 0000000000000..f4bdbb1647ee6 --- /dev/null +++ b/LICENSES/BOTTLENECK_LICENCE @@ -0,0 +1,25 @@ +Copyright (c) 2010-2019 Keith Goodman +Copyright (c) 2019 Bottleneck Developers +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/LICENSES/DATEUTIL_LICENSE b/LICENSES/DATEUTIL_LICENSE index 6053d35cfc60b..1e65815cf0b31 100644 --- a/LICENSES/DATEUTIL_LICENSE +++ b/LICENSES/DATEUTIL_LICENSE @@ -51,4 +51,4 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -The above BSD License Applies to all code, even that also covered by Apache 2.0. +The above BSD License Applies to all code, even that also covered by Apache 2.0. \ No newline at end of file diff --git a/LICENSES/KLIB_LICENSE b/LICENSES/KLIB_LICENSE index 0a996fae3360f..2de13e402643b 100644 --- a/LICENSES/KLIB_LICENSE +++ b/LICENSES/KLIB_LICENSE @@ -20,4 +20,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE. \ No newline at end of file diff --git a/LICENSES/MUSL_LICENSE b/LICENSES/MUSL_LICENSE index a8833d4bc4744..5ff71b5f5a7fe 100644 --- a/LICENSES/MUSL_LICENSE +++ b/LICENSES/MUSL_LICENSE @@ -1,7 +1,7 @@ musl as a whole is licensed under the following standard MIT license: ---------------------------------------------------------------------- -Copyright © 2005-2014 Rich Felker, et al. +Copyright © 2005-2020 Rich Felker, et al. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -25,37 +25,88 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Authors/contributors include: +A. Wilcox +Ada Worcester +Alex Dowad +Alex Suykov +Alexander Monakov +Andre McCurdy +Andrew Kelley Anthony G. Basile +Aric Belsito Arvid Picciani +Bartosz Brachaczek +Benjamin Peterson Bobby Bingham Boris Brezillon Brent Cook Chris Spiegel Clément Vasseur +Daniel Micay +Daniel Sabogal +Daurnimator +David Carlier +David Edelsohn +Denys Vlasenko +Dmitry Ivanov +Dmitry V. Levin +Drew DeVault Emil Renner Berthing +Fangrui Song +Felix Fietkau +Felix Janda +Gianluca Anzolin +Hauke Mehrtens +He X Hiltjo Posthuma Isaac Dunham +Jaydeep Patil Jens Gustedt Jeremy Huntwork +Jo-Philipp Wich +Joakim Sindholt John Spencer +Julien Ramseier Justin Cormack +Kaarle Ritvanen +Khem Raj +Kylie McClain +Leah Neukirchen Luca Barbato Luka Perkov M Farkas-Dyck (Strake) +Mahesh Bodapati +Markus Wichmann +Masanori Ogino +Michael Clark Michael Forney +Mikhail Kremnyov +Natanael Copa Nicholas J. Kain orc Pascal Cuoq +Patrick Oppenlander +Petr Hosek +Petr Skocik Pierre Carrier +Reini Urban Rich Felker Richard Pennington +Ryan Fairfax +Samuel Holland +Segev Finer +Shiz sin Solar Designer Stefan Kristiansson +Stefan O'Rear Szabolcs Nagy Timo Teräs +Trutz Behn Valentin Ochs +Will Dietz William Haddon +William Pitcock Portions of this software are derived from third-party works licensed under terms compatible with the above MIT license: @@ -71,18 +122,22 @@ Copyright © 1993,2004 Sun Microsystems or Copyright © 2003-2011 David Schultz or Copyright © 2003-2009 Steven G. Kargl or Copyright © 2003-2009 Bruce D. Evans or -Copyright © 2008 Stephen L. Moshier +Copyright © 2008 Stephen L. Moshier or +Copyright © 2017-2018 Arm Limited and labelled as such in comments in the individual source files. All have been licensed under extremely permissive terms. -The ARM memcpy code (src/string/armel/memcpy.s) is Copyright © 2008 +The ARM memcpy code (src/string/arm/memcpy.S) is Copyright © 2008 The Android Open Source Project and is licensed under a two-clause BSD license. It was taken from Bionic libc, used on Android. -The implementation of DES for crypt (src/misc/crypt_des.c) is +The AArch64 memcpy and memset code (src/string/aarch64/*) are +Copyright © 1999-2019, Arm Limited. + +The implementation of DES for crypt (src/crypt/crypt_des.c) is Copyright © 1994 David Burren. It is licensed under a BSD license. -The implementation of blowfish crypt (src/misc/crypt_blowfish.c) was +The implementation of blowfish crypt (src/crypt/crypt_blowfish.c) was originally written by Solar Designer and placed into the public domain. The code also comes with a fallback permissive license for use in jurisdictions that may not recognize the public domain. @@ -90,22 +145,17 @@ in jurisdictions that may not recognize the public domain. The smoothsort implementation (src/stdlib/qsort.c) is Copyright © 2011 Valentin Ochs and is licensed under an MIT-style license. -The BSD PRNG implementation (src/prng/random.c) and XSI search API -(src/search/*.c) functions are Copyright © 2011 Szabolcs Nagy and -licensed under following terms: "Permission to use, copy, modify, -and/or distribute this code for any purpose with or without fee is -hereby granted. There is no warranty." - -The x86_64 port was written by Nicholas J. Kain. Several files (crt) -were released into the public domain; others are licensed under the -standard MIT license terms at the top of this file. See individual -files for their copyright status. +The x86_64 port was written by Nicholas J. Kain and is licensed under +the standard MIT terms. The mips and microblaze ports were originally written by Richard Pennington for use in the ellcc project. The original code was adapted by Rich Felker for build system and code conventions during upstream integration. It is licensed under the standard MIT terms. +The mips64 port was contributed by Imagination Technologies and is +licensed under the standard MIT terms. + The powerpc port was also originally written by Richard Pennington, and later supplemented and integrated by John Spencer. It is licensed under the standard MIT terms. @@ -118,15 +168,26 @@ can be found in the git version control history of the project. The omission of copyright and license comments in each file is in the interest of source tree size. -All public header files (include/* and arch/*/bits/*) should be -treated as Public Domain as they intentionally contain no content -which can be covered by copyright. Some source modules may fall in -this category as well. If you believe that a file is so trivial that -it should be in the Public Domain, please contact the authors and -request an explicit statement releasing it from copyright. +In addition, permission is hereby granted for all public header files +(include/* and arch/*/bits/*) and crt files intended to be linked into +applications (crt/*, ldso/dlstart.c, and arch/*/crt_arch.h) to omit +the copyright notice and permission notice otherwise required by the +license, and to use these files without any requirement of +attribution. These files include substantial contributions from: + +Bobby Bingham +John Spencer +Nicholas J. Kain +Rich Felker +Richard Pennington +Stefan Kristiansson +Szabolcs Nagy -The following files are trivial, believed not to be copyrightable in -the first place, and hereby explicitly released to the Public Domain: +all of whom have explicitly granted such permission. -All public headers: include/*, arch/*/bits/* -Startup files: crt/* +This file previously contained text expressing a belief that most of +the files covered by the above exception were sufficiently trivial not +to be subject to copyright, resulting in confusion over whether it +negated the permissions granted in the license. In the spirit of +permissive licensing, and of not having licensing issues being an +obstacle to adoption, that text has been removed. \ No newline at end of file diff --git a/LICENSES/NUMPY_LICENSE b/LICENSES/NUMPY_LICENSE index 7e972cff80759..f2d647bf0bc48 100644 --- a/LICENSES/NUMPY_LICENSE +++ b/LICENSES/NUMPY_LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2005-2011, NumPy Developers. +Copyright (c) 2005-2023, NumPy Developers. All rights reserved. Redistribution and use in source and binary forms, with or without @@ -27,4 +27,4 @@ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/LICENSES/OTHER b/LICENSES/OTHER deleted file mode 100644 index e156152990cc4..0000000000000 --- a/LICENSES/OTHER +++ /dev/null @@ -1,57 +0,0 @@ -Bottleneck license ------------------- - -Copyright (c) 2010-2012 Archipel Asset Management AB. -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. - -Pyperclip v1.3 license ----------------------- - -Copyright (c) 2010, Albert Sweigart -All rights reserved. - -BSD-style license: - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - * Neither the name of the pyperclip nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY Albert Sweigart "AS IS" AND ANY -EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL Albert Sweigart BE LIABLE FOR ANY -DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/LICENSES/PACKAGING_LICENSE b/LICENSES/PACKAGING_LICENSE index 4216ea1ce2379..2bfcd5297c470 100644 --- a/LICENSES/PACKAGING_LICENSE +++ b/LICENSES/PACKAGING_LICENSE @@ -199,4 +199,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/LICENSES/PSF_LICENSE b/LICENSES/PSF_LICENSE index 5cdb01e8d24af..f26bcf4d2de6e 100644 --- a/LICENSES/PSF_LICENSE +++ b/LICENSES/PSF_LICENSE @@ -2,25 +2,24 @@ A. HISTORY OF THE SOFTWARE ========================== Python was created in the early 1990s by Guido van Rossum at Stichting -Mathematisch Centrum (CWI, see http://www.cwi.nl) in the Netherlands +Mathematisch Centrum (CWI, see https://www.cwi.nl) in the Netherlands as a successor of a language called ABC. Guido remains Python's principal author, although it includes many contributions from others. In 1995, Guido continued his work on Python at the Corporation for -National Research Initiatives (CNRI, see http://www.cnri.reston.va.us) +National Research Initiatives (CNRI, see https://www.cnri.reston.va.us) in Reston, Virginia where he released several versions of the software. In May 2000, Guido and the Python core development team moved to BeOpen.com to form the BeOpen PythonLabs team. In October of the same -year, the PythonLabs team moved to Digital Creations (now Zope -Corporation, see http://www.zope.com). In 2001, the Python Software -Foundation (PSF, see http://www.python.org/psf/) was formed, a -non-profit organization created specifically to own Python-related -Intellectual Property. Zope Corporation is a sponsoring member of -the PSF. - -All Python releases are Open Source (see http://www.opensource.org for +year, the PythonLabs team moved to Digital Creations, which became +Zope Corporation. In 2001, the Python Software Foundation (PSF, see +https://www.python.org/psf/) was formed, a non-profit organization +created specifically to own Python-related Intellectual Property. +Zope Corporation was a sponsoring member of the PSF. + +All Python releases are Open Source (see https://opensource.org for the Open Source Definition). Historically, most, but not all, Python releases have also been GPL-compatible; the table below summarizes the various releases. @@ -36,34 +35,9 @@ the various releases. 2.1 2.0+1.6.1 2001 PSF no 2.0.1 2.0+1.6.1 2001 PSF yes 2.1.1 2.1+2.0.1 2001 PSF yes - 2.2 2.1.1 2001 PSF yes 2.1.2 2.1.1 2002 PSF yes 2.1.3 2.1.2 2002 PSF yes - 2.2.1 2.2 2002 PSF yes - 2.2.2 2.2.1 2002 PSF yes - 2.2.3 2.2.2 2003 PSF yes - 2.3 2.2.2 2002-2003 PSF yes - 2.3.1 2.3 2002-2003 PSF yes - 2.3.2 2.3.1 2002-2003 PSF yes - 2.3.3 2.3.2 2002-2003 PSF yes - 2.3.4 2.3.3 2004 PSF yes - 2.3.5 2.3.4 2005 PSF yes - 2.4 2.3 2004 PSF yes - 2.4.1 2.4 2005 PSF yes - 2.4.2 2.4.1 2005 PSF yes - 2.4.3 2.4.2 2006 PSF yes - 2.4.4 2.4.3 2006 PSF yes - 2.5 2.4 2006 PSF yes - 2.5.1 2.5 2007 PSF yes - 2.5.2 2.5.1 2008 PSF yes - 2.5.3 2.5.2 2008 PSF yes - 2.6 2.5 2008 PSF yes - 2.6.1 2.6 2008 PSF yes - 2.6.2 2.6.1 2009 PSF yes - 2.6.3 2.6.2 2009 PSF yes - 2.6.4 2.6.3 2009 PSF yes - 2.6.5 2.6.4 2010 PSF yes - 2.7 2.6 2010 PSF yes + 2.2 and above 2.1.1 2001-now PSF yes Footnotes: @@ -85,6 +59,17 @@ direction to make these releases possible. B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON =============================================================== +Python software and documentation are licensed under the +Python Software Foundation License Version 2. + +Starting with Python 3.8.6, examples, recipes, and other code in +the documentation are dual licensed under the PSF License Version 2 +and the Zero-Clause BSD license. + +Some software incorporated into Python is under different licenses. +The licenses are listed with code falling under that license. + + PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 -------------------------------------------- @@ -98,9 +83,10 @@ grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce, analyze, test, perform and/or display publicly, prepare derivative works, distribute, and otherwise use Python alone or in any derivative version, provided, however, that PSF's License Agreement and PSF's notice of copyright, -i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 -Python Software Foundation; All Rights Reserved" are retained in Python alone or -in any derivative version prepared by Licensee. +i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, +2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Python Software Foundation; +All Rights Reserved" are retained in Python alone or in any derivative version +prepared by Licensee. 3. In the event Licensee prepares a derivative work that is based on or incorporates Python or any part thereof, and wants to make @@ -205,9 +191,9 @@ version prepared by Licensee. Alternately, in lieu of CNRI's License Agreement, Licensee may substitute the following text (omitting the quotes): "Python 1.6.1 is made available subject to the terms and conditions in CNRI's License Agreement. This Agreement together with -Python 1.6.1 may be located on the Internet using the following +Python 1.6.1 may be located on the internet using the following unique, persistent identifier (known as a handle): 1895.22/1013. This -Agreement may also be obtained from a proxy server on the Internet +Agreement may also be obtained from a proxy server on the internet using the following URL: http://hdl.handle.net/1895.22/1013". 3. In the event Licensee prepares a derivative work that is based on @@ -277,3 +263,17 @@ FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION +---------------------------------------------------------------------- + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. diff --git a/LICENSES/PYPERCLIP_LICENSE b/LICENSES/PYPERCLIP_LICENSE new file mode 100644 index 0000000000000..07cc746cd5ad6 --- /dev/null +++ b/LICENSES/PYPERCLIP_LICENSE @@ -0,0 +1,27 @@ +Copyright (c) 2014, Al Sweigart +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +* Neither the name of the {organization} nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/LICENSES/PYUPGRADE_LICENSE b/LICENSES/PYUPGRADE_LICENSE index 522fbe20b8991..edeac73dade04 100644 --- a/LICENSES/PYUPGRADE_LICENSE +++ b/LICENSES/PYUPGRADE_LICENSE @@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +THE SOFTWARE. \ No newline at end of file diff --git a/LICENSES/SAS7BDAT_LICENSE b/LICENSES/SAS7BDAT_LICENSE index 8fbf194013e93..94b7fe934e85c 100644 --- a/LICENSES/SAS7BDAT_LICENSE +++ b/LICENSES/SAS7BDAT_LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2015 Jared Hobbs +Copyright (c) 2015-2019 Jared Hobbs Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in @@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE. \ No newline at end of file diff --git a/LICENSES/SCIPY_LICENSE b/LICENSES/SCIPY_LICENSE deleted file mode 100644 index d887ce5f9890f..0000000000000 --- a/LICENSES/SCIPY_LICENSE +++ /dev/null @@ -1,31 +0,0 @@ -Copyright (c) 2001, 2002 Enthought, Inc. -All rights reserved. - -Copyright (c) 2003-2012 SciPy Developers. -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - a. Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - b. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - c. Neither the name of Enthought nor the names of the SciPy Developers - may be used to endorse or promote products derived from this software - without specific prior written permission. - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH -DAMAGE. - diff --git a/LICENSES/ULTRAJSON_LICENSE b/LICENSES/ULTRAJSON_LICENSE index a905fb017d813..58fc9dfc0a35b 100644 --- a/LICENSES/ULTRAJSON_LICENSE +++ b/LICENSES/ULTRAJSON_LICENSE @@ -1,21 +1,22 @@ -Copyright (c) 2011-2013, ESN Social Software AB and Jonas Tarnstrom +Developed by ESN, an Electronic Arts Inc. studio. +Copyright (c) 2014, Electronic Arts Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - * Neither the name of the ESN Social Software AB nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. +* Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. +* Neither the name of ESN, Electronic Arts Inc. nor the +names of its contributors may be used to endorse or promote products +derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL ESN SOCIAL SOFTWARE AB OR JONAS TARNSTROM BE LIABLE +DISCLAIMED. IN NO EVENT SHALL ELECTRONIC ARTS INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND @@ -23,12 +24,91 @@ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +---- Portions of code from MODP_ASCII - Ascii transformations (upper/lower, etc) https://github.com/client9/stringencoders -Copyright (c) 2007 Nick Galbreath -- nickg [at] modp [dot] com. All rights reserved. -Numeric decoder derived from TCL library -http://www.opensource.apple.com/source/tcl/tcl-14/tcl/license.terms + Copyright 2005, 2006, 2007 + Nick Galbreath -- nickg [at] modp [dot] com + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + + Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + Neither the name of the modp.com nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + This is the standard "new" BSD license: + http://www.opensource.org/licenses/bsd-license.php + +https://github.com/client9/stringencoders/blob/cfd5c1507325ae497ea9bacdacba12c0ffd79d30/COPYING + +---- + +Numeric decoder derived from from TCL library +https://opensource.apple.com/source/tcl/tcl-14/tcl/license.terms * Copyright (c) 1988-1993 The Regents of the University of California. * Copyright (c) 1994 Sun Microsystems, Inc. + + This software is copyrighted by the Regents of the University of + California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState + Corporation and other parties. The following terms apply to all files + associated with the software unless explicitly disclaimed in + individual files. + + The authors hereby grant permission to use, copy, modify, distribute, + and license this software and its documentation for any purpose, provided + that existing copyright notices are retained in all copies and that this + notice is included verbatim in any distributions. No written agreement, + license, or royalty fee is required for any of the authorized uses. + Modifications to this software may be copyrighted by their authors + and need not follow the licensing terms described here, provided that + the new terms are clearly indicated on the first page of each file where + they apply. + + IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY + FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES + ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY + DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. + + THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE + IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE + NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR + MODIFICATIONS. + + GOVERNMENT USE: If you are acquiring this software on behalf of the + U.S. government, the Government shall have only "Restricted Rights" + in the software and related documentation as defined in the Federal + Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you + are acquiring the software on behalf of the Department of Defense, the + software shall be classified as "Commercial Computer Software" and the + Government shall have only "Restricted Rights" as defined in Clause + 252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the + authors grant the U.S. Government and others acting in its behalf + permission to use and distribute the software in accordance with the + terms specified in this license. \ No newline at end of file diff --git a/LICENSES/XARRAY_LICENSE b/LICENSES/XARRAY_LICENSE index 6bafeb9d3d80e..8405e89a0b120 100644 --- a/LICENSES/XARRAY_LICENSE +++ b/LICENSES/XARRAY_LICENSE @@ -1,7 +1,3 @@ -Copyright 2014-2019, xarray Developers - --------------------------------------------------------------------------------- - Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -192,4 +188,4 @@ third-party archives. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and - limitations under the License. + limitations under the License. \ No newline at end of file diff --git a/pandas/_libs/include/pandas/portable.h b/pandas/_libs/include/pandas/portable.h index 954b5c3cce082..2569aa4fded08 100644 --- a/pandas/_libs/include/pandas/portable.h +++ b/pandas/_libs/include/pandas/portable.h @@ -16,7 +16,7 @@ The full license is in the LICENSE file, distributed with this software. #endif // GH-23516 - works around locale perf issues -// from MUSL libc, MIT Licensed - see LICENSES +// from MUSL libc, licence at LICENSES/MUSL_LICENSE #define isdigit_ascii(c) (((unsigned)(c) - '0') < 10u) #define getdigit_ascii(c, default) (isdigit_ascii(c) ? ((int)((c) - '0')) : default) #define isspace_ascii(c) (((c) == ' ') || (((unsigned)(c) - '\t') < 5)) diff --git a/pandas/_libs/include/pandas/vendored/klib/khash.h b/pandas/_libs/include/pandas/vendored/klib/khash.h index 95b25d053a9df..758f089cc11a5 100644 --- a/pandas/_libs/include/pandas/vendored/klib/khash.h +++ b/pandas/_libs/include/pandas/vendored/klib/khash.h @@ -1,27 +1,4 @@ -/* The MIT License - - Copyright (c) 2008, 2009, 2011 by Attractive Chaos <attractor@live.co.uk> - - Permission is hereby granted, free of charge, to any person obtaining - a copy of this software and associated documentation files (the - "Software"), to deal in the Software without restriction, including - without limitation the rights to use, copy, modify, merge, publish, - distribute, sublicense, and/or sell copies of the Software, and to - permit persons to whom the Software is furnished to do so, subject to - the following conditions: - - The above copyright notice and this permission notice shall be - included in all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS - BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN - ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. -*/ +//Licence at LICENSES/KLIB_LICENSE /* An example: diff --git a/pandas/_libs/include/pandas/vendored/klib/khash_python.h b/pandas/_libs/include/pandas/vendored/klib/khash_python.h index 76b212a4b4660..1009671adc56b 100644 --- a/pandas/_libs/include/pandas/vendored/klib/khash_python.h +++ b/pandas/_libs/include/pandas/vendored/klib/khash_python.h @@ -1,3 +1,5 @@ +//Licence at LICENSES/KLIB_LICENSE + #include <string.h> #include <Python.h> diff --git a/pandas/_libs/sas.pyx b/pandas/_libs/sas.pyx index cf2e0e4d80bb5..9e1af2cb9c3e7 100644 --- a/pandas/_libs/sas.pyx +++ b/pandas/_libs/sas.pyx @@ -62,6 +62,7 @@ cdef buf_free(Buffer buf): # algorithm. It is partially documented here: # # https://cran.r-project.org/package=sas7bdat/vignettes/sas7bdat.pdf +# Licence at LICENSES/SAS7BDAT_LICENSE cdef int rle_decompress(Buffer inbuff, Buffer outbuff) except? 0: cdef: diff --git a/pandas/_libs/src/vendored/numpy/datetime/np_datetime.c b/pandas/_libs/src/vendored/numpy/datetime/np_datetime.c index 7e5cb53cf8f62..49016f79de5b9 100644 --- a/pandas/_libs/src/vendored/numpy/datetime/np_datetime.c +++ b/pandas/_libs/src/vendored/numpy/datetime/np_datetime.c @@ -14,6 +14,8 @@ This file is derived from NumPy 1.7. See NUMPY_LICENSE.txt */ +// Licence at LICENSES/NUMPY_LICENSE + #define NO_IMPORT #ifndef NPY_NO_DEPRECATED_API diff --git a/pandas/_libs/src/vendored/numpy/datetime/np_datetime_strings.c b/pandas/_libs/src/vendored/numpy/datetime/np_datetime_strings.c index 629d88ca6f589..9646183fa1786 100644 --- a/pandas/_libs/src/vendored/numpy/datetime/np_datetime_strings.c +++ b/pandas/_libs/src/vendored/numpy/datetime/np_datetime_strings.c @@ -19,6 +19,8 @@ This file implements string parsing and creation for NumPy datetime. */ +// LICENSES/NUMPY_LICENSE + #define PY_SSIZE_T_CLEAN #define NO_IMPORT diff --git a/pandas/_libs/src/vendored/ujson/lib/ultrajsondec.c b/pandas/_libs/src/vendored/ujson/lib/ultrajsondec.c index 9ec12cb242728..70794786016fb 100644 --- a/pandas/_libs/src/vendored/ujson/lib/ultrajsondec.c +++ b/pandas/_libs/src/vendored/ujson/lib/ultrajsondec.c @@ -38,6 +38,8 @@ Numeric decoder derived from TCL library * Copyright (c) 1994 Sun Microsystems, Inc. */ +// Licence at LICENSES/ULTRAJSON_LICENSE + #include <assert.h> #include <errno.h> #include <limits.h> diff --git a/pandas/_libs/src/vendored/ujson/lib/ultrajsonenc.c b/pandas/_libs/src/vendored/ujson/lib/ultrajsonenc.c index 726676799af65..e3e710ce1b876 100644 --- a/pandas/_libs/src/vendored/ujson/lib/ultrajsonenc.c +++ b/pandas/_libs/src/vendored/ujson/lib/ultrajsonenc.c @@ -38,6 +38,8 @@ Numeric decoder derived from TCL library * Copyright (c) 1994 Sun Microsystems, Inc. */ +// Licence at LICENSES/ULTRAJSON_LICENSE + #include <assert.h> #include <float.h> #include <locale.h> diff --git a/pandas/_libs/src/vendored/ujson/python/JSONtoObj.c b/pandas/_libs/src/vendored/ujson/python/JSONtoObj.c index f4055fcedcfa6..d230642b0632d 100644 --- a/pandas/_libs/src/vendored/ujson/python/JSONtoObj.c +++ b/pandas/_libs/src/vendored/ujson/python/JSONtoObj.c @@ -35,6 +35,8 @@ Numeric decoder derived from TCL library * Copyright (c) 1994 Sun Microsystems, Inc. */ +// Licence at LICENSES/ULTRAJSON_LICENSE + #define PY_ARRAY_UNIQUE_SYMBOL UJSON_NUMPY #define NO_IMPORT_ARRAY #define PY_SSIZE_T_CLEAN diff --git a/pandas/_libs/src/vendored/ujson/python/objToJSON.c b/pandas/_libs/src/vendored/ujson/python/objToJSON.c index 30b940726af0a..8c55505f61b51 100644 --- a/pandas/_libs/src/vendored/ujson/python/objToJSON.c +++ b/pandas/_libs/src/vendored/ujson/python/objToJSON.c @@ -36,6 +36,8 @@ Numeric decoder derived from TCL library * Copyright (c) 1994 Sun Microsystems, Inc. */ +// Licence at LICENSES/ULTRAJSON_LICENSE + #define PY_SSIZE_T_CLEAN #include <Python.h> #include <math.h> diff --git a/pandas/_libs/src/vendored/ujson/python/ujson.c b/pandas/_libs/src/vendored/ujson/python/ujson.c index 6a6a1bdcbe0e0..12dbb33f2874f 100644 --- a/pandas/_libs/src/vendored/ujson/python/ujson.c +++ b/pandas/_libs/src/vendored/ujson/python/ujson.c @@ -35,6 +35,8 @@ Numeric decoder derived from TCL library * Copyright (c) 1994 Sun Microsystems, Inc. */ +// Licence at LICENSES/ULTRAJSON_LICENSE + #include "pandas/vendored/ujson/python/version.h" #define PY_SSIZE_T_CLEAN #include <Python.h> diff --git a/pandas/_libs/tslibs/parsing.pyx b/pandas/_libs/tslibs/parsing.pyx index 3643c840a50a6..ef1a870b8653c 100644 --- a/pandas/_libs/tslibs/parsing.pyx +++ b/pandas/_libs/tslibs/parsing.pyx @@ -796,7 +796,7 @@ def try_parse_year_month_day( # is not practical. In fact, using this class issues warnings (xref gh-21322). # Thus, we port the class over so that both issues are resolved. # -# Copyright (c) 2017 - dateutil contributors +# Licence at LICENSES/DATEUTIL_LICENSE class _timelex: def __init__(self, instream): if getattr(instream, "decode", None) is not None: diff --git a/pandas/_libs/tslibs/strptime.pyx b/pandas/_libs/tslibs/strptime.pyx index 542afa9315a60..e6924a4e24dff 100644 --- a/pandas/_libs/tslibs/strptime.pyx +++ b/pandas/_libs/tslibs/strptime.pyx @@ -3,6 +3,7 @@ TimeRE, _calc_julian_from_U_or_W are vendored from the standard library, see https://github.com/python/cpython/blob/main/Lib/_strptime.py +Licence at LICENSES/PSF_LICENSE The original module-level docstring follows. Strptime-related classes and functions. @@ -672,7 +673,8 @@ cdef tzinfo parse_timezone_directive(str z): Notes ----- This is essentially similar to the cpython implementation - https://github.com/python/cpython/blob/master/Lib/_strptime.py#L457-L479 + https://github.com/python/cpython/blob/546cab84448b892c92e68d9c1a3d3b58c13b3463/Lib/_strptime.py#L437-L454 + Licence at LICENSES/PSF_LICENSE """ cdef: diff --git a/pandas/_libs/window/aggregations.pyx b/pandas/_libs/window/aggregations.pyx index 9c151b8269a52..6365c030b695b 100644 --- a/pandas/_libs/window/aggregations.pyx +++ b/pandas/_libs/window/aggregations.pyx @@ -987,9 +987,8 @@ def roll_median_c(const float64_t[:] values, ndarray[int64_t] start, # ---------------------------------------------------------------------- -# Moving maximum / minimum code taken from Bottleneck under the terms -# of its Simplified BSD license -# https://github.com/pydata/bottleneck +# Moving maximum / minimum code taken from Bottleneck +# Licence at LICENSES/BOTTLENECK_LICENCE cdef float64_t init_mm(float64_t ai, Py_ssize_t *nobs, bint is_max) noexcept nogil: diff --git a/pandas/core/accessor.py b/pandas/core/accessor.py index 1b36659944561..698abb2ec4989 100644 --- a/pandas/core/accessor.py +++ b/pandas/core/accessor.py @@ -187,7 +187,7 @@ def add_delegate_accessors(cls): return add_delegate_accessors -# Ported with modifications from xarray +# Ported with modifications from xarray; licence at LICENSES/XARRAY_LICENSE # https://github.com/pydata/xarray/blob/master/xarray/core/extensions.py # 1. We don't need to catch and re-raise AttributeErrors as RuntimeErrors # 2. We use a UserWarning instead of a custom Warning diff --git a/pandas/io/clipboard/__init__.py b/pandas/io/clipboard/__init__.py index c07f51d875d4d..806d42381afc6 100644 --- a/pandas/io/clipboard/__init__.py +++ b/pandas/io/clipboard/__init__.py @@ -4,7 +4,7 @@ A cross-platform clipboard module for Python, with copy & paste functions for plain text. By Al Sweigart al@inventwithpython.com -BSD License +Licence at LICENSES/PYPERCLIP_LICENSE Usage: import pyperclip diff --git a/pandas/tests/io/test_spss.py b/pandas/tests/io/test_spss.py index d1d0795234e72..5d8dce72d69c9 100644 --- a/pandas/tests/io/test_spss.py +++ b/pandas/tests/io/test_spss.py @@ -15,6 +15,7 @@ @pytest.mark.parametrize("path_klass", [lambda p: p, Path]) def test_spss_labelled_num(path_klass, datapath): # test file from the Haven project (https://haven.tidyverse.org/) + # Licence at LICENSES/HAVEN_LICENSE, LICENSES/HAVEN_MIT fname = path_klass(datapath("io", "data", "spss", "labelled-num.sav")) df = pd.read_spss(fname, convert_categoricals=True) @@ -30,6 +31,7 @@ def test_spss_labelled_num(path_klass, datapath): @pytest.mark.filterwarnings("ignore::pandas.errors.ChainedAssignmentError") def test_spss_labelled_num_na(datapath): # test file from the Haven project (https://haven.tidyverse.org/) + # Licence at LICENSES/HAVEN_LICENSE, LICENSES/HAVEN_MIT fname = datapath("io", "data", "spss", "labelled-num-na.sav") df = pd.read_spss(fname, convert_categoricals=True) @@ -45,6 +47,7 @@ def test_spss_labelled_num_na(datapath): @pytest.mark.filterwarnings("ignore::pandas.errors.ChainedAssignmentError") def test_spss_labelled_str(datapath): # test file from the Haven project (https://haven.tidyverse.org/) + # Licence at LICENSES/HAVEN_LICENSE, LICENSES/HAVEN_MIT fname = datapath("io", "data", "spss", "labelled-str.sav") df = pd.read_spss(fname, convert_categoricals=True) @@ -60,6 +63,7 @@ def test_spss_labelled_str(datapath): @pytest.mark.filterwarnings("ignore::pandas.errors.ChainedAssignmentError") def test_spss_umlauts(datapath): # test file from the Haven project (https://haven.tidyverse.org/) + # Licence at LICENSES/HAVEN_LICENSE, LICENSES/HAVEN_MIT fname = datapath("io", "data", "spss", "umlauts.sav") df = pd.read_spss(fname, convert_categoricals=True) @@ -84,6 +88,7 @@ def test_spss_usecols(datapath): def test_spss_umlauts_dtype_backend(datapath, dtype_backend): # test file from the Haven project (https://haven.tidyverse.org/) + # Licence at LICENSES/HAVEN_LICENSE, LICENSES/HAVEN_MIT fname = datapath("io", "data", "spss", "umlauts.sav") df = pd.read_spss(fname, convert_categoricals=False, dtype_backend=dtype_backend) diff --git a/pandas/util/version/__init__.py b/pandas/util/version/__init__.py index c72598eb50410..3a5efbbb09c1e 100644 --- a/pandas/util/version/__init__.py +++ b/pandas/util/version/__init__.py @@ -4,8 +4,7 @@ # 04/30/2021 # This file is dual licensed under the terms of the Apache License, Version -# 2.0, and the BSD License. See the LICENSE file in the root of this repository -# for complete details. +# 2.0, and the BSD License. Licence at LICENSES/PACKAGING_LICENSE from __future__ import annotations import collections diff --git a/scripts/no_bool_in_generic.py b/scripts/no_bool_in_generic.py index 3368b485662ad..c483d221a4266 100644 --- a/scripts/no_bool_in_generic.py +++ b/scripts/no_bool_in_generic.py @@ -9,6 +9,7 @@ The function `visit` is adapted from a function by the same name in pyupgrade: https://github.com/asottile/pyupgrade/blob/5495a248f2165941c5d3b82ac3226ba7ad1fa59d/pyupgrade/_data.py#L70-L113 +Licence at LICENSES/PYUPGRADE_LICENSE """ from __future__ import annotations
null
https://api.github.com/repos/pandas-dev/pandas/pulls/54743
2023-08-25T00:21:27Z
2023-08-25T17:18:30Z
2023-08-25T17:18:30Z
2023-08-25T17:18:32Z
Backport PR #54728 on branch 2.1.x (Docs: Update doc string to not reference deprecated function fillna for ffill)
diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 954573febed41..09ebd9387220f 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7348,7 +7348,7 @@ def ffill( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='ffill'``. + Fill NA/NaN values by propagating the last valid observation to next valid. Returns -------
Backport PR #54728: Docs: Update doc string to not reference deprecated function fillna for ffill
https://api.github.com/repos/pandas-dev/pandas/pulls/54740
2023-08-24T21:07:38Z
2023-08-24T22:44:39Z
2023-08-24T22:44:39Z
2023-08-24T22:44:39Z
TYP: Added type hint to Index.repeat
diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 796aadf9e4061..32c1ef1ff50f3 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1205,7 +1205,7 @@ def _maybe_disallow_fill(self, allow_fill: bool, fill_value, indices) -> bool: """ @Appender(_index_shared_docs["repeat"] % _index_doc_kwargs) - def repeat(self, repeats, axis=None): + def repeat(self, repeats, axis: None = None): repeats = ensure_platform_int(repeats) nv.validate_repeat((), {"axis": axis}) res_values = self._values.repeat(repeats)
- [ ] Fixes a bullet point on https://github.com/noatamir/pyladies-aug23-sprint/issues/5#issue-1805063243 - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. @noatamir @phofl
https://api.github.com/repos/pandas-dev/pandas/pulls/54739
2023-08-24T20:58:20Z
2023-08-29T16:28:07Z
2023-08-29T16:28:07Z
2023-08-29T16:30:22Z
DOC: fix an example which raises an Error in whatsnew/v0.24.0.rst
diff --git a/doc/source/whatsnew/v0.24.0.rst b/doc/source/whatsnew/v0.24.0.rst index 38c6e1123aaae..4ad5f4e7b5c3d 100644 --- a/doc/source/whatsnew/v0.24.0.rst +++ b/doc/source/whatsnew/v0.24.0.rst @@ -1377,18 +1377,22 @@ the object's ``freq`` attribute (:issue:`21939`, :issue:`23878`). *New behavior*: -.. ipython:: python - :okexcept: - :okwarning: +.. code-block:: ipython + + In [108]: ts = pd.Timestamp('1994-05-06 12:15:16', freq=pd.offsets.Hour()) + + In[109]: ts + 2 * ts.freq + Out[109]: Timestamp('1994-05-06 14:15:16', freq='H') + + In [110]: tdi = pd.timedelta_range('1D', periods=2) - ts = pd.Timestamp('1994-05-06 12:15:16', freq=pd.offsets.Hour()) - ts + 2 * ts.freq + In [111]: tdi - np.array([2 * tdi.freq, 1 * tdi.freq]) + Out[111]: TimedeltaIndex(['-1 days', '1 days'], dtype='timedelta64[ns]', freq=None) - tdi = pd.timedelta_range('1D', periods=2) - tdi - np.array([2 * tdi.freq, 1 * tdi.freq]) + In [112]: dti = pd.date_range('2001-01-01', periods=2, freq='7D') - dti = pd.date_range('2001-01-01', periods=2, freq='7D') - dti + pd.Index([1 * dti.freq, 2 * dti.freq]) + In [113]: dti + pd.Index([1 * dti.freq, 2 * dti.freq]) + Out[113]: DatetimeIndex(['2001-01-08', '2001-01-22'], dtype='datetime64[ns]', freq=None) .. _whatsnew_0240.deprecations.integer_tz:
Fix an example in doc/source/whatsnew/v0.24.0.rst, which raises an Error (see https://pandas.pydata.org/docs/dev/whatsnew/v0.24.0.html#integer-addition-subtraction-with-datetimes-and-timedeltas-is-deprecated)
https://api.github.com/repos/pandas-dev/pandas/pulls/54738
2023-08-24T20:31:18Z
2023-08-25T13:05:32Z
2023-08-25T13:05:32Z
2023-08-25T13:05:32Z
MAINT: small simplification of meson.build following best practices
diff --git a/meson.build b/meson.build index a927b59abeaf9..e16f565d491fe 100644 --- a/meson.build +++ b/meson.build @@ -2,13 +2,10 @@ project( 'pandas', 'c', 'cpp', 'cython', - version: run_command(['python', 'generate_version.py', '--print'], check: true).stdout().strip(), + version: run_command(['python3', 'generate_version.py', '--print'], check: true).stdout().strip(), license: 'BSD-3', meson_version: '>=1.0.1', default_options: [ - # TODO: investigate, does meson try to compile against debug Python - # when buildtype = debug, this seems to be causing problems on CI - # where provided Python is not compiled in debug mode 'buildtype=release', # TODO: Reactivate werror, some warnings on Windows #'werror=true', @@ -16,10 +13,8 @@ project( ] ) -py_mod = import('python') fs = import('fs') -py = py_mod.find_installation('python') -py_dep = py.dependency() +py = import('python').find_installation() tempita = files('generate_pxi.py') versioneer = files('generate_version.py') diff --git a/pandas/_libs/window/meson.build b/pandas/_libs/window/meson.build index b83d8730f9447..85aa060a26406 100644 --- a/pandas/_libs/window/meson.build +++ b/pandas/_libs/window/meson.build @@ -3,7 +3,6 @@ py.extension_module( ['aggregations.pyx'], cython_args: ['-X always_allow_keywords=true'], include_directories: [inc_np, inc_pd], - dependencies: [py_dep], subdir: 'pandas/_libs/window', override_options : ['cython_language=cpp'], install: true @@ -14,7 +13,6 @@ py.extension_module( ['indexers.pyx'], cython_args: ['-X always_allow_keywords=true'], include_directories: [inc_np, inc_pd], - dependencies: [py_dep], subdir: 'pandas/_libs/window', install: true )
Just a couple of things I observed having a quick look at `meson.build`.
https://api.github.com/repos/pandas-dev/pandas/pulls/54737
2023-08-24T20:27:46Z
2023-08-28T11:44:35Z
2023-08-28T11:44:35Z
2023-08-28T13:12:17Z
Docs: fix for links on see also for DataFrame.agg
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 07756b6af04f5..53ab03696551e 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -9818,12 +9818,12 @@ def _gotitem( -------- DataFrame.apply : Perform any type of operations. DataFrame.transform : Perform transformation type operations. - core.groupby.GroupBy : Perform operations over groups. - core.resample.Resampler : Perform operations over resampled bins. - core.window.Rolling : Perform operations over rolling window. - core.window.Expanding : Perform operations over expanding window. - core.window.ExponentialMovingWindow : Perform operation over exponential weighted - window. + pandas.core.groupby.GroupBy : Perform operations over groups. + pandas.core.resample.Resampler : Perform operations over resampled bins. + pandas.core.window.Rolling : Perform operations over rolling window. + pandas.core.window.Expanding : Perform operations over expanding window. + pandas.core.window.ExponentialMovingWindow : Perform operation over exponential + weighted window. """ )
- [x] fix for 1st bullet point on https://github.com/noatamir/pyladies-aug23-sprint/issues/13 - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. @noatamir @phofl PyLadies Berlin Aug Sprint
https://api.github.com/repos/pandas-dev/pandas/pulls/54736
2023-08-24T20:11:24Z
2023-08-25T17:59:26Z
2023-08-25T17:59:26Z
2023-08-25T17:59:36Z
Backport PR #54720 on branch 2.1.x (Infer strings as pyarrow_numpy backed strings)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 5d46f819b07f9..fabe910261c3d 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -21,7 +21,7 @@ PyArrow will become a required dependency with pandas 3.0 `PyArrow <https://arrow.apache.org/docs/python/index.html>`_ will become a required dependency of pandas starting with pandas 3.0. This decision was made based on -`PDEP 12 <https://pandas.pydata.org/pdeps/0010-required-pyarrow-dependency.html>`_. +`PDEP 10 <https://pandas.pydata.org/pdeps/0010-required-pyarrow-dependency.html>`_. This will enable more changes that are hugely beneficial to pandas users, including but not limited to: @@ -41,7 +41,9 @@ Avoid NumPy object dtype for strings by default Previously, all strings were stored in columns with NumPy object dtype. This release introduces an option ``future.infer_string`` that infers all -strings as PyArrow backed strings with dtype ``pd.ArrowDtype(pa.string())`` instead. +strings as PyArrow backed strings with dtype ``"string[pyarrow_numpy]"`` instead. +This is a new string dtype implementation that follows NumPy semantics in comparison +operations and will return ``np.nan`` as the missing value indicator. This option only works if PyArrow is installed. PyArrow backed strings have a significantly reduced memory footprint and provide a big performance improvement compared to NumPy object (:issue:`54430`). diff --git a/pandas/_libs/lib.pyx b/pandas/_libs/lib.pyx index 2681115bbdcfb..859cb8e5ebead 100644 --- a/pandas/_libs/lib.pyx +++ b/pandas/_libs/lib.pyx @@ -2682,11 +2682,9 @@ def maybe_convert_objects(ndarray[object] objects, elif seen.str_: if using_pyarrow_string_dtype() and is_string_array(objects, skipna=True): - import pyarrow as pa + from pandas.core.arrays.string_ import StringDtype - from pandas.core.dtypes.dtypes import ArrowDtype - - dtype = ArrowDtype(pa.string()) + dtype = StringDtype(storage="pyarrow_numpy") return dtype.construct_array_type()._from_sequence(objects, dtype=dtype) seen.object_ = True diff --git a/pandas/core/construction.py b/pandas/core/construction.py index f733ba3b445fd..aaac0dc73486f 100644 --- a/pandas/core/construction.py +++ b/pandas/core/construction.py @@ -51,10 +51,7 @@ is_object_dtype, pandas_dtype, ) -from pandas.core.dtypes.dtypes import ( - ArrowDtype, - NumpyEADtype, -) +from pandas.core.dtypes.dtypes import NumpyEADtype from pandas.core.dtypes.generic import ( ABCDataFrame, ABCExtensionArray, @@ -595,9 +592,9 @@ def sanitize_array( if data.dtype == object: subarr = maybe_infer_to_datetimelike(data) elif data.dtype.kind == "U" and using_pyarrow_string_dtype(): - import pyarrow as pa + from pandas.core.arrays.string_ import StringDtype - dtype = ArrowDtype(pa.string()) + dtype = StringDtype(storage="pyarrow_numpy") subarr = dtype.construct_array_type()._from_sequence(data, dtype=dtype) if subarr is data and copy: diff --git a/pandas/core/dtypes/cast.py b/pandas/core/dtypes/cast.py index 657cbce40087a..8ed57e9bf5532 100644 --- a/pandas/core/dtypes/cast.py +++ b/pandas/core/dtypes/cast.py @@ -799,10 +799,9 @@ def infer_dtype_from_scalar(val) -> tuple[DtypeObj, Any]: dtype = _dtype_obj if using_pyarrow_string_dtype(): - import pyarrow as pa + from pandas.core.arrays.string_ import StringDtype - pa_dtype = pa.string() - dtype = ArrowDtype(pa_dtype) + dtype = StringDtype(storage="pyarrow_numpy") elif isinstance(val, (np.datetime64, dt.datetime)): try: diff --git a/pandas/core/internals/construction.py b/pandas/core/internals/construction.py index 8879d3318f7ca..8aafb9dd623c5 100644 --- a/pandas/core/internals/construction.py +++ b/pandas/core/internals/construction.py @@ -32,10 +32,7 @@ is_named_tuple, is_object_dtype, ) -from pandas.core.dtypes.dtypes import ( - ArrowDtype, - ExtensionDtype, -) +from pandas.core.dtypes.dtypes import ExtensionDtype from pandas.core.dtypes.generic import ( ABCDataFrame, ABCSeries, @@ -379,10 +376,9 @@ def ndarray_to_mgr( nb = new_block_2d(values, placement=bp, refs=refs) block_values = [nb] elif dtype is None and values.dtype.kind == "U" and using_pyarrow_string_dtype(): - import pyarrow as pa + dtype = StringDtype(storage="pyarrow_numpy") obj_columns = list(values) - dtype = ArrowDtype(pa.string()) block_values = [ new_block( dtype.construct_array_type()._from_sequence(data, dtype=dtype), diff --git a/pandas/io/_util.py b/pandas/io/_util.py index 27316b3ab0af0..915595833468d 100644 --- a/pandas/io/_util.py +++ b/pandas/io/_util.py @@ -28,4 +28,4 @@ def _arrow_dtype_mapping() -> dict: def arrow_string_types_mapper() -> Callable: pa = import_optional_dependency("pyarrow") - return {pa.string(): pd.ArrowDtype(pa.string())}.get + return {pa.string(): pd.StringDtype(storage="pyarrow_numpy")}.get diff --git a/pandas/io/pytables.py b/pandas/io/pytables.py index f26411f65d91f..d3055f0ad2a38 100644 --- a/pandas/io/pytables.py +++ b/pandas/io/pytables.py @@ -68,7 +68,6 @@ ) from pandas.core.dtypes.missing import array_equivalent -import pandas as pd from pandas import ( DataFrame, DatetimeIndex, @@ -3224,9 +3223,7 @@ def read( values = self.read_array("values", start=start, stop=stop) result = Series(values, index=index, name=self.name, copy=False) if using_pyarrow_string_dtype() and is_string_array(values, skipna=True): - import pyarrow as pa - - result = result.astype(pd.ArrowDtype(pa.string())) + result = result.astype("string[pyarrow_numpy]") return result # error: Signature of "write" incompatible with supertype "Fixed" @@ -3296,9 +3293,7 @@ def read( columns = items[items.get_indexer(blk_items)] df = DataFrame(values.T, columns=columns, index=axes[1], copy=False) if using_pyarrow_string_dtype() and is_string_array(values, skipna=True): - import pyarrow as pa - - df = df.astype(pd.ArrowDtype(pa.string())) + df = df.astype("string[pyarrow_numpy]") dfs.append(df) if len(dfs) > 0: @@ -4686,9 +4681,7 @@ def read( values, # type: ignore[arg-type] skipna=True, ): - import pyarrow as pa - - df = df.astype(pd.ArrowDtype(pa.string())) + df = df.astype("string[pyarrow_numpy]") frames.append(df) if len(frames) == 1: diff --git a/pandas/tests/frame/test_constructors.py b/pandas/tests/frame/test_constructors.py index 63cddb7f192e6..a8ab3ce1ba014 100644 --- a/pandas/tests/frame/test_constructors.py +++ b/pandas/tests/frame/test_constructors.py @@ -2685,8 +2685,8 @@ def test_construct_with_strings_and_none(self): def test_frame_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = DataFrame( {"a": ["a", "b"]}, dtype=dtype, columns=Index(["a"], dtype=dtype) ) @@ -2720,8 +2720,8 @@ def test_frame_string_inference(self): def test_frame_string_inference_array_string_dtype(self): # GH#54496 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = DataFrame( {"a": ["a", "b"]}, dtype=dtype, columns=Index(["a"], dtype=dtype) ) diff --git a/pandas/tests/indexes/base_class/test_constructors.py b/pandas/tests/indexes/base_class/test_constructors.py index 638124ac20e06..60abbfc441e8e 100644 --- a/pandas/tests/indexes/base_class/test_constructors.py +++ b/pandas/tests/indexes/base_class/test_constructors.py @@ -46,8 +46,8 @@ def test_construct_empty_tuples(self, tuple_list): def test_index_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = Index(["a", "b"], dtype=dtype) with pd.option_context("future.infer_string", True): ser = Index(["a", "b"]) diff --git a/pandas/tests/io/json/test_pandas.py b/pandas/tests/io/json/test_pandas.py index 637d62b98a831..437012d836941 100644 --- a/pandas/tests/io/json/test_pandas.py +++ b/pandas/tests/io/json/test_pandas.py @@ -2099,7 +2099,7 @@ def test_pyarrow_engine_lines_false(): def test_json_roundtrip_string_inference(orient): - pa = pytest.importorskip("pyarrow") + pytest.importorskip("pyarrow") df = DataFrame( [["a", "b"], ["c", "d"]], index=["row 1", "row 2"], columns=["col 1", "col 2"] ) @@ -2108,8 +2108,8 @@ def test_json_roundtrip_string_inference(orient): result = read_json(StringIO(out)) expected = DataFrame( [["a", "b"], ["c", "d"]], - dtype=pd.ArrowDtype(pa.string()), - index=pd.Index(["row 1", "row 2"], dtype=pd.ArrowDtype(pa.string())), - columns=pd.Index(["col 1", "col 2"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + index=pd.Index(["row 1", "row 2"], dtype="string[pyarrow_numpy]"), + columns=pd.Index(["col 1", "col 2"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/parser/dtypes/test_dtypes_basic.py b/pandas/tests/io/parser/dtypes/test_dtypes_basic.py index 1c0f0939029ff..8494c5d58171b 100644 --- a/pandas/tests/io/parser/dtypes/test_dtypes_basic.py +++ b/pandas/tests/io/parser/dtypes/test_dtypes_basic.py @@ -542,8 +542,8 @@ def test_ea_int_avoid_overflow(all_parsers): def test_string_inference(all_parsers): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" data = """a,b x,1 diff --git a/pandas/tests/io/pytables/test_read.py b/pandas/tests/io/pytables/test_read.py index 425828cb881a7..bc5ed4d208e0f 100644 --- a/pandas/tests/io/pytables/test_read.py +++ b/pandas/tests/io/pytables/test_read.py @@ -392,7 +392,7 @@ def test_read_py2_hdf_file_in_py3(datapath): def test_read_infer_string(tmp_path, setup_path): # GH#54431 - pa = pytest.importorskip("pyarrow") + pytest.importorskip("pyarrow") df = DataFrame({"a": ["a", "b", None]}) path = tmp_path / setup_path df.to_hdf(path, key="data", format="table") @@ -400,7 +400,7 @@ def test_read_infer_string(tmp_path, setup_path): result = read_hdf(path, key="data", mode="r") expected = DataFrame( {"a": ["a", "b", None]}, - dtype=pd.ArrowDtype(pa.string()), - columns=Index(["a"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + columns=Index(["a"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_feather.py b/pandas/tests/io/test_feather.py index a0fee6751bf53..cf43203466ef4 100644 --- a/pandas/tests/io/test_feather.py +++ b/pandas/tests/io/test_feather.py @@ -222,14 +222,10 @@ def test_invalid_dtype_backend(self): def test_string_inference(self, tmp_path): # GH#54431 - import pyarrow as pa - path = tmp_path / "test_string_inference.p" df = pd.DataFrame(data={"a": ["x", "y"]}) df.to_feather(path) with pd.option_context("future.infer_string", True): result = read_feather(path) - expected = pd.DataFrame( - data={"a": ["x", "y"]}, dtype=pd.ArrowDtype(pa.string()) - ) + expected = pd.DataFrame(data={"a": ["x", "y"]}, dtype="string[pyarrow_numpy]") tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_orc.py b/pandas/tests/io/test_orc.py index c2d791ba24c87..d90f803f1e607 100644 --- a/pandas/tests/io/test_orc.py +++ b/pandas/tests/io/test_orc.py @@ -426,7 +426,7 @@ def test_string_inference(tmp_path): result = read_orc(path) expected = pd.DataFrame( data={"a": ["x", "y"]}, - dtype=pd.ArrowDtype(pa.string()), - columns=pd.Index(["a"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + columns=pd.Index(["a"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_parquet.py b/pandas/tests/io/test_parquet.py index a4c6cfcf9fe0e..ccba44b7f8fe4 100644 --- a/pandas/tests/io/test_parquet.py +++ b/pandas/tests/io/test_parquet.py @@ -1099,8 +1099,6 @@ def test_df_attrs_persistence(self, tmp_path, pa): def test_string_inference(self, tmp_path, pa): # GH#54431 - import pyarrow as pa - path = tmp_path / "test_string_inference.p" df = pd.DataFrame(data={"a": ["x", "y"]}, index=["a", "b"]) df.to_parquet(path, engine="pyarrow") @@ -1108,8 +1106,8 @@ def test_string_inference(self, tmp_path, pa): result = read_parquet(path, engine="pyarrow") expected = pd.DataFrame( data={"a": ["x", "y"]}, - dtype=pd.ArrowDtype(pa.string()), - index=pd.Index(["a", "b"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + index=pd.Index(["a", "b"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_sql.py b/pandas/tests/io/test_sql.py index 02736406e109b..2f446e6b8c81d 100644 --- a/pandas/tests/io/test_sql.py +++ b/pandas/tests/io/test_sql.py @@ -2946,7 +2946,7 @@ def test_read_sql_dtype_backend_table(self, string_storage, func): def test_read_sql_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") + pytest.importorskip("pyarrow") table = "test" df = DataFrame({"a": ["x", "y"]}) df.to_sql(table, con=self.conn, index=False, if_exists="replace") @@ -2954,7 +2954,7 @@ def test_read_sql_string_inference(self): with pd.option_context("future.infer_string", True): result = read_sql_table(table, self.conn) - dtype = pd.ArrowDtype(pa.string()) + dtype = "string[pyarrow_numpy]" expected = DataFrame( {"a": ["x", "y"]}, dtype=dtype, columns=Index(["a"], dtype=dtype) ) diff --git a/pandas/tests/series/test_constructors.py b/pandas/tests/series/test_constructors.py index 97bd8633954d8..ef734e9664844 100644 --- a/pandas/tests/series/test_constructors.py +++ b/pandas/tests/series/test_constructors.py @@ -2077,8 +2077,8 @@ def test_series_from_index_dtype_equal_does_not_copy(self): def test_series_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = Series(["a", "b"], dtype=dtype) with pd.option_context("future.infer_string", True): ser = Series(["a", "b"]) @@ -2092,8 +2092,8 @@ def test_series_string_inference(self): @pytest.mark.parametrize("na_value", [None, np.nan, pd.NA]) def test_series_string_with_na_inference(self, na_value): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = Series(["a", na_value], dtype=dtype) with pd.option_context("future.infer_string", True): ser = Series(["a", na_value]) @@ -2101,16 +2101,16 @@ def test_series_string_with_na_inference(self, na_value): def test_series_string_inference_scalar(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - expected = Series("a", index=[1], dtype=pd.ArrowDtype(pa.string())) + pytest.importorskip("pyarrow") + expected = Series("a", index=[1], dtype="string[pyarrow_numpy]") with pd.option_context("future.infer_string", True): ser = Series("a", index=[1]) tm.assert_series_equal(ser, expected) def test_series_string_inference_array_string_dtype(self): # GH#54496 - pa = pytest.importorskip("pyarrow") - expected = Series(["a", "b"], dtype=pd.ArrowDtype(pa.string())) + pytest.importorskip("pyarrow") + expected = Series(["a", "b"], dtype="string[pyarrow_numpy]") with pd.option_context("future.infer_string", True): ser = Series(np.array(["a", "b"])) tm.assert_series_equal(ser, expected)
Backport PR #54720: Infer strings as pyarrow_numpy backed strings
https://api.github.com/repos/pandas-dev/pandas/pulls/54735
2023-08-24T19:30:11Z
2023-08-24T21:33:27Z
2023-08-24T21:33:27Z
2023-08-24T21:33:27Z
Deleted non-existing method reference.
diff --git a/pandas/core/series.py b/pandas/core/series.py index 9a934217ed5c1..761ec3cec66bf 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -5753,7 +5753,6 @@ def to_period(self, freq: str | None = None, copy: bool | None = None) -> Series See Also -------- Series.reindex : Conform Series to new index. - Series.set_index : Set Series as DataFrame index. Index : The base pandas index type. Notes
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54734
2023-08-24T18:40:55Z
2023-08-24T21:06:00Z
2023-08-24T21:06:00Z
2023-08-24T21:06:07Z
adding dtype_backend=pyarrow in documentation
diff --git a/doc/source/user_guide/io.rst b/doc/source/user_guide/io.rst index fb3e1ba32228c..0802207bad559 100644 --- a/doc/source/user_guide/io.rst +++ b/doc/source/user_guide/io.rst @@ -492,6 +492,19 @@ Setting ``dtype_backend="numpy_nullable"`` will result in nullable dtypes for ev .. _io.categorical: +Setting ``dtype_backend="pyarrow"`` will result in pyarrow dtypes. + +.. ipython:: python + + data = """a,b,c,d,e,f,g,h,i,j + 1,2.5,True,a,,,,,12-31-2019, + 3,4.5,False,b,6,7.5,True,a,12-31-2019, + """ + + df = pd.read_csv(StringIO(data), dtype_backend="pyarrow", parse_dates=["i"]) + df + df.dtypes + Specifying categorical dtype ''''''''''''''''''''''''''''
- [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. Issue took from [here](https://github.com/noatamir/pyladies-aug23-sprint/issues/4)
https://api.github.com/repos/pandas-dev/pandas/pulls/54733
2023-08-24T18:40:20Z
2023-10-09T18:36:41Z
null
2023-10-09T18:36:42Z
added description to parameters
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 53ab03696551e..08c26f111cdde 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -4909,7 +4909,13 @@ def insert( column : str, number, or hashable object Label of the inserted column. value : Scalar, Series, or array-like + Column Value to be inserted. It can be any datatype. + Also, single value, list of values or Series can be provided. + In can be single value, it will be used to populate + all rows from that column. allow_duplicates : bool, optional, default lib.no_default + This is a boolean value which checks if column + with same name already exists or not. See Also --------
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54731
2023-08-24T18:31:58Z
2023-09-18T17:16:04Z
null
2023-09-18T17:16:04Z
DOC: fix formatting in .at docstring
diff --git a/pandas/core/indexing.py b/pandas/core/indexing.py index a2871f364f092..97578e3f1668b 100644 --- a/pandas/core/indexing.py +++ b/pandas/core/indexing.py @@ -604,12 +604,12 @@ def at(self) -> _AtIndexer: Raises ------ KeyError - * If getting a value and 'label' does not exist in a DataFrame or - Series. + If getting a value and 'label' does not exist in a DataFrame or Series. + ValueError - * If row/column label pair is not a tuple or if any label from - the pair is not a scalar for DataFrame. - * If label is list-like (*excluding* NamedTuple) for Series. + If row/column label pair is not a tuple or if any label + from the pair is not a scalar for DataFrame. + If label is list-like (*excluding* NamedTuple) for Series. See Also --------
- [x] Fix for 9th bullet point of https://github.com/noatamir/pyladies-aug23-sprint/issues/13 - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). Done during the 'Let's contribute to pandas - mentored workshop' event - PyLadies Berlin @noatamir @phofl
https://api.github.com/repos/pandas-dev/pandas/pulls/54730
2023-08-24T18:30:02Z
2023-08-28T15:09:54Z
2023-08-28T15:09:54Z
2023-08-28T15:09:55Z
typing improvements on level and fill_value in Series.eq
diff --git a/pandas/core/series.py b/pandas/core/series.py index 318f3fee2756b..f1bc67810b788 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -166,6 +166,7 @@ DtypeBackend, DtypeObj, FilePath, + Frequency, IgnoreRaise, IndexKeyFunc, IndexLabel, @@ -5630,7 +5631,7 @@ def dropna( def to_timestamp( self, - freq=None, + freq: Frequency | None = None, how: Literal["s", "e", "start", "end"] = "start", copy: bool | None = None, ) -> Series: @@ -5946,7 +5947,13 @@ def _flex_method(self, other, op, *, level=None, fill_value=None, axis: Axis = 0 return op(self, other) @Appender(ops.make_flex_doc("eq", "series")) - def eq(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: + def eq( + self, + other, + level: Level | None = None, + fill_value: float | None = None, + axis: Axis = 0, + ) -> Series: return self._flex_method( other, operator.eq, level=level, fill_value=fill_value, axis=axis )
- [x] item 6 and 7 in [issue#11](https://github.com/noatamir/pyladies-aug23-sprint/issues/11) - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit).
https://api.github.com/repos/pandas-dev/pandas/pulls/54729
2023-08-24T18:24:28Z
2023-08-25T13:14:13Z
2023-08-25T13:14:13Z
2023-08-26T07:05:00Z
Docs: Update doc string to not reference deprecated function fillna for ffill
diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 6e4d3610f4ffa..9682e5a864e2c 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7368,7 +7368,7 @@ def ffill( downcast: dict | None | lib.NoDefault = lib.no_default, ) -> Self | None: """ - Synonym for :meth:`DataFrame.fillna` with ``method='ffill'``. + Fill NA/NaN values by propagating the last valid observation to next valid. Returns -------
- [x] fix for 1st bullet point on https://github.com/noatamir/pyladies-aug23-sprint/issues/13 - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. @noatamir @phofl PyLadies Berlin Aug Sprint
https://api.github.com/repos/pandas-dev/pandas/pulls/54728
2023-08-24T17:31:53Z
2023-08-24T21:07:30Z
2023-08-24T21:07:30Z
2023-08-25T00:42:34Z
Backport PR #54721 on branch 2.1.x (BUG/WARN: Passing EA object to dtype instead of an instance)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index b79797fa86431..5d46f819b07f9 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -837,6 +837,7 @@ ExtensionArray - Bug in :meth:`Series.rank` returning wrong order for small values with ``Float64`` dtype (:issue:`52471`) - Bug in :meth:`Series.unique` for boolean ``ArrowDtype`` with ``NA`` values (:issue:`54667`) - Bug in :meth:`~arrays.ArrowExtensionArray.__iter__` and :meth:`~arrays.ArrowExtensionArray.__getitem__` returning python datetime and timedelta objects for non-nano dtypes (:issue:`53326`) +- Bug when passing an :class:`ExtensionArray` subclass to ``dtype`` keywords. This will now raise a ``UserWarning`` to encourage passing an instance instead (:issue:`31356`, :issue:`54592`) - Bug where the :class:`DataFrame` repr would not work when a column had an :class:`ArrowDtype` with a ``pyarrow.ExtensionDtype`` (:issue:`54063`) - Bug where the ``__from_arrow__`` method of masked ExtensionDtypes (e.g. :class:`Float64Dtype`, :class:`BooleanDtype`) would not accept PyArrow arrays of type ``pyarrow.null()`` (:issue:`52223`) diff --git a/pandas/core/dtypes/common.py b/pandas/core/dtypes/common.py index c2e498e75b7d3..3db36fc50e343 100644 --- a/pandas/core/dtypes/common.py +++ b/pandas/core/dtypes/common.py @@ -1614,6 +1614,15 @@ def pandas_dtype(dtype) -> DtypeObj: # registered extension types result = registry.find(dtype) if result is not None: + if isinstance(result, type): + # GH 31356, GH 54592 + warnings.warn( + f"Instantiating {result.__name__} without any arguments." + f"Pass a {result.__name__} instance to silence this warning.", + UserWarning, + stacklevel=find_stack_level(), + ) + result = result() return result # try a numpy dtype diff --git a/pandas/tests/dtypes/test_common.py b/pandas/tests/dtypes/test_common.py index 471e456146178..165bf61302145 100644 --- a/pandas/tests/dtypes/test_common.py +++ b/pandas/tests/dtypes/test_common.py @@ -782,3 +782,9 @@ def test_pandas_dtype_numpy_warning(): match="Converting `np.integer` or `np.signedinteger` to a dtype is deprecated", ): pandas_dtype(np.integer) + + +def test_pandas_dtype_ea_not_instance(): + # GH 31356 GH 54592 + with tm.assert_produces_warning(UserWarning): + assert pandas_dtype(CategoricalDtype) == CategoricalDtype()
Backport PR #54721: BUG/WARN: Passing EA object to dtype instead of an instance
https://api.github.com/repos/pandas-dev/pandas/pulls/54726
2023-08-24T16:14:24Z
2023-08-24T19:00:43Z
2023-08-24T19:00:43Z
2023-08-24T19:00:43Z
TYP: Return type for eq/ne/div/...
diff --git a/pandas/core/frame.py b/pandas/core/frame.py index e9d8ba6aab4a8..07756b6af04f5 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -8067,43 +8067,49 @@ def _flex_cmp_method(self, other, op, *, axis: Axis = "columns", level=None): return self._construct_result(new_data) @Appender(ops.make_flex_doc("eq", "dataframe")) - def eq(self, other, axis: Axis = "columns", level=None): + def eq(self, other, axis: Axis = "columns", level=None) -> DataFrame: return self._flex_cmp_method(other, operator.eq, axis=axis, level=level) @Appender(ops.make_flex_doc("ne", "dataframe")) - def ne(self, other, axis: Axis = "columns", level=None): + def ne(self, other, axis: Axis = "columns", level=None) -> DataFrame: return self._flex_cmp_method(other, operator.ne, axis=axis, level=level) @Appender(ops.make_flex_doc("le", "dataframe")) - def le(self, other, axis: Axis = "columns", level=None): + def le(self, other, axis: Axis = "columns", level=None) -> DataFrame: return self._flex_cmp_method(other, operator.le, axis=axis, level=level) @Appender(ops.make_flex_doc("lt", "dataframe")) - def lt(self, other, axis: Axis = "columns", level=None): + def lt(self, other, axis: Axis = "columns", level=None) -> DataFrame: return self._flex_cmp_method(other, operator.lt, axis=axis, level=level) @Appender(ops.make_flex_doc("ge", "dataframe")) - def ge(self, other, axis: Axis = "columns", level=None): + def ge(self, other, axis: Axis = "columns", level=None) -> DataFrame: return self._flex_cmp_method(other, operator.ge, axis=axis, level=level) @Appender(ops.make_flex_doc("gt", "dataframe")) - def gt(self, other, axis: Axis = "columns", level=None): + def gt(self, other, axis: Axis = "columns", level=None) -> DataFrame: return self._flex_cmp_method(other, operator.gt, axis=axis, level=level) @Appender(ops.make_flex_doc("add", "dataframe")) - def add(self, other, axis: Axis = "columns", level=None, fill_value=None): + def add( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, operator.add, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("radd", "dataframe")) - def radd(self, other, axis: Axis = "columns", level=None, fill_value=None): + def radd( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, roperator.radd, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("sub", "dataframe")) - def sub(self, other, axis: Axis = "columns", level=None, fill_value=None): + def sub( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, operator.sub, level=level, fill_value=fill_value, axis=axis ) @@ -8111,13 +8117,17 @@ def sub(self, other, axis: Axis = "columns", level=None, fill_value=None): subtract = sub @Appender(ops.make_flex_doc("rsub", "dataframe")) - def rsub(self, other, axis: Axis = "columns", level=None, fill_value=None): + def rsub( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, roperator.rsub, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("mul", "dataframe")) - def mul(self, other, axis: Axis = "columns", level=None, fill_value=None): + def mul( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, operator.mul, level=level, fill_value=fill_value, axis=axis ) @@ -8125,13 +8135,17 @@ def mul(self, other, axis: Axis = "columns", level=None, fill_value=None): multiply = mul @Appender(ops.make_flex_doc("rmul", "dataframe")) - def rmul(self, other, axis: Axis = "columns", level=None, fill_value=None): + def rmul( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, roperator.rmul, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("truediv", "dataframe")) - def truediv(self, other, axis: Axis = "columns", level=None, fill_value=None): + def truediv( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, operator.truediv, level=level, fill_value=fill_value, axis=axis ) @@ -8140,7 +8154,9 @@ def truediv(self, other, axis: Axis = "columns", level=None, fill_value=None): divide = truediv @Appender(ops.make_flex_doc("rtruediv", "dataframe")) - def rtruediv(self, other, axis: Axis = "columns", level=None, fill_value=None): + def rtruediv( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, roperator.rtruediv, level=level, fill_value=fill_value, axis=axis ) @@ -8148,37 +8164,49 @@ def rtruediv(self, other, axis: Axis = "columns", level=None, fill_value=None): rdiv = rtruediv @Appender(ops.make_flex_doc("floordiv", "dataframe")) - def floordiv(self, other, axis: Axis = "columns", level=None, fill_value=None): + def floordiv( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, operator.floordiv, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("rfloordiv", "dataframe")) - def rfloordiv(self, other, axis: Axis = "columns", level=None, fill_value=None): + def rfloordiv( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, roperator.rfloordiv, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("mod", "dataframe")) - def mod(self, other, axis: Axis = "columns", level=None, fill_value=None): + def mod( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, operator.mod, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("rmod", "dataframe")) - def rmod(self, other, axis: Axis = "columns", level=None, fill_value=None): + def rmod( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, roperator.rmod, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("pow", "dataframe")) - def pow(self, other, axis: Axis = "columns", level=None, fill_value=None): + def pow( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, operator.pow, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("rpow", "dataframe")) - def rpow(self, other, axis: Axis = "columns", level=None, fill_value=None): + def rpow( + self, other, axis: Axis = "columns", level=None, fill_value=None + ) -> DataFrame: return self._flex_arith_method( other, roperator.rpow, level=level, fill_value=fill_value, axis=axis ) diff --git a/pandas/core/series.py b/pandas/core/series.py index 9a934217ed5c1..318f3fee2756b 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -5946,55 +5946,55 @@ def _flex_method(self, other, op, *, level=None, fill_value=None, axis: Axis = 0 return op(self, other) @Appender(ops.make_flex_doc("eq", "series")) - def eq(self, other, level=None, fill_value=None, axis: Axis = 0): + def eq(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.eq, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("ne", "series")) - def ne(self, other, level=None, fill_value=None, axis: Axis = 0): + def ne(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.ne, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("le", "series")) - def le(self, other, level=None, fill_value=None, axis: Axis = 0): + def le(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.le, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("lt", "series")) - def lt(self, other, level=None, fill_value=None, axis: Axis = 0): + def lt(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.lt, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("ge", "series")) - def ge(self, other, level=None, fill_value=None, axis: Axis = 0): + def ge(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.ge, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("gt", "series")) - def gt(self, other, level=None, fill_value=None, axis: Axis = 0): + def gt(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.gt, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("add", "series")) - def add(self, other, level=None, fill_value=None, axis: Axis = 0): + def add(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.add, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("radd", "series")) - def radd(self, other, level=None, fill_value=None, axis: Axis = 0): + def radd(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.radd, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("sub", "series")) - def sub(self, other, level=None, fill_value=None, axis: Axis = 0): + def sub(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.sub, level=level, fill_value=fill_value, axis=axis ) @@ -6002,7 +6002,7 @@ def sub(self, other, level=None, fill_value=None, axis: Axis = 0): subtract = sub @Appender(ops.make_flex_doc("rsub", "series")) - def rsub(self, other, level=None, fill_value=None, axis: Axis = 0): + def rsub(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.rsub, level=level, fill_value=fill_value, axis=axis ) @@ -6014,7 +6014,7 @@ def mul( level: Level | None = None, fill_value: float | None = None, axis: Axis = 0, - ): + ) -> Series: return self._flex_method( other, operator.mul, level=level, fill_value=fill_value, axis=axis ) @@ -6022,13 +6022,13 @@ def mul( multiply = mul @Appender(ops.make_flex_doc("rmul", "series")) - def rmul(self, other, level=None, fill_value=None, axis: Axis = 0): + def rmul(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.rmul, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("truediv", "series")) - def truediv(self, other, level=None, fill_value=None, axis: Axis = 0): + def truediv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.truediv, level=level, fill_value=fill_value, axis=axis ) @@ -6037,7 +6037,7 @@ def truediv(self, other, level=None, fill_value=None, axis: Axis = 0): divide = truediv @Appender(ops.make_flex_doc("rtruediv", "series")) - def rtruediv(self, other, level=None, fill_value=None, axis: Axis = 0): + def rtruediv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.rtruediv, level=level, fill_value=fill_value, axis=axis ) @@ -6045,49 +6045,49 @@ def rtruediv(self, other, level=None, fill_value=None, axis: Axis = 0): rdiv = rtruediv @Appender(ops.make_flex_doc("floordiv", "series")) - def floordiv(self, other, level=None, fill_value=None, axis: Axis = 0): + def floordiv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.floordiv, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("rfloordiv", "series")) - def rfloordiv(self, other, level=None, fill_value=None, axis: Axis = 0): + def rfloordiv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.rfloordiv, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("mod", "series")) - def mod(self, other, level=None, fill_value=None, axis: Axis = 0): + def mod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.mod, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("rmod", "series")) - def rmod(self, other, level=None, fill_value=None, axis: Axis = 0): + def rmod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.rmod, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("pow", "series")) - def pow(self, other, level=None, fill_value=None, axis: Axis = 0): + def pow(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, operator.pow, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("rpow", "series")) - def rpow(self, other, level=None, fill_value=None, axis: Axis = 0): + def rpow(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.rpow, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("divmod", "series")) - def divmod(self, other, level=None, fill_value=None, axis: Axis = 0): + def divmod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, divmod, level=level, fill_value=fill_value, axis=axis ) @Appender(ops.make_flex_doc("rdivmod", "series")) - def rdivmod(self, other, level=None, fill_value=None, axis: Axis = 0): + def rdivmod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series: return self._flex_method( other, roperator.rdivmod, level=level, fill_value=fill_value, axis=axis )
I was first trying to use `Self` (not sure whether it should be used here) but that seems to confuse mypy when the method is assigned to an alias (e.g., `subtract = sub`) as it then seems to loose track of what Self refers to.
https://api.github.com/repos/pandas-dev/pandas/pulls/54725
2023-08-24T14:01:24Z
2023-08-24T16:18:16Z
2023-08-24T16:18:16Z
2023-09-19T15:24:48Z
BUG/WARN: Passing EA object to dtype instead of an instance
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index b79797fa86431..5d46f819b07f9 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -837,6 +837,7 @@ ExtensionArray - Bug in :meth:`Series.rank` returning wrong order for small values with ``Float64`` dtype (:issue:`52471`) - Bug in :meth:`Series.unique` for boolean ``ArrowDtype`` with ``NA`` values (:issue:`54667`) - Bug in :meth:`~arrays.ArrowExtensionArray.__iter__` and :meth:`~arrays.ArrowExtensionArray.__getitem__` returning python datetime and timedelta objects for non-nano dtypes (:issue:`53326`) +- Bug when passing an :class:`ExtensionArray` subclass to ``dtype`` keywords. This will now raise a ``UserWarning`` to encourage passing an instance instead (:issue:`31356`, :issue:`54592`) - Bug where the :class:`DataFrame` repr would not work when a column had an :class:`ArrowDtype` with a ``pyarrow.ExtensionDtype`` (:issue:`54063`) - Bug where the ``__from_arrow__`` method of masked ExtensionDtypes (e.g. :class:`Float64Dtype`, :class:`BooleanDtype`) would not accept PyArrow arrays of type ``pyarrow.null()`` (:issue:`52223`) diff --git a/pandas/core/dtypes/common.py b/pandas/core/dtypes/common.py index c2e498e75b7d3..3db36fc50e343 100644 --- a/pandas/core/dtypes/common.py +++ b/pandas/core/dtypes/common.py @@ -1614,6 +1614,15 @@ def pandas_dtype(dtype) -> DtypeObj: # registered extension types result = registry.find(dtype) if result is not None: + if isinstance(result, type): + # GH 31356, GH 54592 + warnings.warn( + f"Instantiating {result.__name__} without any arguments." + f"Pass a {result.__name__} instance to silence this warning.", + UserWarning, + stacklevel=find_stack_level(), + ) + result = result() return result # try a numpy dtype diff --git a/pandas/tests/dtypes/test_common.py b/pandas/tests/dtypes/test_common.py index 471e456146178..165bf61302145 100644 --- a/pandas/tests/dtypes/test_common.py +++ b/pandas/tests/dtypes/test_common.py @@ -782,3 +782,9 @@ def test_pandas_dtype_numpy_warning(): match="Converting `np.integer` or `np.signedinteger` to a dtype is deprecated", ): pandas_dtype(np.integer) + + +def test_pandas_dtype_ea_not_instance(): + # GH 31356 GH 54592 + with tm.assert_produces_warning(UserWarning): + assert pandas_dtype(CategoricalDtype) == CategoricalDtype()
- [x] closes #31356 (Replace xxxx with the GitHub issue number) - [x] closes #54592 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. Instantiating an empty instance is an imperfect solution since the EADtype could require positional arguments, so raises a UserWarning to encourage users to pass instances instead
https://api.github.com/repos/pandas-dev/pandas/pulls/54721
2023-08-23T22:37:14Z
2023-08-24T16:13:19Z
2023-08-24T16:13:19Z
2023-08-24T16:13:35Z
Infer strings as pyarrow_numpy backed strings
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index b79797fa86431..8056e6f3393e9 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -21,7 +21,7 @@ PyArrow will become a required dependency with pandas 3.0 `PyArrow <https://arrow.apache.org/docs/python/index.html>`_ will become a required dependency of pandas starting with pandas 3.0. This decision was made based on -`PDEP 12 <https://pandas.pydata.org/pdeps/0010-required-pyarrow-dependency.html>`_. +`PDEP 10 <https://pandas.pydata.org/pdeps/0010-required-pyarrow-dependency.html>`_. This will enable more changes that are hugely beneficial to pandas users, including but not limited to: @@ -41,7 +41,9 @@ Avoid NumPy object dtype for strings by default Previously, all strings were stored in columns with NumPy object dtype. This release introduces an option ``future.infer_string`` that infers all -strings as PyArrow backed strings with dtype ``pd.ArrowDtype(pa.string())`` instead. +strings as PyArrow backed strings with dtype ``"string[pyarrow_numpy]"`` instead. +This is a new string dtype implementation that follows NumPy semantics in comparison +operations and will return ``np.nan`` as the missing value indicator. This option only works if PyArrow is installed. PyArrow backed strings have a significantly reduced memory footprint and provide a big performance improvement compared to NumPy object (:issue:`54430`). diff --git a/pandas/_libs/lib.pyx b/pandas/_libs/lib.pyx index 2681115bbdcfb..859cb8e5ebead 100644 --- a/pandas/_libs/lib.pyx +++ b/pandas/_libs/lib.pyx @@ -2682,11 +2682,9 @@ def maybe_convert_objects(ndarray[object] objects, elif seen.str_: if using_pyarrow_string_dtype() and is_string_array(objects, skipna=True): - import pyarrow as pa + from pandas.core.arrays.string_ import StringDtype - from pandas.core.dtypes.dtypes import ArrowDtype - - dtype = ArrowDtype(pa.string()) + dtype = StringDtype(storage="pyarrow_numpy") return dtype.construct_array_type()._from_sequence(objects, dtype=dtype) seen.object_ = True diff --git a/pandas/core/construction.py b/pandas/core/construction.py index f733ba3b445fd..aaac0dc73486f 100644 --- a/pandas/core/construction.py +++ b/pandas/core/construction.py @@ -51,10 +51,7 @@ is_object_dtype, pandas_dtype, ) -from pandas.core.dtypes.dtypes import ( - ArrowDtype, - NumpyEADtype, -) +from pandas.core.dtypes.dtypes import NumpyEADtype from pandas.core.dtypes.generic import ( ABCDataFrame, ABCExtensionArray, @@ -595,9 +592,9 @@ def sanitize_array( if data.dtype == object: subarr = maybe_infer_to_datetimelike(data) elif data.dtype.kind == "U" and using_pyarrow_string_dtype(): - import pyarrow as pa + from pandas.core.arrays.string_ import StringDtype - dtype = ArrowDtype(pa.string()) + dtype = StringDtype(storage="pyarrow_numpy") subarr = dtype.construct_array_type()._from_sequence(data, dtype=dtype) if subarr is data and copy: diff --git a/pandas/core/dtypes/cast.py b/pandas/core/dtypes/cast.py index aa228191adc62..1d5db123068e2 100644 --- a/pandas/core/dtypes/cast.py +++ b/pandas/core/dtypes/cast.py @@ -799,10 +799,9 @@ def infer_dtype_from_scalar(val) -> tuple[DtypeObj, Any]: dtype = _dtype_obj if using_pyarrow_string_dtype(): - import pyarrow as pa + from pandas.core.arrays.string_ import StringDtype - pa_dtype = pa.string() - dtype = ArrowDtype(pa_dtype) + dtype = StringDtype(storage="pyarrow_numpy") elif isinstance(val, (np.datetime64, dt.datetime)): try: diff --git a/pandas/core/internals/construction.py b/pandas/core/internals/construction.py index f9f9e6d053b5f..5c8873d4324e0 100644 --- a/pandas/core/internals/construction.py +++ b/pandas/core/internals/construction.py @@ -32,10 +32,7 @@ is_named_tuple, is_object_dtype, ) -from pandas.core.dtypes.dtypes import ( - ArrowDtype, - ExtensionDtype, -) +from pandas.core.dtypes.dtypes import ExtensionDtype from pandas.core.dtypes.generic import ( ABCDataFrame, ABCSeries, @@ -379,10 +376,9 @@ def ndarray_to_mgr( nb = new_block_2d(values, placement=bp, refs=refs) block_values = [nb] elif dtype is None and values.dtype.kind == "U" and using_pyarrow_string_dtype(): - import pyarrow as pa + dtype = StringDtype(storage="pyarrow_numpy") obj_columns = list(values) - dtype = ArrowDtype(pa.string()) block_values = [ new_block( dtype.construct_array_type()._from_sequence(data, dtype=dtype), diff --git a/pandas/io/_util.py b/pandas/io/_util.py index 27316b3ab0af0..915595833468d 100644 --- a/pandas/io/_util.py +++ b/pandas/io/_util.py @@ -28,4 +28,4 @@ def _arrow_dtype_mapping() -> dict: def arrow_string_types_mapper() -> Callable: pa = import_optional_dependency("pyarrow") - return {pa.string(): pd.ArrowDtype(pa.string())}.get + return {pa.string(): pd.StringDtype(storage="pyarrow_numpy")}.get diff --git a/pandas/io/pytables.py b/pandas/io/pytables.py index 89c3f7bbc4f84..fb0354ef9df6c 100644 --- a/pandas/io/pytables.py +++ b/pandas/io/pytables.py @@ -68,7 +68,6 @@ ) from pandas.core.dtypes.missing import array_equivalent -import pandas as pd from pandas import ( DataFrame, DatetimeIndex, @@ -3224,9 +3223,7 @@ def read( values = self.read_array("values", start=start, stop=stop) result = Series(values, index=index, name=self.name, copy=False) if using_pyarrow_string_dtype() and is_string_array(values, skipna=True): - import pyarrow as pa - - result = result.astype(pd.ArrowDtype(pa.string())) + result = result.astype("string[pyarrow_numpy]") return result # error: Signature of "write" incompatible with supertype "Fixed" @@ -3296,9 +3293,7 @@ def read( columns = items[items.get_indexer(blk_items)] df = DataFrame(values.T, columns=columns, index=axes[1], copy=False) if using_pyarrow_string_dtype() and is_string_array(values, skipna=True): - import pyarrow as pa - - df = df.astype(pd.ArrowDtype(pa.string())) + df = df.astype("string[pyarrow_numpy]") dfs.append(df) if len(dfs) > 0: @@ -4686,9 +4681,7 @@ def read( values, # type: ignore[arg-type] skipna=True, ): - import pyarrow as pa - - df = df.astype(pd.ArrowDtype(pa.string())) + df = df.astype("string[pyarrow_numpy]") frames.append(df) if len(frames) == 1: diff --git a/pandas/tests/frame/test_constructors.py b/pandas/tests/frame/test_constructors.py index 63cddb7f192e6..a8ab3ce1ba014 100644 --- a/pandas/tests/frame/test_constructors.py +++ b/pandas/tests/frame/test_constructors.py @@ -2685,8 +2685,8 @@ def test_construct_with_strings_and_none(self): def test_frame_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = DataFrame( {"a": ["a", "b"]}, dtype=dtype, columns=Index(["a"], dtype=dtype) ) @@ -2720,8 +2720,8 @@ def test_frame_string_inference(self): def test_frame_string_inference_array_string_dtype(self): # GH#54496 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = DataFrame( {"a": ["a", "b"]}, dtype=dtype, columns=Index(["a"], dtype=dtype) ) diff --git a/pandas/tests/indexes/base_class/test_constructors.py b/pandas/tests/indexes/base_class/test_constructors.py index 638124ac20e06..60abbfc441e8e 100644 --- a/pandas/tests/indexes/base_class/test_constructors.py +++ b/pandas/tests/indexes/base_class/test_constructors.py @@ -46,8 +46,8 @@ def test_construct_empty_tuples(self, tuple_list): def test_index_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = Index(["a", "b"], dtype=dtype) with pd.option_context("future.infer_string", True): ser = Index(["a", "b"]) diff --git a/pandas/tests/io/json/test_pandas.py b/pandas/tests/io/json/test_pandas.py index 4ee9e1e2d1598..ca3ce6ba34515 100644 --- a/pandas/tests/io/json/test_pandas.py +++ b/pandas/tests/io/json/test_pandas.py @@ -2095,7 +2095,7 @@ def test_pyarrow_engine_lines_false(): def test_json_roundtrip_string_inference(orient): - pa = pytest.importorskip("pyarrow") + pytest.importorskip("pyarrow") df = DataFrame( [["a", "b"], ["c", "d"]], index=["row 1", "row 2"], columns=["col 1", "col 2"] ) @@ -2104,9 +2104,9 @@ def test_json_roundtrip_string_inference(orient): result = read_json(StringIO(out)) expected = DataFrame( [["a", "b"], ["c", "d"]], - dtype=pd.ArrowDtype(pa.string()), - index=pd.Index(["row 1", "row 2"], dtype=pd.ArrowDtype(pa.string())), - columns=pd.Index(["col 1", "col 2"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + index=pd.Index(["row 1", "row 2"], dtype="string[pyarrow_numpy]"), + columns=pd.Index(["col 1", "col 2"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/parser/dtypes/test_dtypes_basic.py b/pandas/tests/io/parser/dtypes/test_dtypes_basic.py index 1c0f0939029ff..8494c5d58171b 100644 --- a/pandas/tests/io/parser/dtypes/test_dtypes_basic.py +++ b/pandas/tests/io/parser/dtypes/test_dtypes_basic.py @@ -542,8 +542,8 @@ def test_ea_int_avoid_overflow(all_parsers): def test_string_inference(all_parsers): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" data = """a,b x,1 diff --git a/pandas/tests/io/pytables/test_read.py b/pandas/tests/io/pytables/test_read.py index 72fc2361c5053..9b4590ca3f01f 100644 --- a/pandas/tests/io/pytables/test_read.py +++ b/pandas/tests/io/pytables/test_read.py @@ -392,7 +392,7 @@ def test_read_py2_hdf_file_in_py3(datapath): def test_read_infer_string(tmp_path, setup_path): # GH#54431 - pa = pytest.importorskip("pyarrow") + pytest.importorskip("pyarrow") df = DataFrame({"a": ["a", "b", None]}) path = tmp_path / setup_path df.to_hdf(path, key="data", format="table") @@ -400,7 +400,7 @@ def test_read_infer_string(tmp_path, setup_path): result = read_hdf(path, key="data", mode="r") expected = DataFrame( {"a": ["a", "b", None]}, - dtype=pd.ArrowDtype(pa.string()), - columns=Index(["a"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + columns=Index(["a"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_feather.py b/pandas/tests/io/test_feather.py index a0fee6751bf53..cf43203466ef4 100644 --- a/pandas/tests/io/test_feather.py +++ b/pandas/tests/io/test_feather.py @@ -222,14 +222,10 @@ def test_invalid_dtype_backend(self): def test_string_inference(self, tmp_path): # GH#54431 - import pyarrow as pa - path = tmp_path / "test_string_inference.p" df = pd.DataFrame(data={"a": ["x", "y"]}) df.to_feather(path) with pd.option_context("future.infer_string", True): result = read_feather(path) - expected = pd.DataFrame( - data={"a": ["x", "y"]}, dtype=pd.ArrowDtype(pa.string()) - ) + expected = pd.DataFrame(data={"a": ["x", "y"]}, dtype="string[pyarrow_numpy]") tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_orc.py b/pandas/tests/io/test_orc.py index c2d791ba24c87..d90f803f1e607 100644 --- a/pandas/tests/io/test_orc.py +++ b/pandas/tests/io/test_orc.py @@ -426,7 +426,7 @@ def test_string_inference(tmp_path): result = read_orc(path) expected = pd.DataFrame( data={"a": ["x", "y"]}, - dtype=pd.ArrowDtype(pa.string()), - columns=pd.Index(["a"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + columns=pd.Index(["a"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_parquet.py b/pandas/tests/io/test_parquet.py index 9182e4c4e7674..6ca71b9507322 100644 --- a/pandas/tests/io/test_parquet.py +++ b/pandas/tests/io/test_parquet.py @@ -1113,8 +1113,6 @@ def test_df_attrs_persistence(self, tmp_path, pa): def test_string_inference(self, tmp_path, pa): # GH#54431 - import pyarrow as pa - path = tmp_path / "test_string_inference.p" df = pd.DataFrame(data={"a": ["x", "y"]}, index=["a", "b"]) df.to_parquet(path, engine="pyarrow") @@ -1122,8 +1120,8 @@ def test_string_inference(self, tmp_path, pa): result = read_parquet(path, engine="pyarrow") expected = pd.DataFrame( data={"a": ["x", "y"]}, - dtype=pd.ArrowDtype(pa.string()), - index=pd.Index(["a", "b"], dtype=pd.ArrowDtype(pa.string())), + dtype="string[pyarrow_numpy]", + index=pd.Index(["a", "b"], dtype="string[pyarrow_numpy]"), ) tm.assert_frame_equal(result, expected) diff --git a/pandas/tests/io/test_sql.py b/pandas/tests/io/test_sql.py index 02736406e109b..2f446e6b8c81d 100644 --- a/pandas/tests/io/test_sql.py +++ b/pandas/tests/io/test_sql.py @@ -2946,7 +2946,7 @@ def test_read_sql_dtype_backend_table(self, string_storage, func): def test_read_sql_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") + pytest.importorskip("pyarrow") table = "test" df = DataFrame({"a": ["x", "y"]}) df.to_sql(table, con=self.conn, index=False, if_exists="replace") @@ -2954,7 +2954,7 @@ def test_read_sql_string_inference(self): with pd.option_context("future.infer_string", True): result = read_sql_table(table, self.conn) - dtype = pd.ArrowDtype(pa.string()) + dtype = "string[pyarrow_numpy]" expected = DataFrame( {"a": ["x", "y"]}, dtype=dtype, columns=Index(["a"], dtype=dtype) ) diff --git a/pandas/tests/series/test_constructors.py b/pandas/tests/series/test_constructors.py index 97bd8633954d8..ef734e9664844 100644 --- a/pandas/tests/series/test_constructors.py +++ b/pandas/tests/series/test_constructors.py @@ -2077,8 +2077,8 @@ def test_series_from_index_dtype_equal_does_not_copy(self): def test_series_string_inference(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = Series(["a", "b"], dtype=dtype) with pd.option_context("future.infer_string", True): ser = Series(["a", "b"]) @@ -2092,8 +2092,8 @@ def test_series_string_inference(self): @pytest.mark.parametrize("na_value", [None, np.nan, pd.NA]) def test_series_string_with_na_inference(self, na_value): # GH#54430 - pa = pytest.importorskip("pyarrow") - dtype = pd.ArrowDtype(pa.string()) + pytest.importorskip("pyarrow") + dtype = "string[pyarrow_numpy]" expected = Series(["a", na_value], dtype=dtype) with pd.option_context("future.infer_string", True): ser = Series(["a", na_value]) @@ -2101,16 +2101,16 @@ def test_series_string_with_na_inference(self, na_value): def test_series_string_inference_scalar(self): # GH#54430 - pa = pytest.importorskip("pyarrow") - expected = Series("a", index=[1], dtype=pd.ArrowDtype(pa.string())) + pytest.importorskip("pyarrow") + expected = Series("a", index=[1], dtype="string[pyarrow_numpy]") with pd.option_context("future.infer_string", True): ser = Series("a", index=[1]) tm.assert_series_equal(ser, expected) def test_series_string_inference_array_string_dtype(self): # GH#54496 - pa = pytest.importorskip("pyarrow") - expected = Series(["a", "b"], dtype=pd.ArrowDtype(pa.string())) + pytest.importorskip("pyarrow") + expected = Series(["a", "b"], dtype="string[pyarrow_numpy]") with pd.option_context("future.infer_string", True): ser = Series(np.array(["a", "b"])) tm.assert_series_equal(ser, expected)
- [x] closes #54724 (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature. Follow-up on https://github.com/pandas-dev/pandas/pull/54533#issuecomment-1686137395 Context: https://github.com/pandas-dev/pandas/issues/54792
https://api.github.com/repos/pandas-dev/pandas/pulls/54720
2023-08-23T21:58:39Z
2023-08-24T19:30:03Z
2023-08-24T19:30:03Z
2023-08-28T09:48:30Z
TST: clean ups in extension tests
diff --git a/pandas/tests/extension/base/accumulate.py b/pandas/tests/extension/base/accumulate.py index 776ff80cd6e17..9a41a3a582c4a 100644 --- a/pandas/tests/extension/base/accumulate.py +++ b/pandas/tests/extension/base/accumulate.py @@ -23,14 +23,6 @@ def check_accumulate(self, ser: pd.Series, op_name: str, skipna: bool): alt = ser.astype(object) result = getattr(ser, op_name)(skipna=skipna) - - if result.dtype == pd.Float32Dtype() and op_name == "cumprod" and skipna: - # TODO: avoid special-casing here - pytest.skip( - f"Float32 precision lead to large differences with op {op_name} " - f"and skipna={skipna}" - ) - expected = getattr(alt, op_name)(skipna=skipna) tm.assert_series_equal(result, expected, check_dtype=False) diff --git a/pandas/tests/extension/base/constructors.py b/pandas/tests/extension/base/constructors.py index 8828f33b7c62c..7215e910365cf 100644 --- a/pandas/tests/extension/base/constructors.py +++ b/pandas/tests/extension/base/constructors.py @@ -35,7 +35,8 @@ def test_series_constructor(self, data): if hasattr(result._mgr, "blocks"): assert isinstance(result2._mgr.blocks[0], EABackedBlock) - def test_series_constructor_no_data_with_index(self, dtype, na_value): + def test_series_constructor_no_data_with_index(self, dtype): + na_value = dtype.na_value result = pd.Series(index=[1, 2, 3], dtype=dtype) expected = pd.Series([na_value] * 3, index=[1, 2, 3], dtype=dtype) tm.assert_series_equal(result, expected) @@ -45,7 +46,8 @@ def test_series_constructor_no_data_with_index(self, dtype, na_value): expected = pd.Series([], index=pd.Index([], dtype="object"), dtype=dtype) tm.assert_series_equal(result, expected) - def test_series_constructor_scalar_na_with_index(self, dtype, na_value): + def test_series_constructor_scalar_na_with_index(self, dtype): + na_value = dtype.na_value result = pd.Series(na_value, index=[1, 2, 3], dtype=dtype) expected = pd.Series([na_value] * 3, index=[1, 2, 3], dtype=dtype) tm.assert_series_equal(result, expected) diff --git a/pandas/tests/extension/base/getitem.py b/pandas/tests/extension/base/getitem.py index 5f0c1b960a475..be16a105384c6 100644 --- a/pandas/tests/extension/base/getitem.py +++ b/pandas/tests/extension/base/getitem.py @@ -148,7 +148,8 @@ def test_getitem_invalid(self, data): with pytest.raises(IndexError, match=msg): data[-ub - 1] - def test_getitem_scalar_na(self, data_missing, na_cmp, na_value): + def test_getitem_scalar_na(self, data_missing, na_cmp): + na_value = data_missing.dtype.na_value result = data_missing[0] assert na_cmp(result, na_value) @@ -348,7 +349,8 @@ def test_take_sequence(self, data): assert result.iloc[1] == data[1] assert result.iloc[2] == data[3] - def test_take(self, data, na_value, na_cmp): + def test_take(self, data, na_cmp): + na_value = data.dtype.na_value result = data.take([0, -1]) assert result.dtype == data.dtype assert result[0] == data[0] @@ -361,7 +363,8 @@ def test_take(self, data, na_value, na_cmp): with pytest.raises(IndexError, match="out of bounds"): data.take([len(data) + 1]) - def test_take_empty(self, data, na_value, na_cmp): + def test_take_empty(self, data, na_cmp): + na_value = data.dtype.na_value empty = data[:0] result = empty.take([-1], allow_fill=True) @@ -393,7 +396,8 @@ def test_take_non_na_fill_value(self, data_missing): expected = arr.take([1, 1]) tm.assert_extension_array_equal(result, expected) - def test_take_pandas_style_negative_raises(self, data, na_value): + def test_take_pandas_style_negative_raises(self, data): + na_value = data.dtype.na_value with pytest.raises(ValueError, match=""): data.take([0, -2], fill_value=na_value, allow_fill=True) @@ -413,7 +417,8 @@ def test_take_series(self, data): ) tm.assert_series_equal(result, expected) - def test_reindex(self, data, na_value): + def test_reindex(self, data): + na_value = data.dtype.na_value s = pd.Series(data) result = s.reindex([0, 1, 3]) expected = pd.Series(data.take([0, 1, 3]), index=[0, 1, 3]) diff --git a/pandas/tests/extension/base/methods.py b/pandas/tests/extension/base/methods.py index 16059155a7a8f..4e0bc8d804bab 100644 --- a/pandas/tests/extension/base/methods.py +++ b/pandas/tests/extension/base/methods.py @@ -121,7 +121,7 @@ def test_argsort_missing(self, data_missing_for_sorting): expected = pd.Series(np.array([1, -1, 0], dtype=np.intp)) tm.assert_series_equal(result, expected) - def test_argmin_argmax(self, data_for_sorting, data_missing_for_sorting, na_value): + def test_argmin_argmax(self, data_for_sorting, data_missing_for_sorting): # GH 24382 is_bool = data_for_sorting.dtype._is_boolean @@ -154,9 +154,10 @@ def test_argmin_argmax_empty_array(self, method, data): getattr(data[:0], method)() @pytest.mark.parametrize("method", ["argmax", "argmin"]) - def test_argmin_argmax_all_na(self, method, data, na_value): + def test_argmin_argmax_all_na(self, method, data): # all missing with skipna=True is the same as empty err_msg = "attempt to get" + na_value = data.dtype.na_value data_na = type(data)._from_sequence([na_value, na_value], dtype=data.dtype) with pytest.raises(ValueError, match=err_msg): getattr(data_na, method)() @@ -543,7 +544,8 @@ def _test_searchsorted_bool_dtypes(self, data_for_sorting, as_series): sorter = np.array([1, 0]) assert data_for_sorting.searchsorted(a, sorter=sorter) == 0 - def test_where_series(self, data, na_value, as_frame): + def test_where_series(self, data, as_frame): + na_value = data.dtype.na_value assert data[0] != data[1] cls = type(data) a, b = data[:2] @@ -670,7 +672,8 @@ def test_insert_invalid_loc(self, data): data.insert(1.5, data[0]) @pytest.mark.parametrize("box", [pd.array, pd.Series, pd.DataFrame]) - def test_equals(self, data, na_value, as_series, box): + def test_equals(self, data, as_series, box): + na_value = data.dtype.na_value data2 = type(data)._from_sequence([data[0]] * len(data), dtype=data.dtype) data_na = type(data)._from_sequence([na_value] * len(data), dtype=data.dtype) diff --git a/pandas/tests/extension/base/ops.py b/pandas/tests/extension/base/ops.py index d5eb65ec9d35d..d2aa4bd63c428 100644 --- a/pandas/tests/extension/base/ops.py +++ b/pandas/tests/extension/base/ops.py @@ -5,6 +5,8 @@ import numpy as np import pytest +from pandas.core.dtypes.common import is_string_dtype + import pandas as pd import pandas._testing as tm from pandas.core import ops @@ -128,12 +130,18 @@ class BaseArithmeticOpsTests(BaseOpsUtil): def test_arith_series_with_scalar(self, data, all_arithmetic_operators): # series & scalar + if all_arithmetic_operators == "__rmod__" and is_string_dtype(data.dtype): + pytest.skip("Skip testing Python string formatting") + op_name = all_arithmetic_operators ser = pd.Series(data) self.check_opname(ser, op_name, ser.iloc[0]) def test_arith_frame_with_scalar(self, data, all_arithmetic_operators): # frame & scalar + if all_arithmetic_operators == "__rmod__" and is_string_dtype(data.dtype): + pytest.skip("Skip testing Python string formatting") + op_name = all_arithmetic_operators df = pd.DataFrame({"A": data}) self.check_opname(df, op_name, data[0]) diff --git a/pandas/tests/extension/base/reshaping.py b/pandas/tests/extension/base/reshaping.py index a9bd12917e73e..13ab56adfe914 100644 --- a/pandas/tests/extension/base/reshaping.py +++ b/pandas/tests/extension/base/reshaping.py @@ -72,7 +72,8 @@ def test_concat_mixed_dtypes(self, data): expected = pd.concat([df1["A"].astype("object"), df2["A"].astype("object")]) tm.assert_series_equal(result, expected) - def test_concat_columns(self, data, na_value): + def test_concat_columns(self, data): + na_value = data.dtype.na_value df1 = pd.DataFrame({"A": data[:3]}) df2 = pd.DataFrame({"B": [1, 2, 3]}) @@ -96,8 +97,9 @@ def test_concat_columns(self, data, na_value): result = pd.concat([df1["A"], df2["B"]], axis=1) tm.assert_frame_equal(result, expected) - def test_concat_extension_arrays_copy_false(self, data, na_value): + def test_concat_extension_arrays_copy_false(self, data): # GH 20756 + na_value = data.dtype.na_value df1 = pd.DataFrame({"A": data[:3]}) df2 = pd.DataFrame({"B": data[3:7]}) expected = pd.DataFrame( @@ -122,7 +124,8 @@ def test_concat_with_reindex(self, data): ) tm.assert_frame_equal(result, expected) - def test_align(self, data, na_value): + def test_align(self, data): + na_value = data.dtype.na_value a = data[:3] b = data[2:5] r1, r2 = pd.Series(a).align(pd.Series(b, index=[1, 2, 3])) @@ -133,7 +136,8 @@ def test_align(self, data, na_value): tm.assert_series_equal(r1, e1) tm.assert_series_equal(r2, e2) - def test_align_frame(self, data, na_value): + def test_align_frame(self, data): + na_value = data.dtype.na_value a = data[:3] b = data[2:5] r1, r2 = pd.DataFrame({"A": a}).align(pd.DataFrame({"A": b}, index=[1, 2, 3])) @@ -148,8 +152,9 @@ def test_align_frame(self, data, na_value): tm.assert_frame_equal(r1, e1) tm.assert_frame_equal(r2, e2) - def test_align_series_frame(self, data, na_value): + def test_align_series_frame(self, data): # https://github.com/pandas-dev/pandas/issues/20576 + na_value = data.dtype.na_value ser = pd.Series(data, name="a") df = pd.DataFrame({"col": np.arange(len(ser) + 1)}) r1, r2 = ser.align(df) @@ -180,7 +185,7 @@ def test_set_frame_overwrite_object(self, data): df["A"] = data assert df.dtypes["A"] == data.dtype - def test_merge(self, data, na_value): + def test_merge(self, data): # GH-20743 df1 = pd.DataFrame({"ext": data[:3], "int1": [1, 2, 3], "key": [0, 1, 2]}) df2 = pd.DataFrame({"int2": [1, 2, 3, 4], "key": [0, 0, 1, 3]}) @@ -205,7 +210,8 @@ def test_merge(self, data, na_value): "int2": [1, 2, 3, np.nan, 4], "key": [0, 0, 1, 2, 3], "ext": data._from_sequence( - [data[0], data[0], data[1], data[2], na_value], dtype=data.dtype + [data[0], data[0], data[1], data[2], data.dtype.na_value], + dtype=data.dtype, ), } ) diff --git a/pandas/tests/extension/base/setitem.py b/pandas/tests/extension/base/setitem.py index fd90635deffac..c975138837e6b 100644 --- a/pandas/tests/extension/base/setitem.py +++ b/pandas/tests/extension/base/setitem.py @@ -359,7 +359,8 @@ def test_setitem_with_expansion_dataframe_column(self, data, full_indexer): tm.assert_frame_equal(result, expected) - def test_setitem_with_expansion_row(self, data, na_value): + def test_setitem_with_expansion_row(self, data): + na_value = data.dtype.na_value df = pd.DataFrame({"data": data[:1]}) df.loc[1, "data"] = data[1] diff --git a/pandas/tests/extension/conftest.py b/pandas/tests/extension/conftest.py index 7b7945b15ed83..eb60aea7cc8c2 100644 --- a/pandas/tests/extension/conftest.py +++ b/pandas/tests/extension/conftest.py @@ -116,12 +116,6 @@ def na_cmp(): return operator.is_ -@pytest.fixture -def na_value(dtype): - """The scalar missing value for this type. Default dtype.na_value""" - return dtype.na_value - - @pytest.fixture def data_for_grouping(): """ diff --git a/pandas/tests/extension/json/test_json.py b/pandas/tests/extension/json/test_json.py index 9e1a4fb5da251..68a27a28b160f 100644 --- a/pandas/tests/extension/json/test_json.py +++ b/pandas/tests/extension/json/test_json.py @@ -97,24 +97,24 @@ def test_from_dtype(self, data): super().test_from_dtype(data) @pytest.mark.xfail(reason="RecursionError, GH-33900") - def test_series_constructor_no_data_with_index(self, dtype, na_value): + def test_series_constructor_no_data_with_index(self, dtype): # RecursionError: maximum recursion depth exceeded in comparison rec_limit = sys.getrecursionlimit() try: # Limit to avoid stack overflow on Windows CI sys.setrecursionlimit(100) - super().test_series_constructor_no_data_with_index(dtype, na_value) + super().test_series_constructor_no_data_with_index(dtype) finally: sys.setrecursionlimit(rec_limit) @pytest.mark.xfail(reason="RecursionError, GH-33900") - def test_series_constructor_scalar_na_with_index(self, dtype, na_value): + def test_series_constructor_scalar_na_with_index(self, dtype): # RecursionError: maximum recursion depth exceeded in comparison rec_limit = sys.getrecursionlimit() try: # Limit to avoid stack overflow on Windows CI sys.setrecursionlimit(100) - super().test_series_constructor_scalar_na_with_index(dtype, na_value) + super().test_series_constructor_scalar_na_with_index(dtype) finally: sys.setrecursionlimit(rec_limit) @@ -214,19 +214,19 @@ def test_combine_first(self, data): super().test_combine_first(data) @pytest.mark.xfail(reason="broadcasting error") - def test_where_series(self, data, na_value): + def test_where_series(self, data): # Fails with # *** ValueError: operands could not be broadcast together # with shapes (4,) (4,) (0,) - super().test_where_series(data, na_value) + super().test_where_series(data) @pytest.mark.xfail(reason="Can't compare dicts.") def test_searchsorted(self, data_for_sorting): super().test_searchsorted(data_for_sorting) @pytest.mark.xfail(reason="Can't compare dicts.") - def test_equals(self, data, na_value, as_series): - super().test_equals(data, na_value, as_series) + def test_equals(self, data, as_series): + super().test_equals(data, as_series) @pytest.mark.skip("fill-value is interpreted as a dict of values") def test_fillna_copy_frame(self, data_missing): diff --git a/pandas/tests/extension/test_arrow.py b/pandas/tests/extension/test_arrow.py index 890ffd6dfbdd9..cb79539cd2bd1 100644 --- a/pandas/tests/extension/test_arrow.py +++ b/pandas/tests/extension/test_arrow.py @@ -518,9 +518,7 @@ def test_reduce_series_numeric(self, data, all_numeric_reductions, skipna, reque super().test_reduce_series_numeric(data, all_numeric_reductions, skipna) @pytest.mark.parametrize("skipna", [True, False]) - def test_reduce_series_boolean( - self, data, all_boolean_reductions, skipna, na_value, request - ): + def test_reduce_series_boolean(self, data, all_boolean_reductions, skipna, request): pa_dtype = data.dtype.pyarrow_dtype xfail_mark = pytest.mark.xfail( raises=TypeError, @@ -753,9 +751,7 @@ def test_value_counts_returns_pyarrow_int64(self, data): result = data.value_counts() assert result.dtype == ArrowDtype(pa.int64()) - def test_argmin_argmax( - self, data_for_sorting, data_missing_for_sorting, na_value, request - ): + def test_argmin_argmax(self, data_for_sorting, data_missing_for_sorting, request): pa_dtype = data_for_sorting.dtype.pyarrow_dtype if pa.types.is_decimal(pa_dtype) and pa_version_under7p0: request.node.add_marker( @@ -764,7 +760,7 @@ def test_argmin_argmax( raises=pa.ArrowNotImplementedError, ) ) - super().test_argmin_argmax(data_for_sorting, data_missing_for_sorting, na_value) + super().test_argmin_argmax(data_for_sorting, data_missing_for_sorting) @pytest.mark.parametrize( "op_name, skipna, expected", @@ -1033,9 +1029,7 @@ def _get_arith_xfail_marker(self, opname, pa_dtype): def test_arith_series_with_scalar(self, data, all_arithmetic_operators, request): pa_dtype = data.dtype.pyarrow_dtype - if all_arithmetic_operators == "__rmod__" and ( - pa.types.is_string(pa_dtype) or pa.types.is_binary(pa_dtype) - ): + if all_arithmetic_operators == "__rmod__" and (pa.types.is_binary(pa_dtype)): pytest.skip("Skip testing Python string formatting") mark = self._get_arith_xfail_marker(all_arithmetic_operators, pa_dtype) diff --git a/pandas/tests/extension/test_categorical.py b/pandas/tests/extension/test_categorical.py index 79b8e9ddbf8f5..82b6c54bc3106 100644 --- a/pandas/tests/extension/test_categorical.py +++ b/pandas/tests/extension/test_categorical.py @@ -165,14 +165,14 @@ def test_arith_series_with_scalar(self, data, all_arithmetic_operators, request) ) super().test_arith_series_with_scalar(data, op_name) - def _compare_other(self, s, data, op, other): + def _compare_other(self, ser: pd.Series, data, op, other): op_name = f"__{op.__name__}__" if op_name not in ["__eq__", "__ne__"]: msg = "Unordered Categoricals can only compare equality or not" with pytest.raises(TypeError, match=msg): op(data, other) else: - return super()._compare_other(s, data, op, other) + return super()._compare_other(ser, data, op, other) @pytest.mark.xfail(reason="Categorical overrides __repr__") @pytest.mark.parametrize("size", ["big", "small"]) diff --git a/pandas/tests/extension/test_masked.py b/pandas/tests/extension/test_masked.py index 7efb8fbad8cd1..f5b0b6f4efa98 100644 --- a/pandas/tests/extension/test_masked.py +++ b/pandas/tests/extension/test_masked.py @@ -323,6 +323,13 @@ def check_accumulate(self, ser: pd.Series, op_name: str, skipna: bool): else: expected_dtype = f"Int{length}" + if expected_dtype == "Float32" and op_name == "cumprod" and skipna: + # TODO: xfail? + pytest.skip( + f"Float32 precision lead to large differences with op {op_name} " + f"and skipna={skipna}" + ) + if op_name == "cumsum": result = getattr(ser, op_name)(skipna=skipna) expected = pd.Series( diff --git a/pandas/tests/extension/test_sparse.py b/pandas/tests/extension/test_sparse.py index 7330e03a57daf..f56dea3f43de7 100644 --- a/pandas/tests/extension/test_sparse.py +++ b/pandas/tests/extension/test_sparse.py @@ -146,29 +146,29 @@ def test_concat_mixed_dtypes(self, data): def test_stack(self, data, columns, future_stack): super().test_stack(data, columns, future_stack) - def test_concat_columns(self, data, na_value): + def test_concat_columns(self, data): self._check_unsupported(data) - super().test_concat_columns(data, na_value) + super().test_concat_columns(data) - def test_concat_extension_arrays_copy_false(self, data, na_value): + def test_concat_extension_arrays_copy_false(self, data): self._check_unsupported(data) - super().test_concat_extension_arrays_copy_false(data, na_value) + super().test_concat_extension_arrays_copy_false(data) - def test_align(self, data, na_value): + def test_align(self, data): self._check_unsupported(data) - super().test_align(data, na_value) + super().test_align(data) - def test_align_frame(self, data, na_value): + def test_align_frame(self, data): self._check_unsupported(data) - super().test_align_frame(data, na_value) + super().test_align_frame(data) - def test_align_series_frame(self, data, na_value): + def test_align_series_frame(self, data): self._check_unsupported(data) - super().test_align_series_frame(data, na_value) + super().test_align_series_frame(data) - def test_merge(self, data, na_value): + def test_merge(self, data): self._check_unsupported(data) - super().test_merge(data, na_value) + super().test_merge(data) class TestGetitem(BaseSparseTests, base.BaseGetitemTests): @@ -180,9 +180,9 @@ def test_get(self, data): assert ser.get(4) == ser.iloc[2] assert ser.get(2) == ser.iloc[1] - def test_reindex(self, data, na_value): + def test_reindex(self, data): self._check_unsupported(data) - super().test_reindex(data, na_value) + super().test_reindex(data) class TestSetitem(BaseSparseTests, base.BaseSetitemTests): @@ -282,7 +282,7 @@ def test_fillna_copy_series(self, data_missing, using_copy_on_write): def test_fillna_length_mismatch(self, data_missing): super().test_fillna_length_mismatch(data_missing) - def test_where_series(self, data, na_value): + def test_where_series(self, data): assert data[0] != data[1] cls = type(data) a, b = data[:2] @@ -293,6 +293,7 @@ def test_where_series(self, data, na_value): result = ser.where(cond) new_dtype = SparseDtype("float", 0.0) + na_value = data.dtype.na_value expected = pd.Series( cls._from_sequence([a, a, na_value, na_value], dtype=new_dtype) ) @@ -316,15 +317,15 @@ def test_shift_0_periods(self, data): assert result._sparse_values[0] != result._sparse_values[1] @pytest.mark.parametrize("method", ["argmax", "argmin"]) - def test_argmin_argmax_all_na(self, method, data, na_value): + def test_argmin_argmax_all_na(self, method, data): # overriding because Sparse[int64, 0] cannot handle na_value self._check_unsupported(data) - super().test_argmin_argmax_all_na(method, data, na_value) + super().test_argmin_argmax_all_na(method, data) @pytest.mark.parametrize("box", [pd.array, pd.Series, pd.DataFrame]) - def test_equals(self, data, na_value, as_series, box): + def test_equals(self, data, as_series, box): self._check_unsupported(data) - super().test_equals(data, na_value, as_series, box) + super().test_equals(data, as_series, box) @pytest.mark.parametrize( "func, na_action, expected",
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54719
2023-08-23T21:48:49Z
2023-08-24T16:21:07Z
2023-08-24T16:21:07Z
2023-08-25T18:26:06Z
DOC: add awkward-pandas to ecosystem page
diff --git a/web/pandas/community/ecosystem.md b/web/pandas/community/ecosystem.md index e9f5c8643b493..561503de416a5 100644 --- a/web/pandas/community/ecosystem.md +++ b/web/pandas/community/ecosystem.md @@ -511,9 +511,16 @@ assumptions about your datasets and check that they're *actually* true. Pandas provides an interface for defining [extension types](https://pandas.pydata.org/docs/development/extending.html#extension-types) to extend NumPy's type system. -The following librariesimplement that interface to provide types not found in NumPy or pandas, +The following libraries implement that interface to provide types not found in NumPy or pandas, which work well with pandas' data containers. +### [awkward-pandas](https://awkward-pandas.readthedocs.io/) + +Awkward-pandas provides an extension type for storing [Awkward +Arrays](https://awkward-array.org/) inside pandas' Series and +DataFrame. It also provides an accessor for using awkward functions +on Series that are of awkward type. + ### [cyberpandas](https://cyberpandas.readthedocs.io/en/latest) Cyberpandas provides an extension type for storing arrays of IP @@ -553,6 +560,7 @@ authors to coordinate on the namespace. | Library | Accessor | Classes | | -------------------------------------------------------------------- | ---------- | --------------------- | + | [awkward-pandas](https://awkward-pandas.readthedocs.io/en/latest/) | `ak` | `Series` | | [cyberpandas](https://cyberpandas.readthedocs.io/en/latest) | `ip` | `Series` | | [pdvega](https://altair-viz.github.io/pdvega/) | `vgplot` | `Series`, `DataFrame` | | [pandas-genomics](https://pandas-genomics.readthedocs.io/en/latest/) | `genomics` | `Series`, `DataFrame` |
We'd love to have [awkward-pandas](https://github.com/intake/awkward-pandas) listed on the ecosystem webpage. (I added the package to the existing lists in alphabetical order, would be happy to reorder) - [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [ ] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54718
2023-08-23T21:26:54Z
2023-08-24T16:22:23Z
2023-08-24T16:22:23Z
2023-08-24T16:33:39Z
CLN: Update vendored packaging Version
diff --git a/pandas/util/version/__init__.py b/pandas/util/version/__init__.py index c72598eb50410..2ff1c256920a8 100644 --- a/pandas/util/version/__init__.py +++ b/pandas/util/version/__init__.py @@ -1,26 +1,23 @@ -# Vendored from https://github.com/pypa/packaging/blob/main/packaging/_structures.py -# and https://github.com/pypa/packaging/blob/main/packaging/_structures.py -# changeset ae891fd74d6dd4c6063bb04f2faeadaac6fc6313 -# 04/30/2021 +# Vendored from +# https://github.com/pypa/packaging/blob/7e68d828f265ef05cf4cd3b5def9baffef8c2968/src/packaging/version.py +# https://github.com/pypa/packaging/blob/7e68d828f265ef05cf4cd3b5def9baffef8c2968/src/packaging/_structures.py +# on 2023-08-23 # This file is dual licensed under the terms of the Apache License, Version -# 2.0, and the BSD License. See the LICENSE file in the root of this repository -# for complete details. +# 2.0, and the BSD License. See LICENSES/PACKAGING_LICENSE from __future__ import annotations -import collections -from collections.abc import Iterator import itertools import re from typing import ( + Any, Callable, + NamedTuple, SupportsInt, - Tuple, Union, ) -import warnings -__all__ = ["parse", "Version", "LegacyVersion", "InvalidVersion", "VERSION_PATTERN"] +__all__ = ["VERSION_PATTERN", "parse", "Version", "InvalidVersion"] class InfinityType: @@ -87,59 +84,57 @@ def __neg__(self: object) -> InfinityType: NegativeInfinity = NegativeInfinityType() -InfiniteTypes = Union[InfinityType, NegativeInfinityType] -PrePostDevType = Union[InfiniteTypes, tuple[str, int]] -SubLocalType = Union[InfiniteTypes, int, str] -LocalType = Union[ +LocalType = tuple[Union[int, str], ...] + +CmpPrePostDevType = Union[InfinityType, NegativeInfinityType, tuple[str, int]] +CmpLocalType = Union[ NegativeInfinityType, - tuple[ - Union[ - SubLocalType, - tuple[SubLocalType, str], - tuple[NegativeInfinityType, SubLocalType], - ], - ..., - ], + tuple[Union[tuple[int, str], tuple[NegativeInfinityType, Union[int, str]]], ...], ] CmpKey = tuple[ - int, tuple[int, ...], PrePostDevType, PrePostDevType, PrePostDevType, LocalType -] -LegacyCmpKey = tuple[int, tuple[str, ...]] -VersionComparisonMethod = Callable[ - [Union[CmpKey, LegacyCmpKey], Union[CmpKey, LegacyCmpKey]], bool + int, + tuple[int, ...], + CmpPrePostDevType, + CmpPrePostDevType, + CmpPrePostDevType, + CmpLocalType, ] +VersionComparisonMethod = Callable[[CmpKey, CmpKey], bool] -_Version = collections.namedtuple( - "_Version", ["epoch", "release", "dev", "pre", "post", "local"] -) +class _Version(NamedTuple): + epoch: int + release: tuple[int, ...] + dev: tuple[str, int] | None + pre: tuple[str, int] | None + post: tuple[str, int] | None + local: LocalType | None -def parse(version: str) -> LegacyVersion | Version: - """ - Parse the given version string and return either a :class:`Version` object - or a :class:`LegacyVersion` object depending on if the given version is - a valid PEP 440 version or a legacy version. + +def parse(version: str) -> Version: + """Parse the given version string. + + >>> parse('1.0.dev1') + <Version('1.0.dev1')> + + :param version: The version string to parse. + :raises InvalidVersion: When the version string is not a valid version. """ - try: - return Version(version) - except InvalidVersion: - return LegacyVersion(version) + return Version(version) class InvalidVersion(ValueError): - """ - An invalid version was found, users should refer to PEP 440. + """Raised when a version string is not a valid version. - Examples - -------- - >>> pd.util.version.Version('1.') + >>> Version("invalid") Traceback (most recent call last): - InvalidVersion: Invalid version: '1.' + ... + packaging.version.InvalidVersion: Invalid version: 'invalid' """ class _BaseVersion: - _key: CmpKey | LegacyCmpKey + _key: tuple[Any, ...] def __hash__(self) -> int: return hash(self._key) @@ -184,132 +179,16 @@ def __ne__(self, other: object) -> bool: return self._key != other._key -class LegacyVersion(_BaseVersion): - def __init__(self, version: str) -> None: - self._version = str(version) - self._key = _legacy_cmpkey(self._version) - - warnings.warn( - "Creating a LegacyVersion has been deprecated and will be " - "removed in the next major release.", - DeprecationWarning, - ) - - def __str__(self) -> str: - return self._version - - def __repr__(self) -> str: - return f"<LegacyVersion('{self}')>" - - @property - def public(self) -> str: - return self._version - - @property - def base_version(self) -> str: - return self._version - - @property - def epoch(self) -> int: - return -1 - - @property - def release(self) -> None: - return None - - @property - def pre(self) -> None: - return None - - @property - def post(self) -> None: - return None - - @property - def dev(self) -> None: - return None - - @property - def local(self) -> None: - return None - - @property - def is_prerelease(self) -> bool: - return False - - @property - def is_postrelease(self) -> bool: - return False - - @property - def is_devrelease(self) -> bool: - return False - - -_legacy_version_component_re = re.compile(r"(\d+ | [a-z]+ | \.| -)", re.VERBOSE) - -_legacy_version_replacement_map = { - "pre": "c", - "preview": "c", - "-": "final-", - "rc": "c", - "dev": "@", -} - - -def _parse_version_parts(s: str) -> Iterator[str]: - for part in _legacy_version_component_re.split(s): - mapped_part = _legacy_version_replacement_map.get(part, part) - - if not mapped_part or mapped_part == ".": - continue - - if mapped_part[:1] in "0123456789": - # pad for numeric comparison - yield mapped_part.zfill(8) - else: - yield "*" + mapped_part - - # ensure that alpha/beta/candidate are before final - yield "*final" - - -def _legacy_cmpkey(version: str) -> LegacyCmpKey: - # We hardcode an epoch of -1 here. A PEP 440 version can only have a epoch - # greater than or equal to 0. This will effectively put the LegacyVersion, - # which uses the defacto standard originally implemented by setuptools, - # as before all PEP 440 versions. - epoch = -1 - - # This scheme is taken from pkg_resources.parse_version setuptools prior to - # it's adoption of the packaging library. - parts: list[str] = [] - for part in _parse_version_parts(version.lower()): - if part.startswith("*"): - # remove "-" before a prerelease tag - if part < "*final": - while parts and parts[-1] == "*final-": - parts.pop() - - # remove trailing zeros from each series of numeric parts - while parts and parts[-1] == "00000000": - parts.pop() - - parts.append(part) - - return epoch, tuple(parts) - - # Deliberately not anchored to the start and end of the string, to make it # easier for 3rd party code to reuse -VERSION_PATTERN = r""" +_VERSION_PATTERN = r""" v? (?: (?:(?P<epoch>[0-9]+)!)? # epoch (?P<release>[0-9]+(?:\.[0-9]+)*) # release segment (?P<pre> # pre-release [-_\.]? - (?P<pre_l>(a|b|c|rc|alpha|beta|pre|preview)) + (?P<pre_l>alpha|a|beta|b|preview|pre|c|rc) [-_\.]? (?P<pre_n>[0-9]+)? )? @@ -333,11 +212,57 @@ def _legacy_cmpkey(version: str) -> LegacyCmpKey: (?:\+(?P<local>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))? # local version """ +VERSION_PATTERN = _VERSION_PATTERN +""" +A string containing the regular expression used to match a valid version. + +The pattern is not anchored at either end, and is intended for embedding in larger +expressions (for example, matching a version number as part of a file name). The +regular expression should be compiled with the ``re.VERBOSE`` and ``re.IGNORECASE`` +flags set. + +:meta hide-value: +""" + class Version(_BaseVersion): + """This class abstracts handling of a project's versions. + + A :class:`Version` instance is comparison aware and can be compared and + sorted using the standard Python interfaces. + + >>> v1 = Version("1.0a5") + >>> v2 = Version("1.0") + >>> v1 + <Version('1.0a5')> + >>> v2 + <Version('1.0')> + >>> v1 < v2 + True + >>> v1 == v2 + False + >>> v1 > v2 + False + >>> v1 >= v2 + False + >>> v1 <= v2 + True + """ + _regex = re.compile(r"^\s*" + VERSION_PATTERN + r"\s*$", re.VERBOSE | re.IGNORECASE) + _key: CmpKey def __init__(self, version: str) -> None: + """Initialize a Version object. + + :param version: + The string representation of a version which will be parsed and normalized + before use. + :raises InvalidVersion: + If the ``version`` does not conform to PEP 440 in any way then this + exception will be raised. + """ + # Validate the version and parse it into pieces match = self._regex.search(version) if not match: @@ -366,9 +291,19 @@ def __init__(self, version: str) -> None: ) def __repr__(self) -> str: + """A representation of the Version that shows all internal state. + + >>> Version('1.0.0') + <Version('1.0.0')> + """ return f"<Version('{self}')>" def __str__(self) -> str: + """A string representation of the version that can be rounded-tripped. + + >>> str(Version("1.0a5")) + '1.0a5' + """ parts = [] # Epoch @@ -376,11 +311,11 @@ def __str__(self) -> str: parts.append(f"{self.epoch}!") # Release segment - parts.append(".".join([str(x) for x in self.release])) + parts.append(".".join(str(x) for x in self.release)) # Pre-release if self.pre is not None: - parts.append("".join([str(x) for x in self.pre])) + parts.append("".join(str(x) for x in self.pre)) # Post-release if self.post is not None: @@ -398,40 +333,109 @@ def __str__(self) -> str: @property def epoch(self) -> int: - _epoch: int = self._version.epoch - return _epoch + """The epoch of the version. + + >>> Version("2.0.0").epoch + 0 + >>> Version("1!2.0.0").epoch + 1 + """ + return self._version.epoch @property def release(self) -> tuple[int, ...]: - _release: tuple[int, ...] = self._version.release - return _release + """The components of the "release" segment of the version. + + >>> Version("1.2.3").release + (1, 2, 3) + >>> Version("2.0.0").release + (2, 0, 0) + >>> Version("1!2.0.0.post0").release + (2, 0, 0) + + Includes trailing zeroes but not the epoch or any pre-release / development / + post-release suffixes. + """ + return self._version.release @property def pre(self) -> tuple[str, int] | None: - _pre: tuple[str, int] | None = self._version.pre - return _pre + """The pre-release segment of the version. + + >>> print(Version("1.2.3").pre) + None + >>> Version("1.2.3a1").pre + ('a', 1) + >>> Version("1.2.3b1").pre + ('b', 1) + >>> Version("1.2.3rc1").pre + ('rc', 1) + """ + return self._version.pre @property def post(self) -> int | None: + """The post-release number of the version. + + >>> print(Version("1.2.3").post) + None + >>> Version("1.2.3.post1").post + 1 + """ return self._version.post[1] if self._version.post else None @property def dev(self) -> int | None: + """The development number of the version. + + >>> print(Version("1.2.3").dev) + None + >>> Version("1.2.3.dev1").dev + 1 + """ return self._version.dev[1] if self._version.dev else None @property def local(self) -> str | None: + """The local version segment of the version. + + >>> print(Version("1.2.3").local) + None + >>> Version("1.2.3+abc").local + 'abc' + """ if self._version.local: - return ".".join([str(x) for x in self._version.local]) + return ".".join(str(x) for x in self._version.local) else: return None @property def public(self) -> str: + """The public portion of the version. + + >>> Version("1.2.3").public + '1.2.3' + >>> Version("1.2.3+abc").public + '1.2.3' + >>> Version("1.2.3+abc.dev1").public + '1.2.3' + """ return str(self).split("+", 1)[0] @property def base_version(self) -> str: + """The "base version" of the version. + + >>> Version("1.2.3").base_version + '1.2.3' + >>> Version("1.2.3+abc").base_version + '1.2.3' + >>> Version("1!1.2.3+abc.dev1").base_version + '1!1.2.3' + + The "base version" is the public version of the project without any pre or post + release markers. + """ parts = [] # Epoch @@ -439,32 +443,78 @@ def base_version(self) -> str: parts.append(f"{self.epoch}!") # Release segment - parts.append(".".join([str(x) for x in self.release])) + parts.append(".".join(str(x) for x in self.release)) return "".join(parts) @property def is_prerelease(self) -> bool: + """Whether this version is a pre-release. + + >>> Version("1.2.3").is_prerelease + False + >>> Version("1.2.3a1").is_prerelease + True + >>> Version("1.2.3b1").is_prerelease + True + >>> Version("1.2.3rc1").is_prerelease + True + >>> Version("1.2.3dev1").is_prerelease + True + """ return self.dev is not None or self.pre is not None @property def is_postrelease(self) -> bool: + """Whether this version is a post-release. + + >>> Version("1.2.3").is_postrelease + False + >>> Version("1.2.3.post1").is_postrelease + True + """ return self.post is not None @property def is_devrelease(self) -> bool: + """Whether this version is a development release. + + >>> Version("1.2.3").is_devrelease + False + >>> Version("1.2.3.dev1").is_devrelease + True + """ return self.dev is not None @property def major(self) -> int: + """The first item of :attr:`release` or ``0`` if unavailable. + + >>> Version("1.2.3").major + 1 + """ return self.release[0] if len(self.release) >= 1 else 0 @property def minor(self) -> int: + """The second item of :attr:`release` or ``0`` if unavailable. + + >>> Version("1.2.3").minor + 2 + >>> Version("1").minor + 0 + """ return self.release[1] if len(self.release) >= 2 else 0 @property def micro(self) -> int: + """The third item of :attr:`release` or ``0`` if unavailable. + + >>> Version("1.2.3").micro + 3 + >>> Version("1").micro + 0 + """ return self.release[2] if len(self.release) >= 3 else 0 @@ -524,7 +574,7 @@ def _cmpkey( pre: tuple[str, int] | None, post: tuple[str, int] | None, dev: tuple[str, int] | None, - local: tuple[SubLocalType] | None, + local: LocalType | None, ) -> CmpKey: # When we compare a release version, we want to compare it with all of the # trailing zeros removed. So we'll use a reverse the list, drop all the now @@ -540,7 +590,7 @@ def _cmpkey( # if there is not a pre or a post segment. If we have one of those then # the normal sorting rules will handle this case correctly. if pre is None and post is None and dev is not None: - _pre: PrePostDevType = NegativeInfinity + _pre: CmpPrePostDevType = NegativeInfinity # Versions without a pre-release (except as noted above) should sort after # those with one. elif pre is None: @@ -550,21 +600,21 @@ def _cmpkey( # Versions without a post segment should sort before those with one. if post is None: - _post: PrePostDevType = NegativeInfinity + _post: CmpPrePostDevType = NegativeInfinity else: _post = post # Versions without a development segment should sort after those with one. if dev is None: - _dev: PrePostDevType = Infinity + _dev: CmpPrePostDevType = Infinity else: _dev = dev if local is None: # Versions without a local segment should sort before those with one. - _local: LocalType = NegativeInfinity + _local: CmpLocalType = NegativeInfinity else: # Versions with a local segment need that segment parsed to implement # the sorting rules in PEP440.
null
https://api.github.com/repos/pandas-dev/pandas/pulls/54716
2023-08-23T17:34:02Z
2023-08-25T00:22:18Z
null
2023-08-25T00:22:21Z
Backport PR #54533 on branch 2.1.x (Implement Arrow String Array that is compatible with NumPy semantics)
diff --git a/pandas/conftest.py b/pandas/conftest.py index 5210e727aeb3c..10826f50d1fe1 100644 --- a/pandas/conftest.py +++ b/pandas/conftest.py @@ -1321,6 +1321,7 @@ def nullable_string_dtype(request): params=[ "python", pytest.param("pyarrow", marks=td.skip_if_no("pyarrow")), + pytest.param("pyarrow_numpy", marks=td.skip_if_no("pyarrow")), ] ) def string_storage(request): @@ -1329,6 +1330,7 @@ def string_storage(request): * 'python' * 'pyarrow' + * 'pyarrow_numpy' """ return request.param @@ -1380,6 +1382,7 @@ def object_dtype(request): "object", "string[python]", pytest.param("string[pyarrow]", marks=td.skip_if_no("pyarrow")), + pytest.param("string[pyarrow_numpy]", marks=td.skip_if_no("pyarrow")), ] ) def any_string_dtype(request): @@ -2000,4 +2003,4 @@ def warsaw(request) -> str: @pytest.fixture() def arrow_string_storage(): - return ("pyarrow",) + return ("pyarrow", "pyarrow_numpy") diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index 48ff769f6c737..c4960f49e3ba5 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -515,7 +515,10 @@ def __getitem__(self, item: PositionalIndexer): if isinstance(item, np.ndarray): if not len(item): # Removable once we migrate StringDtype[pyarrow] to ArrowDtype[string] - if self._dtype.name == "string" and self._dtype.storage == "pyarrow": + if self._dtype.name == "string" and self._dtype.storage in ( + "pyarrow", + "pyarrow_numpy", + ): pa_dtype = pa.string() else: pa_dtype = self._dtype.pyarrow_dtype diff --git a/pandas/core/arrays/string_.py b/pandas/core/arrays/string_.py index 25f1c2ec6ce4f..1e285f90e9fea 100644 --- a/pandas/core/arrays/string_.py +++ b/pandas/core/arrays/string_.py @@ -76,7 +76,7 @@ class StringDtype(StorageExtensionDtype): Parameters ---------- - storage : {"python", "pyarrow"}, optional + storage : {"python", "pyarrow", "pyarrow_numpy"}, optional If not given, the value of ``pd.options.mode.string_storage``. Attributes @@ -108,11 +108,11 @@ def na_value(self) -> libmissing.NAType: def __init__(self, storage=None) -> None: if storage is None: storage = get_option("mode.string_storage") - if storage not in {"python", "pyarrow"}: + if storage not in {"python", "pyarrow", "pyarrow_numpy"}: raise ValueError( f"Storage must be 'python' or 'pyarrow'. Got {storage} instead." ) - if storage == "pyarrow" and pa_version_under7p0: + if storage in ("pyarrow", "pyarrow_numpy") and pa_version_under7p0: raise ImportError( "pyarrow>=7.0.0 is required for PyArrow backed StringArray." ) @@ -160,6 +160,8 @@ def construct_from_string(cls, string): return cls(storage="python") elif string == "string[pyarrow]": return cls(storage="pyarrow") + elif string == "string[pyarrow_numpy]": + return cls(storage="pyarrow_numpy") else: raise TypeError(f"Cannot construct a '{cls.__name__}' from '{string}'") @@ -176,12 +178,17 @@ def construct_array_type( # type: ignore[override] ------- type """ - from pandas.core.arrays.string_arrow import ArrowStringArray + from pandas.core.arrays.string_arrow import ( + ArrowStringArray, + ArrowStringArrayNumpySemantics, + ) if self.storage == "python": return StringArray - else: + elif self.storage == "pyarrow": return ArrowStringArray + else: + return ArrowStringArrayNumpySemantics def __from_arrow__( self, array: pyarrow.Array | pyarrow.ChunkedArray @@ -193,6 +200,10 @@ def __from_arrow__( from pandas.core.arrays.string_arrow import ArrowStringArray return ArrowStringArray(array) + elif self.storage == "pyarrow_numpy": + from pandas.core.arrays.string_arrow import ArrowStringArrayNumpySemantics + + return ArrowStringArrayNumpySemantics(array) else: import pyarrow diff --git a/pandas/core/arrays/string_arrow.py b/pandas/core/arrays/string_arrow.py index 4a70fcf6b5a93..bc1d7cb52e196 100644 --- a/pandas/core/arrays/string_arrow.py +++ b/pandas/core/arrays/string_arrow.py @@ -1,5 +1,6 @@ from __future__ import annotations +from functools import partial import re from typing import ( TYPE_CHECKING, @@ -27,6 +28,7 @@ ) from pandas.core.dtypes.missing import isna +from pandas.core.arrays._arrow_string_mixins import ArrowStringArrayMixin from pandas.core.arrays.arrow import ArrowExtensionArray from pandas.core.arrays.boolean import BooleanDtype from pandas.core.arrays.integer import Int64Dtype @@ -113,10 +115,11 @@ class ArrowStringArray(ObjectStringArrayMixin, ArrowExtensionArray, BaseStringAr # error: Incompatible types in assignment (expression has type "StringDtype", # base class "ArrowExtensionArray" defined the type as "ArrowDtype") _dtype: StringDtype # type: ignore[assignment] + _storage = "pyarrow" def __init__(self, values) -> None: super().__init__(values) - self._dtype = StringDtype(storage="pyarrow") + self._dtype = StringDtype(storage=self._storage) if not pa.types.is_string(self._pa_array.type) and not ( pa.types.is_dictionary(self._pa_array.type) @@ -144,7 +147,10 @@ def _from_sequence(cls, scalars, dtype: Dtype | None = None, copy: bool = False) if dtype and not (isinstance(dtype, str) and dtype == "string"): dtype = pandas_dtype(dtype) - assert isinstance(dtype, StringDtype) and dtype.storage == "pyarrow" + assert isinstance(dtype, StringDtype) and dtype.storage in ( + "pyarrow", + "pyarrow_numpy", + ) if isinstance(scalars, BaseMaskedArray): # avoid costly conversion to object dtype in ensure_string_array and @@ -178,6 +184,10 @@ def insert(self, loc: int, item) -> ArrowStringArray: raise TypeError("Scalar must be NA or str") return super().insert(loc, item) + @classmethod + def _result_converter(cls, values, na=None): + return BooleanDtype().__from_arrow__(values) + def _maybe_convert_setitem_value(self, value): """Maybe convert value to be pyarrow compatible.""" if is_scalar(value): @@ -313,7 +323,7 @@ def _str_contains( result = pc.match_substring_regex(self._pa_array, pat, ignore_case=not case) else: result = pc.match_substring(self._pa_array, pat, ignore_case=not case) - result = BooleanDtype().__from_arrow__(result) + result = self._result_converter(result, na=na) if not isna(na): result[isna(result)] = bool(na) return result @@ -322,7 +332,7 @@ def _str_startswith(self, pat: str, na=None): result = pc.starts_with(self._pa_array, pattern=pat) if not isna(na): result = result.fill_null(na) - result = BooleanDtype().__from_arrow__(result) + result = self._result_converter(result) if not isna(na): result[isna(result)] = bool(na) return result @@ -331,7 +341,7 @@ def _str_endswith(self, pat: str, na=None): result = pc.ends_with(self._pa_array, pattern=pat) if not isna(na): result = result.fill_null(na) - result = BooleanDtype().__from_arrow__(result) + result = self._result_converter(result) if not isna(na): result[isna(result)] = bool(na) return result @@ -369,39 +379,39 @@ def _str_fullmatch( def _str_isalnum(self): result = pc.utf8_is_alnum(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_isalpha(self): result = pc.utf8_is_alpha(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_isdecimal(self): result = pc.utf8_is_decimal(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_isdigit(self): result = pc.utf8_is_digit(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_islower(self): result = pc.utf8_is_lower(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_isnumeric(self): result = pc.utf8_is_numeric(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_isspace(self): result = pc.utf8_is_space(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_istitle(self): result = pc.utf8_is_title(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_isupper(self): result = pc.utf8_is_upper(self._pa_array) - return BooleanDtype().__from_arrow__(result) + return self._result_converter(result) def _str_len(self): result = pc.utf8_length(self._pa_array) @@ -433,3 +443,114 @@ def _str_rstrip(self, to_strip=None): else: result = pc.utf8_rtrim(self._pa_array, characters=to_strip) return type(self)(result) + + +class ArrowStringArrayNumpySemantics(ArrowStringArray): + _storage = "pyarrow_numpy" + + @classmethod + def _result_converter(cls, values, na=None): + if not isna(na): + values = values.fill_null(bool(na)) + return ArrowExtensionArray(values).to_numpy(na_value=np.nan) + + def __getattribute__(self, item): + # ArrowStringArray and we both inherit from ArrowExtensionArray, which + # creates inheritance problems (Diamond inheritance) + if item in ArrowStringArrayMixin.__dict__ and item != "_pa_array": + return partial(getattr(ArrowStringArrayMixin, item), self) + return super().__getattribute__(item) + + def _str_map( + self, f, na_value=None, dtype: Dtype | None = None, convert: bool = True + ): + if dtype is None: + dtype = self.dtype + if na_value is None: + na_value = self.dtype.na_value + + mask = isna(self) + arr = np.asarray(self) + + if is_integer_dtype(dtype) or is_bool_dtype(dtype): + if is_integer_dtype(dtype): + na_value = np.nan + else: + na_value = False + try: + result = lib.map_infer_mask( + arr, + f, + mask.view("uint8"), + convert=False, + na_value=na_value, + dtype=np.dtype(dtype), # type: ignore[arg-type] + ) + return result + + except ValueError: + result = lib.map_infer_mask( + arr, + f, + mask.view("uint8"), + convert=False, + na_value=na_value, + ) + if convert and result.dtype == object: + result = lib.maybe_convert_objects(result) + return result + + elif is_string_dtype(dtype) and not is_object_dtype(dtype): + # i.e. StringDtype + result = lib.map_infer_mask( + arr, f, mask.view("uint8"), convert=False, na_value=na_value + ) + result = pa.array(result, mask=mask, type=pa.string(), from_pandas=True) + return type(self)(result) + else: + # This is when the result type is object. We reach this when + # -> We know the result type is truly object (e.g. .encode returns bytes + # or .findall returns a list). + # -> We don't know the result type. E.g. `.get` can return anything. + return lib.map_infer_mask(arr, f, mask.view("uint8")) + + def _convert_int_dtype(self, result): + if result.dtype == np.int32: + result = result.astype(np.int64) + return result + + def _str_count(self, pat: str, flags: int = 0): + if flags: + return super()._str_count(pat, flags) + result = pc.count_substring_regex(self._pa_array, pat).to_numpy() + return self._convert_int_dtype(result) + + def _str_len(self): + result = pc.utf8_length(self._pa_array).to_numpy() + return self._convert_int_dtype(result) + + def _str_find(self, sub: str, start: int = 0, end: int | None = None): + if start != 0 and end is not None: + slices = pc.utf8_slice_codeunits(self._pa_array, start, stop=end) + result = pc.find_substring(slices, sub) + not_found = pc.equal(result, -1) + offset_result = pc.add(result, end - start) + result = pc.if_else(not_found, result, offset_result) + elif start == 0 and end is None: + slices = self._pa_array + result = pc.find_substring(slices, sub) + else: + return super()._str_find(sub, start, end) + return self._convert_int_dtype(result.to_numpy()) + + def _cmp_method(self, other, op): + result = super()._cmp_method(other, op) + return result.to_numpy(np.bool_, na_value=False) + + def value_counts(self, dropna: bool = True): + from pandas import Series + + result = super().value_counts(dropna) + return Series( + result._values.to_numpy(), index=result.index, name=result.name, copy=False + ) diff --git a/pandas/core/config_init.py b/pandas/core/config_init.py index 27e9bf8958ab0..745689ab1fcc8 100644 --- a/pandas/core/config_init.py +++ b/pandas/core/config_init.py @@ -500,7 +500,7 @@ def use_inf_as_na_cb(key) -> None: "string_storage", "python", string_storage_doc, - validator=is_one_of_factory(["python", "pyarrow"]), + validator=is_one_of_factory(["python", "pyarrow", "pyarrow_numpy"]), ) diff --git a/pandas/core/strings/accessor.py b/pandas/core/strings/accessor.py index becf9b47b3af1..124ca546c4583 100644 --- a/pandas/core/strings/accessor.py +++ b/pandas/core/strings/accessor.py @@ -145,7 +145,9 @@ def _map_and_wrap(name: str | None, docstring: str | None): @forbid_nonstring_types(["bytes"], name=name) def wrapper(self): result = getattr(self._data.array, f"_str_{name}")() - return self._wrap_result(result) + return self._wrap_result( + result, returns_string=name not in ("isnumeric", "isdecimal") + ) wrapper.__doc__ = docstring return wrapper diff --git a/pandas/tests/arrays/string_/test_string.py b/pandas/tests/arrays/string_/test_string.py index de93e89ecacd5..e29a72e1a5338 100644 --- a/pandas/tests/arrays/string_/test_string.py +++ b/pandas/tests/arrays/string_/test_string.py @@ -5,12 +5,16 @@ import numpy as np import pytest +from pandas.compat.pyarrow import pa_version_under12p0 + from pandas.core.dtypes.common import is_dtype_equal import pandas as pd import pandas._testing as tm -from pandas.core.arrays.string_arrow import ArrowStringArray -from pandas.util.version import Version +from pandas.core.arrays.string_arrow import ( + ArrowStringArray, + ArrowStringArrayNumpySemantics, +) @pytest.fixture @@ -33,7 +37,12 @@ def test_repr(dtype): expected = "0 a\n1 <NA>\n2 b\nName: A, dtype: string" assert repr(df.A) == expected - arr_name = "ArrowStringArray" if dtype.storage == "pyarrow" else "StringArray" + if dtype.storage == "pyarrow": + arr_name = "ArrowStringArray" + elif dtype.storage == "pyarrow_numpy": + arr_name = "ArrowStringArrayNumpySemantics" + else: + arr_name = "StringArray" expected = f"<{arr_name}>\n['a', <NA>, 'b']\nLength: 3, dtype: string" assert repr(df.A.array) == expected @@ -195,19 +204,34 @@ def test_comparison_methods_scalar(comparison_op, dtype): a = pd.array(["a", None, "c"], dtype=dtype) other = "a" result = getattr(a, op_name)(other) - expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" - expected = np.array([getattr(item, op_name)(other) for item in a], dtype=object) - expected = pd.array(expected, dtype=expected_dtype) - tm.assert_extension_array_equal(result, expected) + if dtype.storage == "pyarrow_numpy": + expected = np.array([getattr(item, op_name)(other) for item in a], dtype=object) + expected = ( + pd.array(expected, dtype="boolean") + .to_numpy(na_value=False) + .astype(np.bool_) + ) + tm.assert_numpy_array_equal(result, expected) + else: + expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" + expected = np.array([getattr(item, op_name)(other) for item in a], dtype=object) + expected = pd.array(expected, dtype=expected_dtype) + tm.assert_extension_array_equal(result, expected) def test_comparison_methods_scalar_pd_na(comparison_op, dtype): op_name = f"__{comparison_op.__name__}__" a = pd.array(["a", None, "c"], dtype=dtype) result = getattr(a, op_name)(pd.NA) - expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" - expected = pd.array([None, None, None], dtype=expected_dtype) - tm.assert_extension_array_equal(result, expected) + + if dtype.storage == "pyarrow_numpy": + expected = np.array([False, False, False]) + tm.assert_numpy_array_equal(result, expected) + else: + expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" + expected = pd.array([None, None, None], dtype=expected_dtype) + tm.assert_extension_array_equal(result, expected) + tm.assert_extension_array_equal(result, expected) def test_comparison_methods_scalar_not_string(comparison_op, dtype): @@ -223,12 +247,21 @@ def test_comparison_methods_scalar_not_string(comparison_op, dtype): return result = getattr(a, op_name)(other) - expected_data = {"__eq__": [False, None, False], "__ne__": [True, None, True]}[ - op_name - ] - expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" - expected = pd.array(expected_data, dtype=expected_dtype) - tm.assert_extension_array_equal(result, expected) + + if dtype.storage == "pyarrow_numpy": + expected_data = { + "__eq__": [False, False, False], + "__ne__": [True, False, True], + }[op_name] + expected = np.array(expected_data) + tm.assert_numpy_array_equal(result, expected) + else: + expected_data = {"__eq__": [False, None, False], "__ne__": [True, None, True]}[ + op_name + ] + expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" + expected = pd.array(expected_data, dtype=expected_dtype) + tm.assert_extension_array_equal(result, expected) def test_comparison_methods_array(comparison_op, dtype): @@ -237,15 +270,25 @@ def test_comparison_methods_array(comparison_op, dtype): a = pd.array(["a", None, "c"], dtype=dtype) other = [None, None, "c"] result = getattr(a, op_name)(other) - expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" - expected = np.full(len(a), fill_value=None, dtype="object") - expected[-1] = getattr(other[-1], op_name)(a[-1]) - expected = pd.array(expected, dtype=expected_dtype) - tm.assert_extension_array_equal(result, expected) + if dtype.storage == "pyarrow_numpy": + expected = np.array([False, False, False]) + expected[-1] = getattr(other[-1], op_name)(a[-1]) + tm.assert_numpy_array_equal(result, expected) - result = getattr(a, op_name)(pd.NA) - expected = pd.array([None, None, None], dtype=expected_dtype) - tm.assert_extension_array_equal(result, expected) + result = getattr(a, op_name)(pd.NA) + expected = np.array([False, False, False]) + tm.assert_numpy_array_equal(result, expected) + + else: + expected_dtype = "boolean[pyarrow]" if dtype.storage == "pyarrow" else "boolean" + expected = np.full(len(a), fill_value=None, dtype="object") + expected[-1] = getattr(other[-1], op_name)(a[-1]) + expected = pd.array(expected, dtype=expected_dtype) + tm.assert_extension_array_equal(result, expected) + + result = getattr(a, op_name)(pd.NA) + expected = pd.array([None, None, None], dtype=expected_dtype) + tm.assert_extension_array_equal(result, expected) def test_constructor_raises(cls): @@ -297,7 +340,7 @@ def test_from_sequence_no_mutate(copy, cls, request): result = cls._from_sequence(nan_arr, copy=copy) - if cls is ArrowStringArray: + if cls in (ArrowStringArray, ArrowStringArrayNumpySemantics): import pyarrow as pa expected = cls(pa.array(na_arr, type=pa.string(), from_pandas=True)) @@ -412,7 +455,7 @@ def test_arrow_array(dtype): data = pd.array(["a", "b", "c"], dtype=dtype) arr = pa.array(data) expected = pa.array(list(data), type=pa.string(), from_pandas=True) - if dtype.storage == "pyarrow" and Version(pa.__version__) <= Version("11.0.0"): + if dtype.storage in ("pyarrow", "pyarrow_numpy") and pa_version_under12p0: expected = pa.chunked_array(expected) assert arr.equals(expected) @@ -455,6 +498,8 @@ def test_arrow_load_from_zero_chunks(dtype, string_storage2): def test_value_counts_na(dtype): if getattr(dtype, "storage", "") == "pyarrow": exp_dtype = "int64[pyarrow]" + elif getattr(dtype, "storage", "") == "pyarrow_numpy": + exp_dtype = "int64" else: exp_dtype = "Int64" arr = pd.array(["a", "b", "a", pd.NA], dtype=dtype) @@ -470,6 +515,8 @@ def test_value_counts_na(dtype): def test_value_counts_with_normalize(dtype): if getattr(dtype, "storage", "") == "pyarrow": exp_dtype = "double[pyarrow]" + elif getattr(dtype, "storage", "") == "pyarrow_numpy": + exp_dtype = np.float64 else: exp_dtype = "Float64" ser = pd.Series(["a", "b", "a", pd.NA], dtype=dtype) diff --git a/pandas/tests/arrays/test_datetimelike.py b/pandas/tests/arrays/test_datetimelike.py index 9eee2e0bea687..20530e37116f2 100644 --- a/pandas/tests/arrays/test_datetimelike.py +++ b/pandas/tests/arrays/test_datetimelike.py @@ -324,7 +324,12 @@ def test_searchsorted_castable_strings(self, arr1d, box, string_storage): ): arr.searchsorted("foo") - arr_type = "StringArray" if string_storage == "python" else "ArrowStringArray" + if string_storage == "python": + arr_type = "StringArray" + elif string_storage == "pyarrow": + arr_type = "ArrowStringArray" + else: + arr_type = "ArrowStringArrayNumpySemantics" with pd.option_context("string_storage", string_storage): with pytest.raises( diff --git a/pandas/tests/extension/base/methods.py b/pandas/tests/extension/base/methods.py index 2dd62a4ca7538..16059155a7a8f 100644 --- a/pandas/tests/extension/base/methods.py +++ b/pandas/tests/extension/base/methods.py @@ -70,6 +70,9 @@ def test_value_counts_with_normalize(self, data): ): # TODO: avoid special-casing expected = expected.astype("double[pyarrow]") + elif getattr(data.dtype, "storage", "") == "pyarrow_numpy": + # TODO: avoid special-casing + expected = expected.astype("float64") elif na_value_for_dtype(data.dtype) is pd.NA: # TODO(GH#44692): avoid special-casing expected = expected.astype("Float64") diff --git a/pandas/tests/extension/test_string.py b/pandas/tests/extension/test_string.py index 4e142eb6e14b8..069d53aeb248f 100644 --- a/pandas/tests/extension/test_string.py +++ b/pandas/tests/extension/test_string.py @@ -184,6 +184,8 @@ def _cast_pointwise_result(self, op_name: str, obj, other, pointwise_result): # attribute "storage" if dtype.storage == "pyarrow": # type: ignore[union-attr] cast_to = "boolean[pyarrow]" + elif dtype.storage == "pyarrow_numpy": # type: ignore[union-attr] + cast_to = np.bool_ # type: ignore[assignment] else: cast_to = "boolean" return pointwise_result.astype(cast_to) diff --git a/pandas/tests/io/conftest.py b/pandas/tests/io/conftest.py index 170e2f61e7d4a..701bfe3767db4 100644 --- a/pandas/tests/io/conftest.py +++ b/pandas/tests/io/conftest.py @@ -234,3 +234,19 @@ def compression_format(request): @pytest.fixture(params=_compression_formats_params) def compression_ext(request): return request.param[0] + + +@pytest.fixture( + params=[ + "python", + pytest.param("pyarrow", marks=td.skip_if_no("pyarrow")), + ] +) +def string_storage(request): + """ + Parametrized fixture for pd.options.mode.string_storage. + + * 'python' + * 'pyarrow' + """ + return request.param diff --git a/pandas/tests/strings/__init__.py b/pandas/tests/strings/__init__.py index 496a2d095d85b..bf119f2721ed4 100644 --- a/pandas/tests/strings/__init__.py +++ b/pandas/tests/strings/__init__.py @@ -2,7 +2,7 @@ import pandas as pd -object_pyarrow_numpy = ("object",) +object_pyarrow_numpy = ("object", "string[pyarrow_numpy]") def _convert_na_value(ser, expected): diff --git a/pandas/tests/strings/test_case_justify.py b/pandas/tests/strings/test_case_justify.py index ced941187f548..1dee25e631648 100644 --- a/pandas/tests/strings/test_case_justify.py +++ b/pandas/tests/strings/test_case_justify.py @@ -278,6 +278,11 @@ def test_center_ljust_rjust_mixed_object(): def test_center_ljust_rjust_fillchar(any_string_dtype): + if any_string_dtype == "string[pyarrow_numpy]": + pytest.skip( + "Arrow logic is different, " + "see https://github.com/pandas-dev/pandas/pull/54533/files#r1299808126", + ) s = Series(["a", "bb", "cccc", "ddddd", "eeeeee"], dtype=any_string_dtype) result = s.str.center(5, fillchar="X") diff --git a/pandas/tests/strings/test_find_replace.py b/pandas/tests/strings/test_find_replace.py index d5017b1c47d85..78f0730d730e8 100644 --- a/pandas/tests/strings/test_find_replace.py +++ b/pandas/tests/strings/test_find_replace.py @@ -22,7 +22,7 @@ def using_pyarrow(dtype): - return dtype in ("string[pyarrow]",) + return dtype in ("string[pyarrow]", "string[pyarrow_numpy]") def test_contains(any_string_dtype): @@ -223,6 +223,8 @@ def test_contains_nan(any_string_dtype): result = s.str.contains("foo", na="foo") if any_string_dtype == "object": expected = Series(["foo", "foo", "foo"], dtype=np.object_) + elif any_string_dtype == "string[pyarrow_numpy]": + expected = Series([True, True, True], dtype=np.bool_) else: expected = Series([True, True, True], dtype="boolean") tm.assert_series_equal(result, expected) @@ -807,7 +809,7 @@ def test_find(any_string_dtype): ser = Series( ["ABCDEFG", "BCDEFEF", "DEFGHIJEF", "EFGHEF", "XXXX"], dtype=any_string_dtype ) - expected_dtype = np.int64 if any_string_dtype == "object" else "Int64" + expected_dtype = np.int64 if any_string_dtype in object_pyarrow_numpy else "Int64" result = ser.str.find("EF") expected = Series([4, 3, 1, 0, -1], dtype=expected_dtype)
Backport PR #54533: Implement Arrow String Array that is compatible with NumPy semantics
https://api.github.com/repos/pandas-dev/pandas/pulls/54713
2023-08-23T16:46:02Z
2023-08-23T21:09:24Z
2023-08-23T21:09:24Z
2023-08-23T21:09:24Z
Backport PR #54707 on branch 2.1.x (BUG: ArrowExtensionArray.fillna with duration types)
diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index 48ff769f6c737..4ba0e70393efb 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -381,8 +381,7 @@ def _box_pa_scalar(cls, value, pa_type: pa.DataType | None = None) -> pa.Scalar: elif isna(value): pa_scalar = pa.scalar(None, type=pa_type) else: - # GH 53171: pyarrow does not yet handle pandas non-nano correctly - # see https://github.com/apache/arrow/issues/33321 + # Workaround https://github.com/apache/arrow/issues/37291 if isinstance(value, Timedelta): if pa_type is None: pa_type = pa.duration(value.unit) @@ -448,8 +447,7 @@ def _box_pa_array( and pa.types.is_duration(pa_type) and (not isinstance(value, np.ndarray) or value.dtype.kind not in "mi") ): - # GH 53171: pyarrow does not yet handle pandas non-nano correctly - # see https://github.com/apache/arrow/issues/33321 + # Workaround https://github.com/apache/arrow/issues/37291 from pandas.core.tools.timedeltas import to_timedelta value = to_timedelta(value, unit=pa_type.unit).as_unit(pa_type.unit) @@ -462,8 +460,7 @@ def _box_pa_array( pa_array = pa.array(value, from_pandas=True) if pa_type is None and pa.types.is_duration(pa_array.type): - # GH 53171: pyarrow does not yet handle pandas non-nano correctly - # see https://github.com/apache/arrow/issues/33321 + # Workaround https://github.com/apache/arrow/issues/37291 from pandas.core.tools.timedeltas import to_timedelta value = to_timedelta(value) @@ -965,26 +962,11 @@ def fillna( f" expected {len(self)}" ) - def convert_fill_value(value, pa_type, dtype): - if value is None: - return value - if isinstance(value, (pa.Scalar, pa.Array, pa.ChunkedArray)): - return value - if isinstance(value, Timedelta) and value.unit in ("s", "ms"): - # Workaround https://github.com/apache/arrow/issues/37291 - value = value.to_numpy() - if is_array_like(value): - pa_box = pa.array - else: - pa_box = pa.scalar - try: - value = pa_box(value, type=pa_type, from_pandas=True) - except pa.ArrowTypeError as err: - msg = f"Invalid value '{str(value)}' for dtype {dtype}" - raise TypeError(msg) from err - return value - - fill_value = convert_fill_value(value, self._pa_array.type, self.dtype) + try: + fill_value = self._box_pa(value, pa_type=self._pa_array.type) + except pa.ArrowTypeError as err: + msg = f"Invalid value '{str(value)}' for dtype {self.dtype}" + raise TypeError(msg) from err try: if method is None: diff --git a/pandas/tests/extension/test_arrow.py b/pandas/tests/extension/test_arrow.py index a9b7a8c655032..86a7f20214a9a 100644 --- a/pandas/tests/extension/test_arrow.py +++ b/pandas/tests/extension/test_arrow.py @@ -3049,3 +3049,13 @@ def test_arrowextensiondtype_dataframe_repr(): # pyarrow.ExtensionType values are displayed expected = " col\n0 15340\n1 15341\n2 15342" assert result == expected + + +@pytest.mark.parametrize("pa_type", tm.TIMEDELTA_PYARROW_DTYPES) +def test_duration_fillna_numpy(pa_type): + # GH 54707 + ser1 = pd.Series([None, 2], dtype=ArrowDtype(pa_type)) + ser2 = pd.Series(np.array([1, 3], dtype=f"m8[{pa_type.unit}]")) + result = ser1.fillna(ser2) + expected = pd.Series([1, 2], dtype=ArrowDtype(pa_type)) + tm.assert_series_equal(result, expected)
Backport PR #54707: BUG: ArrowExtensionArray.fillna with duration types
https://api.github.com/repos/pandas-dev/pandas/pulls/54711
2023-08-23T15:42:30Z
2023-08-23T18:39:10Z
2023-08-23T18:39:10Z
2023-08-23T18:39:10Z
DEPR: downcasting in replace
diff --git a/doc/source/user_guide/missing_data.rst b/doc/source/user_guide/missing_data.rst index e0e752099b77a..4a2aa565dd15c 100644 --- a/doc/source/user_guide/missing_data.rst +++ b/doc/source/user_guide/missing_data.rst @@ -401,7 +401,7 @@ Limit the number of NA values filled df.ffill(limit=1) -NA values can be replaced with corresponding value from a :class:`Series`` or :class:`DataFrame`` +NA values can be replaced with corresponding value from a :class:`Series` or :class:`DataFrame` where the index and column aligns between the original object and the filled object. .. ipython:: python @@ -660,7 +660,7 @@ Pass a list of regular expressions that will replace matches with a scalar. .. ipython:: python - df.replace([r"\s*\.\s*", r"a|b"], np.nan, regex=True) + df.replace([r"\s*\.\s*", r"a|b"], "placeholder", regex=True) All of the regular expression examples can also be passed with the ``to_replace`` argument as the ``regex`` argument. In this case the ``value`` @@ -669,7 +669,7 @@ dictionary. .. ipython:: python - df.replace(regex=[r"\s*\.\s*", r"a|b"], value=np.nan) + df.replace(regex=[r"\s*\.\s*", r"a|b"], value="placeholder") .. note:: diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst index 54e855f61905a..dec6638a239a4 100644 --- a/doc/source/whatsnew/v2.2.0.rst +++ b/doc/source/whatsnew/v2.2.0.rst @@ -162,7 +162,8 @@ Deprecations - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_parquet` except ``path``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_pickle` except ``path``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_string` except ``buf``. (:issue:`54229`) -- Deprecated downcasting behavior in :meth:`Series.where`, :meth:`DataFrame.where`, :meth:`Series.mask`, :meth:`DataFrame.mask`, :meth:`Series.clip`, :meth:`DataFrame.clip`; in a future version these will not infer object-dtype columns to non-object dtype, or all-round floats to integer dtype. Call ``result.infer_objects(copy=False)`` on the result for object inference, or explicitly cast floats to ints. To opt in to the future version, use ``pd.set_option("future.downcasting", True)`` (:issue:`53656`) +- Deprecated automatic downcasting of object-dtype results in :meth:`Series.replace` and :meth:`DataFrame.replace`, explicitly call ``result = result.infer_objects(copy=False)`` instead. To opt in to the future version, use ``pd.set_option("future.no_silent_downcasting", True)`` (:issue:`54710`) +- Deprecated downcasting behavior in :meth:`Series.where`, :meth:`DataFrame.where`, :meth:`Series.mask`, :meth:`DataFrame.mask`, :meth:`Series.clip`, :meth:`DataFrame.clip`; in a future version these will not infer object-dtype columns to non-object dtype, or all-round floats to integer dtype. Call ``result.infer_objects(copy=False)`` on the result for object inference, or explicitly cast floats to ints. To opt in to the future version, use ``pd.set_option("future.no_silent_downcasting", True)`` (:issue:`53656`) - Deprecated including the groups in computations when using :meth:`DataFrameGroupBy.apply` and :meth:`DataFrameGroupBy.resample`; pass ``include_groups=False`` to exclude the groups (:issue:`7155`) - Deprecated not passing a tuple to :class:`DataFrameGroupBy.get_group` or :class:`SeriesGroupBy.get_group` when grouping by a length-1 list-like (:issue:`25971`) - Deprecated strings ``S``, ``U``, and ``N`` denoting units in :func:`to_timedelta` (:issue:`52536`) diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index 6399f85723ae5..57833c1d626ee 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -761,7 +761,23 @@ def replace( if not (self.is_object and value is None): # if the user *explicitly* gave None, we keep None, otherwise # may downcast to NaN - blocks = blk.convert(copy=False, using_cow=using_cow) + if get_option("future.no_silent_downcasting") is True: + blocks = [blk] + else: + blocks = blk.convert(copy=False, using_cow=using_cow) + if len(blocks) > 1 or blocks[0].dtype != blk.dtype: + warnings.warn( + # GH#54710 + "Downcasting behavior in `replace` is deprecated and " + "will be removed in a future version. To retain the old " + "behavior, explicitly call " + "`result.infer_objects(copy=False)`. " + "To opt-in to the future " + "behavior, set " + "`pd.set_option('future.no_silent_downcasting', True)`", + FutureWarning, + stacklevel=find_stack_level(), + ) else: blocks = [blk] return blocks @@ -836,7 +852,21 @@ def _replace_regex( replace_regex(block.values, rx, value, mask) - return block.convert(copy=False, using_cow=using_cow) + nbs = block.convert(copy=False, using_cow=using_cow) + opt = get_option("future.no_silent_downcasting") + if (len(nbs) > 1 or nbs[0].dtype != block.dtype) and not opt: + warnings.warn( + # GH#54710 + "Downcasting behavior in `replace` is deprecated and " + "will be removed in a future version. To retain the old " + "behavior, explicitly call `result.infer_objects(copy=False)`. " + "To opt-in to the future " + "behavior, set " + "`pd.set_option('future.no_silent_downcasting', True)`", + FutureWarning, + stacklevel=find_stack_level(), + ) + return nbs @final def replace_list( @@ -902,6 +932,7 @@ def replace_list( else: rb = [self if inplace else self.copy()] + opt = get_option("future.no_silent_downcasting") for i, ((src, dest), mask) in enumerate(zip(pairs, masks)): convert = i == src_len # only convert once at the end new_rb: list[Block] = [] @@ -939,14 +970,33 @@ def replace_list( b.refs.referenced_blocks.index(ref) ) - if convert and blk.is_object and not all(x is None for x in dest_list): + if ( + not opt + and convert + and blk.is_object + and not all(x is None for x in dest_list) + ): # GH#44498 avoid unwanted cast-back - result = extend_blocks( - [ - b.convert(copy=True and not using_cow, using_cow=using_cow) - for b in result - ] - ) + nbs = [] + for res_blk in result: + converted = res_blk.convert( + copy=True and not using_cow, using_cow=using_cow + ) + if len(converted) > 1 or converted[0].dtype != res_blk.dtype: + warnings.warn( + # GH#54710 + "Downcasting behavior in `replace` is deprecated " + "and will be removed in a future version. To " + "retain the old behavior, explicitly call " + "`result.infer_objects(copy=False)`. " + "To opt-in to the future " + "behavior, set " + "`pd.set_option('future.no_silent_downcasting', True)`", + FutureWarning, + stacklevel=find_stack_level(), + ) + nbs.extend(converted) + result = nbs new_rb.extend(result) rb = new_rb return rb diff --git a/pandas/tests/frame/methods/test_replace.py b/pandas/tests/frame/methods/test_replace.py index 61e44b4e24c08..f07c53060a06b 100644 --- a/pandas/tests/frame/methods/test_replace.py +++ b/pandas/tests/frame/methods/test_replace.py @@ -289,7 +289,9 @@ def test_regex_replace_dict_nested_non_first_character(self, any_string_dtype): def test_regex_replace_dict_nested_gh4115(self): df = DataFrame({"Type": ["Q", "T", "Q", "Q", "T"], "tmp": 2}) expected = DataFrame({"Type": [0, 1, 0, 0, 1], "tmp": 2}) - result = df.replace({"Type": {"Q": 0, "T": 1}}) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + result = df.replace({"Type": {"Q": 0, "T": 1}}) tm.assert_frame_equal(result, expected) def test_regex_replace_list_to_scalar(self, mix_abc): @@ -301,16 +303,20 @@ def test_regex_replace_list_to_scalar(self, mix_abc): "c": [np.nan, np.nan, np.nan, "d"], } ) - res = df.replace([r"\s*\.\s*", "a|b"], np.nan, regex=True) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + res = df.replace([r"\s*\.\s*", "a|b"], np.nan, regex=True) res2 = df.copy() res3 = df.copy() - return_value = res2.replace( - [r"\s*\.\s*", "a|b"], np.nan, regex=True, inplace=True - ) + with tm.assert_produces_warning(FutureWarning, match=msg): + return_value = res2.replace( + [r"\s*\.\s*", "a|b"], np.nan, regex=True, inplace=True + ) assert return_value is None - return_value = res3.replace( - regex=[r"\s*\.\s*", "a|b"], value=np.nan, inplace=True - ) + with tm.assert_produces_warning(FutureWarning, match=msg): + return_value = res3.replace( + regex=[r"\s*\.\s*", "a|b"], value=np.nan, inplace=True + ) assert return_value is None tm.assert_frame_equal(res, expec) tm.assert_frame_equal(res2, expec) @@ -520,7 +526,9 @@ def test_replace_convert(self): # gh 3907 df = DataFrame([["foo", "bar", "bah"], ["bar", "foo", "bah"]]) m = {"foo": 1, "bar": 2, "bah": 3} - rep = df.replace(m) + msg = "Downcasting behavior in `replace` " + with tm.assert_produces_warning(FutureWarning, match=msg): + rep = df.replace(m) expec = Series([np.int64] * 3) res = rep.dtypes tm.assert_series_equal(expec, res) @@ -838,7 +846,12 @@ def test_replace_for_new_dtypes(self, datetime_frame): ], ) def test_replace_dtypes(self, frame, to_replace, value, expected): - result = frame.replace(to_replace, value) + warn = None + if isinstance(to_replace, datetime) and to_replace.year == 2920: + warn = FutureWarning + msg = "Downcasting behavior in `replace` " + with tm.assert_produces_warning(warn, match=msg): + result = frame.replace(to_replace, value) tm.assert_frame_equal(result, expected) def test_replace_input_formats_listlike(self): @@ -927,7 +940,9 @@ def test_replace_dict_no_regex(self): "Strongly Disagree": 1, } expected = Series({0: 5, 1: 4, 2: 3, 3: 2, 4: 1}) - result = answer.replace(weights) + msg = "Downcasting behavior in `replace` " + with tm.assert_produces_warning(FutureWarning, match=msg): + result = answer.replace(weights) tm.assert_series_equal(result, expected) def test_replace_series_no_regex(self): @@ -950,7 +965,9 @@ def test_replace_series_no_regex(self): } ) expected = Series({0: 5, 1: 4, 2: 3, 3: 2, 4: 1}) - result = answer.replace(weights) + msg = "Downcasting behavior in `replace` " + with tm.assert_produces_warning(FutureWarning, match=msg): + result = answer.replace(weights) tm.assert_series_equal(result, expected) def test_replace_dict_tuple_list_ordering_remains_the_same(self): @@ -1076,7 +1093,9 @@ def test_replace_period(self): expected = DataFrame({"fname": [d["fname"][k] for k in df.fname.values]}) assert expected.dtypes.iloc[0] == "Period[M]" - result = df.replace(d) + msg = "Downcasting behavior in `replace` " + with tm.assert_produces_warning(FutureWarning, match=msg): + result = df.replace(d) tm.assert_frame_equal(result, expected) def test_replace_datetime(self): @@ -1106,7 +1125,9 @@ def test_replace_datetime(self): ) assert set(df.fname.values) == set(d["fname"].keys()) expected = DataFrame({"fname": [d["fname"][k] for k in df.fname.values]}) - result = df.replace(d) + msg = "Downcasting behavior in `replace` " + with tm.assert_produces_warning(FutureWarning, match=msg): + result = df.replace(d) tm.assert_frame_equal(result, expected) def test_replace_datetimetz(self): @@ -1307,10 +1328,12 @@ def test_replace_commutative(self, df, to_replace, exp): np.float64(1), ], ) - def test_replace_replacer_dtype(self, request, replacer): + def test_replace_replacer_dtype(self, replacer): # GH26632 df = DataFrame(["a"]) - result = df.replace({"a": replacer, "b": replacer}) + msg = "Downcasting behavior in `replace` " + with tm.assert_produces_warning(FutureWarning, match=msg): + result = df.replace({"a": replacer, "b": replacer}) expected = DataFrame([replacer]) tm.assert_frame_equal(result, expected) @@ -1564,12 +1587,15 @@ def test_replace_regex_dtype_frame(self, regex): # GH-48644 df1 = DataFrame({"A": ["0"], "B": ["0"]}) expected_df1 = DataFrame({"A": [1], "B": [1]}) - result_df1 = df1.replace(to_replace="0", value=1, regex=regex) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + result_df1 = df1.replace(to_replace="0", value=1, regex=regex) tm.assert_frame_equal(result_df1, expected_df1) df2 = DataFrame({"A": ["0"], "B": ["1"]}) expected_df2 = DataFrame({"A": [1], "B": ["1"]}) - result_df2 = df2.replace(to_replace="0", value=1, regex=regex) + with tm.assert_produces_warning(FutureWarning, match=msg): + result_df2 = df2.replace(to_replace="0", value=1, regex=regex) tm.assert_frame_equal(result_df2, expected_df2) def test_replace_with_value_also_being_replaced(self): diff --git a/pandas/tests/indexing/test_coercion.py b/pandas/tests/indexing/test_coercion.py index 2c39729097487..82368c67dc6d4 100644 --- a/pandas/tests/indexing/test_coercion.py +++ b/pandas/tests/indexing/test_coercion.py @@ -836,8 +836,6 @@ def test_replace_series(self, how, to_key, from_key, replacer): # tested below return - result = obj.replace(replacer) - if (from_key == "float64" and to_key in ("int64")) or ( from_key == "complex128" and to_key in ("int64", "float64") ): @@ -851,6 +849,17 @@ def test_replace_series(self, how, to_key, from_key, replacer): exp = pd.Series(self.rep[to_key], index=index, name="yyy") assert exp.dtype == to_key + msg = "Downcasting behavior in `replace`" + warn = FutureWarning + if ( + exp.dtype == obj.dtype + or exp.dtype == object + or (exp.dtype.kind in "iufc" and obj.dtype.kind in "iufc") + ): + warn = None + with tm.assert_produces_warning(warn, match=msg): + result = obj.replace(replacer) + tm.assert_series_equal(result, exp) @pytest.mark.parametrize( @@ -866,11 +875,14 @@ def test_replace_series_datetime_tz(self, how, to_key, from_key, replacer): obj = pd.Series(self.rep[from_key], index=index, name="yyy") assert obj.dtype == from_key - result = obj.replace(replacer) - exp = pd.Series(self.rep[to_key], index=index, name="yyy") assert exp.dtype == to_key + msg = "Downcasting behavior in `replace`" + warn = FutureWarning if exp.dtype != object else None + with tm.assert_produces_warning(warn, match=msg): + result = obj.replace(replacer) + tm.assert_series_equal(result, exp) @pytest.mark.parametrize( @@ -888,16 +900,22 @@ def test_replace_series_datetime_datetime(self, how, to_key, from_key, replacer) obj = pd.Series(self.rep[from_key], index=index, name="yyy") assert obj.dtype == from_key - result = obj.replace(replacer) - exp = pd.Series(self.rep[to_key], index=index, name="yyy") + warn = FutureWarning if isinstance(obj.dtype, pd.DatetimeTZDtype) and isinstance( exp.dtype, pd.DatetimeTZDtype ): # with mismatched tzs, we retain the original dtype as of 2.0 exp = exp.astype(obj.dtype) + warn = None else: assert exp.dtype == to_key + if to_key == from_key: + warn = None + + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(warn, match=msg): + result = obj.replace(replacer) tm.assert_series_equal(result, exp) diff --git a/pandas/tests/io/excel/test_writers.py b/pandas/tests/io/excel/test_writers.py index 9cbb29605a1ec..c54d06b6ab4ce 100644 --- a/pandas/tests/io/excel/test_writers.py +++ b/pandas/tests/io/excel/test_writers.py @@ -1197,7 +1197,9 @@ def test_render_as_column_name(self, path): def test_true_and_false_value_options(self, path): # see gh-13347 df = DataFrame([["foo", "bar"]], columns=["col1", "col2"]) - expected = df.replace({"foo": True, "bar": False}) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + expected = df.replace({"foo": True, "bar": False}) df.to_excel(path) read_frame = pd.read_excel( diff --git a/pandas/tests/series/methods/test_replace.py b/pandas/tests/series/methods/test_replace.py index ec9db8c3830d6..f08966c3816c0 100644 --- a/pandas/tests/series/methods/test_replace.py +++ b/pandas/tests/series/methods/test_replace.py @@ -76,7 +76,9 @@ def test_replace(self): ser[20:30] = "bar" # replace list with a single value - rs = ser.replace([np.nan, "foo", "bar"], -1) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + rs = ser.replace([np.nan, "foo", "bar"], -1) assert (rs[:5] == -1).all() assert (rs[6:10] == -1).all() @@ -84,7 +86,8 @@ def test_replace(self): assert (pd.isna(ser[:5])).all() # replace with different values - rs = ser.replace({np.nan: -1, "foo": -2, "bar": -3}) + with tm.assert_produces_warning(FutureWarning, match=msg): + rs = ser.replace({np.nan: -1, "foo": -2, "bar": -3}) assert (rs[:5] == -1).all() assert (rs[6:10] == -2).all() @@ -92,11 +95,13 @@ def test_replace(self): assert (pd.isna(ser[:5])).all() # replace with different values with 2 lists - rs2 = ser.replace([np.nan, "foo", "bar"], [-1, -2, -3]) + with tm.assert_produces_warning(FutureWarning, match=msg): + rs2 = ser.replace([np.nan, "foo", "bar"], [-1, -2, -3]) tm.assert_series_equal(rs, rs2) # replace inplace - return_value = ser.replace([np.nan, "foo", "bar"], -1, inplace=True) + with tm.assert_produces_warning(FutureWarning, match=msg): + return_value = ser.replace([np.nan, "foo", "bar"], -1, inplace=True) assert return_value is None assert (ser[:5] == -1).all() @@ -294,7 +299,9 @@ def test_replace2(self): ser[20:30] = "bar" # replace list with a single value - rs = ser.replace([np.nan, "foo", "bar"], -1) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + rs = ser.replace([np.nan, "foo", "bar"], -1) assert (rs[:5] == -1).all() assert (rs[6:10] == -1).all() @@ -302,7 +309,8 @@ def test_replace2(self): assert (pd.isna(ser[:5])).all() # replace with different values - rs = ser.replace({np.nan: -1, "foo": -2, "bar": -3}) + with tm.assert_produces_warning(FutureWarning, match=msg): + rs = ser.replace({np.nan: -1, "foo": -2, "bar": -3}) assert (rs[:5] == -1).all() assert (rs[6:10] == -2).all() @@ -310,11 +318,13 @@ def test_replace2(self): assert (pd.isna(ser[:5])).all() # replace with different values with 2 lists - rs2 = ser.replace([np.nan, "foo", "bar"], [-1, -2, -3]) + with tm.assert_produces_warning(FutureWarning, match=msg): + rs2 = ser.replace([np.nan, "foo", "bar"], [-1, -2, -3]) tm.assert_series_equal(rs, rs2) # replace inplace - return_value = ser.replace([np.nan, "foo", "bar"], -1, inplace=True) + with tm.assert_produces_warning(FutureWarning, match=msg): + return_value = ser.replace([np.nan, "foo", "bar"], -1, inplace=True) assert return_value is None assert (ser[:5] == -1).all() assert (ser[6:10] == -1).all() @@ -373,7 +383,9 @@ def test_replace_unicode_with_number(self): def test_replace_mixed_types_with_string(self): # Testing mixed s = pd.Series([1, 2, 3, "4", 4, 5]) - result = s.replace([2, "4"], np.nan) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + result = s.replace([2, "4"], np.nan) expected = pd.Series([1, np.nan, 3, np.nan, 4, 5]) tm.assert_series_equal(expected, result) @@ -387,7 +399,9 @@ def test_replace_mixed_types_with_string(self): def test_replace_categorical(self, categorical, numeric): # GH 24971, GH#23305 ser = pd.Series(categorical) - result = ser.replace({"A": 1, "B": 2}) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + result = ser.replace({"A": 1, "B": 2}) expected = pd.Series(numeric).astype("category") if 2 not in expected.cat.categories: # i.e. categories should be [1, 2] even if there are no "B"s present @@ -710,7 +724,9 @@ def test_replace_regex_dtype_series(self, regex): # GH-48644 series = pd.Series(["0"]) expected = pd.Series([1]) - result = series.replace(to_replace="0", value=1, regex=regex) + msg = "Downcasting behavior in `replace`" + with tm.assert_produces_warning(FutureWarning, match=msg): + result = series.replace(to_replace="0", value=1, regex=regex) tm.assert_series_equal(result, expected) def test_replace_different_int_types(self, any_int_numpy_dtype):
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54710
2023-08-23T15:32:08Z
2023-09-18T17:20:39Z
2023-09-18T17:20:38Z
2023-09-18T17:44:11Z
BUG: ArrowExtensionArray.fillna with duration types
diff --git a/pandas/core/arrays/arrow/array.py b/pandas/core/arrays/arrow/array.py index 48ff769f6c737..4ba0e70393efb 100644 --- a/pandas/core/arrays/arrow/array.py +++ b/pandas/core/arrays/arrow/array.py @@ -381,8 +381,7 @@ def _box_pa_scalar(cls, value, pa_type: pa.DataType | None = None) -> pa.Scalar: elif isna(value): pa_scalar = pa.scalar(None, type=pa_type) else: - # GH 53171: pyarrow does not yet handle pandas non-nano correctly - # see https://github.com/apache/arrow/issues/33321 + # Workaround https://github.com/apache/arrow/issues/37291 if isinstance(value, Timedelta): if pa_type is None: pa_type = pa.duration(value.unit) @@ -448,8 +447,7 @@ def _box_pa_array( and pa.types.is_duration(pa_type) and (not isinstance(value, np.ndarray) or value.dtype.kind not in "mi") ): - # GH 53171: pyarrow does not yet handle pandas non-nano correctly - # see https://github.com/apache/arrow/issues/33321 + # Workaround https://github.com/apache/arrow/issues/37291 from pandas.core.tools.timedeltas import to_timedelta value = to_timedelta(value, unit=pa_type.unit).as_unit(pa_type.unit) @@ -462,8 +460,7 @@ def _box_pa_array( pa_array = pa.array(value, from_pandas=True) if pa_type is None and pa.types.is_duration(pa_array.type): - # GH 53171: pyarrow does not yet handle pandas non-nano correctly - # see https://github.com/apache/arrow/issues/33321 + # Workaround https://github.com/apache/arrow/issues/37291 from pandas.core.tools.timedeltas import to_timedelta value = to_timedelta(value) @@ -965,26 +962,11 @@ def fillna( f" expected {len(self)}" ) - def convert_fill_value(value, pa_type, dtype): - if value is None: - return value - if isinstance(value, (pa.Scalar, pa.Array, pa.ChunkedArray)): - return value - if isinstance(value, Timedelta) and value.unit in ("s", "ms"): - # Workaround https://github.com/apache/arrow/issues/37291 - value = value.to_numpy() - if is_array_like(value): - pa_box = pa.array - else: - pa_box = pa.scalar - try: - value = pa_box(value, type=pa_type, from_pandas=True) - except pa.ArrowTypeError as err: - msg = f"Invalid value '{str(value)}' for dtype {dtype}" - raise TypeError(msg) from err - return value - - fill_value = convert_fill_value(value, self._pa_array.type, self.dtype) + try: + fill_value = self._box_pa(value, pa_type=self._pa_array.type) + except pa.ArrowTypeError as err: + msg = f"Invalid value '{str(value)}' for dtype {self.dtype}" + raise TypeError(msg) from err try: if method is None: diff --git a/pandas/tests/extension/test_arrow.py b/pandas/tests/extension/test_arrow.py index f9c420607812c..890ffd6dfbdd9 100644 --- a/pandas/tests/extension/test_arrow.py +++ b/pandas/tests/extension/test_arrow.py @@ -2997,3 +2997,13 @@ def test_arrowextensiondtype_dataframe_repr(): # pyarrow.ExtensionType values are displayed expected = " col\n0 15340\n1 15341\n2 15342" assert result == expected + + +@pytest.mark.parametrize("pa_type", tm.TIMEDELTA_PYARROW_DTYPES) +def test_duration_fillna_numpy(pa_type): + # GH 54707 + ser1 = pd.Series([None, 2], dtype=ArrowDtype(pa_type)) + ser2 = pd.Series(np.array([1, 3], dtype=f"m8[{pa_type.unit}]")) + result = ser1.fillna(ser2) + expected = pd.Series([1, 2], dtype=ArrowDtype(pa_type)) + tm.assert_series_equal(result, expected)
- [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. cc @mroeschke - this expands on #54678 to cover a few more cases.
https://api.github.com/repos/pandas-dev/pandas/pulls/54707
2023-08-23T10:29:28Z
2023-08-23T15:37:37Z
2023-08-23T15:37:37Z
2023-09-06T00:53:59Z
DOC: updated date_format description for read_csv
diff --git a/pandas/io/parsers/readers.py b/pandas/io/parsers/readers.py index f01595a684344..10d3ab230cb9d 100644 --- a/pandas/io/parsers/readers.py +++ b/pandas/io/parsers/readers.py @@ -280,11 +280,20 @@ Use ``date_format`` instead, or read in as ``object`` and then apply :func:`~pandas.to_datetime` as-needed. date_format : str or dict of column -> format, optional - Format to use for parsing dates when used in conjunction with ``parse_dates``. - For anything more complex, please read in as ``object`` and then apply - :func:`~pandas.to_datetime` as-needed. - - .. versionadded:: 2.0.0 + Format to use for parsing dates when used in conjunction with ``parse_dates``. + The strftime to parse time, e.g. :const:`"%d/%m/%Y"`. See + `strftime documentation + <https://docs.python.org/3/library/datetime.html + #strftime-and-strptime-behavior>`_ for more information on choices, though + note that :const:`"%f"` will parse all the way up to nanoseconds. + You can also pass: + + - "ISO8601", to parse any `ISO8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ + time string (not necessarily in exactly the same format); + - "mixed", to infer the format for each element individually. This is risky, + and you should probably use it along with `dayfirst`. + + .. versionadded:: 2.0.0 dayfirst : bool, default False DD/MM format dates, international and European format. cache_dates : bool, default True
- [x] closes #54285 - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit).
https://api.github.com/repos/pandas-dev/pandas/pulls/54705
2023-08-23T06:59:08Z
2023-08-23T15:50:25Z
2023-08-23T15:50:25Z
2023-08-24T05:43:24Z
DEPR: deprecated nonkeyword arguments in to_gbq
diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst index a9522a09d73be..f03a091541d03 100644 --- a/doc/source/whatsnew/v2.2.0.rst +++ b/doc/source/whatsnew/v2.2.0.rst @@ -134,6 +134,7 @@ Deprecations - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_clipboard`. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_csv` except ``path_or_buf``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_dict`. (:issue:`54229`) +- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_gbq` except ``destination_table``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_hdf` except ``path_or_buf``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_html` except ``buf``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_json` except ``path_or_buf``. (:issue:`54229`) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index c52f9cae78c91..e9d8ba6aab4a8 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -2048,6 +2048,9 @@ def to_dict( return to_dict(self, orient, into, index) + @deprecate_nonkeyword_arguments( + version="3.0", allowed_args=["self", "destination_table"], name="to_gbq" + ) def to_gbq( self, destination_table: str,
- [x] xref #54229 - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added an entry in the latest `doc/source/whatsnew/v2.2.0.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54704
2023-08-23T06:18:06Z
2023-08-23T15:45:50Z
2023-08-23T15:45:49Z
2023-08-23T15:53:28Z
DEPR: deprecated nonkeyword arguments in to_excel
diff --git a/doc/source/whatsnew/v2.2.0.rst b/doc/source/whatsnew/v2.2.0.rst index f03a091541d03..15326aae428d4 100644 --- a/doc/source/whatsnew/v2.2.0.rst +++ b/doc/source/whatsnew/v2.2.0.rst @@ -134,6 +134,7 @@ Deprecations - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_clipboard`. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_csv` except ``path_or_buf``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_dict`. (:issue:`54229`) +- Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_excel` except ``excel_writer``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_gbq` except ``destination_table``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_hdf` except ``path_or_buf``. (:issue:`54229`) - Deprecated allowing non-keyword arguments in :meth:`DataFrame.to_html` except ``buf``. (:issue:`54229`) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a763d46e11939..6e4d3610f4ffa 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2187,6 +2187,9 @@ def _repr_data_resource_(self): # I/O Methods @final + @deprecate_nonkeyword_arguments( + version="3.0", allowed_args=["self", "excel_writer"], name="to_excel" + ) @doc( klass="object", storage_options=_shared_docs["storage_options"], diff --git a/pandas/tests/io/excel/test_openpyxl.py b/pandas/tests/io/excel/test_openpyxl.py index b8d41164792e0..da94c74f2303e 100644 --- a/pandas/tests/io/excel/test_openpyxl.py +++ b/pandas/tests/io/excel/test_openpyxl.py @@ -241,7 +241,7 @@ def test_if_sheet_exists_raises(ext, if_sheet_exists, msg): df = DataFrame({"fruit": ["pear"]}) with tm.ensure_clean(ext) as f: with pytest.raises(ValueError, match=re.escape(msg)): - df.to_excel(f, "foo", engine="openpyxl") + df.to_excel(f, sheet_name="foo", engine="openpyxl") with ExcelWriter( f, engine="openpyxl", mode="a", if_sheet_exists=if_sheet_exists ) as writer: diff --git a/pandas/tests/io/excel/test_readers.py b/pandas/tests/io/excel/test_readers.py index 20bc6e98577d5..6db70c894f692 100644 --- a/pandas/tests/io/excel/test_readers.py +++ b/pandas/tests/io/excel/test_readers.py @@ -591,7 +591,7 @@ def test_dtype_backend(self, read_ext, dtype_backend): } ) with tm.ensure_clean(read_ext) as file_path: - df.to_excel(file_path, "test", index=False) + df.to_excel(file_path, sheet_name="test", index=False) result = pd.read_excel( file_path, sheet_name="test", dtype_backend=dtype_backend ) @@ -623,7 +623,7 @@ def test_dtype_backend_and_dtype(self, read_ext): df = DataFrame({"a": [np.nan, 1.0], "b": [2.5, np.nan]}) with tm.ensure_clean(read_ext) as file_path: - df.to_excel(file_path, "test", index=False) + df.to_excel(file_path, sheet_name="test", index=False) result = pd.read_excel( file_path, sheet_name="test", @@ -647,7 +647,7 @@ def test_dtype_backend_string(self, read_ext, string_storage): } ) with tm.ensure_clean(read_ext) as file_path: - df.to_excel(file_path, "test", index=False) + df.to_excel(file_path, sheet_name="test", index=False) result = pd.read_excel( file_path, sheet_name="test", dtype_backend="numpy_nullable" ) diff --git a/pandas/tests/io/excel/test_writers.py b/pandas/tests/io/excel/test_writers.py index 905c733ea5ef1..9cbb29605a1ec 100644 --- a/pandas/tests/io/excel/test_writers.py +++ b/pandas/tests/io/excel/test_writers.py @@ -79,7 +79,7 @@ def test_read_one_empty_col_no_header(self, ext, header, expected): df = DataFrame([["", 1, 100], ["", 2, 200], ["", 3, 300], ["", 4, 400]]) with tm.ensure_clean(ext) as path: - df.to_excel(path, filename, index=False, header=False) + df.to_excel(path, sheet_name=filename, index=False, header=False) result = pd.read_excel( path, sheet_name=filename, usecols=[0], header=header ) @@ -95,7 +95,7 @@ def test_read_one_empty_col_with_header(self, ext, header, expected): df = DataFrame([["", 1, 100], ["", 2, 200], ["", 3, 300], ["", 4, 400]]) with tm.ensure_clean(ext) as path: - df.to_excel(path, "with_header", index=False, header=True) + df.to_excel(path, sheet_name="with_header", index=False, header=True) result = pd.read_excel( path, sheet_name=filename, usecols=[0], header=header ) @@ -109,8 +109,10 @@ def test_set_column_names_in_parameter(self, ext): with tm.ensure_clean(ext) as pth: with ExcelWriter(pth) as writer: - refdf.to_excel(writer, "Data_no_head", header=False, index=False) - refdf.to_excel(writer, "Data_with_head", index=False) + refdf.to_excel( + writer, sheet_name="Data_no_head", header=False, index=False + ) + refdf.to_excel(writer, sheet_name="Data_with_head", index=False) refdf.columns = ["A", "B"] @@ -145,7 +147,7 @@ def tdf(col_sheet_name): with tm.ensure_clean(ext) as pth: with ExcelWriter(pth) as ew: for sheetname, df in dfs.items(): - df.to_excel(ew, sheetname) + df.to_excel(ew, sheet_name=sheetname) dfs_returned = pd.read_excel(pth, sheet_name=sheets, index_col=0) @@ -371,10 +373,10 @@ def test_excel_sheet_by_name_raise(self, path): def test_excel_writer_context_manager(self, frame, path): with ExcelWriter(path) as writer: - frame.to_excel(writer, "Data1") + frame.to_excel(writer, sheet_name="Data1") frame2 = frame.copy() frame2.columns = frame.columns[::-1] - frame2.to_excel(writer, "Data2") + frame2.to_excel(writer, sheet_name="Data2") with ExcelFile(path) as reader: found_df = pd.read_excel(reader, sheet_name="Data1", index_col=0) @@ -387,42 +389,42 @@ def test_roundtrip(self, frame, path): frame = frame.copy() frame.iloc[:5, frame.columns.get_loc("A")] = np.nan - frame.to_excel(path, "test1") - frame.to_excel(path, "test1", columns=["A", "B"]) - frame.to_excel(path, "test1", header=False) - frame.to_excel(path, "test1", index=False) + frame.to_excel(path, sheet_name="test1") + frame.to_excel(path, sheet_name="test1", columns=["A", "B"]) + frame.to_excel(path, sheet_name="test1", header=False) + frame.to_excel(path, sheet_name="test1", index=False) # test roundtrip - frame.to_excel(path, "test1") + frame.to_excel(path, sheet_name="test1") recons = pd.read_excel(path, sheet_name="test1", index_col=0) tm.assert_frame_equal(frame, recons) - frame.to_excel(path, "test1", index=False) + frame.to_excel(path, sheet_name="test1", index=False) recons = pd.read_excel(path, sheet_name="test1", index_col=None) recons.index = frame.index tm.assert_frame_equal(frame, recons) - frame.to_excel(path, "test1", na_rep="NA") + frame.to_excel(path, sheet_name="test1", na_rep="NA") recons = pd.read_excel(path, sheet_name="test1", index_col=0, na_values=["NA"]) tm.assert_frame_equal(frame, recons) # GH 3611 - frame.to_excel(path, "test1", na_rep="88") + frame.to_excel(path, sheet_name="test1", na_rep="88") recons = pd.read_excel(path, sheet_name="test1", index_col=0, na_values=["88"]) tm.assert_frame_equal(frame, recons) - frame.to_excel(path, "test1", na_rep="88") + frame.to_excel(path, sheet_name="test1", na_rep="88") recons = pd.read_excel( path, sheet_name="test1", index_col=0, na_values=[88, 88.0] ) tm.assert_frame_equal(frame, recons) # GH 6573 - frame.to_excel(path, "Sheet1") + frame.to_excel(path, sheet_name="Sheet1") recons = pd.read_excel(path, index_col=0) tm.assert_frame_equal(frame, recons) - frame.to_excel(path, "0") + frame.to_excel(path, sheet_name="0") recons = pd.read_excel(path, index_col=0) tm.assert_frame_equal(frame, recons) @@ -436,7 +438,7 @@ def test_mixed(self, frame, path): mixed_frame = frame.copy() mixed_frame["foo"] = "bar" - mixed_frame.to_excel(path, "test1") + mixed_frame.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) tm.assert_frame_equal(mixed_frame, recons) @@ -448,7 +450,7 @@ def test_ts_frame(self, tsframe, path): index = pd.DatetimeIndex(np.asarray(df.index), freq=None) df.index = index - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) tm.assert_frame_equal(df, recons) @@ -456,10 +458,10 @@ def test_ts_frame(self, tsframe, path): def test_basics_with_nan(self, frame, path): frame = frame.copy() frame.iloc[:5, frame.columns.get_loc("A")] = np.nan - frame.to_excel(path, "test1") - frame.to_excel(path, "test1", columns=["A", "B"]) - frame.to_excel(path, "test1", header=False) - frame.to_excel(path, "test1", index=False) + frame.to_excel(path, sheet_name="test1") + frame.to_excel(path, sheet_name="test1", columns=["A", "B"]) + frame.to_excel(path, sheet_name="test1", header=False) + frame.to_excel(path, sheet_name="test1", index=False) @pytest.mark.parametrize("np_type", [np.int8, np.int16, np.int32, np.int64]) def test_int_types(self, np_type, path): @@ -468,7 +470,7 @@ def test_int_types(self, np_type, path): df = DataFrame( np.random.default_rng(2).integers(-10, 10, size=(10, 2)), dtype=np_type ) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) @@ -483,7 +485,7 @@ def test_int_types(self, np_type, path): def test_float_types(self, np_type, path): # Test np.float values read come back as float. df = DataFrame(np.random.default_rng(2).random(10), dtype=np_type) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0).astype( @@ -495,7 +497,7 @@ def test_float_types(self, np_type, path): def test_bool_types(self, path): # Test np.bool_ values read come back as float. df = DataFrame([1, 0, True, False], dtype=np.bool_) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0).astype( @@ -506,7 +508,7 @@ def test_bool_types(self, path): def test_inf_roundtrip(self, path): df = DataFrame([(1, np.inf), (2, 3), (5, -np.inf)]) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) @@ -521,15 +523,15 @@ def test_sheets(self, frame, tsframe, path): frame = frame.copy() frame.iloc[:5, frame.columns.get_loc("A")] = np.nan - frame.to_excel(path, "test1") - frame.to_excel(path, "test1", columns=["A", "B"]) - frame.to_excel(path, "test1", header=False) - frame.to_excel(path, "test1", index=False) + frame.to_excel(path, sheet_name="test1") + frame.to_excel(path, sheet_name="test1", columns=["A", "B"]) + frame.to_excel(path, sheet_name="test1", header=False) + frame.to_excel(path, sheet_name="test1", index=False) # Test writing to separate sheets with ExcelWriter(path) as writer: - frame.to_excel(writer, "test1") - tsframe.to_excel(writer, "test2") + frame.to_excel(writer, sheet_name="test1") + tsframe.to_excel(writer, sheet_name="test2") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) tm.assert_frame_equal(frame, recons) @@ -543,14 +545,14 @@ def test_colaliases(self, frame, path): frame = frame.copy() frame.iloc[:5, frame.columns.get_loc("A")] = np.nan - frame.to_excel(path, "test1") - frame.to_excel(path, "test1", columns=["A", "B"]) - frame.to_excel(path, "test1", header=False) - frame.to_excel(path, "test1", index=False) + frame.to_excel(path, sheet_name="test1") + frame.to_excel(path, sheet_name="test1", columns=["A", "B"]) + frame.to_excel(path, sheet_name="test1", header=False) + frame.to_excel(path, sheet_name="test1", index=False) # column aliases col_aliases = Index(["AA", "X", "Y", "Z"]) - frame.to_excel(path, "test1", header=col_aliases) + frame.to_excel(path, sheet_name="test1", header=col_aliases) with ExcelFile(path) as reader: rs = pd.read_excel(reader, sheet_name="test1", index_col=0) xp = frame.copy() @@ -561,14 +563,16 @@ def test_roundtrip_indexlabels(self, merge_cells, frame, path): frame = frame.copy() frame.iloc[:5, frame.columns.get_loc("A")] = np.nan - frame.to_excel(path, "test1") - frame.to_excel(path, "test1", columns=["A", "B"]) - frame.to_excel(path, "test1", header=False) - frame.to_excel(path, "test1", index=False) + frame.to_excel(path, sheet_name="test1") + frame.to_excel(path, sheet_name="test1", columns=["A", "B"]) + frame.to_excel(path, sheet_name="test1", header=False) + frame.to_excel(path, sheet_name="test1", index=False) # test index_label df = DataFrame(np.random.default_rng(2).standard_normal((10, 2))) >= 0 - df.to_excel(path, "test1", index_label=["test"], merge_cells=merge_cells) + df.to_excel( + path, sheet_name="test1", index_label=["test"], merge_cells=merge_cells + ) with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0).astype( np.int64 @@ -579,7 +583,7 @@ def test_roundtrip_indexlabels(self, merge_cells, frame, path): df = DataFrame(np.random.default_rng(2).standard_normal((10, 2))) >= 0 df.to_excel( path, - "test1", + sheet_name="test1", index_label=["test", "dummy", "dummy2"], merge_cells=merge_cells, ) @@ -591,7 +595,9 @@ def test_roundtrip_indexlabels(self, merge_cells, frame, path): assert df.index.names == recons.index.names df = DataFrame(np.random.default_rng(2).standard_normal((10, 2))) >= 0 - df.to_excel(path, "test1", index_label="test", merge_cells=merge_cells) + df.to_excel( + path, sheet_name="test1", index_label="test", merge_cells=merge_cells + ) with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0).astype( np.int64 @@ -601,7 +607,7 @@ def test_roundtrip_indexlabels(self, merge_cells, frame, path): frame.to_excel( path, - "test1", + sheet_name="test1", columns=["A", "B", "C", "D"], index=False, merge_cells=merge_cells, @@ -636,7 +642,7 @@ def test_excel_roundtrip_datetime(self, merge_cells, tsframe, path): tsf = tsframe.copy() tsf.index = [x.date() for x in tsframe.index] - tsf.to_excel(path, "test1", merge_cells=merge_cells) + tsf.to_excel(path, sheet_name="test1", merge_cells=merge_cells) with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) @@ -666,14 +672,14 @@ def test_excel_date_datetime_format(self, ext, path): with tm.ensure_clean(ext) as filename2: with ExcelWriter(path) as writer1: - df.to_excel(writer1, "test1") + df.to_excel(writer1, sheet_name="test1") with ExcelWriter( filename2, date_format="DD.MM.YYYY", datetime_format="DD.MM.YYYY HH-MM-SS", ) as writer2: - df.to_excel(writer2, "test1") + df.to_excel(writer2, sheet_name="test1") with ExcelFile(path) as reader1: rs1 = pd.read_excel(reader1, sheet_name="test1", index_col=0) @@ -699,7 +705,7 @@ def test_to_excel_interval_no_labels(self, path): df["new"] = pd.cut(df[0], 10) expected["new"] = pd.cut(expected[0], 10).astype(str) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) tm.assert_frame_equal(expected, recons) @@ -718,7 +724,7 @@ def test_to_excel_interval_labels(self, path): df["new"] = intervals expected["new"] = pd.Series(list(intervals)) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) tm.assert_frame_equal(expected, recons) @@ -739,7 +745,7 @@ def test_to_excel_timedelta(self, path): lambda x: timedelta(seconds=x).total_seconds() / 86400 ) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=0) tm.assert_frame_equal(expected, recons) @@ -747,7 +753,7 @@ def test_to_excel_timedelta(self, path): def test_to_excel_periodindex(self, tsframe, path): xp = tsframe.resample("M", kind="period").mean() - xp.to_excel(path, "sht1") + xp.to_excel(path, sheet_name="sht1") with ExcelFile(path) as reader: rs = pd.read_excel(reader, sheet_name="sht1", index_col=0) @@ -758,11 +764,11 @@ def test_to_excel_multiindex(self, merge_cells, frame, path): new_index = MultiIndex.from_arrays(arrays, names=["first", "second"]) frame.index = new_index - frame.to_excel(path, "test1", header=False) - frame.to_excel(path, "test1", columns=["A", "B"]) + frame.to_excel(path, sheet_name="test1", header=False) + frame.to_excel(path, sheet_name="test1", columns=["A", "B"]) # round trip - frame.to_excel(path, "test1", merge_cells=merge_cells) + frame.to_excel(path, sheet_name="test1", merge_cells=merge_cells) with ExcelFile(path) as reader: df = pd.read_excel(reader, sheet_name="test1", index_col=[0, 1]) tm.assert_frame_equal(frame, df) @@ -797,7 +803,7 @@ def test_to_excel_multiindex_cols(self, merge_cells, frame, path): header = 0 # round trip - frame.to_excel(path, "test1", merge_cells=merge_cells) + frame.to_excel(path, sheet_name="test1", merge_cells=merge_cells) with ExcelFile(path) as reader: df = pd.read_excel( reader, sheet_name="test1", header=header, index_col=[0, 1] @@ -813,7 +819,7 @@ def test_to_excel_multiindex_dates(self, merge_cells, tsframe, path): tsframe.index = MultiIndex.from_arrays(new_index) tsframe.index.names = ["time", "foo"] - tsframe.to_excel(path, "test1", merge_cells=merge_cells) + tsframe.to_excel(path, sheet_name="test1", merge_cells=merge_cells) with ExcelFile(path) as reader: recons = pd.read_excel(reader, sheet_name="test1", index_col=[0, 1]) @@ -832,7 +838,7 @@ def test_to_excel_multiindex_no_write_index(self, path): frame2.index = multi_index # Write out to Excel without the index. - frame2.to_excel(path, "test1", index=False) + frame2.to_excel(path, sheet_name="test1", index=False) # Read it back in. with ExcelFile(path) as reader: @@ -846,7 +852,7 @@ def test_to_excel_empty_multiindex(self, path): expected = DataFrame([], columns=[0, 1, 2]) df = DataFrame([], index=MultiIndex.from_tuples([], names=[0, 1]), columns=[2]) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") with ExcelFile(path) as reader: result = pd.read_excel(reader, sheet_name="test1") @@ -860,7 +866,7 @@ def test_to_excel_float_format(self, path): index=["A", "B"], columns=["X", "Y", "Z"], ) - df.to_excel(path, "test1", float_format="%.2f") + df.to_excel(path, sheet_name="test1", float_format="%.2f") with ExcelFile(path) as reader: result = pd.read_excel(reader, sheet_name="test1", index_col=0) @@ -898,7 +904,7 @@ def test_to_excel_unicode_filename(self, ext): index=["A", "B"], columns=["X", "Y", "Z"], ) - df.to_excel(filename, "test1", float_format="%.2f") + df.to_excel(filename, sheet_name="test1", float_format="%.2f") with ExcelFile(filename) as reader: result = pd.read_excel(reader, sheet_name="test1", index_col=0) @@ -968,7 +974,7 @@ def roundtrip(data, header=True, parser_hdr=0, index=True): def test_duplicated_columns(self, path): # see gh-5235 df = DataFrame([[1, 2, 3], [1, 2, 3], [1, 2, 3]], columns=["A", "B", "B"]) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") expected = DataFrame( [[1, 2, 3], [1, 2, 3], [1, 2, 3]], columns=["A", "B", "B.1"] ) @@ -979,7 +985,7 @@ def test_duplicated_columns(self, path): # see gh-11007, gh-10970 df = DataFrame([[1, 2, 3, 4], [5, 6, 7, 8]], columns=["A", "B", "A", "B"]) - df.to_excel(path, "test1") + df.to_excel(path, sheet_name="test1") result = pd.read_excel(path, sheet_name="test1", index_col=0) expected = DataFrame( @@ -988,7 +994,7 @@ def test_duplicated_columns(self, path): tm.assert_frame_equal(result, expected) # see gh-10982 - df.to_excel(path, "test1", index=False, header=False) + df.to_excel(path, sheet_name="test1", index=False, header=False) result = pd.read_excel(path, sheet_name="test1", header=None) expected = DataFrame([[1, 2, 3, 4], [5, 6, 7, 8]]) @@ -997,7 +1003,7 @@ def test_duplicated_columns(self, path): def test_swapped_columns(self, path): # Test for issue #5427. write_frame = DataFrame({"A": [1, 1, 1], "B": [2, 2, 2]}) - write_frame.to_excel(path, "test1", columns=["B", "A"]) + write_frame.to_excel(path, sheet_name="test1", columns=["B", "A"]) read_frame = pd.read_excel(path, sheet_name="test1", header=0) @@ -1009,12 +1015,12 @@ def test_invalid_columns(self, path): write_frame = DataFrame({"A": [1, 1, 1], "B": [2, 2, 2]}) with pytest.raises(KeyError, match="Not all names specified"): - write_frame.to_excel(path, "test1", columns=["B", "C"]) + write_frame.to_excel(path, sheet_name="test1", columns=["B", "C"]) with pytest.raises( KeyError, match="'passes columns are not ALL present dataframe'" ): - write_frame.to_excel(path, "test1", columns=["C", "D"]) + write_frame.to_excel(path, sheet_name="test1", columns=["C", "D"]) @pytest.mark.parametrize( "to_excel_index,read_excel_index_col", @@ -1027,7 +1033,7 @@ def test_write_subset_columns(self, path, to_excel_index, read_excel_index_col): # GH 31677 write_frame = DataFrame({"A": [1, 1, 1], "B": [2, 2, 2], "C": [3, 3, 3]}) write_frame.to_excel( - path, "col_subset_bug", columns=["A", "B"], index=to_excel_index + path, sheet_name="col_subset_bug", columns=["A", "B"], index=to_excel_index ) expected = write_frame[["A", "B"]] @@ -1044,7 +1050,7 @@ def test_comment_arg(self, path): # Create file to read in. df = DataFrame({"A": ["one", "#one", "one"], "B": ["two", "two", "#two"]}) - df.to_excel(path, "test_c") + df.to_excel(path, sheet_name="test_c") # Read file without comment arg. result1 = pd.read_excel(path, sheet_name="test_c", index_col=0) @@ -1062,7 +1068,7 @@ def test_comment_default(self, path): # Create file to read in df = DataFrame({"A": ["one", "#one", "one"], "B": ["two", "two", "#two"]}) - df.to_excel(path, "test_c") + df.to_excel(path, sheet_name="test_c") # Read file with default and explicit comment=None result1 = pd.read_excel(path, sheet_name="test_c") @@ -1076,7 +1082,7 @@ def test_comment_used(self, path): # Create file to read in. df = DataFrame({"A": ["one", "#one", "one"], "B": ["two", "two", "#two"]}) - df.to_excel(path, "test_c") + df.to_excel(path, sheet_name="test_c") # Test read_frame_comment against manually produced expected output. expected = DataFrame({"A": ["one", None, "one"], "B": ["two", None, None]}) @@ -1112,7 +1118,7 @@ def test_datetimes(self, path): ] write_frame = DataFrame({"A": datetimes}) - write_frame.to_excel(path, "Sheet1") + write_frame.to_excel(path, sheet_name="Sheet1") read_frame = pd.read_excel(path, sheet_name="Sheet1", header=0) tm.assert_series_equal(write_frame["A"], read_frame["A"]) @@ -1171,7 +1177,7 @@ def test_write_lists_dict(self, path): "str": ["apple", "banana", "cherry"], } ) - df.to_excel(path, "Sheet1") + df.to_excel(path, sheet_name="Sheet1") read = pd.read_excel(path, sheet_name="Sheet1", header=0, index_col=0) expected = df.copy() @@ -1183,7 +1189,7 @@ def test_write_lists_dict(self, path): def test_render_as_column_name(self, path): # see gh-34331 df = DataFrame({"render": [1, 2], "data": [3, 4]}) - df.to_excel(path, "Sheet1") + df.to_excel(path, sheet_name="Sheet1") read = pd.read_excel(path, "Sheet1", index_col=0) expected = df tm.assert_frame_equal(read, expected) @@ -1202,7 +1208,7 @@ def test_true_and_false_value_options(self, path): def test_freeze_panes(self, path): # see gh-15160 expected = DataFrame([[1, 2], [3, 4]], columns=["col1", "col2"]) - expected.to_excel(path, "Sheet1", freeze_panes=(1, 1)) + expected.to_excel(path, sheet_name="Sheet1", freeze_panes=(1, 1)) result = pd.read_excel(path, index_col=0) tm.assert_frame_equal(result, expected) @@ -1372,6 +1378,18 @@ def test_excelwriter_fspath(self): with ExcelWriter(path) as writer: assert os.fspath(writer) == str(path) + def test_to_excel_pos_args_deprecation(self): + # GH-54229 + df = DataFrame({"a": [1, 2, 3]}) + msg = ( + r"Starting with pandas version 3.0 all arguments of to_excel except " + r"for the argument 'excel_writer' will be keyword-only." + ) + with tm.assert_produces_warning(FutureWarning, match=msg): + buf = BytesIO() + writer = ExcelWriter(buf) + df.to_excel(writer, "Sheet_name_1") + @pytest.mark.parametrize("klass", _writers.values()) def test_subclass_attr(klass):
- [x] closes #54229 - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added an entry in the latest `doc/source/whatsnew/v2.2.0.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54703
2023-08-23T06:12:42Z
2023-08-23T21:15:48Z
2023-08-23T21:15:48Z
2023-08-24T05:44:20Z
TST: added test for fixed bug gh#50372
diff --git a/pandas/tests/indexing/multiindex/test_getitem.py b/pandas/tests/indexing/multiindex/test_getitem.py index e2fbc0653695b..9d11827e2923e 100644 --- a/pandas/tests/indexing/multiindex/test_getitem.py +++ b/pandas/tests/indexing/multiindex/test_getitem.py @@ -145,6 +145,23 @@ def test_frame_getitem_simple_key_error( indexer(df) +def test_tuple_string_column_names(): + # GH#50372 + mi = MultiIndex.from_tuples([("a", "aa"), ("a", "ab"), ("b", "ba"), ("b", "bb")]) + df = DataFrame([range(0, 4), range(1, 5), range(2, 6)], columns=mi) + df["single_index"] = 0 + + df_flat = df.copy() + df_flat.columns = df_flat.columns.to_flat_index() + df_flat["new_single_index"] = 0 + + result = df_flat[[("a", "aa"), "new_single_index"]] + expected = DataFrame( + [[0, 0], [1, 0], [2, 0]], columns=Index([("a", "aa"), "new_single_index"]) + ) + tm.assert_frame_equal(result, expected) + + def test_frame_getitem_multicolumn_empty_level(): df = DataFrame({"a": ["1", "2", "3"], "b": ["2", "3", "4"]}) df.columns = [
- [x] closes #50372 - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). I added a test to prevent the bug described in GG#50372 from happening again.
https://api.github.com/repos/pandas-dev/pandas/pulls/54701
2023-08-23T04:19:26Z
2023-08-23T21:12:44Z
2023-08-23T21:12:44Z
2023-08-23T21:12:51Z
Backport PR #54508 on branch 2.1.x (PERF: DataFrame.iloc[int] for EA dtypes)
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index 7dd2fb570c695..3f7226890a5b5 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -622,6 +622,7 @@ Performance improvements - Performance improvement in :meth:`.ArrowExtensionArray.to_numpy` (:issue:`52525`) - Performance improvement in :meth:`.DataFrameGroupBy.groups` (:issue:`53088`) - Performance improvement in :meth:`DataFrame.astype` when ``dtype`` is an extension dtype (:issue:`54299`) +- Performance improvement in :meth:`DataFrame.iloc` when input is an single integer and dataframe is backed by extension dtypes (:issue:`54508`) - Performance improvement in :meth:`DataFrame.isin` for extension dtypes (:issue:`53514`) - Performance improvement in :meth:`DataFrame.loc` when selecting rows and columns (:issue:`53014`) - Performance improvement in :meth:`DataFrame.transpose` when transposing a DataFrame with a single PyArrow dtype (:issue:`54224`) diff --git a/pandas/core/internals/managers.py b/pandas/core/internals/managers.py index 7bb579b22aeed..4a6d3c333a6a5 100644 --- a/pandas/core/internals/managers.py +++ b/pandas/core/internals/managers.py @@ -968,19 +968,10 @@ def fast_xs(self, loc: int) -> SingleBlockManager: n = len(self) - # GH#46406 - immutable_ea = isinstance(dtype, ExtensionDtype) and dtype._is_immutable - - if isinstance(dtype, ExtensionDtype) and not immutable_ea: - cls = dtype.construct_array_type() - result = cls._empty((n,), dtype=dtype) + if isinstance(dtype, ExtensionDtype): + result = np.empty(n, dtype=object) else: - # error: Argument "dtype" to "empty" has incompatible type - # "Union[Type[object], dtype[Any], ExtensionDtype, None]"; expected - # "None" - result = np.empty( - n, dtype=object if immutable_ea else dtype # type: ignore[arg-type] - ) + result = np.empty(n, dtype=dtype) result = ensure_wrapped_if_datetimelike(result) for blk in self.blocks: @@ -989,9 +980,9 @@ def fast_xs(self, loc: int) -> SingleBlockManager: for i, rl in enumerate(blk.mgr_locs): result[rl] = blk.iget((i, loc)) - if immutable_ea: - dtype = cast(ExtensionDtype, dtype) - result = dtype.construct_array_type()._from_sequence(result, dtype=dtype) + if isinstance(dtype, ExtensionDtype): + cls = dtype.construct_array_type() + result = cls._from_sequence(result, dtype=dtype) bp = BlockPlacement(slice(0, len(result))) block = new_block(result, placement=bp, ndim=1)
Backport PR #54508: PERF: DataFrame.iloc[int] for EA dtypes
https://api.github.com/repos/pandas-dev/pandas/pulls/54700
2023-08-23T00:23:59Z
2023-08-23T02:42:44Z
2023-08-23T02:42:44Z
2023-08-23T02:42:44Z
BUG: setitem with object type inserting Series maintains Series
diff --git a/doc/source/whatsnew/v2.1.0.rst b/doc/source/whatsnew/v2.1.0.rst index b79797fa86431..f12caf3fb7ab6 100644 --- a/doc/source/whatsnew/v2.1.0.rst +++ b/doc/source/whatsnew/v2.1.0.rst @@ -727,6 +727,7 @@ Indexing - Bug in :meth:`DataFrame.__setitem__` losing dtype when setting a :class:`DataFrame` into duplicated columns (:issue:`53143`) - Bug in :meth:`DataFrame.__setitem__` with a boolean mask and :meth:`DataFrame.putmask` with mixed non-numeric dtypes and a value other than ``NaN`` incorrectly raising ``TypeError`` (:issue:`53291`) - Bug in :meth:`DataFrame.iloc` when using ``nan`` as the only element (:issue:`52234`) +- Bug in :meth:`Series.loc` casting :class:`Series` to ``np.dnarray`` when assigning :class:`Series` at predefined index of ``object`` dtype :class:`Series` (:issue:`48933`) Missing ^^^^^^^ diff --git a/pandas/core/internals/blocks.py b/pandas/core/internals/blocks.py index ffaeef14e42a5..c1f02561d92e7 100644 --- a/pandas/core/internals/blocks.py +++ b/pandas/core/internals/blocks.py @@ -1132,7 +1132,9 @@ def setitem(self, indexer, value, using_cow: bool = False) -> Block: # length checking check_setitem_lengths(indexer, value, values) - value = extract_array(value, extract_numpy=True) + if self.dtype != _dtype_obj: + # GH48933: extract_array would convert a pd.Series value to np.ndarray + value = extract_array(value, extract_numpy=True) try: casted = np_can_hold_element(values.dtype, value) except LossySetitemError: diff --git a/pandas/tests/indexing/test_indexing.py b/pandas/tests/indexing/test_indexing.py index d6d8a63797bb6..224555399ff8f 100644 --- a/pandas/tests/indexing/test_indexing.py +++ b/pandas/tests/indexing/test_indexing.py @@ -1132,3 +1132,19 @@ def test_scalar_setitem_series_with_nested_value_length1(value, indexer_sli): assert (ser.loc[0] == value).all() else: assert ser.loc[0] == value + + +def test_object_dtype_series_set_series_element(): + # GH 48933 + s1 = Series(dtype="O", index=["a", "b"]) + + s1["a"] = Series() + s1.loc["b"] = Series() + + tm.assert_series_equal(s1.loc["a"], Series()) + tm.assert_series_equal(s1.loc["b"], Series()) + + s2 = Series(dtype="O", index=["a", "b"]) + + s2.iloc[1] = Series() + tm.assert_series_equal(s2.iloc[1], Series())
- [x] closes #48933 (Replace xxxx with the GitHub issue number) - [x] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [x] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [x] Added an entry in the latest `doc/source/whatsnew/vX.X.X.rst` file if fixing a bug or adding a new feature.
https://api.github.com/repos/pandas-dev/pandas/pulls/54699
2023-08-23T00:15:22Z
2023-08-25T18:01:45Z
2023-08-25T18:01:45Z
2023-08-25T18:01:48Z