zookeeper.py 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. from __future__ import absolute_import
  2. from datetime import datetime
  3. from pytz import utc
  4. from kazoo.exceptions import NoNodeError, NodeExistsError
  5. from apscheduler.jobstores.base import BaseJobStore, JobLookupError, ConflictingIdError
  6. from apscheduler.util import maybe_ref, datetime_to_utc_timestamp, utc_timestamp_to_datetime
  7. from apscheduler.job import Job
  8. try:
  9. import cPickle as pickle
  10. except ImportError: # pragma: nocover
  11. import pickle
  12. try:
  13. from kazoo.client import KazooClient
  14. except ImportError: # pragma: nocover
  15. raise ImportError('ZooKeeperJobStore requires Kazoo installed')
  16. class ZooKeeperJobStore(BaseJobStore):
  17. """
  18. Stores jobs in a ZooKeeper tree. Any leftover keyword arguments are directly passed to
  19. kazoo's `KazooClient
  20. <http://kazoo.readthedocs.io/en/latest/api/client.html>`_.
  21. Plugin alias: ``zookeeper``
  22. :param str path: path to store jobs in
  23. :param client: a :class:`~kazoo.client.KazooClient` instance to use instead of
  24. providing connection arguments
  25. :param int pickle_protocol: pickle protocol level to use (for serialization), defaults to the
  26. highest available
  27. """
  28. def __init__(self, path='/apscheduler', client=None, close_connection_on_exit=False,
  29. pickle_protocol=pickle.HIGHEST_PROTOCOL, **connect_args):
  30. super(ZooKeeperJobStore, self).__init__()
  31. self.pickle_protocol = pickle_protocol
  32. self.close_connection_on_exit = close_connection_on_exit
  33. if not path:
  34. raise ValueError('The "path" parameter must not be empty')
  35. self.path = path
  36. if client:
  37. self.client = maybe_ref(client)
  38. else:
  39. self.client = KazooClient(**connect_args)
  40. self._ensured_path = False
  41. def _ensure_paths(self):
  42. if not self._ensured_path:
  43. self.client.ensure_path(self.path)
  44. self._ensured_path = True
  45. def start(self, scheduler, alias):
  46. super(ZooKeeperJobStore, self).start(scheduler, alias)
  47. if not self.client.connected:
  48. self.client.start()
  49. def lookup_job(self, job_id):
  50. self._ensure_paths()
  51. node_path = self.path + "/" + str(job_id)
  52. try:
  53. content, _ = self.client.get(node_path)
  54. doc = pickle.loads(content)
  55. job = self._reconstitute_job(doc['job_state'])
  56. return job
  57. except BaseException:
  58. return None
  59. def get_due_jobs(self, now):
  60. timestamp = datetime_to_utc_timestamp(now)
  61. jobs = [job_def['job'] for job_def in self._get_jobs()
  62. if job_def['next_run_time'] is not None and job_def['next_run_time'] <= timestamp]
  63. return jobs
  64. def get_next_run_time(self):
  65. next_runs = [job_def['next_run_time'] for job_def in self._get_jobs()
  66. if job_def['next_run_time'] is not None]
  67. return utc_timestamp_to_datetime(min(next_runs)) if len(next_runs) > 0 else None
  68. def get_all_jobs(self):
  69. jobs = [job_def['job'] for job_def in self._get_jobs()]
  70. self._fix_paused_jobs_sorting(jobs)
  71. return jobs
  72. def add_job(self, job):
  73. self._ensure_paths()
  74. node_path = self.path + "/" + str(job.id)
  75. value = {
  76. 'next_run_time': datetime_to_utc_timestamp(job.next_run_time),
  77. 'job_state': job.__getstate__()
  78. }
  79. data = pickle.dumps(value, self.pickle_protocol)
  80. try:
  81. self.client.create(node_path, value=data)
  82. except NodeExistsError:
  83. raise ConflictingIdError(job.id)
  84. def update_job(self, job):
  85. self._ensure_paths()
  86. node_path = self.path + "/" + str(job.id)
  87. changes = {
  88. 'next_run_time': datetime_to_utc_timestamp(job.next_run_time),
  89. 'job_state': job.__getstate__()
  90. }
  91. data = pickle.dumps(changes, self.pickle_protocol)
  92. try:
  93. self.client.set(node_path, value=data)
  94. except NoNodeError:
  95. raise JobLookupError(job.id)
  96. def remove_job(self, job_id):
  97. self._ensure_paths()
  98. node_path = self.path + "/" + str(job_id)
  99. try:
  100. self.client.delete(node_path)
  101. except NoNodeError:
  102. raise JobLookupError(job_id)
  103. def remove_all_jobs(self):
  104. try:
  105. self.client.delete(self.path, recursive=True)
  106. except NoNodeError:
  107. pass
  108. self._ensured_path = False
  109. def shutdown(self):
  110. if self.close_connection_on_exit:
  111. self.client.stop()
  112. self.client.close()
  113. def _reconstitute_job(self, job_state):
  114. job_state = job_state
  115. job = Job.__new__(Job)
  116. job.__setstate__(job_state)
  117. job._scheduler = self._scheduler
  118. job._jobstore_alias = self._alias
  119. return job
  120. def _get_jobs(self):
  121. self._ensure_paths()
  122. jobs = []
  123. failed_job_ids = []
  124. all_ids = self.client.get_children(self.path)
  125. for node_name in all_ids:
  126. try:
  127. node_path = self.path + "/" + node_name
  128. content, _ = self.client.get(node_path)
  129. doc = pickle.loads(content)
  130. job_def = {
  131. 'job_id': node_name,
  132. 'next_run_time': doc['next_run_time'] if doc['next_run_time'] else None,
  133. 'job_state': doc['job_state'],
  134. 'job': self._reconstitute_job(doc['job_state']),
  135. 'creation_time': _.ctime
  136. }
  137. jobs.append(job_def)
  138. except BaseException:
  139. self._logger.exception('Unable to restore job "%s" -- removing it' % node_name)
  140. failed_job_ids.append(node_name)
  141. # Remove all the jobs we failed to restore
  142. if failed_job_ids:
  143. for failed_id in failed_job_ids:
  144. self.remove_job(failed_id)
  145. paused_sort_key = datetime(9999, 12, 31, tzinfo=utc)
  146. return sorted(jobs, key=lambda job_def: (job_def['job'].next_run_time or paused_sort_key,
  147. job_def['creation_time']))
  148. def __repr__(self):
  149. self._logger.exception('<%s (client=%s)>' % (self.__class__.__name__, self.client))
  150. return '<%s (client=%s)>' % (self.__class__.__name__, self.client)