Hold off on deprecating xarray versions of these attributes

Author: spencerkclark

doc/whats-new.rst

@@ -19,6 +19,16 @@ New Features
   By `Alfonso Ladino <https://github.com/aladinor>`_.
 - Added complex dtype support to FillValueCoder for the Zarr backend. (:pull:`11151`)
   By `Max Jones <https://github.com/maxrjones>`_.
+- Following pandas, xarray's
+  :py:class:`~xarray.core.accessor_dt.DatetimeAccessor` now supports
+  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.day_of_week` and
+  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.day_of_year` attributes,
+  which are alternative names for the existing
+  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.dayofweek` and
+  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.dayofyear` attributes.
+  These alternative attributes have similarly been added to
+  :py:class:`~xarray.CFTimeIndex` (:pull:`11270`). By `Spencer Clark
+  <https://github.com/spencerkclark>`_.
 
 Breaking Changes
 ~~~~~~~~~~~~~~~~
@@ -104,25 +114,7 @@ Breaking Changes
 
 Deprecations
 ~~~~~~~~~~~~
-- Following pandas, on xarray's
-  :py:class:`~xarray.core.accessor_dt.DatetimeAccessor`,
-  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.daysinmonth`
-  is deprecated in favor of
-  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.days_in_month`;
-  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.dayofweek` and
-  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.weekday` are deprecated
-  in favor of :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.day_of_week`;
-  and :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.dayofyear` is
-  deprecated in favor of
-  :py:attr:`~xarray.core.accessor_dt.DatetimeAccessor.day_of_year`
-  (:issue:`11268`, :pull:`11270`). By `Spencer Clark
-  <https://github.com/spencerkclark>`_.
-- Following pandas, on xarray's :py:class:`~xarray.CFTimeIndex`,
-  :py:attr:`~xarray.CFTimeIndex.dayofweek` and
-  :py:attr:`~xarray.CFTimeIndex.dayofyear` are deprecated in favor of
-  :py:attr:`~xarray.CFTimeIndex.day_of_week` and
-  :py:attr:`~xarray.CFTimeIndex.day_of_year`, respectively (:pull:`11270`).
-  By `Spencer Clark <https://github.com/spencerkclark>`_.
+-
 
 Bug Fixes
 ~~~~~~~~~

xarray/coding/cftimeindex.py

@@ -131,7 +131,6 @@ def _field_accessor(
     name: str,
     docstring: str | None = None,
     min_cftime_version: str = "0.0",
-    deprecation_pair: tuple[str, str] | None = None,
 ):
     """Adapted from pandas.tseries.index._field_accessor"""
 
@@ -141,14 +140,6 @@ def f(self, min_cftime_version=min_cftime_version):
         else:
             cftime = attempt_import("cftime")
 
-        if deprecation_pair is not None:
-            original, replacement = deprecation_pair
-            emit_user_level_warning(
-                f"CFTimeIndex.{original} is deprecated and will be removed in "
-                f"a future version. Use CFTimeIndex.{replacement} instead",
-                FutureWarning,
-            )
-
         if Version(cftime.__version__) >= Version(min_cftime_version):
             return get_date_field(self._data, name)
         else:
@@ -265,13 +256,11 @@ class CFTimeIndex(pd.Index):
         "dayofyr",
         "The ordinal day of year of the datetime",
         "1.0.2.1",
-        ("dayofyear", "day_of_year"),
     )
     dayofweek = _field_accessor(
         "dayofwk",
         "The day of week of the datetime",
         "1.0.2.1",
-        ("dayofweek", "day_of_week"),
     )
     day_of_year = _field_accessor(
         "dayofyr", "The ordinal day of year of the datetime", "1.0.2.1"

xarray/core/accessor_dt.py

@@ -16,7 +16,6 @@
     is_np_timedelta_like,
 )
 from xarray.core.types import T_DataArray
-from xarray.core.utils import emit_user_level_warning
 from xarray.core.variable import IndexVariable, Variable
 from xarray.namedarray.utils import is_duck_dask_array
 
@@ -474,21 +473,11 @@ def day_of_week(self) -> T_DataArray:
     @property
     def dayofweek(self) -> T_DataArray:
         """The day of the week with Monday=0, Sunday=6"""
-        emit_user_level_warning(
-            "dt.dayofweek is deprecated and will be removed in a future "
-            "version. Use dt.day_of_week instead.",
-            FutureWarning,
-        )
         return self._date_field("day_of_week", np.int64)
 
     @property
     def weekday(self) -> T_DataArray:
         """The day of the week with Monday=0, Sunday=6"""
-        emit_user_level_warning(
-            "dt.weekday is deprecated and will be removed in a "
-            "future version. Use dt.day_of_week instead.",
-            FutureWarning,
-        )
         return self._date_field("day_of_week", np.int64)
 
     @property
@@ -499,11 +488,6 @@ def day_of_year(self) -> T_DataArray:
     @property
     def dayofyear(self) -> T_DataArray:
         """The ordinal day of the year"""
-        emit_user_level_warning(
-            "dt.dayofyear is deprecated and will be removed in a future "
-            "version. Use dt.day_of_year instead.",
-            FutureWarning,
-        )
         return self._date_field("day_of_year", np.int64)
 
     @property
@@ -519,11 +503,6 @@ def days_in_month(self) -> T_DataArray:
     @property
     def daysinmonth(self) -> T_DataArray:
         """The number of days in the month"""
-        emit_user_level_warning(
-            "dt.daysinmonth is deprecated and will be removed in a future "
-            "version. Use dt.days_in_month instead.",
-            FutureWarning,
-        )
         return self._date_field("days_in_month", np.int64)
 
     @property

xarray/tests/test_accessor_dt.py

@@ -102,21 +102,6 @@ def test_field_access(self, field) -> None:
         assert expected.dtype == actual.dtype
         assert_identical(expected, actual)
 
-    @pytest.mark.parametrize(
-        ("field", "replacement"),
-        [
-            ("daysinmonth", "days_in_month"),
-            ("dayofweek", "day_of_week"),
-            ("weekday", "day_of_week"),
-            ("dayofyear", "day_of_year"),
-        ],
-    )
-    def test_deprecated_field_access(self, field, replacement) -> None:
-        expected = getattr(self.data.time.dt, replacement)
-        with pytest.warns(FutureWarning, match=f"{field}.*{replacement}"):
-            actual = getattr(self.data.time.dt, field)
-        assert_identical(expected, actual)
-
     def test_total_seconds(self) -> None:
         # Subtract a value in the middle of the range to ensure that some values
         # are negative

xarray/tests/test_cftimeindex.py

@@ -329,30 +329,18 @@ def test_empty_cftimeindex_field_accessors(field):
 
 
 @requires_cftime
-@pytest.mark.parametrize(
-    ("field", "replacement"), [("day_of_year", None), ("dayofyear", "day_of_year")]
-)
-def test_cftimeindex_dayofyear_accessor(index, field, replacement):
-    if replacement is not None:
-        with pytest.warns(FutureWarning, match=f"{field}.*{replacement}"):
-            result = getattr(index, field)
-    else:
-        result = getattr(index, field)
+@pytest.mark.parametrize("field", ["day_of_year", "dayofyear"])
+def test_cftimeindex_dayofyear_accessor(index, field):
+    result = getattr(index, field)
     expected = np.array([date.dayofyr for date in index], dtype=np.int64)
     assert_array_equal(result, expected)
     assert result.dtype == expected.dtype
 
 
 @requires_cftime
-@pytest.mark.parametrize(
-    ("field", "replacement"), [("day_of_week", None), ("dayofweek", "day_of_week")]
-)
-def test_cftimeindex_dayofweek_accessor(index, field, replacement):
-    if replacement is not None:
-        with pytest.warns(FutureWarning, match=f"{field}.*{replacement}"):
-            result = getattr(index, field)
-    else:
-        result = getattr(index, field)
+@pytest.mark.parametrize("field", ["day_of_week", "dayofweek"])
+def test_cftimeindex_dayofweek_accessor(index, field):
+    result = getattr(index, field)
     expected = np.array([date.dayofwk for date in index], dtype=np.int64)
     assert_array_equal(result, expected)
     assert result.dtype == expected.dtype