Skip to content

Commit 43c40c0

Browse files
committed
Deprecate week and weekofyear in DatetimeArray
1 parent 949caf5 commit 43c40c0

File tree

2 files changed

+30
-10
lines changed

2 files changed

+30
-10
lines changed

pandas/core/arrays/datetimes.py

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,6 @@ class DatetimeArray(dtl.DatetimeLikeArrayMixin, dtl.TimelikeOps, dtl.DatelikeOps
172172
"hour",
173173
"minute",
174174
"second",
175-
"weekofyear",
176-
"week",
177175
"weekday",
178176
"dayofweek",
179177
"dayofyear",
@@ -1289,6 +1287,28 @@ def isocalendar(self):
12891287
iso_calendar_df.iloc[self._isnan] = None
12901288
return iso_calendar_df
12911289

1290+
@property
1291+
def weekofyear(self):
1292+
"""
1293+
The week ordinal of the year.
1294+
1295+
.. deprecated:: 1.1.0
1296+
1297+
weekofyear and week have been deprecated.
1298+
Please use DatetimeArray.isocalendar().week instead.
1299+
"""
1300+
import warnings
1301+
1302+
warnings.warn(
1303+
"weekofyear and week have been deprecated. "
1304+
"Please use DatetimeArray.isocalendar().week instead.",
1305+
FutureWarning,
1306+
stacklevel=2,
1307+
)
1308+
return self.isocalendar().week
1309+
1310+
week = weekofyear
1311+
12921312
year = _field_accessor(
12931313
"year",
12941314
"Y",
@@ -1473,14 +1493,6 @@ def isocalendar(self):
14731493
dtype: int64
14741494
""",
14751495
)
1476-
weekofyear = _field_accessor(
1477-
"weekofyear",
1478-
"woy",
1479-
"""
1480-
The week ordinal of the year.
1481-
""",
1482-
)
1483-
week = weekofyear
14841496
_dayofweek_doc = """
14851497
The day of the week with Monday=0, Sunday=6.
14861498

pandas/tests/arrays/test_datetimes.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,3 +425,11 @@ def test_min_max_empty(self, skipna, tz):
425425

426426
result = arr.max(skipna=skipna)
427427
assert result is pd.NaT
428+
429+
430+
def test_week_and_week_of_year_are_deprecated():
431+
arr = DatetimeArray._from_sequence(["2000-01-03"])
432+
with tm.assert_produces_warning(FutureWarning):
433+
arr.week
434+
with tm.assert_produces_warning(FutureWarning):
435+
arr.weekofyear

0 commit comments

Comments
 (0)