Skip to content

ENH: improve error message when specifying a previously-deprecated frequen… #62539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 5, 2025
Merged

ENH: improve error message when specifying a previously-deprecated frequen… #62539

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8c2b5fb
improve error message when specifying a previously-deprecated frequen…
jgao8 Oct 1, 2025
920945d
update location of checking deprecated freq
jgao8 Oct 2, 2025
326909b
address PR comments
jgao8 Oct 3, 2025
86a89a9
improve error message when specifying a previously-deprecated frequen…
jgao8 Oct 1, 2025
51c55cd
update location of checking deprecated freq
jgao8 Oct 2, 2025
931610a
address PR comments
jgao8 Oct 3, 2025
7636cd4
fix message and test case
jgao8 Oct 3, 2025
182a3d5
merge remote
jgao8 Oct 3, 2025
de83629
Merge branch 'main' into improve-error-msg-freq
jgao8 Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5276,6 +5276,18 @@ def _get_offset(name: str) -> BaseOffset:
return _offset_map[name]


deprec_to_valid_alias = {
"H": "h",
"BH": "bh",
"CBH": "cbh",
"T": "min",
"S": "s",
"L": "ms",
"U": "us",
"N": "ns",
}


cpdef to_offset(freq, bint is_period=False):
"""
Return DateOffset object from string or datetime.timedelta object.
Expand Down Expand Up @@ -5359,6 +5371,11 @@ cpdef to_offset(freq, bint is_period=False):

tups = zip(split[0::4], split[1::4], split[2::4])
for n, (sep, stride, name) in enumerate(tups):
if name in deprec_to_valid_alias:
raise ValueError(INVALID_FREQ_ERR_MSG.format(
f"{name}. Did you mean {deprec_to_valid_alias[name]}?")
)

name = _warn_about_deprecated_aliases(name, is_period)
_validate_to_offset_alias(name, is_period)
if is_period:
Expand Down
5 changes: 5 additions & 0 deletions pandas/tests/tseries/offsets/test_offsets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1157,6 +1157,11 @@ def test_offset_multiplication(
tm.assert_series_equal(resultarray, expectedarray)


def test_offset_deprecated_error():
with pytest.raises(ValueError, match=r"Did you mean h?"):
date_range("2012-01-01", periods=3, freq="H")


def test_dateoffset_operations_on_dataframes(performance_warning):
# GH 47953
df = DataFrame({"T": [Timestamp("2019-04-30")], "D": [DateOffset(months=1)]})
Expand Down
Loading