Date offsets#

DateOffset#

DateOffset

Standard kind of date increment used for a date range.

Properties#

DateOffset.freqstr

Return a string representing the frequency.

DateOffset.kwds

Return a dict of extra parameters for the offset.

DateOffset.name

Return a string representing the base frequency.

DateOffset.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

DateOffset.normalize

Return boolean whether the frequency can align with midnight.

DateOffset.rule_code

Return a string representing the base frequency.

DateOffset.n

Methods#

DateOffset.copy()

Return a copy of the frequency.

DateOffset.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

DateOffset.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

DateOffset.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

DateOffset.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

DateOffset.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

DateOffset.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

DateOffset.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

DateOffset.rollback(dt)

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

DateOffset.rollforward(dt)

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

BusinessDay#

BusinessDay

DateOffset subclass representing possibly n business days.

Alias:

BDay

alias of BusinessDay

Properties#

BusinessDay.freqstr

Return a string representing the frequency.

BusinessDay.kwds

Return a dict of extra parameters for the offset.

BusinessDay.name

Return a string representing the base frequency.

BusinessDay.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BusinessDay.normalize

Return boolean whether the frequency can align with midnight.

BusinessDay.rule_code

Return a string representing the base frequency.

BusinessDay.n

BusinessDay.weekmask

BusinessDay.holidays

BusinessDay.calendar

Methods#

BusinessDay.copy()

Return a copy of the frequency.

BusinessDay.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BusinessDay.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BusinessDay.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BusinessDay.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BusinessDay.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BusinessDay.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BusinessDay.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BusinessHour#

BusinessHour

DateOffset subclass representing possibly n business hours.

Properties#

BusinessHour.freqstr

Return a string representing the frequency.

BusinessHour.kwds

Return a dict of extra parameters for the offset.

BusinessHour.name

Return a string representing the base frequency.

BusinessHour.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BusinessHour.normalize

Return boolean whether the frequency can align with midnight.

BusinessHour.rule_code

Return a string representing the base frequency.

BusinessHour.n

BusinessHour.start

Return the start time(s) of the business hour.

BusinessHour.end

Return the end time(s) of the business hour.

BusinessHour.weekmask

BusinessHour.holidays

BusinessHour.calendar

Methods#

BusinessHour.copy()

Return a copy of the frequency.

BusinessHour.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BusinessHour.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BusinessHour.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BusinessHour.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BusinessHour.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BusinessHour.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BusinessHour.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

CustomBusinessDay#

CustomBusinessDay

DateOffset subclass representing possibly n custom business days.

Alias:

Properties#

CustomBusinessDay.freqstr

Return a string representing the frequency.

CustomBusinessDay.kwds

Return a dict of extra parameters for the offset.

CustomBusinessDay.name

Return a string representing the base frequency.

CustomBusinessDay.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

CustomBusinessDay.normalize

Return boolean whether the frequency can align with midnight.

CustomBusinessDay.rule_code

Return a string representing the base frequency.

CustomBusinessDay.n

CustomBusinessDay.weekmask

CustomBusinessDay.calendar

CustomBusinessDay.holidays

Methods#

CustomBusinessDay.copy()

Return a copy of the frequency.

CustomBusinessDay.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

CustomBusinessDay.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

CustomBusinessDay.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

CustomBusinessDay.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

CustomBusinessDay.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

CustomBusinessDay.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

CustomBusinessDay.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

CustomBusinessHour#

CustomBusinessHour

DateOffset subclass representing possibly n custom business days.

Properties#

CustomBusinessHour.freqstr

Return a string representing the frequency.

CustomBusinessHour.kwds

Return a dict of extra parameters for the offset.

CustomBusinessHour.name

Return a string representing the base frequency.

CustomBusinessHour.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

CustomBusinessHour.normalize

Return boolean whether the frequency can align with midnight.

CustomBusinessHour.rule_code

Return a string representing the base frequency.

CustomBusinessHour.n

CustomBusinessHour.weekmask

CustomBusinessHour.calendar

CustomBusinessHour.holidays

CustomBusinessHour.start

Return the start time(s) of the business hour.

CustomBusinessHour.end

Return the end time(s) of the business hour.

Methods#

CustomBusinessHour.copy()

Return a copy of the frequency.

CustomBusinessHour.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

CustomBusinessHour.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

CustomBusinessHour.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

CustomBusinessHour.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

CustomBusinessHour.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

CustomBusinessHour.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

CustomBusinessHour.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

MonthEnd#

MonthEnd

DateOffset of one month end.

Properties#

MonthEnd.freqstr

Return a string representing the frequency.

MonthEnd.kwds

Return a dict of extra parameters for the offset.

MonthEnd.name

Return a string representing the base frequency.

MonthEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

MonthEnd.normalize

Return boolean whether the frequency can align with midnight.

MonthEnd.rule_code

Return a string representing the base frequency.

MonthEnd.n

Methods#

MonthEnd.copy()

Return a copy of the frequency.

MonthEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

MonthEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

MonthEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

MonthEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

MonthEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

MonthEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

MonthEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

MonthBegin#

MonthBegin

DateOffset of one month at beginning.

Properties#

MonthBegin.freqstr

Return a string representing the frequency.

MonthBegin.kwds

Return a dict of extra parameters for the offset.

MonthBegin.name

Return a string representing the base frequency.

MonthBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

MonthBegin.normalize

Return boolean whether the frequency can align with midnight.

MonthBegin.rule_code

Return a string representing the base frequency.

MonthBegin.n

Methods#

MonthBegin.copy()

Return a copy of the frequency.

MonthBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

MonthBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

MonthBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

MonthBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

MonthBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

MonthBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

MonthBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BusinessMonthEnd#

BusinessMonthEnd

DateOffset increments between the last business day of the month.

Alias:

Properties#

BusinessMonthEnd.freqstr

Return a string representing the frequency.

BusinessMonthEnd.kwds

Return a dict of extra parameters for the offset.

BusinessMonthEnd.name

Return a string representing the base frequency.

BusinessMonthEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BusinessMonthEnd.normalize

Return boolean whether the frequency can align with midnight.

BusinessMonthEnd.rule_code

Return a string representing the base frequency.

BusinessMonthEnd.n

Methods#

BusinessMonthEnd.copy()

Return a copy of the frequency.

BusinessMonthEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BusinessMonthEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BusinessMonthEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BusinessMonthEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BusinessMonthEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BusinessMonthEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BusinessMonthEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BusinessMonthBegin#

BusinessMonthBegin

DateOffset of one month at the first business day.

Alias:

Properties#

BusinessMonthBegin.freqstr

Return a string representing the frequency.

BusinessMonthBegin.kwds

Return a dict of extra parameters for the offset.

BusinessMonthBegin.name

Return a string representing the base frequency.

BusinessMonthBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BusinessMonthBegin.normalize

Return boolean whether the frequency can align with midnight.

BusinessMonthBegin.rule_code

Return a string representing the base frequency.

BusinessMonthBegin.n

Methods#

BusinessMonthBegin.copy()

Return a copy of the frequency.

BusinessMonthBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BusinessMonthBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BusinessMonthBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BusinessMonthBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BusinessMonthBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BusinessMonthBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BusinessMonthBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

CustomBusinessMonthEnd#

CustomBusinessMonthEnd

DateOffset subclass representing custom business month(s).

Alias:

Properties#

CustomBusinessMonthEnd.freqstr

Return a string representing the frequency.

CustomBusinessMonthEnd.kwds

Return a dict of extra parameters for the offset.

CustomBusinessMonthEnd.m_offset

CustomBusinessMonthEnd.name

Return a string representing the base frequency.

CustomBusinessMonthEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

CustomBusinessMonthEnd.normalize

Return boolean whether the frequency can align with midnight.

CustomBusinessMonthEnd.rule_code

Return a string representing the base frequency.

CustomBusinessMonthEnd.n

CustomBusinessMonthEnd.weekmask

CustomBusinessMonthEnd.calendar

CustomBusinessMonthEnd.holidays

Methods#

CustomBusinessMonthEnd.copy()

Return a copy of the frequency.

CustomBusinessMonthEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

CustomBusinessMonthEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

CustomBusinessMonthEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

CustomBusinessMonthEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

CustomBusinessMonthEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

CustomBusinessMonthEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

CustomBusinessMonthEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

CustomBusinessMonthBegin#

CustomBusinessMonthBegin

DateOffset subclass representing custom business month(s).

Alias:

Properties#

CustomBusinessMonthBegin.freqstr

Return a string representing the frequency.

CustomBusinessMonthBegin.kwds

Return a dict of extra parameters for the offset.

CustomBusinessMonthBegin.m_offset

CustomBusinessMonthBegin.name

Return a string representing the base frequency.

CustomBusinessMonthBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

CustomBusinessMonthBegin.normalize

Return boolean whether the frequency can align with midnight.

CustomBusinessMonthBegin.rule_code

Return a string representing the base frequency.

CustomBusinessMonthBegin.n

CustomBusinessMonthBegin.weekmask

CustomBusinessMonthBegin.calendar

CustomBusinessMonthBegin.holidays

Methods#

CustomBusinessMonthBegin.copy()

Return a copy of the frequency.

CustomBusinessMonthBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

CustomBusinessMonthBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

CustomBusinessMonthBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

CustomBusinessMonthBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

CustomBusinessMonthBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

CustomBusinessMonthBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

CustomBusinessMonthBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

SemiMonthEnd#

SemiMonthEnd

Two DateOffset's per month repeating on the last day of the month & day_of_month.

Properties#

SemiMonthEnd.freqstr

Return a string representing the frequency.

SemiMonthEnd.kwds

Return a dict of extra parameters for the offset.

SemiMonthEnd.name

Return a string representing the base frequency.

SemiMonthEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

SemiMonthEnd.normalize

Return boolean whether the frequency can align with midnight.

SemiMonthEnd.rule_code

SemiMonthEnd.n

SemiMonthEnd.day_of_month

Methods#

SemiMonthEnd.copy()

Return a copy of the frequency.

SemiMonthEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

SemiMonthEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

SemiMonthEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

SemiMonthEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

SemiMonthEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

SemiMonthEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

SemiMonthEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

SemiMonthBegin#

SemiMonthBegin

Two DateOffset's per month repeating on the first day of the month & day_of_month.

Properties#

SemiMonthBegin.freqstr

Return a string representing the frequency.

SemiMonthBegin.kwds

Return a dict of extra parameters for the offset.

SemiMonthBegin.name

Return a string representing the base frequency.

SemiMonthBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

SemiMonthBegin.normalize

Return boolean whether the frequency can align with midnight.

SemiMonthBegin.rule_code

SemiMonthBegin.n

SemiMonthBegin.day_of_month

Methods#

SemiMonthBegin.copy()

Return a copy of the frequency.

SemiMonthBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

SemiMonthBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

SemiMonthBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

SemiMonthBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

SemiMonthBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

SemiMonthBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

SemiMonthBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Week#

Week

Weekly offset.

Properties#

Week.freqstr

Return a string representing the frequency.

Week.kwds

Return a dict of extra parameters for the offset.

Week.name

Return a string representing the base frequency.

Week.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

Week.normalize

Return boolean whether the frequency can align with midnight.

Week.rule_code

Return a string representing the base frequency.

Week.n

Week.weekday

Methods#

Week.copy()

Return a copy of the frequency.

Week.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Week.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Week.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Week.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Week.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Week.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Week.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

WeekOfMonth#

WeekOfMonth

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

Properties#

WeekOfMonth.freqstr

Return a string representing the frequency.

WeekOfMonth.kwds

Return a dict of extra parameters for the offset.

WeekOfMonth.name

Return a string representing the base frequency.

WeekOfMonth.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

WeekOfMonth.normalize

Return boolean whether the frequency can align with midnight.

WeekOfMonth.rule_code

Return a string representing the base frequency.

WeekOfMonth.n

WeekOfMonth.week

Methods#

WeekOfMonth.copy()

Return a copy of the frequency.

WeekOfMonth.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

WeekOfMonth.weekday

WeekOfMonth.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

WeekOfMonth.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

WeekOfMonth.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

WeekOfMonth.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

WeekOfMonth.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

WeekOfMonth.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

LastWeekOfMonth#

LastWeekOfMonth

Describes monthly dates in last week of month.

Properties#

LastWeekOfMonth.freqstr

Return a string representing the frequency.

LastWeekOfMonth.kwds

Return a dict of extra parameters for the offset.

LastWeekOfMonth.name

Return a string representing the base frequency.

LastWeekOfMonth.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

LastWeekOfMonth.normalize

Return boolean whether the frequency can align with midnight.

LastWeekOfMonth.rule_code

Return a string representing the base frequency.

LastWeekOfMonth.n

LastWeekOfMonth.weekday

LastWeekOfMonth.week

Methods#

LastWeekOfMonth.copy()

Return a copy of the frequency.

LastWeekOfMonth.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

LastWeekOfMonth.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

LastWeekOfMonth.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

LastWeekOfMonth.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

LastWeekOfMonth.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

LastWeekOfMonth.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

LastWeekOfMonth.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BQuarterEnd#

BQuarterEnd

DateOffset increments between the last business day of each Quarter.

Properties#

BQuarterEnd.freqstr

Return a string representing the frequency.

BQuarterEnd.kwds

Return a dict of extra parameters for the offset.

BQuarterEnd.name

Return a string representing the base frequency.

BQuarterEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BQuarterEnd.normalize

Return boolean whether the frequency can align with midnight.

BQuarterEnd.rule_code

BQuarterEnd.n

BQuarterEnd.startingMonth

Methods#

BQuarterEnd.copy()

Return a copy of the frequency.

BQuarterEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BQuarterEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BQuarterEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BQuarterEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BQuarterEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BQuarterEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BQuarterEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BQuarterBegin#

BQuarterBegin

DateOffset increments between the first business day of each Quarter.

Properties#

BQuarterBegin.freqstr

Return a string representing the frequency.

BQuarterBegin.kwds

Return a dict of extra parameters for the offset.

BQuarterBegin.name

Return a string representing the base frequency.

BQuarterBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BQuarterBegin.normalize

Return boolean whether the frequency can align with midnight.

BQuarterBegin.rule_code

BQuarterBegin.n

BQuarterBegin.startingMonth

Methods#

BQuarterBegin.copy()

Return a copy of the frequency.

BQuarterBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BQuarterBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BQuarterBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BQuarterBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BQuarterBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BQuarterBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BQuarterBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

QuarterEnd#

QuarterEnd

DateOffset increments between Quarter end dates.

Properties#

QuarterEnd.freqstr

Return a string representing the frequency.

QuarterEnd.kwds

Return a dict of extra parameters for the offset.

QuarterEnd.name

Return a string representing the base frequency.

QuarterEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

QuarterEnd.normalize

Return boolean whether the frequency can align with midnight.

QuarterEnd.rule_code

QuarterEnd.n

QuarterEnd.startingMonth

Methods#

QuarterEnd.copy()

Return a copy of the frequency.

QuarterEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

QuarterEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

QuarterEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

QuarterEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

QuarterEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

QuarterEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

QuarterEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

QuarterBegin#

QuarterBegin

DateOffset increments between Quarter start dates.

Properties#

QuarterBegin.freqstr

Return a string representing the frequency.

QuarterBegin.kwds

Return a dict of extra parameters for the offset.

QuarterBegin.name

Return a string representing the base frequency.

QuarterBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

QuarterBegin.normalize

Return boolean whether the frequency can align with midnight.

QuarterBegin.rule_code

QuarterBegin.n

QuarterBegin.startingMonth

Methods#

QuarterBegin.copy()

Return a copy of the frequency.

QuarterBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

QuarterBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

QuarterBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

QuarterBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

QuarterBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

QuarterBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

QuarterBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BHalfYearEnd#

BHalfYearEnd

DateOffset increments between the last business day of each half-year.

Properties#

BHalfYearEnd.freqstr

Return a string representing the frequency.

BHalfYearEnd.kwds

Return a dict of extra parameters for the offset.

BHalfYearEnd.name

Return a string representing the base frequency.

BHalfYearEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BHalfYearEnd.normalize

Return boolean whether the frequency can align with midnight.

BHalfYearEnd.rule_code

BHalfYearEnd.n

BHalfYearEnd.startingMonth

Methods#

BHalfYearEnd.copy()

Return a copy of the frequency.

BHalfYearEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BHalfYearEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BHalfYearEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BHalfYearEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BHalfYearEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BHalfYearEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BHalfYearEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BHalfYearBegin#

BHalfYearBegin

DateOffset increments between the first business day of each half-year.

Properties#

BHalfYearBegin.freqstr

Return a string representing the frequency.

BHalfYearBegin.kwds

Return a dict of extra parameters for the offset.

BHalfYearBegin.name

Return a string representing the base frequency.

BHalfYearBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BHalfYearBegin.normalize

Return boolean whether the frequency can align with midnight.

BHalfYearBegin.rule_code

BHalfYearBegin.n

BHalfYearBegin.startingMonth

Methods#

BHalfYearBegin.copy()

Return a copy of the frequency.

BHalfYearBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BHalfYearBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BHalfYearBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BHalfYearBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BHalfYearBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BHalfYearBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BHalfYearBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

HalfYearEnd#

HalfYearEnd

DateOffset increments between half-year end dates.

Properties#

HalfYearEnd.freqstr

Return a string representing the frequency.

HalfYearEnd.kwds

Return a dict of extra parameters for the offset.

HalfYearEnd.name

Return a string representing the base frequency.

HalfYearEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

HalfYearEnd.normalize

Return boolean whether the frequency can align with midnight.

HalfYearEnd.rule_code

HalfYearEnd.n

HalfYearEnd.startingMonth

Methods#

HalfYearEnd.copy()

Return a copy of the frequency.

HalfYearEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

HalfYearEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

HalfYearEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

HalfYearEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

HalfYearEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

HalfYearEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

HalfYearEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

HalfYearBegin#

HalfYearBegin

DateOffset increments between half-year start dates.

Properties#

HalfYearBegin.freqstr

Return a string representing the frequency.

HalfYearBegin.kwds

Return a dict of extra parameters for the offset.

HalfYearBegin.name

Return a string representing the base frequency.

HalfYearBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

HalfYearBegin.normalize

Return boolean whether the frequency can align with midnight.

HalfYearBegin.rule_code

HalfYearBegin.n

HalfYearBegin.startingMonth

Methods#

HalfYearBegin.copy()

Return a copy of the frequency.

HalfYearBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

HalfYearBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

HalfYearBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

HalfYearBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

HalfYearBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

HalfYearBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

HalfYearBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BYearEnd#

BYearEnd

DateOffset increments between the last business day of the year.

Properties#

BYearEnd.freqstr

Return a string representing the frequency.

BYearEnd.kwds

Return a dict of extra parameters for the offset.

BYearEnd.name

Return a string representing the base frequency.

BYearEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BYearEnd.normalize

Return boolean whether the frequency can align with midnight.

BYearEnd.rule_code

Return a string representing the base frequency.

BYearEnd.n

BYearEnd.month

Methods#

BYearEnd.copy()

Return a copy of the frequency.

BYearEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BYearEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BYearEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BYearEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BYearEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BYearEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BYearEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

BYearBegin#

BYearBegin

DateOffset increments between the first business day of the year.

Properties#

BYearBegin.freqstr

Return a string representing the frequency.

BYearBegin.kwds

Return a dict of extra parameters for the offset.

BYearBegin.name

Return a string representing the base frequency.

BYearBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

BYearBegin.normalize

Return boolean whether the frequency can align with midnight.

BYearBegin.rule_code

Return a string representing the base frequency.

BYearBegin.n

BYearBegin.month

Methods#

BYearBegin.copy()

Return a copy of the frequency.

BYearBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

BYearBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

BYearBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

BYearBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

BYearBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

BYearBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

BYearBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

YearEnd#

YearEnd([n, normalize, month])

DateOffset increments between calendar year end dates.

Properties#

YearEnd.freqstr

Return a string representing the frequency.

YearEnd.kwds

Return a dict of extra parameters for the offset.

YearEnd.name

Return a string representing the base frequency.

YearEnd.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

YearEnd.normalize

Return boolean whether the frequency can align with midnight.

YearEnd.rule_code

Return a string representing the base frequency.

YearEnd.n

YearEnd.month

Methods#

YearEnd.copy()

Return a copy of the frequency.

YearEnd.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

YearEnd.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

YearEnd.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

YearEnd.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

YearEnd.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

YearEnd.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

YearEnd.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

YearBegin#

YearBegin

DateOffset increments between calendar year begin dates.

Properties#

YearBegin.freqstr

Return a string representing the frequency.

YearBegin.kwds

Return a dict of extra parameters for the offset.

YearBegin.name

Return a string representing the base frequency.

YearBegin.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

YearBegin.normalize

Return boolean whether the frequency can align with midnight.

YearBegin.rule_code

Return a string representing the base frequency.

YearBegin.n

YearBegin.month

Methods#

YearBegin.copy()

Return a copy of the frequency.

YearBegin.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

YearBegin.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

YearBegin.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

YearBegin.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

YearBegin.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

YearBegin.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

YearBegin.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

FY5253#

FY5253

Describes 52-53 week fiscal year.

Properties#

FY5253.freqstr

Return a string representing the frequency.

FY5253.kwds

Return a dict of extra parameters for the offset.

FY5253.name

Return a string representing the base frequency.

FY5253.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

FY5253.normalize

Return boolean whether the frequency can align with midnight.

FY5253.rule_code

FY5253.n

FY5253.startingMonth

FY5253.variation

FY5253.weekday

Methods#

FY5253.copy()

Return a copy of the frequency.

FY5253.get_rule_code_suffix()

Return the suffix component of the rule code.

FY5253.get_year_end(dt)

FY5253.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

FY5253.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

FY5253.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

FY5253.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

FY5253.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

FY5253.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

FY5253.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

FY5253Quarter#

FY5253Quarter

DateOffset increments between business quarter dates for 52-53 week fiscal year.

Properties#

FY5253Quarter.freqstr

Return a string representing the frequency.

FY5253Quarter.kwds

Return a dict of extra parameters for the offset.

FY5253Quarter.name

Return a string representing the base frequency.

FY5253Quarter.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

FY5253Quarter.normalize

Return boolean whether the frequency can align with midnight.

FY5253Quarter.rule_code

FY5253Quarter.n

FY5253Quarter.qtr_with_extra_week

FY5253Quarter.startingMonth

FY5253Quarter.variation

FY5253Quarter.weekday

Methods#

FY5253Quarter.copy()

Return a copy of the frequency.

FY5253Quarter.get_rule_code_suffix()

Return the suffix component of the rule code.

FY5253Quarter.get_weeks(dt)

FY5253Quarter.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

FY5253Quarter.year_has_extra_week(dt)

FY5253Quarter.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

FY5253Quarter.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

FY5253Quarter.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

FY5253Quarter.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

FY5253Quarter.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

FY5253Quarter.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Easter#

Easter

DateOffset for the Easter holiday using logic defined in dateutil.

Properties#

Easter.freqstr

Return a string representing the frequency.

Easter.kwds

Return a dict of extra parameters for the offset.

Easter.name

Return a string representing the base frequency.

Easter.nanos

Returns an integer of the total number of nanoseconds for fixed frequencies.

Easter.normalize

Return boolean whether the frequency can align with midnight.

Easter.rule_code

Return a string representing the base frequency.

Easter.n

Methods#

Easter.copy()

Return a copy of the frequency.

Easter.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Easter.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Easter.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Easter.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Easter.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Easter.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Easter.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Tick#

Properties#

Tick.freqstr

Return a string representing the frequency.

Tick.kwds

Return a dict of extra parameters for the offset.

Tick.name

Return a string representing the base frequency.

Tick.nanos

Returns an integer of the total number of nanoseconds.

Tick.normalize

Return boolean whether the frequency can align with midnight.

Tick.rule_code

Return a string representing the base frequency.

Tick.n

Methods#

Tick.copy()

Return a copy of the frequency.

Tick.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Tick.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Tick.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Tick.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Tick.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Tick.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Tick.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Day#

Day

Offset n days.

Properties#

Day.freqstr

Return a string representing the frequency.

Day.kwds

Return a dict of extra parameters for the offset.

Day.name

Return a string representing the base frequency.

Day.nanos

Returns an integer of the total number of nanoseconds.

Day.normalize

Return boolean whether the frequency can align with midnight.

Day.rule_code

Return a string representing the base frequency.

Day.n

Methods#

Day.copy()

Return a copy of the frequency.

Day.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Day.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Day.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Day.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Day.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Day.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Day.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Hour#

Hour

Offset n hours.

Properties#

Hour.freqstr

Return a string representing the frequency.

Hour.kwds

Return a dict of extra parameters for the offset.

Hour.name

Return a string representing the base frequency.

Hour.nanos

Returns an integer of the total number of nanoseconds.

Hour.normalize

Return boolean whether the frequency can align with midnight.

Hour.rule_code

Return a string representing the base frequency.

Hour.n

Methods#

Hour.copy()

Return a copy of the frequency.

Hour.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Hour.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Hour.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Hour.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Hour.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Hour.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Hour.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Minute#

Minute

Offset n minutes.

Properties#

Minute.freqstr

Return a string representing the frequency.

Minute.kwds

Return a dict of extra parameters for the offset.

Minute.name

Return a string representing the base frequency.

Minute.nanos

Returns an integer of the total number of nanoseconds.

Minute.normalize

Return boolean whether the frequency can align with midnight.

Minute.rule_code

Return a string representing the base frequency.

Minute.n

Methods#

Minute.copy()

Return a copy of the frequency.

Minute.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Minute.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Minute.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Minute.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Minute.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Minute.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Minute.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Second#

Second

Offset n seconds.

Properties#

Second.freqstr

Return a string representing the frequency.

Second.kwds

Return a dict of extra parameters for the offset.

Second.name

Return a string representing the base frequency.

Second.nanos

Returns an integer of the total number of nanoseconds.

Second.normalize

Return boolean whether the frequency can align with midnight.

Second.rule_code

Return a string representing the base frequency.

Second.n

Methods#

Second.copy()

Return a copy of the frequency.

Second.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Second.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Second.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Second.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Second.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Second.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Second.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Milli#

Milli

Offset n milliseconds.

Properties#

Milli.freqstr

Return a string representing the frequency.

Milli.kwds

Return a dict of extra parameters for the offset.

Milli.name

Return a string representing the base frequency.

Milli.nanos

Returns an integer of the total number of nanoseconds.

Milli.normalize

Return boolean whether the frequency can align with midnight.

Milli.rule_code

Return a string representing the base frequency.

Milli.n

Methods#

Milli.copy()

Return a copy of the frequency.

Milli.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Milli.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Milli.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Milli.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Milli.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Milli.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Milli.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Micro#

Micro

Offset n microseconds.

Properties#

Micro.freqstr

Return a string representing the frequency.

Micro.kwds

Return a dict of extra parameters for the offset.

Micro.name

Return a string representing the base frequency.

Micro.nanos

Returns an integer of the total number of nanoseconds.

Micro.normalize

Return boolean whether the frequency can align with midnight.

Micro.rule_code

Return a string representing the base frequency.

Micro.n

Methods#

Micro.copy()

Return a copy of the frequency.

Micro.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Micro.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Micro.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Micro.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Micro.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Micro.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Micro.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Nano#

Nano

Offset n nanoseconds.

Properties#

Nano.freqstr

Return a string representing the frequency.

Nano.kwds

Return a dict of extra parameters for the offset.

Nano.name

Return a string representing the base frequency.

Nano.nanos

Returns an integer of the total number of nanoseconds.

Nano.normalize

Return boolean whether the frequency can align with midnight.

Nano.rule_code

Return a string representing the base frequency.

Nano.n

Methods#

Nano.copy()

Return a copy of the frequency.

Nano.is_on_offset(dt)

Return boolean whether a timestamp intersects with this frequency.

Nano.is_month_start(ts)

Return boolean whether a timestamp occurs on the month start.

Nano.is_month_end(ts)

Return boolean whether a timestamp occurs on the month end.

Nano.is_quarter_start(ts)

Return boolean whether a timestamp occurs on the quarter start.

Nano.is_quarter_end(ts)

Return boolean whether a timestamp occurs on the quarter end.

Nano.is_year_start(ts)

Return boolean whether a timestamp occurs on the year start.

Nano.is_year_end(ts)

Return boolean whether a timestamp occurs on the year end.

Frequencies#

to_offset(freq[, is_period])

Return DateOffset object from string or datetime.timedelta object.