groupby, resample: Deprecate some positional args

pydata · Jul 11, 2024 · 761177b · 761177b
1 parent c94d9c2
commit 761177b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py
@@ -6681,11 +6681,13 @@ def interp_calendar(
         """
         return interp_calendar(self, target, dim=dim)
 
+    @_deprecate_positional_args("v2024.08.0")
     def groupby(
         self,
         group: (
             Hashable | DataArray | IndexVariable | Mapping[Any, Grouper] | None
         ) = None,
+        *,
         squeeze: bool | None = None,
         restore_coord_dims: bool = False,
         **groupers: Grouper,
@@ -6802,10 +6804,12 @@ def groupby(
             restore_coord_dims=restore_coord_dims,
         )
 
+    @_deprecate_positional_args("v2024.08.0")
     def groupby_bins(
         self,
         group: Hashable | DataArray | IndexVariable,
         bins: ArrayLike,
+        *,
         right: bool = True,
         labels: ArrayLike | Literal[False] | None = None,
         precision: int = 3,
@@ -7226,9 +7230,11 @@ def coarsen(
             coord_func=coord_func,
         )
 
+    @_deprecate_positional_args("v2024.08.0")
     def resample(
         self,
         indexer: Mapping[Hashable, str | Resampler] | None = None,
+        *,
         skipna: bool | None = None,
         closed: SideOptions | None = None,
         label: SideOptions | None = None,

diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py
@@ -10255,11 +10255,13 @@ def interp_calendar(
         """
         return interp_calendar(self, target, dim=dim)
 
+    @_deprecate_positional_args("v2024.08.0")
     def groupby(
         self,
         group: (
             Hashable | DataArray | IndexVariable | Mapping[Any, Grouper] | None
         ) = None,
+        *,
         squeeze: bool | None = None,
         restore_coord_dims: bool = False,
         **groupers: Grouper,
@@ -10343,10 +10345,12 @@ def groupby(
             restore_coord_dims=restore_coord_dims,
         )
 
+    @_deprecate_positional_args("v2024.08.0")
     def groupby_bins(
         self,
         group: Hashable | DataArray | IndexVariable,
         bins: ArrayLike,
+        *,
         right: bool = True,
         labels: ArrayLike | None = None,
         precision: int = 3,
@@ -10612,9 +10616,11 @@ def coarsen(
             coord_func=coord_func,
         )
 
+    @_deprecate_positional_args("v2024.08.0")
     def resample(
         self,
         indexer: Mapping[Any, str | Resampler] | None = None,
+        *,
         skipna: bool | None = None,
         closed: SideOptions | None = None,
         label: SideOptions | None = None,

diff --git a/xarray/tests/test_groupby.py b/xarray/tests/test_groupby.py
@@ -722,7 +722,7 @@ def test_groupby_reduce_dimension_error(array) -> None:
 
 def test_groupby_multiple_string_args(array) -> None:
     with pytest.raises(TypeError):
-        array.groupby("x", "y")
+        array.groupby("x", squeeze="y")
 
 
 def test_groupby_bins_timeseries() -> None:
@@ -2419,7 +2419,7 @@ def test_resample_old_api(self) -> None:
         )
 
         with pytest.raises(TypeError, match=r"resample\(\) no longer supports"):
-            ds.resample("1D", "time")  # type: ignore[arg-type]
+            ds.resample("1D", squeeze="time")  # type: ignore[arg-type]
 
         with pytest.raises(TypeError, match=r"resample\(\) no longer supports"):
             ds.resample("1D", dim="time", how="mean")  # type: ignore[arg-type]