Skip to content

Commit 44fd2d7

Browse files
committed
groupby, resample: Deprecate some positional args
1 parent b55c783 commit 44fd2d7

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

xarray/core/dataarray.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6694,11 +6694,13 @@ def interp_calendar(
66946694
"""
66956695
return interp_calendar(self, target, dim=dim)
66966696

6697+
@_deprecate_positional_args("v2024.08.0")
66976698
def groupby(
66986699
self,
66996700
group: (
67006701
Hashable | DataArray | IndexVariable | Mapping[Any, Grouper] | None
67016702
) = None,
6703+
*,
67026704
squeeze: bool | None = None,
67036705
restore_coord_dims: bool = False,
67046706
**groupers: Grouper,
@@ -6815,6 +6817,7 @@ def groupby(
68156817
restore_coord_dims=restore_coord_dims,
68166818
)
68176819

6820+
@_deprecate_positional_args("v2024.08.0")
68186821
def groupby_bins(
68196822
self,
68206823
group: Hashable | DataArray | IndexVariable,
@@ -7239,9 +7242,11 @@ def coarsen(
72397242
coord_func=coord_func,
72407243
)
72417244

7245+
@_deprecate_positional_args("v2024.08.0")
72427246
def resample(
72437247
self,
72447248
indexer: Mapping[Hashable, str | Resampler] | None = None,
7249+
*,
72457250
skipna: bool | None = None,
72467251
closed: SideOptions | None = None,
72477252
label: SideOptions | None = None,

xarray/core/dataset.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10263,11 +10263,13 @@ def interp_calendar(
1026310263
"""
1026410264
return interp_calendar(self, target, dim=dim)
1026510265

10266+
@_deprecate_positional_args("v2024.08.0")
1026610267
def groupby(
1026710268
self,
1026810269
group: (
1026910270
Hashable | DataArray | IndexVariable | Mapping[Any, Grouper] | None
1027010271
) = None,
10272+
*,
1027110273
squeeze: bool | None = None,
1027210274
restore_coord_dims: bool = False,
1027310275
**groupers: Grouper,
@@ -10351,6 +10353,7 @@ def groupby(
1035110353
restore_coord_dims=restore_coord_dims,
1035210354
)
1035310355

10356+
@_deprecate_positional_args("v2024.08.0")
1035410357
def groupby_bins(
1035510358
self,
1035610359
group: Hashable | DataArray | IndexVariable,
@@ -10620,9 +10623,11 @@ def coarsen(
1062010623
coord_func=coord_func,
1062110624
)
1062210625

10626+
@_deprecate_positional_args("v2024.08.0")
1062310627
def resample(
1062410628
self,
1062510629
indexer: Mapping[Any, str | Resampler] | None = None,
10630+
*,
1062610631
skipna: bool | None = None,
1062710632
closed: SideOptions | None = None,
1062810633
label: SideOptions | None = None,

xarray/tests/test_groupby.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@ def test_groupby_reduce_dimension_error(array) -> None:
722722

723723
def test_groupby_multiple_string_args(array) -> None:
724724
with pytest.raises(TypeError):
725-
array.groupby("x", "y")
725+
array.groupby("x", squeeze="y")
726726

727727

728728
def test_groupby_bins_timeseries() -> None:

0 commit comments

Comments
 (0)