interval.py 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. from datetime import timedelta, datetime
  2. from math import ceil
  3. from tzlocal import get_localzone
  4. from apscheduler.triggers.base import BaseTrigger
  5. from apscheduler.util import convert_to_datetime, timedelta_seconds, datetime_repr, astimezone
  6. class IntervalTrigger(BaseTrigger):
  7. """
  8. Triggers on specified intervals, starting on ``start_date`` if specified, ``datetime.now()`` +
  9. interval otherwise.
  10. :param int weeks: number of weeks to wait
  11. :param int days: number of days to wait
  12. :param int hours: number of hours to wait
  13. :param int minutes: number of minutes to wait
  14. :param int seconds: number of seconds to wait
  15. :param datetime|str start_date: starting point for the interval calculation
  16. :param datetime|str end_date: latest possible date/time to trigger on
  17. :param datetime.tzinfo|str timezone: time zone to use for the date/time calculations
  18. """
  19. __slots__ = 'timezone', 'start_date', 'end_date', 'interval', 'interval_length'
  20. def __init__(self, weeks=0, days=0, hours=0, minutes=0, seconds=0, start_date=None,
  21. end_date=None, timezone=None):
  22. self.interval = timedelta(weeks=weeks, days=days, hours=hours, minutes=minutes,
  23. seconds=seconds)
  24. self.interval_length = timedelta_seconds(self.interval)
  25. if self.interval_length == 0:
  26. self.interval = timedelta(seconds=1)
  27. self.interval_length = 1
  28. if timezone:
  29. self.timezone = astimezone(timezone)
  30. elif start_date and start_date.tzinfo:
  31. self.timezone = start_date.tzinfo
  32. elif end_date and end_date.tzinfo:
  33. self.timezone = end_date.tzinfo
  34. else:
  35. self.timezone = get_localzone()
  36. start_date = start_date or (datetime.now(self.timezone) + self.interval)
  37. self.start_date = convert_to_datetime(start_date, self.timezone, 'start_date')
  38. self.end_date = convert_to_datetime(end_date, self.timezone, 'end_date')
  39. def get_next_fire_time(self, previous_fire_time, now):
  40. if previous_fire_time:
  41. next_fire_time = previous_fire_time + self.interval
  42. elif self.start_date > now:
  43. next_fire_time = self.start_date
  44. else:
  45. timediff_seconds = timedelta_seconds(now - self.start_date)
  46. next_interval_num = int(ceil(timediff_seconds / self.interval_length))
  47. next_fire_time = self.start_date + self.interval * next_interval_num
  48. if not self.end_date or next_fire_time <= self.end_date:
  49. return self.timezone.normalize(next_fire_time)
  50. def __getstate__(self):
  51. return {
  52. 'version': 1,
  53. 'timezone': self.timezone,
  54. 'start_date': self.start_date,
  55. 'end_date': self.end_date,
  56. 'interval': self.interval
  57. }
  58. def __setstate__(self, state):
  59. # This is for compatibility with APScheduler 3.0.x
  60. if isinstance(state, tuple):
  61. state = state[1]
  62. if state.get('version', 1) > 1:
  63. raise ValueError(
  64. 'Got serialized data for version %s of %s, but only version 1 can be handled' %
  65. (state['version'], self.__class__.__name__))
  66. self.timezone = state['timezone']
  67. self.start_date = state['start_date']
  68. self.end_date = state['end_date']
  69. self.interval = state['interval']
  70. self.interval_length = timedelta_seconds(self.interval)
  71. def __str__(self):
  72. return 'interval[%s]' % str(self.interval)
  73. def __repr__(self):
  74. return "<%s (interval=%r, start_date='%s', timezone='%s')>" % (
  75. self.__class__.__name__, self.interval, datetime_repr(self.start_date), self.timezone)