pandas.tseries.offsets.BaseOffset

class pandas.tseries.offsets.BaseOffset

Base class for all pandas date offsets.

Every offset in pandas.tseries.offsets is a subclass of BaseOffset, so isinstance(obj, BaseOffset) is the way to check whether an object is a pandas offset. BaseOffset is not meant to be instantiated directly.

Attributes

n	Return the count of the number of periods.
normalize	Return boolean whether the frequency can align with midnight.

See also

tseries.offsets.DateOffset

Offset backed by a dateutil.relativedelta.

tseries.frequencies.to_offset

Convert a string or timedelta to an offset.

Examples

>>> pd.offsets.Hour(5).n
5
>>> pd.offsets.Hour(5).normalize
False

>>> isinstance(pd.offsets.BDay(), pd.offsets.BaseOffset)
True

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.
n	Return the count of the number of periods.
name	(DEPRECATED) Return a string representing the base frequency.
nanos	Return an integer of the total number of nanoseconds.
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.