fields.py 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. """Fields represent CronTrigger options which map to :class:`~datetime.datetime` fields."""
  2. from calendar import monthrange
  3. import re
  4. import six
  5. from apscheduler.triggers.cron.expressions import (
  6. AllExpression, RangeExpression, WeekdayPositionExpression, LastDayOfMonthExpression,
  7. WeekdayRangeExpression, MonthRangeExpression)
  8. __all__ = ('MIN_VALUES', 'MAX_VALUES', 'DEFAULT_VALUES', 'BaseField', 'WeekField',
  9. 'DayOfMonthField', 'DayOfWeekField')
  10. MIN_VALUES = {'year': 1970, 'month': 1, 'day': 1, 'week': 1, 'day_of_week': 0, 'hour': 0,
  11. 'minute': 0, 'second': 0}
  12. MAX_VALUES = {'year': 9999, 'month': 12, 'day': 31, 'week': 53, 'day_of_week': 6, 'hour': 23,
  13. 'minute': 59, 'second': 59}
  14. DEFAULT_VALUES = {'year': '*', 'month': 1, 'day': 1, 'week': '*', 'day_of_week': '*', 'hour': 0,
  15. 'minute': 0, 'second': 0}
  16. SEPARATOR = re.compile(' *, *')
  17. class BaseField(object):
  18. REAL = True
  19. COMPILERS = [AllExpression, RangeExpression]
  20. def __init__(self, name, exprs, is_default=False):
  21. self.name = name
  22. self.is_default = is_default
  23. self.compile_expressions(exprs)
  24. def get_min(self, dateval):
  25. return MIN_VALUES[self.name]
  26. def get_max(self, dateval):
  27. return MAX_VALUES[self.name]
  28. def get_value(self, dateval):
  29. return getattr(dateval, self.name)
  30. def get_next_value(self, dateval):
  31. smallest = None
  32. for expr in self.expressions:
  33. value = expr.get_next_value(dateval, self)
  34. if smallest is None or (value is not None and value < smallest):
  35. smallest = value
  36. return smallest
  37. def compile_expressions(self, exprs):
  38. self.expressions = []
  39. # Split a comma-separated expression list, if any
  40. for expr in SEPARATOR.split(str(exprs).strip()):
  41. self.compile_expression(expr)
  42. def compile_expression(self, expr):
  43. for compiler in self.COMPILERS:
  44. match = compiler.value_re.match(expr)
  45. if match:
  46. compiled_expr = compiler(**match.groupdict())
  47. try:
  48. compiled_expr.validate_range(self.name)
  49. except ValueError as e:
  50. exc = ValueError('Error validating expression {!r}: {}'.format(expr, e))
  51. six.raise_from(exc, None)
  52. self.expressions.append(compiled_expr)
  53. return
  54. raise ValueError('Unrecognized expression "%s" for field "%s"' % (expr, self.name))
  55. def __eq__(self, other):
  56. return isinstance(self, self.__class__) and self.expressions == other.expressions
  57. def __str__(self):
  58. expr_strings = (str(e) for e in self.expressions)
  59. return ','.join(expr_strings)
  60. def __repr__(self):
  61. return "%s('%s', '%s')" % (self.__class__.__name__, self.name, self)
  62. class WeekField(BaseField):
  63. REAL = False
  64. def get_value(self, dateval):
  65. return dateval.isocalendar()[1]
  66. class DayOfMonthField(BaseField):
  67. COMPILERS = BaseField.COMPILERS + [WeekdayPositionExpression, LastDayOfMonthExpression]
  68. def get_max(self, dateval):
  69. return monthrange(dateval.year, dateval.month)[1]
  70. class DayOfWeekField(BaseField):
  71. REAL = False
  72. COMPILERS = BaseField.COMPILERS + [WeekdayRangeExpression]
  73. def get_value(self, dateval):
  74. return dateval.weekday()
  75. class MonthField(BaseField):
  76. COMPILERS = BaseField.COMPILERS + [MonthRangeExpression]