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.

Sign up for GitHub

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 15 commits into from
Jun 5, 2021
Merged

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

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
638255f
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 28, 2021
fc93316
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 28, 2021
c526864
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 28, 2021
99ffd77
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 28, 2021
9f1363f
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 28, 2021
4990a15
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 28, 2021
afa41d0
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 28, 2021
b99fa40
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 29, 2021
3d8eff7
Merge remote-tracking branch 'upstream/master' into Deprecation-for-i…
Anupam-USP May 29, 2021
f6076d2
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP May 30, 2021
b47ecc2
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP Jun 2, 2021
c27e606
Merge remote-tracking branch 'upstream/master' into Deprecation-for-i…
Anupam-USP Jun 2, 2021
2954950
ENH: Deprecate non-keyword arguments for interpolate
Anupam-USP Jun 3, 2021
3497b5a
Merge branch 'pandas-dev:master' into Deprecation-for-interpolate
Anupam-USP Jun 4, 2021
7ff25da
Update pandas/tests/resample/test_deprecated.py
MarcoGorelli Jun 4, 2021
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -683,6 +683,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:`Resampler.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
2 changes: 2 additions & 0 deletions pandas/core/resample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
from pandas.util._decorators import (
Appender,
Substitution,
deprecate_nonkeyword_arguments,
doc,
)

Expand Down Expand Up @@ -832,6 +833,7 @@ 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
33 changes: 33 additions & 0 deletions pandas/tests/resample/test_deprecated.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,36 @@ 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():
# GH 41485
df = DataFrame({"ds": ["1992-08-27 07:46:48", "1992-08-27 07:46:59"], "y": [1, 4]})
s = Series(
df.iloc[:, 1].values.reshape(-1), index=pd.to_datetime(df.iloc[:, 0].values)
)
Copy link
Member

Choose a reason for hiding this comment

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

Is there a simpler way to create s?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it is needed to give this logic for s, otherwise it is taking the indexes making it not operable

Copy link
Member

Choose a reason for hiding this comment

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

can you do something like

idx = pd.to_datetime(["1992-08-27 07:46:48", "1992-08-27 07:46:59"])
df = DataFrame({'y': [1, 4]}, index=idx)
ser = Series([1, 4], index=idx)


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

with tm.assert_produces_warning(FutureWarning, match=msg):
result = s.resample("3S").interpolate("linear", 0)

df = DataFrame(
{
"ds": [
"1992-08-27 07:46:48",
"1992-08-27 07:46:51",
"1992-08-27 07:46:54",
"1992-08-27 07:46:57",
],
"y": [1.0, 1.0, 1.0, 1.0],
}
)
expected = Series(
df.iloc[:, 1].values.reshape(-1), index=pd.to_datetime(df.iloc[:, 0].values)
)
Copy link
Member

Choose a reason for hiding this comment

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

construct expected explicitly, don't put logic in tests

expected.index.freq = "3s"
Copy link
Member

Choose a reason for hiding this comment

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

@jbrockmendel in other tests I've seen you do

    expected.index._data.freq = "3s"
  • is that preferrable here, or is this OK?

Copy link
Member

Choose a reason for hiding this comment

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

the ._data.freq = is preferable

tm.assert_series_equal(result, expected)