Skip to content

Commit 8e95b60

Browse files
authored
Remove keep_attrs from resample signature (#8444)
1 parent e5d163a commit 8e95b60

File tree

5 files changed

+3
-22
lines changed

5 files changed

+3
-22
lines changed

doc/whats-new.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ Deprecations
4747
existing methods work and don't raise any warnings, given the relatively small
4848
benefits of the change.
4949
By `Maximilian Roos <https://github.com/max-sixty>`_.
50+
- Finally remove ``keep_attrs`` kwarg from :py:meth:`DataArray.resample` and
51+
:py:meth:`Dataset.resample`. These were deprecated a long time ago.
52+
By `Deepak Cherian <https://github.com/dcherian>`_.
5053

5154
Bug fixes
5255
~~~~~~~~~

xarray/core/common.py

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -860,7 +860,6 @@ def _resample(
860860
base: int | None,
861861
offset: pd.Timedelta | datetime.timedelta | str | None,
862862
origin: str | DatetimeLike,
863-
keep_attrs: bool | None,
864863
loffset: datetime.timedelta | str | None,
865864
restore_coord_dims: bool | None,
866865
**indexer_kwargs: str,
@@ -989,13 +988,6 @@ def _resample(
989988
from xarray.core.pdcompat import _convert_base_to_offset
990989
from xarray.core.resample import RESAMPLE_DIM
991990

992-
if keep_attrs is not None:
993-
warnings.warn(
994-
"Passing ``keep_attrs`` to ``resample`` has no effect and will raise an"
995-
" error in xarray 0.20. Pass ``keep_attrs`` directly to the applied"
996-
" function, e.g. ``resample(...).mean(keep_attrs=True)``."
997-
)
998-
999991
# note: the second argument (now 'skipna') use to be 'dim'
1000992
if (
1001993
(skipna is not None and not isinstance(skipna, bool))

xarray/core/dataarray.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7021,7 +7021,6 @@ def resample(
70217021
base: int | None = None,
70227022
offset: pd.Timedelta | datetime.timedelta | str | None = None,
70237023
origin: str | DatetimeLike = "start_day",
7024-
keep_attrs: bool | None = None,
70257024
loffset: datetime.timedelta | str | None = None,
70267025
restore_coord_dims: bool | None = None,
70277026
**indexer_kwargs: str,
@@ -7143,7 +7142,6 @@ def resample(
71437142
base=base,
71447143
offset=offset,
71457144
origin=origin,
7146-
keep_attrs=keep_attrs,
71477145
loffset=loffset,
71487146
restore_coord_dims=restore_coord_dims,
71497147
**indexer_kwargs,

xarray/core/dataset.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10327,7 +10327,6 @@ def resample(
1032710327
base: int | None = None,
1032810328
offset: pd.Timedelta | datetime.timedelta | str | None = None,
1032910329
origin: str | DatetimeLike = "start_day",
10330-
keep_attrs: bool | None = None,
1033110330
loffset: datetime.timedelta | str | None = None,
1033210331
restore_coord_dims: bool | None = None,
1033310332
**indexer_kwargs: str,
@@ -10404,7 +10403,6 @@ def resample(
1040410403
base=base,
1040510404
offset=offset,
1040610405
origin=origin,
10407-
keep_attrs=keep_attrs,
1040810406
loffset=loffset,
1040910407
restore_coord_dims=restore_coord_dims,
1041010408
**indexer_kwargs,

xarray/tests/test_groupby.py

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1776,11 +1776,6 @@ def test_resample_keep_attrs(self):
17761776
expected = DataArray([1, 1, 1], [("time", times[::4])], attrs=array.attrs)
17771777
assert_identical(result, expected)
17781778

1779-
with pytest.warns(
1780-
UserWarning, match="Passing ``keep_attrs`` to ``resample`` has no effect."
1781-
):
1782-
array.resample(time="1D", keep_attrs=True)
1783-
17841779
def test_resample_skipna(self):
17851780
times = pd.date_range("2000-01-01", freq="6H", periods=10)
17861781
array = DataArray(np.ones(10), [("time", times)])
@@ -2138,11 +2133,6 @@ def test_resample_by_mean_with_keep_attrs(self):
21382133
expected = ds.attrs
21392134
assert expected == actual
21402135

2141-
with pytest.warns(
2142-
UserWarning, match="Passing ``keep_attrs`` to ``resample`` has no effect."
2143-
):
2144-
ds.resample(time="1D", keep_attrs=True)
2145-
21462136
def test_resample_loffset(self):
21472137
times = pd.date_range("2000-01-01", freq="6H", periods=10)
21482138
ds = Dataset(

0 commit comments

Comments
 (0)