Skip to content

ENH: Deprecate non-keyword arguments for Resampler.interpolate #41699

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

Merged
Merged
Show file tree
Hide file tree
Changes from 4 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
1 change: 1 addition & 0 deletions doc/source/whatsnew/v1.3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -682,6 +682,7 @@ Deprecations
- Deprecated passing arguments as positional (except for ``"codes"``) in :meth:`MultiIndex.codes` (:issue:`41485`)
- Deprecated passing arguments as positional in :meth:`Index.set_names` and :meth:`MultiIndex.set_names` (except for ``names``) (:issue:`41485`)
- Deprecated passing arguments (apart from ``cond`` and ``other``) as positional in :meth:`DataFrame.mask` and :meth:`Series.mask` (:issue:`41485`)
- Deprecated passing arguments as positional in :meth:`DataFrame.interpolate` (other than ``"method``) (:issue:`41485`)
- Deprecated passing arguments as positional in :meth:`DataFrame.clip` and :meth:`Series.clip` (other than ``"upper"`` and ``"lower"``) (:issue:`41485`)
- Deprecated special treatment of lists with first element a Categorical in the :class:`DataFrame` constructor; pass as ``pd.DataFrame({col: categorical, ...})`` instead (:issue:`38845`)
- Deprecated passing arguments as positional (except for ``"method"``) in :meth:`DataFrame.interpolate` and :meth:`Series.interpolate` (:issue:`41485`)
Expand Down
4 changes: 4 additions & 0 deletions pandas/core/resample.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
Appender,
Substitution,
doc,
deprecate_nonkeyword_arguments
)

from pandas.core.dtypes.generic import (
Expand Down Expand Up @@ -832,6 +833,9 @@ def fillna(self, method, limit=None):
"""
return self._upsample(method, limit=limit)

@deprecate_nonkeyword_arguments(
version=None, allowed_args=["self", "method"]
)
@doc(NDFrame.interpolate, **_shared_docs_kwargs)
def interpolate(
self,
Expand Down
16 changes: 16 additions & 0 deletions pandas/tests/resample/test_deprecated.py
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,19 @@ def test_resample_base_with_timedeltaindex():

tm.assert_index_equal(without_base.index, exp_without_base)
tm.assert_index_equal(with_base.index, exp_with_base)


def test_interpolate_posargs_deprecation():

df = DataFrame([1.0, np.nan, -2.0, 2.0])

msg = (
r"In a future version of pandas all arguments of DataFrame\.interpolate "
r"except for the argument 'method' will be keyword-only"
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this test pass? The message doesn't seem right, and I"d expect it to be different for the Series case

Have you run

pytest pandas/tests/resample/test_deprecated.py

locally?

Copy link
Contributor Author

@Anupam-USP Anupam-USP May 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is giving me following error AssertionError: Did not see expected warning of class 'FutureWarning'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, so that needs fixing first :) I suggest you remove the with tm.assert_produces_warning, dedent the following line, run the test, check what error message you get, and use that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done that, got new issues due to resample("3s"), trying to resolve it. I think I have to create expected in another way.


with tm.assert_produces_warning(FutureWarning, match=msg):
result = df.interpolate(method='linear', limit_direction='forward', axis=0)

expected = DataFrame([1.0, -0.5, -2.0, 2.0])
tm.assert_frame_equal(result, expected)