Decorators#

Module Contents#

Classes Summary#

DayBeginOffset

FiveMinOffset

MonthBeginOffset

support_date_range

Maximum frequency of ranges. if None, then no new ranges are created.

YearBeginOffset

Functions#

date_range_maker

Generate a date range based on start and end dates and a frequency.

pjm_update_dates

PJM has a weird API. This method updates the date range list to account

Contents#

gridstatus.decorators.date_range_maker(start, end, freq, inclusive='neither')[source]#

Generate a date range based on start and end dates and a frequency.

class gridstatus.decorators.DayBeginOffset[source]#

Methods

__ladd__

__radd__

__ladd__(other)[source]#
__radd__(other)[source]#
class gridstatus.decorators.FiveMinOffset[source]#

Methods

__ladd__

__radd__

__ladd__(other)[source]#
__radd__(other)[source]#
class gridstatus.decorators.MonthBeginOffset[source]#

Methods

__ladd__

__radd__

__ladd__(other)[source]#
__radd__(other)[source]#
gridstatus.decorators.pjm_update_dates(dates, args_dict)[source]#

PJM has a weird API. This method updates the date range list to account for the following restrictions:

  • date ranges cannot span year boundaries

  • date ranges cannot span archive / standard boundaries

  • date range is inclusive of start and end dates

class gridstatus.decorators.support_date_range(frequency, update_dates=None)[source]#

Maximum frequency of ranges. if None, then no new ranges are created.

Methods

__call__

__call__(f)[source]#
class gridstatus.decorators.YearBeginOffset[source]#

Methods

__ladd__

__radd__

__ladd__(other)[source]#
__radd__(other)[source]#