Skip to main content
`Ctrl`+`K`

# 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:
    n int, default 1

      The number of years represented.

    normalize bool, default False

      Normalize start/end dates to midnight before generating date range.

    month int, default 12

      A specific integer for the month of the year.

  See also

  `DateOffset`

    Standard kind of date increment.

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

  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.
  `month` |
  `n` | Return the count of the number of periods.
  `name` | Return a string representing the base frequency.
  `nanos` | Returns an integer of the total number of nanoseconds for fixed frequencies.
  `normalize` | Return boolean whether the frequency can align with midnight.
  `rule_code` | Return a string representing the base frequency.

  Methods

  `copy`() | Return a copy of the frequency.
  `is_month_end`(ts) | Return boolean whether a timestamp occurs on the month end.
  `is_month_start`(ts) | Return boolean whether a timestamp occurs on the month start.
  `is_on_offset`(dt) | Return boolean whether a timestamp intersects with this frequency.
  `is_quarter_end`(ts) | Return boolean whether a timestamp occurs on the quarter end.
  `is_quarter_start`(ts) | Return boolean whether a timestamp occurs on the quarter start.
  `is_year_end`(ts) | Return boolean whether a timestamp occurs on the year end.
  `is_year_start`(ts) | Return boolean whether a timestamp occurs on the year start.
  `rollback`(dt) | Roll provided date backward to next offset only if not on offset.
  `rollforward`(dt) | Roll provided date forward to next offset only if not on offset.