pandas.tseries.offsets.YearEnd#

class pandas.tseries.offsets.YearEnd(n=1, normalize=False, month=None)#

DateOffset increments between calendar year end dates.

YearEnd goes to the next date which is the end of the year.

Parameters:

nint, default 1: The number of years represented.
normalizebool, default False: Normalize start/end dates to midnight before generating date range.
monthint, default 12: A specific integer for the month of the year.

Attributes

Return the month of the year on which this offset applies.

See also

Examples

>>> ts = pd.Timestamp(2022, 1, 1)
>>> ts + pd.offsets.YearEnd()
Timestamp('2022-12-31 00:00:00')

>>> ts = pd.Timestamp(2022, 12, 31)
>>> ts + pd.offsets.YearEnd()
Timestamp('2023-12-31 00:00:00')

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

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

>>> ts = pd.Timestamp(2022, 12, 31)
>>> pd.offsets.YearEnd().rollforward(ts)
Timestamp('2022-12-31 00:00:00')