pandas.tseries.offsets.BYearEnd — pandas 2.2.3 documentation (original) (raw)
class pandas.tseries.offsets.BYearEnd#
DateOffset increments between the last business day 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.
See also
Standard kind of date increment.
Examples
from pandas.tseries.offsets import BYearEnd ts = pd.Timestamp('2020-05-24 05:01:15') ts - BYearEnd() Timestamp('2019-12-31 05:01:15') ts + BYearEnd() Timestamp('2020-12-31 05:01:15') ts + BYearEnd(3) Timestamp('2022-12-30 05:01:15') ts + BYearEnd(-3) Timestamp('2017-12-29 05:01:15') ts + BYearEnd(month=11) Timestamp('2020-11-30 05:01:15')
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 | |
| name | Return a string representing the base frequency. |
| nanos | |
| normalize | |
| rule_code |
Methods
| copy() | Return a copy of the frequency. |
|---|---|
| is_anchored() | (DEPRECATED) Return boolean whether the frequency is a unit frequency (n=1). |
| 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. |