pandas.tseries.offsets.YearBegin#

class pandas.tseries.offsets.YearBegin#

DateOffset of one year at beginning.

YearBegin goes to the next date which is a start of the year.

See also

DateOffset

Standard kind of date increment.

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')

If you want to get the start of the current year:

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

Attributes

base

Returns a copy of the calling offset object with n=1 and all other attributes equal.

freqstr

Return a string representing the frequency.

kwds

Return a dict of extra parameters for the offset.

name

Return a string representing the base frequency.

month

n

nanos

normalize

rule_code

Methods

copy

Return a copy of the frequency.

is_anchored

Return boolean whether the frequency is a unit frequency (n=1).

is_month_end

Return boolean whether a timestamp occurs on the month end.

is_month_start

Return boolean whether a timestamp occurs on the month start.

is_on_offset

Return boolean whether a timestamp intersects with this frequency.

is_quarter_end

Return boolean whether a timestamp occurs on the quarter end.

is_quarter_start

Return boolean whether a timestamp occurs on the quarter start.

is_year_end

Return boolean whether a timestamp occurs on the year end.

is_year_start

Return boolean whether a timestamp occurs on the year start.

rollback

Roll provided date backward to next offset only if not on offset.

rollforward

Roll provided date forward to next offset only if not on offset.