Skip to content

ENH: raise ValueError if invalid period freq pass to asfreq when the index of df is a PeriodIndex #56945

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 13 commits into from
Feb 7, 2024
Merged

ENH: raise ValueError if invalid period freq pass to asfreq when the index of df is a PeriodIndex #56945

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
39f59c4
raise ValueError in asfreq for invalid period freq
natmokval Jan 18, 2024
2b602bd
Merge branch 'main' into enh-error-msg-asfreq-invalid-period-freq
natmokval Jan 25, 2024
ff1c6e7
correct PeriodIndex.asfreq, fix test, add tests
natmokval Jan 25, 2024
fff7c9d
move raising ValueError to to_offset
natmokval Feb 1, 2024
a389d11
fix pre-commit errors
natmokval Feb 1, 2024
d2ea914
correct def to_offset, dt64arr_to_periodarr and fix tests
natmokval Feb 2, 2024
3735e23
fix tests
natmokval Feb 2, 2024
b1e6ba6
correct def to_offset, fix tests
natmokval Feb 5, 2024
c41557a
add a note to v2.2.1.rst
natmokval Feb 6, 2024
17fd84c
resolve conflict
natmokval Feb 6, 2024
721637b
Merge remote-tracking branch 'upstream/main' into enh-error-msg-asfre…
MarcoGorelli Feb 7, 2024
deea30d
try simplifying / clarifying
MarcoGorelli Feb 7, 2024
4cbcc5e
revert _get_period_alias simplification
MarcoGorelli Feb 7, 2024
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
10 changes: 10 additions & 0 deletions pandas/core/resample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2827,6 +2827,16 @@ def asfreq(
if how is None:
how = "E"

if isinstance(freq, str):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few lines down, there's obj.index.asfreq(freq, how=how) - should these validation go in there?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, you are right. I moved the check if isinstance(freq, str) to the definition of asfreq in pandas/core/indexes/period.py

freq = to_offset(freq, is_period=True)
if hasattr(freq, "_period_dtype_code"):
freq = freq_to_period_freqstr(freq.n, freq.name)
else:
raise ValueError(
f"Invalid offset: '{freq.name}' for converting time series "
f"with PeriodIndex."
)

if isinstance(freq, BaseOffset):
if hasattr(freq, "_period_dtype_code"):
freq = freq_to_period_freqstr(freq.n, freq.name)
Expand Down
20 changes: 18 additions & 2 deletions pandas/tests/resample/test_period_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1032,14 +1032,30 @@ def test_resample_lowercase_frequency_deprecated(
offsets.BusinessHour(2),
],
)
def test_asfreq_invalid_period_freq(self, offset, frame_or_series):
# GH#9586
def test_asfreq_invalid_period_offset(self, offset, frame_or_series):
# GH#55785
msg = f"Invalid offset: '{offset.base}' for converting time series "

obj = frame_or_series(range(5), index=period_range("2020-01-01", periods=5))
with pytest.raises(ValueError, match=msg):
obj.asfreq(freq=offset)

@pytest.mark.parametrize(
"freq",
[
"2BMS",
"2YS-MAR",
"2bh",
],
)
def test_asfreq_invalid_period_freq(self, freq, frame_or_series):
# GH#55785
msg = f"Invalid offset: '{freq[1:]}' for converting time series "

obj = frame_or_series(range(5), index=period_range("2020-01-01", periods=5))
with pytest.raises(ValueError, match=msg):
obj.asfreq(freq=freq)


@pytest.mark.parametrize(
"freq,freq_depr",
Expand Down