pandas.tseries.frequencies.to_offset

pandas.tseries.frequencies.to_offset(freq, is_period=False)

从字符串或 datetime.timedelta 对象返回 DateOffset 对象。

参数:

freqstr, datetime.timedelta, BaseOffset 或 None

表示的频率。

is_period布尔值, 默认为 False

如果 is_period=True，将表示周期频率的字符串转换为相应的偏移频率。

返回:

BaseOffset 子类或 None

引发:

ValueError

如果 freq 是一个无效的频率

参见

BaseOffset

用于日期范围的标准日期增量类型。

示例

>>> from pandas.tseries.frequencies import to_offset
>>> to_offset("5min")
<5 * Minutes>

>>> to_offset("1D1h")
<25 * Hours>

>>> to_offset("2W")
<2 * Weeks: weekday=6>

>>> to_offset("2B")
<2 * BusinessDays>

>>> to_offset(pd.Timedelta(days=1))
<Day>

>>> to_offset(pd.offsets.Hour())
<Hour>

传递参数 is_period 等于 True，你可以使用一个表示周期频率的字符串：

>>> freq = to_offset(freq="ME", is_period=False)
>>> freq.rule_code
'ME'

>>> freq = to_offset(freq="M", is_period=True)
>>> freq.rule_code
'ME'