Date offsets

DateOffset

DateOffset([n, normalize])

Standard kind of date increment used for a date range.

BusinessDay

BusinessDay([n, normalize, offset])

DateOffset subclass representing possibly n business days.

BusinessHour

BusinessHour([n, normalize, start, end, offset])

DateOffset subclass representing possibly n business hours.

CustomBusinessDay

CustomBusinessDay([n, normalize, weekmask, …])

DateOffset subclass representing possibly n custom business days, excluding holidays.

SemiMonthEnd

SemiMonthEnd([n, normalize, day_of_month])

Two DateOffset’s per month repeating on the last day of the month and day_of_month.

SemiMonthBegin

SemiMonthBegin([n, normalize, day_of_month])

Two DateOffset’s per month repeating on the first day of the month and day_of_month.

Week

Week([n, normalize, weekday])

Weekly offset.

Methods

Week.apply(self, other)

Week.apply_index(self, other)

Week.copy(self)

Week.isAnchored(self)

Week.onOffset(self, dt)

Week.is_anchored(self)

Week.is_on_offset(self, dt)

WeekOfMonth

WeekOfMonth([n, normalize, week, weekday])

Describes monthly dates like “the Tuesday of the 2nd week of each month”.

LastWeekOfMonth

LastWeekOfMonth([n, normalize, weekday])

Describes monthly dates in last week of month like “the last Tuesday of each month”.

BQuarterEnd

BQuarterEnd([n, normalize, startingMonth])

DateOffset increments between business Quarter dates.

QuarterEnd

QuarterEnd([n, normalize, startingMonth])

DateOffset increments between business Quarter dates.

YearOffset

YearOffset([n, normalize, month])

DateOffset that just needs a month.

BYearEnd

BYearEnd([n, normalize, month])

DateOffset increments between business EOM dates.

Methods

BYearEnd.apply(self, other)

BYearEnd.apply_index(self, other)

BYearEnd.copy(self)

BYearEnd.isAnchored(self)

BYearEnd.onOffset(self, dt)

BYearEnd.is_anchored(self)

BYearEnd.is_on_offset(self, dt)

BYearBegin

BYearBegin([n, normalize, month])

DateOffset increments between business year begin dates.

YearEnd

YearEnd([n, normalize, month])

DateOffset increments between calendar year ends.

Methods

YearEnd.apply(self, other)

YearEnd.apply_index(self, other)

YearEnd.copy(self)

YearEnd.isAnchored(self)

YearEnd.onOffset(self, dt)

YearEnd.is_anchored(self)

YearEnd.is_on_offset(self, dt)

YearBegin

YearBegin([n, normalize, month])

DateOffset increments between calendar year begin dates.

FY5253

FY5253([n, normalize, weekday, …])

Describes 52-53 week fiscal year.

FY5253Quarter

FY5253Quarter([n, normalize, weekday, …])

DateOffset increments between business quarter dates for 52-53 week fiscal year (also known as a 4-4-5 calendar).

Easter

Easter

DateOffset for the Easter holiday using logic defined in dateutil.

Methods

Easter.apply(self, other)

Easter.copy(self)

Easter.isAnchored(self)

Easter.onOffset(self, dt)

Easter.is_anchored(self)

Easter.is_on_offset(self, dt)

Tick

Tick([n, normalize])

Attributes

Methods

Tick.copy(self)

Tick.isAnchored(self)

Tick.onOffset(self, dt)

Tick.is_anchored(self)

Tick.is_on_offset(self, dt)

Day

Day([n, normalize])

Attributes

Methods

Day.copy(self)

Day.isAnchored(self)

Day.onOffset(self, dt)

Day.is_anchored(self)

Day.is_on_offset(self, dt)

Hour

Hour([n, normalize])

Attributes

Methods

Hour.copy(self)

Hour.isAnchored(self)

Hour.onOffset(self, dt)

Hour.is_anchored(self)

Hour.is_on_offset(self, dt)

Nano

Nano([n, normalize])

Attributes

Methods

Nano.copy(self)

Nano.isAnchored(self)

Nano.onOffset(self, dt)

Nano.is_anchored(self)

Nano.is_on_offset(self, dt)

BDay

BDay

alias of pandas.tseries.offsets.BusinessDay

Properties

BDay.base

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

BDay.freqstr

BDay.kwds

BDay.name

BDay.nanos

BDay.normalize

BDay.offset

Alias for self._offset.

BDay.rule_code

Methods

BDay.apply(self, other)

BDay.apply_index(self, other)

BDay.copy(self)

BDay.isAnchored(self)

BDay.onOffset(self, dt)

BDay.is_anchored(self)

BDay.is_on_offset(self, dt)

BDay.rollback(self, dt)

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

BDay.rollforward(self, dt)

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

BMonthEnd

BMonthEnd

alias of pandas.tseries.offsets.BusinessMonthEnd

Properties

BMonthEnd.base

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

BMonthEnd.freqstr

BMonthEnd.kwds

BMonthEnd.name

BMonthEnd.nanos

BMonthEnd.normalize

BMonthEnd.rule_code

Methods

BMonthEnd.apply(self, other)

BMonthEnd.apply_index(self, other)

BMonthEnd.copy(self)

BMonthEnd.isAnchored(self)

BMonthEnd.onOffset(self, dt)

BMonthEnd.is_anchored(self)

BMonthEnd.is_on_offset(self, dt)

BMonthEnd.rollback(self, dt)

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

BMonthEnd.rollforward(self, dt)

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

BMonthBegin

BMonthBegin

alias of pandas.tseries.offsets.BusinessMonthBegin

Properties

BMonthBegin.base

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

BMonthBegin.freqstr

BMonthBegin.kwds

BMonthBegin.name

BMonthBegin.nanos

BMonthBegin.normalize

BMonthBegin.rule_code

Methods

BMonthBegin.apply(self, other)

BMonthBegin.apply_index(self, other)

BMonthBegin.copy(self)

BMonthBegin.isAnchored(self)

BMonthBegin.onOffset(self, dt)

BMonthBegin.is_anchored(self)

BMonthBegin.is_on_offset(self, dt)

BMonthBegin.rollback(self, dt)

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

BMonthBegin.rollforward(self, dt)

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

CBMonthEnd

CBMonthEnd

alias of pandas.tseries.offsets.CustomBusinessMonthEnd

Properties

CBMonthEnd.base

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

CBMonthEnd.cbday_roll

Define default roll function to be called in apply method.

CBMonthEnd.freqstr

CBMonthEnd.kwds

CBMonthEnd.m_offset

CBMonthEnd.month_roll

Define default roll function to be called in apply method.

CBMonthEnd.name

CBMonthEnd.nanos

CBMonthEnd.normalize

CBMonthEnd.offset

Alias for self._offset.

CBMonthEnd.rule_code

Methods

CBMonthEnd.apply(self, other)

CBMonthEnd.apply_index(self, other)

Vectorized apply of DateOffset to DatetimeIndex, raises NotImplentedError for offsets without a vectorized implementation.

CBMonthEnd.copy(self)

CBMonthEnd.isAnchored(self)

CBMonthEnd.onOffset(self, dt)

CBMonthEnd.is_anchored(self)

CBMonthEnd.is_on_offset(self, dt)

CBMonthEnd.rollback(self, dt)

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

CBMonthEnd.rollforward(self, dt)

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

CBMonthBegin

CBMonthBegin

alias of pandas.tseries.offsets.CustomBusinessMonthBegin

Properties

CBMonthBegin.base

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

CBMonthBegin.cbday_roll

Define default roll function to be called in apply method.

CBMonthBegin.freqstr

CBMonthBegin.kwds

CBMonthBegin.m_offset

CBMonthBegin.month_roll

Define default roll function to be called in apply method.

CBMonthBegin.name

CBMonthBegin.nanos

CBMonthBegin.normalize

CBMonthBegin.offset

Alias for self._offset.

CBMonthBegin.rule_code

Methods

CBMonthBegin.apply(self, other)

CBMonthBegin.apply_index(self, other)

Vectorized apply of DateOffset to DatetimeIndex, raises NotImplentedError for offsets without a vectorized implementation.

CBMonthBegin.copy(self)

CBMonthBegin.isAnchored(self)

CBMonthBegin.onOffset(self, dt)

CBMonthBegin.is_anchored(self)

CBMonthBegin.is_on_offset(self, dt)

CBMonthBegin.rollback(self, dt)

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

CBMonthBegin.rollforward(self, dt)

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

CDay

CDay

alias of pandas.tseries.offsets.CustomBusinessDay

Properties

CDay.base

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

CDay.freqstr

CDay.kwds

CDay.name

CDay.nanos

CDay.normalize

CDay.offset

Alias for self._offset.

CDay.rule_code

Methods

CDay.apply(self, other)

CDay.apply_index(self, i)

Vectorized apply of DateOffset to DatetimeIndex, raises NotImplentedError for offsets without a vectorized implementation.

CDay.copy(self)

CDay.isAnchored(self)

CDay.onOffset(self, dt)

CDay.is_anchored(self)

CDay.is_on_offset(self, dt)

CDay.rollback(self, dt)

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

CDay.rollforward(self, dt)

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

Frequencies

to_offset(freq)

Return DateOffset object from string or tuple representation or datetime.timedelta object.