From d5337d13c39be131ac50ee65aca90494bcc1ddd2 Mon Sep 17 00:00:00 2001 From: gfyoung Date: Mon, 9 Oct 2017 22:05:48 -0700 Subject: [PATCH] DEPR: Deprecate the convert parameter completely Previously, we weren't issuing a warning if the user happened to pass in the original default of "True", which would cause downstream code to break. Closes gh-17828. --- pandas/compat/numpy/function.py | 6 +++--- pandas/core/generic.py | 13 ++++++++++--- pandas/core/sparse/series.py | 8 ++++---- pandas/tests/frame/test_axis_select_reindex.py | 4 ++++ pandas/tests/sparse/test_series.py | 14 ++++++-------- 5 files changed, 27 insertions(+), 18 deletions(-) diff --git a/pandas/compat/numpy/function.py b/pandas/compat/numpy/function.py index d42be569635696..d76512c988022b 100644 --- a/pandas/compat/numpy/function.py +++ b/pandas/compat/numpy/function.py @@ -247,11 +247,11 @@ def validate_take_with_convert(convert, args, kwargs): """ If this function is called via the 'numpy' library, the third parameter in its signature is 'axis', which takes either an - ndarray or 'None', so check if the 'convert' parameter is either - an instance of ndarray or is None + ndarray or 'None'. We don't mind if 'convert' is 'None', but we + should check if it is an instance of ndarray. """ - if isinstance(convert, ndarray) or convert is None: + if isinstance(convert, ndarray): args = (convert,) + args convert = True diff --git a/pandas/core/generic.py b/pandas/core/generic.py index c7ae9bbee90130..f1a7d71a296dcb 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2135,13 +2135,18 @@ def _take(self, indices, axis=0, convert=True, is_copy=True): axis : int, default 0 The axis on which to select elements. "0" means that we are selecting rows, "1" means that we are selecting columns, etc. - convert : bool, default True + convert : bool, default None .. deprecated:: 0.21.0 + In the future, negative indices will always be converted. Whether to convert negative indices into positive ones. For example, ``-1`` would map to the ``len(axis) - 1``. The conversions are similar to the behavior of indexing a regular Python list. + + If ``None`` is passed in, negative indices will be converted + to positive indices. + is_copy : bool, default True Whether to return a copy of the original object or not. @@ -2199,13 +2204,15 @@ class max_speed """ @Appender(_shared_docs['take']) - def take(self, indices, axis=0, convert=True, is_copy=True, **kwargs): + def take(self, indices, axis=0, convert=None, is_copy=True, **kwargs): nv.validate_take(tuple(), kwargs) - if not convert: + if convert is not None: msg = ("The 'convert' parameter is deprecated " "and will be removed in a future version.") warnings.warn(msg, FutureWarning, stacklevel=2) + else: + convert = True return self._take(indices, axis=axis, convert=convert, is_copy=is_copy) diff --git a/pandas/core/sparse/series.py b/pandas/core/sparse/series.py index 3255bd6bd17e8c..380b2a50446161 100644 --- a/pandas/core/sparse/series.py +++ b/pandas/core/sparse/series.py @@ -386,7 +386,7 @@ def _ixs(self, i, axis=0): """ label = self.index[i] if isinstance(label, Index): - return self.take(i, axis=axis, convert=True) + return self.take(i, axis=axis) else: return self._get_val_at(i) @@ -628,10 +628,10 @@ def sparse_reindex(self, new_index): fill_value=self.fill_value).__finalize__(self) @Appender(generic._shared_docs['take']) - def take(self, indices, axis=0, convert=True, *args, **kwargs): - convert = nv.validate_take_with_convert(convert, args, kwargs) + def take(self, indices, axis=0, convert=None, *args, **kwargs): + nv.validate_take_with_convert(convert, args, kwargs) - if not convert: + if convert is not None: msg = ("The 'convert' parameter is deprecated " "and will be removed in a future version.") warnings.warn(msg, FutureWarning, stacklevel=2) diff --git a/pandas/tests/frame/test_axis_select_reindex.py b/pandas/tests/frame/test_axis_select_reindex.py index f9a4275d14f55d..1377104ebd5577 100644 --- a/pandas/tests/frame/test_axis_select_reindex.py +++ b/pandas/tests/frame/test_axis_select_reindex.py @@ -852,6 +852,10 @@ def test_take(self): expected = df.reindex(df.index.take(order)) assert_frame_equal(result, expected) + with tm.assert_produces_warning(FutureWarning): + result = df.take(order, convert=False, axis=0) + assert_frame_equal(result, expected) + with tm.assert_produces_warning(FutureWarning): result = df.take(order, convert=False, axis=0) assert_frame_equal(result, expected) diff --git a/pandas/tests/sparse/test_series.py b/pandas/tests/sparse/test_series.py index 7c7399317809f4..89445a6faa955a 100644 --- a/pandas/tests/sparse/test_series.py +++ b/pandas/tests/sparse/test_series.py @@ -10,7 +10,7 @@ import pandas as pd from pandas import (Series, DataFrame, bdate_range, - isna, compat, _np_version_under1p12) + isna, compat) from pandas.tseries.offsets import BDay import pandas.util.testing as tm from pandas.compat import range @@ -528,6 +528,9 @@ def _compare(idx): exp = pd.Series(np.repeat(nan, 5)) tm.assert_series_equal(sp.take([0, 1, 2, 3, 4]), exp) + with tm.assert_produces_warning(FutureWarning): + sp.take([1, 5], convert=True) + with tm.assert_produces_warning(FutureWarning): sp.take([1, 5], convert=False) @@ -535,13 +538,8 @@ def test_numpy_take(self): sp = SparseSeries([1.0, 2.0, 3.0]) indices = [1, 2] - # gh-17352: older versions of numpy don't properly - # pass in arguments to downstream .take() implementations. - warning = FutureWarning if _np_version_under1p12 else None - - with tm.assert_produces_warning(warning, check_stacklevel=False): - tm.assert_series_equal(np.take(sp, indices, axis=0).to_dense(), - np.take(sp.to_dense(), indices, axis=0)) + tm.assert_series_equal(np.take(sp, indices, axis=0).to_dense(), + np.take(sp.to_dense(), indices, axis=0)) msg = "the 'out' parameter is not supported" tm.assert_raises_regex(ValueError, msg, np.take,