From 019b9c1b339e53aac4976db917864b4c253e2560 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Wed, 26 Dec 2018 21:11:44 +0000 Subject: [PATCH 1/3] WIP: Adding offsets to API ref --- doc/source/api.rst | 821 ++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 776 insertions(+), 45 deletions(-) diff --git a/doc/source/api.rst b/doc/source/api.rst index d80c73d4a7c1c..678690cb08a03 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -2139,54 +2139,785 @@ Date Offsets .. currentmodule:: pandas.tseries.offsets +BDay +~~~~ +.. autosummary:: + :toctree: generated/ + + BDay.apply + BDay.apply_index + BDay.base + BDay.copy + BDay.freqstr + BDay.isAnchored + BDay.kwds + BDay.name + BDay.nanos + BDay.normalize + BDay.offset + BDay.onOffset + BDay.rollback + BDay.rollforward + BDay.rule_code + +BMonthBegin +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthBegin.apply + BMonthBegin.apply_index + BMonthBegin.base + BMonthBegin.copy + BMonthBegin.freqstr + BMonthBegin.isAnchored + BMonthBegin.kwds + BMonthBegin.name + BMonthBegin.nanos + BMonthBegin.normalize + BMonthBegin.onOffset + BMonthBegin.rollback + BMonthBegin.rollforward + BMonthBegin.rule_code + +BMonthEnd +~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthEnd.apply + BMonthEnd.apply_index + BMonthEnd.base + BMonthEnd.copy + BMonthEnd.freqstr + BMonthEnd.isAnchored + BMonthEnd.kwds + BMonthEnd.name + BMonthEnd.nanos + BMonthEnd.normalize + BMonthEnd.onOffset + BMonthEnd.rollback + BMonthEnd.rollforward + BMonthEnd.rule_code + +BQuarterBegin +~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterBegin.apply + BQuarterBegin.apply_index + BQuarterBegin.copy + BQuarterBegin.freqstr + BQuarterBegin.isAnchored + BQuarterBegin.kwds + BQuarterBegin.name + BQuarterBegin.nanos + BQuarterBegin.normalize + BQuarterBegin.onOffset + BQuarterBegin.rule_code + +BQuarterEnd +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterEnd.apply + BQuarterEnd.apply_index + BQuarterEnd.copy + BQuarterEnd.freqstr + BQuarterEnd.isAnchored + BQuarterEnd.kwds + BQuarterEnd.name + BQuarterEnd.nanos + BQuarterEnd.normalize + BQuarterEnd.onOffset + BQuarterEnd.rule_code + +BYearBegin +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearBegin.apply + BYearBegin.apply_index + BYearBegin.copy + BYearBegin.freqstr + BYearBegin.isAnchored + BYearBegin.kwds + BYearBegin.name + BYearBegin.nanos + BYearBegin.normalize + BYearBegin.onOffset + BYearBegin.rule_code + +BYearEnd +~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearEnd.apply + BYearEnd.apply_index + BYearEnd.copy + BYearEnd.freqstr + BYearEnd.isAnchored + BYearEnd.kwds + BYearEnd.name + BYearEnd.nanos + BYearEnd.normalize + BYearEnd.onOffset + BYearEnd.rule_code + +BusinessDay +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessDay.apply + BusinessDay.apply_index + BusinessDay.copy + BusinessDay.freqstr + BusinessDay.isAnchored + BusinessDay.kwds + BusinessDay.name + BusinessDay.nanos + BusinessDay.normalize + BusinessDay.onOffset + BusinessDay.rule_code + +BusinessHour +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessHour.apply + BusinessHour.copy + BusinessHour.freqstr + BusinessHour.isAnchored + BusinessHour.kwds + BusinessHour.name + BusinessHour.nanos + BusinessHour.normalize + BusinessHour.onOffset + BusinessHour.rule_code + +BusinessMonthBegin +~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthBegin.apply + BusinessMonthBegin.apply_index + BusinessMonthBegin.copy + BusinessMonthBegin.freqstr + BusinessMonthBegin.isAnchored + BusinessMonthBegin.kwds + BusinessMonthBegin.name + BusinessMonthBegin.nanos + BusinessMonthBegin.normalize + BusinessMonthBegin.onOffset + BusinessMonthBegin.rule_code + +BusinessMonthEnd +~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthEnd.apply + BusinessMonthEnd.apply_index + BusinessMonthEnd.copy + BusinessMonthEnd.freqstr + BusinessMonthEnd.isAnchored + BusinessMonthEnd.kwds + BusinessMonthEnd.name + BusinessMonthEnd.nanos + BusinessMonthEnd.normalize + BusinessMonthEnd.onOffset + BusinessMonthEnd.rule_code + +CBMonthBegin +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthBegin.apply + CBMonthBegin.apply_index + CBMonthBegin.base + CBMonthBegin.cbday_roll + CBMonthBegin.copy + CBMonthBegin.freqstr + CBMonthBegin.isAnchored + CBMonthBegin.kwds + CBMonthBegin.m_offset + CBMonthBegin.month_roll + CBMonthBegin.name + CBMonthBegin.nanos + CBMonthBegin.normalize + CBMonthBegin.offset + CBMonthBegin.onOffset + CBMonthBegin.rollback + CBMonthBegin.rollforward + CBMonthBegin.rule_code + +CBMonthEnd +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthEnd.apply + CBMonthEnd.apply_index + CBMonthEnd.base + CBMonthEnd.cbday_roll + CBMonthEnd.copy + CBMonthEnd.freqstr + CBMonthEnd.isAnchored + CBMonthEnd.kwds + CBMonthEnd.m_offset + CBMonthEnd.month_roll + CBMonthEnd.name + CBMonthEnd.nanos + CBMonthEnd.normalize + CBMonthEnd.offset + CBMonthEnd.onOffset + CBMonthEnd.rollback + CBMonthEnd.rollforward + CBMonthEnd.rule_code + +CDay +~~~~ +.. autosummary:: + :toctree: generated/ + + CDay.apply + CDay.apply_index + CDay.base + CDay.copy + CDay.freqstr + CDay.isAnchored + CDay.kwds + CDay.name + CDay.nanos + CDay.normalize + CDay.offset + CDay.onOffset + CDay.rollback + CDay.rollforward + CDay.rule_code + +CustomBusinessDay +~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessDay.apply + CustomBusinessDay.copy + CustomBusinessDay.freqstr + CustomBusinessDay.isAnchored + CustomBusinessDay.kwds + CustomBusinessDay.name + CustomBusinessDay.nanos + CustomBusinessDay.normalize + CustomBusinessDay.onOffset + CustomBusinessDay.rule_code + +CustomBusinessHour +~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessHour.apply + CustomBusinessHour.copy + CustomBusinessHour.freqstr + CustomBusinessHour.isAnchored + CustomBusinessHour.kwds + CustomBusinessHour.name + CustomBusinessHour.nanos + CustomBusinessHour.normalize + CustomBusinessHour.onOffset + CustomBusinessHour.rule_code + +CustomBusinessMonthBegin +~~~~~~~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthBegin.apply + CustomBusinessMonthBegin.copy + CustomBusinessMonthBegin.freqstr + CustomBusinessMonthBegin.isAnchored + CustomBusinessMonthBegin.kwds + CustomBusinessMonthBegin.m_offset + CustomBusinessMonthBegin.name + CustomBusinessMonthBegin.nanos + CustomBusinessMonthBegin.normalize + CustomBusinessMonthBegin.onOffset + CustomBusinessMonthBegin.rule_code + +CustomBusinessMonthEnd +~~~~~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthEnd.apply + CustomBusinessMonthEnd.copy + CustomBusinessMonthEnd.freqstr + CustomBusinessMonthEnd.isAnchored + CustomBusinessMonthEnd.kwds + CustomBusinessMonthEnd.m_offset + CustomBusinessMonthEnd.name + CustomBusinessMonthEnd.nanos + CustomBusinessMonthEnd.normalize + CustomBusinessMonthEnd.onOffset + CustomBusinessMonthEnd.rule_code + +DateOffset +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + DateOffset.apply + DateOffset.copy + DateOffset.freqstr + DateOffset.isAnchored + DateOffset.kwds + DateOffset.name + DateOffset.nanos + DateOffset.normalize + DateOffset.onOffset + DateOffset.rule_code + +Day +~~~ +.. autosummary:: + :toctree: generated/ + + Day.copy + Day.delta + Day.freqstr + Day.isAnchored + Day.kwds + Day.name + Day.nanos + Day.normalize + Day.onOffset + Day.rule_code + +Easter +~~~~~~ +.. autosummary:: + :toctree: generated/ + + Easter.apply + Easter.copy + Easter.freqstr + Easter.isAnchored + Easter.kwds + Easter.name + Easter.nanos + Easter.normalize + Easter.onOffset + Easter.rule_code + +FY5253 +~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253.apply + FY5253.copy + FY5253.freqstr + FY5253.get_rule_code_suffix + FY5253.get_year_end + FY5253.isAnchored + FY5253.kwds + FY5253.name + FY5253.nanos + FY5253.normalize + FY5253.onOffset + FY5253.rule_code + +FY5253Quarter +~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253Quarter.apply + FY5253Quarter.copy + FY5253Quarter.freqstr + FY5253Quarter.get_weeks + FY5253Quarter.isAnchored + FY5253Quarter.kwds + FY5253Quarter.name + FY5253Quarter.nanos + FY5253Quarter.normalize + FY5253Quarter.onOffset + FY5253Quarter.rule_code + FY5253Quarter.year_has_extra_week + +Hour +~~~~ +.. autosummary:: + :toctree: generated/ + + Hour.copy + Hour.delta + Hour.freqstr + Hour.isAnchored + Hour.kwds + Hour.name + Hour.nanos + Hour.normalize + Hour.onOffset + Hour.rule_code + +LastWeekOfMonth +~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + LastWeekOfMonth.apply + LastWeekOfMonth.copy + LastWeekOfMonth.freqstr + LastWeekOfMonth.isAnchored + LastWeekOfMonth.kwds + LastWeekOfMonth.name + LastWeekOfMonth.nanos + LastWeekOfMonth.normalize + LastWeekOfMonth.onOffset + LastWeekOfMonth.rule_code + +Micro +~~~~~ +.. autosummary:: + :toctree: generated/ + + Micro.copy + Micro.delta + Micro.freqstr + Micro.isAnchored + Micro.kwds + Micro.name + Micro.nanos + Micro.normalize + Micro.onOffset + Micro.rule_code + +Milli +~~~~~ +.. autosummary:: + :toctree: generated/ + + Milli.copy + Milli.delta + Milli.freqstr + Milli.isAnchored + Milli.kwds + Milli.name + Milli.nanos + Milli.normalize + Milli.onOffset + Milli.rule_code + +Minute +~~~~~~ +.. autosummary:: + :toctree: generated/ + + Minute.copy + Minute.delta + Minute.freqstr + Minute.isAnchored + Minute.kwds + Minute.name + Minute.nanos + Minute.normalize + Minute.onOffset + Minute.rule_code + +MonthBegin +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthBegin.apply + MonthBegin.apply_index + MonthBegin.copy + MonthBegin.freqstr + MonthBegin.isAnchored + MonthBegin.kwds + MonthBegin.name + MonthBegin.nanos + MonthBegin.normalize + MonthBegin.onOffset + MonthBegin.rule_code + +MonthEnd +~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthEnd.apply + MonthEnd.apply_index + MonthEnd.copy + MonthEnd.freqstr + MonthEnd.isAnchored + MonthEnd.kwds + MonthEnd.name + MonthEnd.nanos + MonthEnd.normalize + MonthEnd.onOffset + MonthEnd.rule_code + +MonthOffset +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthOffset.apply + MonthOffset.apply_index + MonthOffset.copy + MonthOffset.freqstr + MonthOffset.isAnchored + MonthOffset.kwds + MonthOffset.name + MonthOffset.nanos + MonthOffset.normalize + MonthOffset.onOffset + MonthOffset.rule_code + +Nano +~~~~ +.. autosummary:: + :toctree: generated/ + + Nano.copy + Nano.delta + Nano.freqstr + Nano.isAnchored + Nano.kwds + Nano.name + Nano.nanos + Nano.normalize + Nano.onOffset + Nano.rule_code + +QuarterBegin +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterBegin.apply + QuarterBegin.apply_index + QuarterBegin.copy + QuarterBegin.freqstr + QuarterBegin.isAnchored + QuarterBegin.kwds + QuarterBegin.name + QuarterBegin.nanos + QuarterBegin.normalize + QuarterBegin.onOffset + QuarterBegin.rule_code + +QuarterEnd +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterEnd.apply + QuarterEnd.apply_index + QuarterEnd.copy + QuarterEnd.freqstr + QuarterEnd.isAnchored + QuarterEnd.kwds + QuarterEnd.name + QuarterEnd.nanos + QuarterEnd.normalize + QuarterEnd.onOffset + QuarterEnd.rule_code + +QuarterOffset +~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterOffset.apply + QuarterOffset.apply_index + QuarterOffset.copy + QuarterOffset.freqstr + QuarterOffset.isAnchored + QuarterOffset.kwds + QuarterOffset.name + QuarterOffset.nanos + QuarterOffset.normalize + QuarterOffset.onOffset + QuarterOffset.rule_code + +Second +~~~~~~ +.. autosummary:: + :toctree: generated/ + + Second.copy + Second.delta + Second.freqstr + Second.isAnchored + Second.kwds + Second.name + Second.nanos + Second.normalize + Second.onOffset + Second.rule_code + +SemiMonthBegin +~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthBegin.apply + SemiMonthBegin.apply_index + SemiMonthBegin.copy + SemiMonthBegin.freqstr + SemiMonthBegin.isAnchored + SemiMonthBegin.kwds + SemiMonthBegin.name + SemiMonthBegin.nanos + SemiMonthBegin.normalize + SemiMonthBegin.onOffset + SemiMonthBegin.rule_code + +SemiMonthEnd +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthEnd.apply + SemiMonthEnd.apply_index + SemiMonthEnd.copy + SemiMonthEnd.freqstr + SemiMonthEnd.isAnchored + SemiMonthEnd.kwds + SemiMonthEnd.name + SemiMonthEnd.nanos + SemiMonthEnd.normalize + SemiMonthEnd.onOffset + SemiMonthEnd.rule_code + +SemiMonthOffset +~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthOffset.apply + SemiMonthOffset.apply_index + SemiMonthOffset.copy + SemiMonthOffset.freqstr + SemiMonthOffset.isAnchored + SemiMonthOffset.kwds + SemiMonthOffset.name + SemiMonthOffset.nanos + SemiMonthOffset.normalize + SemiMonthOffset.onOffset + SemiMonthOffset.rule_code + +Tick +~~~~ +.. autosummary:: + :toctree: generated/ + + Tick.copy + Tick.delta + Tick.freqstr + Tick.isAnchored + Tick.kwds + Tick.name + Tick.nanos + Tick.normalize + Tick.onOffset + Tick.rule_code + +Week +~~~~ +.. autosummary:: + :toctree: generated/ + + Week.apply + Week.apply_index + Week.copy + Week.freqstr + Week.isAnchored + Week.kwds + Week.name + Week.nanos + Week.normalize + Week.onOffset + Week.rule_code + +WeekOfMonth +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + WeekOfMonth.apply + WeekOfMonth.copy + WeekOfMonth.freqstr + WeekOfMonth.isAnchored + WeekOfMonth.kwds + WeekOfMonth.name + WeekOfMonth.nanos + WeekOfMonth.normalize + WeekOfMonth.onOffset + WeekOfMonth.rule_code + +YearBegin +~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearBegin.apply + YearBegin.apply_index + YearBegin.copy + YearBegin.freqstr + YearBegin.isAnchored + YearBegin.kwds + YearBegin.name + YearBegin.nanos + YearBegin.normalize + YearBegin.onOffset + YearBegin.rule_code + +YearEnd +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearEnd.apply + YearEnd.apply_index + YearEnd.copy + YearEnd.freqstr + YearEnd.isAnchored + YearEnd.kwds + YearEnd.name + YearEnd.nanos + YearEnd.normalize + YearEnd.onOffset + YearEnd.rule_code + +YearOffset +~~~~~~~~~~ .. autosummary:: :toctree: generated/ - DateOffset - BusinessDay - BusinessHour - CustomBusinessDay - CustomBusinessHour - MonthOffset - MonthEnd - MonthBegin - BusinessMonthEnd - BusinessMonthBegin - CustomBusinessMonthEnd - CustomBusinessMonthBegin - SemiMonthOffset - SemiMonthEnd - SemiMonthBegin - Week - WeekOfMonth - LastWeekOfMonth - QuarterOffset - BQuarterEnd - BQuarterBegin - QuarterEnd - QuarterBegin - YearOffset - BYearEnd - BYearBegin - YearEnd - YearBegin - FY5253 - FY5253Quarter - Easter - Tick - Day - Hour - Minute - Second - Milli - Micro - Nano - BDay - BMonthEnd - BMonthBegin - CBMonthEnd - CBMonthBegin - CDay + YearOffset.apply + YearOffset.apply_index + YearOffset.copy + YearOffset.freqstr + YearOffset.isAnchored + YearOffset.kwds + YearOffset.name + YearOffset.nanos + YearOffset.normalize + YearOffset.onOffset + YearOffset.rule_code .. _api.frequencies: From 0f5099aa785a6dea9caca1f39758cd6c15dee8c6 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Wed, 26 Dec 2018 21:58:30 +0000 Subject: [PATCH 2/3] Removing offset methods (will add them again with a better organization) --- doc/source/api.rst | 778 --------------------------------------------- 1 file changed, 778 deletions(-) diff --git a/doc/source/api.rst b/doc/source/api.rst index 678690cb08a03..efe6f6b233f10 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -2139,785 +2139,7 @@ Date Offsets .. currentmodule:: pandas.tseries.offsets -BDay -~~~~ -.. autosummary:: - :toctree: generated/ - - BDay.apply - BDay.apply_index - BDay.base - BDay.copy - BDay.freqstr - BDay.isAnchored - BDay.kwds - BDay.name - BDay.nanos - BDay.normalize - BDay.offset - BDay.onOffset - BDay.rollback - BDay.rollforward - BDay.rule_code - -BMonthBegin -~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BMonthBegin.apply - BMonthBegin.apply_index - BMonthBegin.base - BMonthBegin.copy - BMonthBegin.freqstr - BMonthBegin.isAnchored - BMonthBegin.kwds - BMonthBegin.name - BMonthBegin.nanos - BMonthBegin.normalize - BMonthBegin.onOffset - BMonthBegin.rollback - BMonthBegin.rollforward - BMonthBegin.rule_code - -BMonthEnd -~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BMonthEnd.apply - BMonthEnd.apply_index - BMonthEnd.base - BMonthEnd.copy - BMonthEnd.freqstr - BMonthEnd.isAnchored - BMonthEnd.kwds - BMonthEnd.name - BMonthEnd.nanos - BMonthEnd.normalize - BMonthEnd.onOffset - BMonthEnd.rollback - BMonthEnd.rollforward - BMonthEnd.rule_code - -BQuarterBegin -~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BQuarterBegin.apply - BQuarterBegin.apply_index - BQuarterBegin.copy - BQuarterBegin.freqstr - BQuarterBegin.isAnchored - BQuarterBegin.kwds - BQuarterBegin.name - BQuarterBegin.nanos - BQuarterBegin.normalize - BQuarterBegin.onOffset - BQuarterBegin.rule_code - -BQuarterEnd -~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BQuarterEnd.apply - BQuarterEnd.apply_index - BQuarterEnd.copy - BQuarterEnd.freqstr - BQuarterEnd.isAnchored - BQuarterEnd.kwds - BQuarterEnd.name - BQuarterEnd.nanos - BQuarterEnd.normalize - BQuarterEnd.onOffset - BQuarterEnd.rule_code - -BYearBegin -~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BYearBegin.apply - BYearBegin.apply_index - BYearBegin.copy - BYearBegin.freqstr - BYearBegin.isAnchored - BYearBegin.kwds - BYearBegin.name - BYearBegin.nanos - BYearBegin.normalize - BYearBegin.onOffset - BYearBegin.rule_code - -BYearEnd -~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BYearEnd.apply - BYearEnd.apply_index - BYearEnd.copy - BYearEnd.freqstr - BYearEnd.isAnchored - BYearEnd.kwds - BYearEnd.name - BYearEnd.nanos - BYearEnd.normalize - BYearEnd.onOffset - BYearEnd.rule_code - -BusinessDay -~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BusinessDay.apply - BusinessDay.apply_index - BusinessDay.copy - BusinessDay.freqstr - BusinessDay.isAnchored - BusinessDay.kwds - BusinessDay.name - BusinessDay.nanos - BusinessDay.normalize - BusinessDay.onOffset - BusinessDay.rule_code - -BusinessHour -~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BusinessHour.apply - BusinessHour.copy - BusinessHour.freqstr - BusinessHour.isAnchored - BusinessHour.kwds - BusinessHour.name - BusinessHour.nanos - BusinessHour.normalize - BusinessHour.onOffset - BusinessHour.rule_code - -BusinessMonthBegin -~~~~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BusinessMonthBegin.apply - BusinessMonthBegin.apply_index - BusinessMonthBegin.copy - BusinessMonthBegin.freqstr - BusinessMonthBegin.isAnchored - BusinessMonthBegin.kwds - BusinessMonthBegin.name - BusinessMonthBegin.nanos - BusinessMonthBegin.normalize - BusinessMonthBegin.onOffset - BusinessMonthBegin.rule_code - -BusinessMonthEnd -~~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - BusinessMonthEnd.apply - BusinessMonthEnd.apply_index - BusinessMonthEnd.copy - BusinessMonthEnd.freqstr - BusinessMonthEnd.isAnchored - BusinessMonthEnd.kwds - BusinessMonthEnd.name - BusinessMonthEnd.nanos - BusinessMonthEnd.normalize - BusinessMonthEnd.onOffset - BusinessMonthEnd.rule_code - -CBMonthBegin -~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - CBMonthBegin.apply - CBMonthBegin.apply_index - CBMonthBegin.base - CBMonthBegin.cbday_roll - CBMonthBegin.copy - CBMonthBegin.freqstr - CBMonthBegin.isAnchored - CBMonthBegin.kwds - CBMonthBegin.m_offset - CBMonthBegin.month_roll - CBMonthBegin.name - CBMonthBegin.nanos - CBMonthBegin.normalize - CBMonthBegin.offset - CBMonthBegin.onOffset - CBMonthBegin.rollback - CBMonthBegin.rollforward - CBMonthBegin.rule_code - -CBMonthEnd -~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - CBMonthEnd.apply - CBMonthEnd.apply_index - CBMonthEnd.base - CBMonthEnd.cbday_roll - CBMonthEnd.copy - CBMonthEnd.freqstr - CBMonthEnd.isAnchored - CBMonthEnd.kwds - CBMonthEnd.m_offset - CBMonthEnd.month_roll - CBMonthEnd.name - CBMonthEnd.nanos - CBMonthEnd.normalize - CBMonthEnd.offset - CBMonthEnd.onOffset - CBMonthEnd.rollback - CBMonthEnd.rollforward - CBMonthEnd.rule_code - -CDay -~~~~ -.. autosummary:: - :toctree: generated/ - - CDay.apply - CDay.apply_index - CDay.base - CDay.copy - CDay.freqstr - CDay.isAnchored - CDay.kwds - CDay.name - CDay.nanos - CDay.normalize - CDay.offset - CDay.onOffset - CDay.rollback - CDay.rollforward - CDay.rule_code - -CustomBusinessDay -~~~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - CustomBusinessDay.apply - CustomBusinessDay.copy - CustomBusinessDay.freqstr - CustomBusinessDay.isAnchored - CustomBusinessDay.kwds - CustomBusinessDay.name - CustomBusinessDay.nanos - CustomBusinessDay.normalize - CustomBusinessDay.onOffset - CustomBusinessDay.rule_code - -CustomBusinessHour -~~~~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - CustomBusinessHour.apply - CustomBusinessHour.copy - CustomBusinessHour.freqstr - CustomBusinessHour.isAnchored - CustomBusinessHour.kwds - CustomBusinessHour.name - CustomBusinessHour.nanos - CustomBusinessHour.normalize - CustomBusinessHour.onOffset - CustomBusinessHour.rule_code - -CustomBusinessMonthBegin -~~~~~~~~~~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - CustomBusinessMonthBegin.apply - CustomBusinessMonthBegin.copy - CustomBusinessMonthBegin.freqstr - CustomBusinessMonthBegin.isAnchored - CustomBusinessMonthBegin.kwds - CustomBusinessMonthBegin.m_offset - CustomBusinessMonthBegin.name - CustomBusinessMonthBegin.nanos - CustomBusinessMonthBegin.normalize - CustomBusinessMonthBegin.onOffset - CustomBusinessMonthBegin.rule_code - -CustomBusinessMonthEnd -~~~~~~~~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - CustomBusinessMonthEnd.apply - CustomBusinessMonthEnd.copy - CustomBusinessMonthEnd.freqstr - CustomBusinessMonthEnd.isAnchored - CustomBusinessMonthEnd.kwds - CustomBusinessMonthEnd.m_offset - CustomBusinessMonthEnd.name - CustomBusinessMonthEnd.nanos - CustomBusinessMonthEnd.normalize - CustomBusinessMonthEnd.onOffset - CustomBusinessMonthEnd.rule_code - -DateOffset -~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - DateOffset.apply - DateOffset.copy - DateOffset.freqstr - DateOffset.isAnchored - DateOffset.kwds - DateOffset.name - DateOffset.nanos - DateOffset.normalize - DateOffset.onOffset - DateOffset.rule_code - -Day -~~~ -.. autosummary:: - :toctree: generated/ - - Day.copy - Day.delta - Day.freqstr - Day.isAnchored - Day.kwds - Day.name - Day.nanos - Day.normalize - Day.onOffset - Day.rule_code - -Easter -~~~~~~ -.. autosummary:: - :toctree: generated/ - - Easter.apply - Easter.copy - Easter.freqstr - Easter.isAnchored - Easter.kwds - Easter.name - Easter.nanos - Easter.normalize - Easter.onOffset - Easter.rule_code - -FY5253 -~~~~~~ -.. autosummary:: - :toctree: generated/ - - FY5253.apply - FY5253.copy - FY5253.freqstr - FY5253.get_rule_code_suffix - FY5253.get_year_end - FY5253.isAnchored - FY5253.kwds - FY5253.name - FY5253.nanos - FY5253.normalize - FY5253.onOffset - FY5253.rule_code - -FY5253Quarter -~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - FY5253Quarter.apply - FY5253Quarter.copy - FY5253Quarter.freqstr - FY5253Quarter.get_weeks - FY5253Quarter.isAnchored - FY5253Quarter.kwds - FY5253Quarter.name - FY5253Quarter.nanos - FY5253Quarter.normalize - FY5253Quarter.onOffset - FY5253Quarter.rule_code - FY5253Quarter.year_has_extra_week - -Hour -~~~~ -.. autosummary:: - :toctree: generated/ - - Hour.copy - Hour.delta - Hour.freqstr - Hour.isAnchored - Hour.kwds - Hour.name - Hour.nanos - Hour.normalize - Hour.onOffset - Hour.rule_code - -LastWeekOfMonth -~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - LastWeekOfMonth.apply - LastWeekOfMonth.copy - LastWeekOfMonth.freqstr - LastWeekOfMonth.isAnchored - LastWeekOfMonth.kwds - LastWeekOfMonth.name - LastWeekOfMonth.nanos - LastWeekOfMonth.normalize - LastWeekOfMonth.onOffset - LastWeekOfMonth.rule_code - -Micro -~~~~~ -.. autosummary:: - :toctree: generated/ - - Micro.copy - Micro.delta - Micro.freqstr - Micro.isAnchored - Micro.kwds - Micro.name - Micro.nanos - Micro.normalize - Micro.onOffset - Micro.rule_code - -Milli -~~~~~ -.. autosummary:: - :toctree: generated/ - - Milli.copy - Milli.delta - Milli.freqstr - Milli.isAnchored - Milli.kwds - Milli.name - Milli.nanos - Milli.normalize - Milli.onOffset - Milli.rule_code - -Minute -~~~~~~ -.. autosummary:: - :toctree: generated/ - - Minute.copy - Minute.delta - Minute.freqstr - Minute.isAnchored - Minute.kwds - Minute.name - Minute.nanos - Minute.normalize - Minute.onOffset - Minute.rule_code - -MonthBegin -~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - MonthBegin.apply - MonthBegin.apply_index - MonthBegin.copy - MonthBegin.freqstr - MonthBegin.isAnchored - MonthBegin.kwds - MonthBegin.name - MonthBegin.nanos - MonthBegin.normalize - MonthBegin.onOffset - MonthBegin.rule_code - -MonthEnd -~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - MonthEnd.apply - MonthEnd.apply_index - MonthEnd.copy - MonthEnd.freqstr - MonthEnd.isAnchored - MonthEnd.kwds - MonthEnd.name - MonthEnd.nanos - MonthEnd.normalize - MonthEnd.onOffset - MonthEnd.rule_code - -MonthOffset -~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - MonthOffset.apply - MonthOffset.apply_index - MonthOffset.copy - MonthOffset.freqstr - MonthOffset.isAnchored - MonthOffset.kwds - MonthOffset.name - MonthOffset.nanos - MonthOffset.normalize - MonthOffset.onOffset - MonthOffset.rule_code - -Nano -~~~~ -.. autosummary:: - :toctree: generated/ - - Nano.copy - Nano.delta - Nano.freqstr - Nano.isAnchored - Nano.kwds - Nano.name - Nano.nanos - Nano.normalize - Nano.onOffset - Nano.rule_code - -QuarterBegin -~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - QuarterBegin.apply - QuarterBegin.apply_index - QuarterBegin.copy - QuarterBegin.freqstr - QuarterBegin.isAnchored - QuarterBegin.kwds - QuarterBegin.name - QuarterBegin.nanos - QuarterBegin.normalize - QuarterBegin.onOffset - QuarterBegin.rule_code - -QuarterEnd -~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - QuarterEnd.apply - QuarterEnd.apply_index - QuarterEnd.copy - QuarterEnd.freqstr - QuarterEnd.isAnchored - QuarterEnd.kwds - QuarterEnd.name - QuarterEnd.nanos - QuarterEnd.normalize - QuarterEnd.onOffset - QuarterEnd.rule_code - -QuarterOffset -~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - QuarterOffset.apply - QuarterOffset.apply_index - QuarterOffset.copy - QuarterOffset.freqstr - QuarterOffset.isAnchored - QuarterOffset.kwds - QuarterOffset.name - QuarterOffset.nanos - QuarterOffset.normalize - QuarterOffset.onOffset - QuarterOffset.rule_code - -Second -~~~~~~ -.. autosummary:: - :toctree: generated/ - - Second.copy - Second.delta - Second.freqstr - Second.isAnchored - Second.kwds - Second.name - Second.nanos - Second.normalize - Second.onOffset - Second.rule_code - -SemiMonthBegin -~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - SemiMonthBegin.apply - SemiMonthBegin.apply_index - SemiMonthBegin.copy - SemiMonthBegin.freqstr - SemiMonthBegin.isAnchored - SemiMonthBegin.kwds - SemiMonthBegin.name - SemiMonthBegin.nanos - SemiMonthBegin.normalize - SemiMonthBegin.onOffset - SemiMonthBegin.rule_code - -SemiMonthEnd -~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - SemiMonthEnd.apply - SemiMonthEnd.apply_index - SemiMonthEnd.copy - SemiMonthEnd.freqstr - SemiMonthEnd.isAnchored - SemiMonthEnd.kwds - SemiMonthEnd.name - SemiMonthEnd.nanos - SemiMonthEnd.normalize - SemiMonthEnd.onOffset - SemiMonthEnd.rule_code - -SemiMonthOffset -~~~~~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - SemiMonthOffset.apply - SemiMonthOffset.apply_index - SemiMonthOffset.copy - SemiMonthOffset.freqstr - SemiMonthOffset.isAnchored - SemiMonthOffset.kwds - SemiMonthOffset.name - SemiMonthOffset.nanos - SemiMonthOffset.normalize - SemiMonthOffset.onOffset - SemiMonthOffset.rule_code - -Tick -~~~~ -.. autosummary:: - :toctree: generated/ - - Tick.copy - Tick.delta - Tick.freqstr - Tick.isAnchored - Tick.kwds - Tick.name - Tick.nanos - Tick.normalize - Tick.onOffset - Tick.rule_code - -Week -~~~~ -.. autosummary:: - :toctree: generated/ - - Week.apply - Week.apply_index - Week.copy - Week.freqstr - Week.isAnchored - Week.kwds - Week.name - Week.nanos - Week.normalize - Week.onOffset - Week.rule_code - -WeekOfMonth -~~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - WeekOfMonth.apply - WeekOfMonth.copy - WeekOfMonth.freqstr - WeekOfMonth.isAnchored - WeekOfMonth.kwds - WeekOfMonth.name - WeekOfMonth.nanos - WeekOfMonth.normalize - WeekOfMonth.onOffset - WeekOfMonth.rule_code - -YearBegin -~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - - YearBegin.apply - YearBegin.apply_index - YearBegin.copy - YearBegin.freqstr - YearBegin.isAnchored - YearBegin.kwds - YearBegin.name - YearBegin.nanos - YearBegin.normalize - YearBegin.onOffset - YearBegin.rule_code - -YearEnd -~~~~~~~ -.. autosummary:: - :toctree: generated/ - - YearEnd.apply - YearEnd.apply_index - YearEnd.copy - YearEnd.freqstr - YearEnd.isAnchored - YearEnd.kwds - YearEnd.name - YearEnd.nanos - YearEnd.normalize - YearEnd.onOffset - YearEnd.rule_code - -YearOffset -~~~~~~~~~~ -.. autosummary:: - :toctree: generated/ - YearOffset.apply - YearOffset.apply_index - YearOffset.copy - YearOffset.freqstr - YearOffset.isAnchored - YearOffset.kwds - YearOffset.name - YearOffset.nanos - YearOffset.normalize - YearOffset.onOffset - YearOffset.rule_code .. _api.frequencies: From 29a5b5b72c1acccc0626deaf3364274e3bbd8d7b Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Wed, 26 Dec 2018 22:46:39 +0000 Subject: [PATCH 3/3] Add offset properties and methods --- doc/source/api.rst | 1363 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1363 insertions(+) diff --git a/doc/source/api.rst b/doc/source/api.rst index efe6f6b233f10..44a7d6f408030 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -2139,7 +2139,1370 @@ Date Offsets .. currentmodule:: pandas.tseries.offsets +DateOffset +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + DateOffset + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + DateOffset.freqstr + DateOffset.kwds + DateOffset.name + DateOffset.nanos + DateOffset.normalize + DateOffset.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + DateOffset.apply + DateOffset.copy + DateOffset.isAnchored + DateOffset.onOffset + +BusinessDay +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessDay + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessDay.freqstr + BusinessDay.kwds + BusinessDay.name + BusinessDay.nanos + BusinessDay.normalize + BusinessDay.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessDay.apply + BusinessDay.apply_index + BusinessDay.copy + BusinessDay.isAnchored + BusinessDay.onOffset + +BusinessHour +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessHour + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessHour.freqstr + BusinessHour.kwds + BusinessHour.name + BusinessHour.nanos + BusinessHour.normalize + BusinessHour.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessHour.apply + BusinessHour.copy + BusinessHour.isAnchored + BusinessHour.onOffset + +CustomBusinessDay +~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessDay + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessDay.freqstr + CustomBusinessDay.kwds + CustomBusinessDay.name + CustomBusinessDay.nanos + CustomBusinessDay.normalize + CustomBusinessDay.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessDay.apply + CustomBusinessDay.copy + CustomBusinessDay.isAnchored + CustomBusinessDay.onOffset + +CustomBusinessHour +~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessHour + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessHour.freqstr + CustomBusinessHour.kwds + CustomBusinessHour.name + CustomBusinessHour.nanos + CustomBusinessHour.normalize + CustomBusinessHour.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessHour.apply + CustomBusinessHour.copy + CustomBusinessHour.isAnchored + CustomBusinessHour.onOffset + +MonthOffset +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthOffset + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthOffset.freqstr + MonthOffset.kwds + MonthOffset.name + MonthOffset.nanos + MonthOffset.normalize + MonthOffset.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthOffset.apply + MonthOffset.apply_index + MonthOffset.copy + MonthOffset.isAnchored + MonthOffset.onOffset + +MonthEnd +~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthEnd.freqstr + MonthEnd.kwds + MonthEnd.name + MonthEnd.nanos + MonthEnd.normalize + MonthEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthEnd.apply + MonthEnd.apply_index + MonthEnd.copy + MonthEnd.isAnchored + MonthEnd.onOffset + +MonthBegin +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthBegin.freqstr + MonthBegin.kwds + MonthBegin.name + MonthBegin.nanos + MonthBegin.normalize + MonthBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + MonthBegin.apply + MonthBegin.apply_index + MonthBegin.copy + MonthBegin.isAnchored + MonthBegin.onOffset + +BusinessMonthEnd +~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthEnd.freqstr + BusinessMonthEnd.kwds + BusinessMonthEnd.name + BusinessMonthEnd.nanos + BusinessMonthEnd.normalize + BusinessMonthEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthEnd.apply + BusinessMonthEnd.apply_index + BusinessMonthEnd.copy + BusinessMonthEnd.isAnchored + BusinessMonthEnd.onOffset + +BusinessMonthBegin +~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthBegin.freqstr + BusinessMonthBegin.kwds + BusinessMonthBegin.name + BusinessMonthBegin.nanos + BusinessMonthBegin.normalize + BusinessMonthBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BusinessMonthBegin.apply + BusinessMonthBegin.apply_index + BusinessMonthBegin.copy + BusinessMonthBegin.isAnchored + BusinessMonthBegin.onOffset + +CustomBusinessMonthEnd +~~~~~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthEnd.freqstr + CustomBusinessMonthEnd.kwds + CustomBusinessMonthEnd.m_offset + CustomBusinessMonthEnd.name + CustomBusinessMonthEnd.nanos + CustomBusinessMonthEnd.normalize + CustomBusinessMonthEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthEnd.apply + CustomBusinessMonthEnd.copy + CustomBusinessMonthEnd.isAnchored + CustomBusinessMonthEnd.onOffset + +CustomBusinessMonthBegin +~~~~~~~~~~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthBegin.freqstr + CustomBusinessMonthBegin.kwds + CustomBusinessMonthBegin.m_offset + CustomBusinessMonthBegin.name + CustomBusinessMonthBegin.nanos + CustomBusinessMonthBegin.normalize + CustomBusinessMonthBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CustomBusinessMonthBegin.apply + CustomBusinessMonthBegin.copy + CustomBusinessMonthBegin.isAnchored + CustomBusinessMonthBegin.onOffset + +SemiMonthOffset +~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthOffset + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthOffset.freqstr + SemiMonthOffset.kwds + SemiMonthOffset.name + SemiMonthOffset.nanos + SemiMonthOffset.normalize + SemiMonthOffset.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthOffset.apply + SemiMonthOffset.apply_index + SemiMonthOffset.copy + SemiMonthOffset.isAnchored + SemiMonthOffset.onOffset + +SemiMonthEnd +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthEnd.freqstr + SemiMonthEnd.kwds + SemiMonthEnd.name + SemiMonthEnd.nanos + SemiMonthEnd.normalize + SemiMonthEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthEnd.apply + SemiMonthEnd.apply_index + SemiMonthEnd.copy + SemiMonthEnd.isAnchored + SemiMonthEnd.onOffset + +SemiMonthBegin +~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthBegin.freqstr + SemiMonthBegin.kwds + SemiMonthBegin.name + SemiMonthBegin.nanos + SemiMonthBegin.normalize + SemiMonthBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + SemiMonthBegin.apply + SemiMonthBegin.apply_index + SemiMonthBegin.copy + SemiMonthBegin.isAnchored + SemiMonthBegin.onOffset + +Week +~~~~ +.. autosummary:: + :toctree: generated/ + + Week + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Week.freqstr + Week.kwds + Week.name + Week.nanos + Week.normalize + Week.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Week.apply + Week.apply_index + Week.copy + Week.isAnchored + Week.onOffset + +WeekOfMonth +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + WeekOfMonth + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + WeekOfMonth.freqstr + WeekOfMonth.kwds + WeekOfMonth.name + WeekOfMonth.nanos + WeekOfMonth.normalize + WeekOfMonth.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + WeekOfMonth.apply + WeekOfMonth.copy + WeekOfMonth.isAnchored + WeekOfMonth.onOffset + +LastWeekOfMonth +~~~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + LastWeekOfMonth + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + LastWeekOfMonth.freqstr + LastWeekOfMonth.kwds + LastWeekOfMonth.name + LastWeekOfMonth.nanos + LastWeekOfMonth.normalize + LastWeekOfMonth.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + LastWeekOfMonth.apply + LastWeekOfMonth.copy + LastWeekOfMonth.isAnchored + LastWeekOfMonth.onOffset + +QuarterOffset +~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterOffset + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterOffset.freqstr + QuarterOffset.kwds + QuarterOffset.name + QuarterOffset.nanos + QuarterOffset.normalize + QuarterOffset.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterOffset.apply + QuarterOffset.apply_index + QuarterOffset.copy + QuarterOffset.isAnchored + QuarterOffset.onOffset + +BQuarterEnd +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterEnd.freqstr + BQuarterEnd.kwds + BQuarterEnd.name + BQuarterEnd.nanos + BQuarterEnd.normalize + BQuarterEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterEnd.apply + BQuarterEnd.apply_index + BQuarterEnd.copy + BQuarterEnd.isAnchored + BQuarterEnd.onOffset + +BQuarterBegin +~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterBegin.freqstr + BQuarterBegin.kwds + BQuarterBegin.name + BQuarterBegin.nanos + BQuarterBegin.normalize + BQuarterBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BQuarterBegin.apply + BQuarterBegin.apply_index + BQuarterBegin.copy + BQuarterBegin.isAnchored + BQuarterBegin.onOffset + +QuarterEnd +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterEnd.freqstr + QuarterEnd.kwds + QuarterEnd.name + QuarterEnd.nanos + QuarterEnd.normalize + QuarterEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterEnd.apply + QuarterEnd.apply_index + QuarterEnd.copy + QuarterEnd.isAnchored + QuarterEnd.onOffset + +QuarterBegin +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterBegin.freqstr + QuarterBegin.kwds + QuarterBegin.name + QuarterBegin.nanos + QuarterBegin.normalize + QuarterBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + QuarterBegin.apply + QuarterBegin.apply_index + QuarterBegin.copy + QuarterBegin.isAnchored + QuarterBegin.onOffset + +YearOffset +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearOffset + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearOffset.freqstr + YearOffset.kwds + YearOffset.name + YearOffset.nanos + YearOffset.normalize + YearOffset.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearOffset.apply + YearOffset.apply_index + YearOffset.copy + YearOffset.isAnchored + YearOffset.onOffset + +BYearEnd +~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearEnd.freqstr + BYearEnd.kwds + BYearEnd.name + BYearEnd.nanos + BYearEnd.normalize + BYearEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearEnd.apply + BYearEnd.apply_index + BYearEnd.copy + BYearEnd.isAnchored + BYearEnd.onOffset + +BYearBegin +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearBegin.freqstr + BYearBegin.kwds + BYearBegin.name + BYearBegin.nanos + BYearBegin.normalize + BYearBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BYearBegin.apply + BYearBegin.apply_index + BYearBegin.copy + BYearBegin.isAnchored + BYearBegin.onOffset + +YearEnd +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearEnd.freqstr + YearEnd.kwds + YearEnd.name + YearEnd.nanos + YearEnd.normalize + YearEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearEnd.apply + YearEnd.apply_index + YearEnd.copy + YearEnd.isAnchored + YearEnd.onOffset + +YearBegin +~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearBegin.freqstr + YearBegin.kwds + YearBegin.name + YearBegin.nanos + YearBegin.normalize + YearBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + YearBegin.apply + YearBegin.apply_index + YearBegin.copy + YearBegin.isAnchored + YearBegin.onOffset + +FY5253 +~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253 + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253.freqstr + FY5253.kwds + FY5253.name + FY5253.nanos + FY5253.normalize + FY5253.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253.apply + FY5253.copy + FY5253.get_rule_code_suffix + FY5253.get_year_end + FY5253.isAnchored + FY5253.onOffset + +FY5253Quarter +~~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253Quarter + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253Quarter.freqstr + FY5253Quarter.kwds + FY5253Quarter.name + FY5253Quarter.nanos + FY5253Quarter.normalize + FY5253Quarter.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + FY5253Quarter.apply + FY5253Quarter.copy + FY5253Quarter.get_weeks + FY5253Quarter.isAnchored + FY5253Quarter.onOffset + FY5253Quarter.year_has_extra_week + +Easter +~~~~~~ +.. autosummary:: + :toctree: generated/ + + Easter + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Easter.freqstr + Easter.kwds + Easter.name + Easter.nanos + Easter.normalize + Easter.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Easter.apply + Easter.copy + Easter.isAnchored + Easter.onOffset + +Tick +~~~~ +.. autosummary:: + :toctree: generated/ + + Tick + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Tick.delta + Tick.freqstr + Tick.kwds + Tick.name + Tick.nanos + Tick.normalize + Tick.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Tick.copy + Tick.isAnchored + Tick.onOffset + +Day +~~~ +.. autosummary:: + :toctree: generated/ + + Day + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Day.delta + Day.freqstr + Day.kwds + Day.name + Day.nanos + Day.normalize + Day.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Day.copy + Day.isAnchored + Day.onOffset + +Hour +~~~~ +.. autosummary:: + :toctree: generated/ + + Hour + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Hour.delta + Hour.freqstr + Hour.kwds + Hour.name + Hour.nanos + Hour.normalize + Hour.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Hour.copy + Hour.isAnchored + Hour.onOffset + +Minute +~~~~~~ +.. autosummary:: + :toctree: generated/ + + Minute + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Minute.delta + Minute.freqstr + Minute.kwds + Minute.name + Minute.nanos + Minute.normalize + Minute.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Minute.copy + Minute.isAnchored + Minute.onOffset + +Second +~~~~~~ +.. autosummary:: + :toctree: generated/ + + Second + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Second.delta + Second.freqstr + Second.kwds + Second.name + Second.nanos + Second.normalize + Second.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Second.copy + Second.isAnchored + Second.onOffset + +Milli +~~~~~ +.. autosummary:: + :toctree: generated/ + + Milli + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Milli.delta + Milli.freqstr + Milli.kwds + Milli.name + Milli.nanos + Milli.normalize + Milli.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Milli.copy + Milli.isAnchored + Milli.onOffset + +Micro +~~~~~ +.. autosummary:: + :toctree: generated/ + + Micro + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Micro.delta + Micro.freqstr + Micro.kwds + Micro.name + Micro.nanos + Micro.normalize + Micro.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Micro.copy + Micro.isAnchored + Micro.onOffset + +Nano +~~~~ +.. autosummary:: + :toctree: generated/ + + Nano + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Nano.delta + Nano.freqstr + Nano.kwds + Nano.name + Nano.nanos + Nano.normalize + Nano.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + Nano.copy + Nano.isAnchored + Nano.onOffset + +BDay +~~~~ +.. autosummary:: + :toctree: generated/ + + BDay + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BDay.base + BDay.freqstr + BDay.kwds + BDay.name + BDay.nanos + BDay.normalize + BDay.offset + BDay.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BDay.apply + BDay.apply_index + BDay.copy + BDay.isAnchored + BDay.onOffset + BDay.rollback + BDay.rollforward + +BMonthEnd +~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthEnd.base + BMonthEnd.freqstr + BMonthEnd.kwds + BMonthEnd.name + BMonthEnd.nanos + BMonthEnd.normalize + BMonthEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthEnd.apply + BMonthEnd.apply_index + BMonthEnd.copy + BMonthEnd.isAnchored + BMonthEnd.onOffset + BMonthEnd.rollback + BMonthEnd.rollforward + +BMonthBegin +~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthBegin.base + BMonthBegin.freqstr + BMonthBegin.kwds + BMonthBegin.name + BMonthBegin.nanos + BMonthBegin.normalize + BMonthBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + BMonthBegin.apply + BMonthBegin.apply_index + BMonthBegin.copy + BMonthBegin.isAnchored + BMonthBegin.onOffset + BMonthBegin.rollback + BMonthBegin.rollforward + +CBMonthEnd +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthEnd + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthEnd.base + CBMonthEnd.cbday_roll + CBMonthEnd.freqstr + CBMonthEnd.kwds + CBMonthEnd.m_offset + CBMonthEnd.month_roll + CBMonthEnd.name + CBMonthEnd.nanos + CBMonthEnd.normalize + CBMonthEnd.offset + CBMonthEnd.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthEnd.apply + CBMonthEnd.apply_index + CBMonthEnd.copy + CBMonthEnd.isAnchored + CBMonthEnd.onOffset + CBMonthEnd.rollback + CBMonthEnd.rollforward + +CBMonthBegin +~~~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthBegin + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthBegin.base + CBMonthBegin.cbday_roll + CBMonthBegin.freqstr + CBMonthBegin.kwds + CBMonthBegin.m_offset + CBMonthBegin.month_roll + CBMonthBegin.name + CBMonthBegin.nanos + CBMonthBegin.normalize + CBMonthBegin.offset + CBMonthBegin.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CBMonthBegin.apply + CBMonthBegin.apply_index + CBMonthBegin.copy + CBMonthBegin.isAnchored + CBMonthBegin.onOffset + CBMonthBegin.rollback + CBMonthBegin.rollforward + +CDay +~~~~ +.. autosummary:: + :toctree: generated/ + + CDay + +Properties +~~~~~~~~~~ +.. autosummary:: + :toctree: generated/ + + CDay.base + CDay.freqstr + CDay.kwds + CDay.name + CDay.nanos + CDay.normalize + CDay.offset + CDay.rule_code + +Methods +~~~~~~~ +.. autosummary:: + :toctree: generated/ + CDay.apply + CDay.apply_index + CDay.copy + CDay.isAnchored + CDay.onOffset + CDay.rollback + CDay.rollforward .. _api.frequencies: