import re
|
|
import pytest
|
|
from pandas import (
|
PeriodIndex,
|
Series,
|
period_range,
|
)
|
import pandas._testing as tm
|
|
from pandas.tseries import offsets
|
|
|
class TestPeriodIndex:
|
def test_asfreq(self):
|
pi1 = period_range(freq="Y", start="1/1/2001", end="1/1/2001")
|
pi2 = period_range(freq="Q", start="1/1/2001", end="1/1/2001")
|
pi3 = period_range(freq="M", start="1/1/2001", end="1/1/2001")
|
pi4 = period_range(freq="D", start="1/1/2001", end="1/1/2001")
|
pi5 = period_range(freq="h", start="1/1/2001", end="1/1/2001 00:00")
|
pi6 = period_range(freq="Min", start="1/1/2001", end="1/1/2001 00:00")
|
pi7 = period_range(freq="s", start="1/1/2001", end="1/1/2001 00:00:00")
|
|
assert pi1.asfreq("Q", "s") == pi2
|
assert pi1.asfreq("Q", "s") == pi2
|
assert pi1.asfreq("M", "start") == pi3
|
assert pi1.asfreq("D", "StarT") == pi4
|
assert pi1.asfreq("h", "beGIN") == pi5
|
assert pi1.asfreq("Min", "s") == pi6
|
assert pi1.asfreq("s", "s") == pi7
|
|
assert pi2.asfreq("Y", "s") == pi1
|
assert pi2.asfreq("M", "s") == pi3
|
assert pi2.asfreq("D", "s") == pi4
|
assert pi2.asfreq("h", "s") == pi5
|
assert pi2.asfreq("Min", "s") == pi6
|
assert pi2.asfreq("s", "s") == pi7
|
|
assert pi3.asfreq("Y", "s") == pi1
|
assert pi3.asfreq("Q", "s") == pi2
|
assert pi3.asfreq("D", "s") == pi4
|
assert pi3.asfreq("h", "s") == pi5
|
assert pi3.asfreq("Min", "s") == pi6
|
assert pi3.asfreq("s", "s") == pi7
|
|
assert pi4.asfreq("Y", "s") == pi1
|
assert pi4.asfreq("Q", "s") == pi2
|
assert pi4.asfreq("M", "s") == pi3
|
assert pi4.asfreq("h", "s") == pi5
|
assert pi4.asfreq("Min", "s") == pi6
|
assert pi4.asfreq("s", "s") == pi7
|
|
assert pi5.asfreq("Y", "s") == pi1
|
assert pi5.asfreq("Q", "s") == pi2
|
assert pi5.asfreq("M", "s") == pi3
|
assert pi5.asfreq("D", "s") == pi4
|
assert pi5.asfreq("Min", "s") == pi6
|
assert pi5.asfreq("s", "s") == pi7
|
|
assert pi6.asfreq("Y", "s") == pi1
|
assert pi6.asfreq("Q", "s") == pi2
|
assert pi6.asfreq("M", "s") == pi3
|
assert pi6.asfreq("D", "s") == pi4
|
assert pi6.asfreq("h", "s") == pi5
|
assert pi6.asfreq("s", "s") == pi7
|
|
assert pi7.asfreq("Y", "s") == pi1
|
assert pi7.asfreq("Q", "s") == pi2
|
assert pi7.asfreq("M", "s") == pi3
|
assert pi7.asfreq("D", "s") == pi4
|
assert pi7.asfreq("h", "s") == pi5
|
assert pi7.asfreq("Min", "s") == pi6
|
|
msg = "How must be one of S or E"
|
with pytest.raises(ValueError, match=msg):
|
pi7.asfreq("T", "foo")
|
result1 = pi1.asfreq("3M")
|
result2 = pi1.asfreq("M")
|
expected = period_range(freq="M", start="2001-12", end="2001-12")
|
tm.assert_numpy_array_equal(result1.asi8, expected.asi8)
|
assert result1.freqstr == "3M"
|
tm.assert_numpy_array_equal(result2.asi8, expected.asi8)
|
assert result2.freqstr == "M"
|
|
def test_asfreq_nat(self):
|
idx = PeriodIndex(["2011-01", "2011-02", "NaT", "2011-04"], freq="M")
|
result = idx.asfreq(freq="Q")
|
expected = PeriodIndex(["2011Q1", "2011Q1", "NaT", "2011Q2"], freq="Q")
|
tm.assert_index_equal(result, expected)
|
|
@pytest.mark.parametrize("freq", ["D", "3D"])
|
def test_asfreq_mult_pi(self, freq):
|
pi = PeriodIndex(["2001-01", "2001-02", "NaT", "2001-03"], freq="2M")
|
|
result = pi.asfreq(freq)
|
exp = PeriodIndex(["2001-02-28", "2001-03-31", "NaT", "2001-04-30"], freq=freq)
|
tm.assert_index_equal(result, exp)
|
assert result.freq == exp.freq
|
|
result = pi.asfreq(freq, how="S")
|
exp = PeriodIndex(["2001-01-01", "2001-02-01", "NaT", "2001-03-01"], freq=freq)
|
tm.assert_index_equal(result, exp)
|
assert result.freq == exp.freq
|
|
def test_asfreq_combined_pi(self):
|
pi = PeriodIndex(["2001-01-01 00:00", "2001-01-02 02:00", "NaT"], freq="h")
|
exp = PeriodIndex(["2001-01-01 00:00", "2001-01-02 02:00", "NaT"], freq="25h")
|
for freq, how in zip(["1D1h", "1h1D"], ["S", "E"]):
|
result = pi.asfreq(freq, how=how)
|
tm.assert_index_equal(result, exp)
|
assert result.freq == exp.freq
|
|
for freq in ["1D1h", "1h1D"]:
|
pi = PeriodIndex(["2001-01-01 00:00", "2001-01-02 02:00", "NaT"], freq=freq)
|
result = pi.asfreq("h")
|
exp = PeriodIndex(["2001-01-02 00:00", "2001-01-03 02:00", "NaT"], freq="h")
|
tm.assert_index_equal(result, exp)
|
assert result.freq == exp.freq
|
|
pi = PeriodIndex(["2001-01-01 00:00", "2001-01-02 02:00", "NaT"], freq=freq)
|
result = pi.asfreq("h", how="S")
|
exp = PeriodIndex(["2001-01-01 00:00", "2001-01-02 02:00", "NaT"], freq="h")
|
tm.assert_index_equal(result, exp)
|
assert result.freq == exp.freq
|
|
def test_astype_asfreq(self):
|
pi1 = PeriodIndex(["2011-01-01", "2011-02-01", "2011-03-01"], freq="D")
|
exp = PeriodIndex(["2011-01", "2011-02", "2011-03"], freq="M")
|
tm.assert_index_equal(pi1.asfreq("M"), exp)
|
tm.assert_index_equal(pi1.astype("period[M]"), exp)
|
|
exp = PeriodIndex(["2011-01", "2011-02", "2011-03"], freq="3M")
|
tm.assert_index_equal(pi1.asfreq("3M"), exp)
|
tm.assert_index_equal(pi1.astype("period[3M]"), exp)
|
|
def test_asfreq_with_different_n(self):
|
ser = Series([1, 2], index=PeriodIndex(["2020-01", "2020-03"], freq="2M"))
|
result = ser.asfreq("M")
|
|
excepted = Series([1, 2], index=PeriodIndex(["2020-02", "2020-04"], freq="M"))
|
tm.assert_series_equal(result, excepted)
|
|
@pytest.mark.parametrize(
|
"freq",
|
[
|
"2BMS",
|
"2YS-MAR",
|
"2bh",
|
],
|
)
|
def test_pi_asfreq_not_supported_frequency(self, freq):
|
# GH#55785
|
msg = f"{freq[1:]} is not supported as period frequency"
|
|
pi = PeriodIndex(["2020-01-01", "2021-01-01"], freq="M")
|
with pytest.raises(ValueError, match=msg):
|
pi.asfreq(freq=freq)
|
|
@pytest.mark.parametrize(
|
"freq",
|
[
|
"2BME",
|
"2YE-MAR",
|
"2QE",
|
],
|
)
|
def test_pi_asfreq_invalid_frequency(self, freq):
|
# GH#55785
|
msg = f"Invalid frequency: {freq}"
|
|
pi = PeriodIndex(["2020-01-01", "2021-01-01"], freq="M")
|
with pytest.raises(ValueError, match=msg):
|
pi.asfreq(freq=freq)
|
|
@pytest.mark.parametrize(
|
"freq",
|
[
|
offsets.MonthBegin(2),
|
offsets.BusinessMonthEnd(2),
|
],
|
)
|
def test_pi_asfreq_invalid_baseoffset(self, freq):
|
# GH#56945
|
msg = re.escape(f"{freq} is not supported as period frequency")
|
|
pi = PeriodIndex(["2020-01-01", "2021-01-01"], freq="M")
|
with pytest.raises(ValueError, match=msg):
|
pi.asfreq(freq=freq)
|
