beat.py 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. # -*- coding: utf-8 -*-
  2. """
  3. The :program:`celery beat` command.
  4. .. program:: celery beat
  5. .. seealso::
  6. See :ref:`preload-options` and :ref:`daemon-options`.
  7. .. cmdoption:: --detach
  8. Detach and run in the background as a daemon.
  9. .. cmdoption:: -s, --schedule
  10. Path to the schedule database. Defaults to `celerybeat-schedule`.
  11. The extension '.db' may be appended to the filename.
  12. Default is {default}.
  13. .. cmdoption:: -S, --scheduler
  14. Scheduler class to use.
  15. Default is :class:`celery.beat.PersistentScheduler`.
  16. .. cmdoption:: max-interval
  17. Max seconds to sleep between schedule iterations.
  18. .. cmdoption:: -f, --logfile
  19. Path to log file. If no logfile is specified, `stderr` is used.
  20. .. cmdoption:: -l, --loglevel
  21. Logging level, choose between `DEBUG`, `INFO`, `WARNING`,
  22. `ERROR`, `CRITICAL`, or `FATAL`.
  23. """
  24. from __future__ import absolute_import
  25. from functools import partial
  26. from celery.platforms import detached
  27. from celery.bin.base import Command, Option, daemon_options
  28. __all__ = ['beat']
  29. class beat(Command):
  30. """Start the beat periodic task scheduler.
  31. Examples::
  32. celery beat -l info
  33. celery beat -s /var/run/celery/beat-schedule --detach
  34. celery beat -S djcelery.schedulers.DatabaseScheduler
  35. """
  36. doc = __doc__
  37. enable_config_from_cmdline = True
  38. supports_args = False
  39. def run(self, detach=False, logfile=None, pidfile=None, uid=None,
  40. gid=None, umask=None, working_directory=None, **kwargs):
  41. workdir = working_directory
  42. kwargs.pop('app', None)
  43. beat = partial(self.app.Beat,
  44. logfile=logfile, pidfile=pidfile, **kwargs)
  45. if detach:
  46. with detached(logfile, pidfile, uid, gid, umask, workdir):
  47. return beat().run()
  48. else:
  49. return beat().run()
  50. def get_options(self):
  51. c = self.app.conf
  52. return (
  53. (Option('--detach', action='store_true'),
  54. Option('-s', '--schedule',
  55. default=c.CELERYBEAT_SCHEDULE_FILENAME),
  56. Option('--max-interval', type='float'),
  57. Option('-S', '--scheduler', dest='scheduler_cls'),
  58. Option('-l', '--loglevel', default=c.CELERYBEAT_LOG_LEVEL))
  59. + daemon_options(default_pidfile='celerybeat.pid')
  60. + tuple(self.app.user_options['beat'])
  61. )
  62. def main(app=None):
  63. beat(app=app).execute_from_commandline()
  64. if __name__ == '__main__': # pragma: no cover
  65. main()