Skip to content

Commit 07307b4

Browse files
authored
groupby, resample: Deprecate some positional args (#9236)
* groupby, resample: Deprecate some positional args * Change version to 2024.07.0
1 parent 39d5b39 commit 07307b4

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.07.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.07.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.07.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
@@ -10268,11 +10268,13 @@ def interp_calendar(
1026810268
"""
1026910269
return interp_calendar(self, target, dim=dim)
1027010270

10271+
@_deprecate_positional_args("v2024.07.0")
1027110272
def groupby(
1027210273
self,
1027310274
group: (
1027410275
Hashable | DataArray | IndexVariable | Mapping[Any, Grouper] | None
1027510276
) = None,
10277+
*,
1027610278
squeeze: bool | None = None,
1027710279
restore_coord_dims: bool = False,
1027810280
**groupers: Grouper,
@@ -10356,6 +10358,7 @@ def groupby(
1035610358
restore_coord_dims=restore_coord_dims,
1035710359
)
1035810360

10361+
@_deprecate_positional_args("v2024.07.0")
1035910362
def groupby_bins(
1036010363
self,
1036110364
group: Hashable | DataArray | IndexVariable,
@@ -10625,9 +10628,11 @@ def coarsen(
1062510628
coord_func=coord_func,
1062610629
)
1062710630

10631+
@_deprecate_positional_args("v2024.07.0")
1062810632
def resample(
1062910633
self,
1063010634
indexer: Mapping[Any, str | Resampler] | None = None,
10635+
*,
1063110636
skipna: bool | None = None,
1063210637
closed: SideOptions | None = None,
1063310638
label: SideOptions | None = None,

xarray/tests/test_groupby.py

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

722722
def test_groupby_multiple_string_args(array) -> None:
723723
with pytest.raises(TypeError):
724-
array.groupby("x", "y")
724+
array.groupby("x", squeeze="y")
725725

726726

727727
def test_groupby_bins_timeseries() -> None:

0 commit comments

Comments
 (0)