pandas.tseries.offsets.YearBegin

class pandas.tseries.offsets.YearBegin

DateOffset 在日历年开始日期之间递增。

YearBegin 前进到下一个位于年初的日期。

Parameters:

nint, 默认值 1

表示的年数.

normalizebool，默认 False

在生成日期范围之前将开始/结束日期规范化到午夜。

monthint, 默认值 1

一年的月份的具体整数.

参见

DateOffset

标准的日期增量类型。

Examples

>>> ts = pd.Timestamp(2022, 12, 1)
>>> ts + pd.offsets.YearBegin()
Timestamp('2023-01-01 00:00:00')

>>> ts = pd.Timestamp(2023, 1, 1)
>>> ts + pd.offsets.YearBegin()
Timestamp('2024-01-01 00:00:00')

>>> ts = pd.Timestamp(2022, 1, 1)
>>> ts + pd.offsets.YearBegin(month=2)
Timestamp('2022-02-01 00:00:00')

如果你想获取当前年份的开始：

>>> ts = pd.Timestamp(2023, 1, 1)
>>> pd.offsets.YearBegin().rollback(ts)
Timestamp('2023-01-01 00:00:00')

Attributes

base	返回调用偏移量对象的副本，其中 n=1 且所有其他属性都相同。
freqstr	返回表示频率的字符串。
kwds	返回偏移量的额外参数字典。
month
n
name	返回表示基本频率的字符串。
nanos
normalize
rule_code

Methods

copy ()	返回频率的副本。
is_anchored ()	(已弃用) 返回频率是否为单位频率 (n=1) 的布尔值.
is_month_end (ts)	如果时间戳发生在月份结束时，则返回布尔值。
is_month_start (ts)	如果时间戳发生在月份开始时，则返回布尔值。
is_on_offset (dt)	如果时间戳与此频率相交，则返回布尔值。
is_quarter_end (ts)	如果时间戳发生在季度结束时，则返回布尔值。
is_quarter_start (ts)	如果时间戳发生在季度开始时，则返回布尔值。
is_year_end (ts)	如果时间戳发生在年份结束时，则返回布尔值。
is_year_start (ts)	如果时间戳发生在年份开始时，则返回布尔值。
rollback (dt)	如果提供的日期不在偏移量上，则将其向后滚动到下一个偏移量。
rollforward (dt)	如果提供的日期不在偏移量上，则将其向前滚动到下一个偏移量。