Packaged relative deltas for convenience

frdelta.py

"""Floored Relative Delta(frdelta)

  This module contains ready-made relativedeltas.  The kwargs class contains
  all the key word arguments used to create the relativedeltas

  All relativedeltas are floored, ie. all lesser absolute information is set
  to zero.

  If you need more than one forward(FWD) or backward(BWD), use multiplication:
    This:
      BKWD_YR * 5

    Results in:
      relativedelta(
        years=-5,
        month=0,
        day=0,
        hour=0,
        minute=0,
        second=0,
        microsecond=0
      )

"""

from dateutil.relativedelta import relativedelta

class kwargs:

  SEC = {'microsecond': 0}
  MIN = {'second': 0}
  MIN.update(SEC)
  HR = {'minute': 0}
  HR.update(MIN)
  DAY = {'hour': 0}
  DAY.update(HR)
  MO = {'day': 0}
  MO.update(DAY)
  YR = {'month': 0}
  YR.update(MO)

  FWD_SEC = {'seconds': 1}
  FWD_SEC.update(SEC)
  FWD_MIN = {'minutes': 1}
  FWD_MIN.update(MIN)
  FWD_HR = {'hours': 1}
  FWD_HR.update(HR)
  FWD_DAY = {'days': 1}
  FWD_DAY.update(DAY)
  FWD_MO = {'months':1}
  FWD_MO.update(MO)
  FWD_YR = {'years': 1}
  FWD_YR.update(YR)

  BKWD_SEC = {'seconds':-1}
  BKWD_SEC.update(SEC)
  BKWD_MIN = {'minutes':-1}
  BKWD_MIN.update(MIN)
  BKWD_HR = {'hours':-1}
  BKWD_HR.update(HR)
  BKWD_DAY = {'days':-1}
  BKWD_DAY.update(DAY)
  BKWD_MO = {'months':-1}
  BKWD_MO.update(MO)
  BKWD_YR = {'years':-1}
  BKWD_YR.update(YR)

SEC = relativedelta(**kwargs.SEC)
MIN = relativedelta(**kwargs.MIN)
HR = relativedelta(**kwargs.HR)
DAY = relativedelta(**kwargs.DAY)
MO = relativedelta(**kwargs.MO)
YR = relativedelta(**kwargs.YR)

FWD_SEC = relativedelta(**kwargs.FWD_SEC)
FWD_MIN = relativedelta(**kwargs.FWD_MIN)
FWD_HR = relativedelta(**kwargs.FWD_HR)
FWD_DAY = relativedelta(**kwargs.FWD_DAY)
FWD_MO = relativedelta(**kwargs.FWD_MO)
FWD_YR = relativedelta(**kwargs.FWD_YR)

BKWD_SEC = relativedelta(**kwargs.BKWD_SEC)
BKWD_MIN = relativedelta(**kwargs.BKWD_MIN)
BKWD_HR = relativedelta(**kwargs.BKWD_HR)
BKWD_DAY = relativedelta(**kwargs.BKWD_DAY)
BKWD_MO = relativedelta(**kwargs.BKWD_MO)
BKWD_YR = relativedelta(**kwargs.BKWD_YR)