Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEPR: enforce deprecation of slice_shift #49271

Merged
merged 1 commit into from
Oct 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions doc/redirects.csv
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,6 @@ generated/pandas.DataFrame.shape,../reference/api/pandas.DataFrame.shape
generated/pandas.DataFrame.shift,../reference/api/pandas.DataFrame.shift
generated/pandas.DataFrame.size,../reference/api/pandas.DataFrame.size
generated/pandas.DataFrame.skew,../reference/api/pandas.DataFrame.skew
generated/pandas.DataFrame.slice_shift,../reference/api/pandas.DataFrame.slice_shift
generated/pandas.DataFrame.sort_index,../reference/api/pandas.DataFrame.sort_index
generated/pandas.DataFrame.sort_values,../reference/api/pandas.DataFrame.sort_values
generated/pandas.DataFrame.squeeze,../reference/api/pandas.DataFrame.squeeze
Expand Down Expand Up @@ -1166,7 +1165,6 @@ generated/pandas.Series.shape,../reference/api/pandas.Series.shape
generated/pandas.Series.shift,../reference/api/pandas.Series.shift
generated/pandas.Series.size,../reference/api/pandas.Series.size
generated/pandas.Series.skew,../reference/api/pandas.Series.skew
generated/pandas.Series.slice_shift,../reference/api/pandas.Series.slice_shift
generated/pandas.Series.sort_index,../reference/api/pandas.Series.sort_index
generated/pandas.Series.sort_values,../reference/api/pandas.Series.sort_values
generated/pandas.Series.sparse.density,../reference/api/pandas.Series.sparse.density
Expand Down
1 change: 0 additions & 1 deletion doc/source/reference/frame.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,6 @@ Time Series-related
DataFrame.asfreq
DataFrame.asof
DataFrame.shift
DataFrame.slice_shift
DataFrame.first_valid_index
DataFrame.last_valid_index
DataFrame.resample
Expand Down
1 change: 0 additions & 1 deletion doc/source/reference/series.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,6 @@ Time Series-related
Series.tz_localize
Series.at_time
Series.between_time
Series.slice_shift

Accessors
---------
Expand Down
1 change: 1 addition & 0 deletions doc/source/whatsnew/v2.0.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ Removal of prior version deprecations/changes
- Removed the ``numeric_only`` keyword from :meth:`Categorical.min` and :meth:`Categorical.max` in favor of ``skipna`` (:issue:`48821`)
- Removed :func:`is_extension_type` in favor of :func:`is_extension_array_dtype` (:issue:`29457`)
- Removed :meth:`Index.get_value` and :meth:`Index.set_value` (:issue:`33907`, :issue:`28621`)
- Removed :meth:`Series.slice_shift` and :meth:`DataFrame.slice_shift` (:issue:`37601`)
- Remove :meth:`DataFrameGroupBy.pad` and :meth:`DataFrameGroupBy.backfill` (:issue:`45076`)
- Remove ``numpy`` argument from :func:`read_json` (:issue:`30636`)
- Removed the ``center`` keyword in :meth:`DataFrame.expanding` (:issue:`20647`)
Expand Down
51 changes: 0 additions & 51 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -10219,57 +10219,6 @@ def shift(
result = self.set_axis(new_ax, axis=axis)
return result.__finalize__(self, method="shift")

@final
def slice_shift(self: NDFrameT, periods: int = 1, axis: Axis = 0) -> NDFrameT:
"""
Equivalent to `shift` without copying data.

.. deprecated:: 1.2.0
slice_shift is deprecated,
use DataFrame/Series.shift instead.

The shifted data will not include the dropped periods and the
shifted axis will be smaller than the original.

Parameters
----------
periods : int
Number of periods to move, can be positive or negative.
axis : {0 or 'index', 1 or 'columns', None}, default 0
For `Series` this parameter is unused and defaults to 0.

Returns
-------
shifted : same type as caller

Notes
-----
While the `slice_shift` is faster than `shift`, you may pay for it
later during alignment.
"""

msg = (
"The 'slice_shift' method is deprecated "
"and will be removed in a future version. "
"You can use DataFrame/Series.shift instead."
)
warnings.warn(msg, FutureWarning, stacklevel=find_stack_level())

if periods == 0:
return self

if periods > 0:
vslicer = slice(None, -periods)
islicer = slice(periods, None)
else:
vslicer = slice(-periods, None)
islicer = slice(None, periods)

new_obj = self._slice(vslicer, axis=axis)
shifted_axis = self._get_axis(axis)[islicer]
new_obj = new_obj.set_axis(shifted_axis, axis=axis, copy=False)
return new_obj.__finalize__(self, method="slice_shift")

def truncate(
self: NDFrameT,
before=None,
Expand Down
8 changes: 0 additions & 8 deletions pandas/tests/generic/test_generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -462,11 +462,3 @@ def test_flags_identity(self, frame_or_series):
assert obj.flags is obj.flags
obj2 = obj.copy()
assert obj2.flags is not obj.flags

def test_slice_shift_deprecated(self, frame_or_series):
# GH 37601
obj = DataFrame({"A": [1, 2, 3, 4]})
obj = tm.get_obj(obj, frame_or_series)

with tm.assert_produces_warning(FutureWarning):
obj.slice_shift()