This document describes the current stable version of Celery (3.1). For development docs, go here.
celery.beat¶
celery.beat¶
The periodic task scheduler.
-
class
celery.beat.
ScheduleEntry
(name=None, task=None, last_run_at=None, total_run_count=None, schedule=None, args=(), kwargs={}, options={}, relative=False, app=None)[source]¶ An entry in the scheduler.
Parameters: - name – see
name
. - schedule – see
schedule
. - args – see
args
. - kwargs – see
kwargs
. - options – see
options
. - last_run_at – see
last_run_at
. - total_run_count – see
total_run_count
. - relative – Is the time relative to when the server starts?
-
args
= None¶ Positional arguments to apply.
-
kwargs
= None¶ Keyword arguments to apply.
-
last_run_at
= None¶ The time and date of when this task was last scheduled.
-
name
= None¶ The task name
-
next
(last_run_at=None)¶ Return a new instance of the same class, but with its date and count fields updated.
-
options
= None¶ Task execution options.
-
schedule
= None¶ The schedule (run_every/crontab)
-
total_run_count
= 0¶ Total number of times this task has been scheduled.
- name – see
-
class
celery.beat.
Scheduler
(app, schedule=None, max_interval=None, Publisher=None, lazy=False, sync_every_tasks=None, **kwargs)[source]¶ Scheduler for periodic tasks.
The celery beat program may instantiate this class multiple times for introspection purposes, but then with the
lazy
argument set. It is important for subclasses to be idempotent when this argument is set.Parameters: - schedule – see
schedule
. - max_interval – see
max_interval
. - lazy – Do not set up the schedule.
-
Entry
¶ alias of
ScheduleEntry
-
info
¶
-
logger
= <celery.utils.log.ProcessAwareLogger object>¶
-
max_interval
= 300¶ Maximum time to sleep between re-checking the schedule.
-
schedule
¶ The schedule dict/shelve.
-
sync_every
= 180¶ How often to sync the schedule (3 minutes by default)
-
sync_every_tasks
= None¶ How many tasks can be called before a sync is forced.
- schedule – see
-
class
celery.beat.
PersistentScheduler
(*args, **kwargs)[source]¶ -
-
info
¶
-
known_suffixes
= ('', '.db', '.dat', '.bak', '.dir')¶
-
persistence
= <module 'shelve' from '/usr/lib/python2.7/shelve.pyc'>¶
-
schedule
¶
-
-
class
celery.beat.
Service
(app, max_interval=None, schedule_filename=None, scheduler_cls=None)[source]¶ -
-
scheduler_cls
¶ alias of
PersistentScheduler
-
-
celery.beat.
EmbeddedService
(app, max_interval=None, **kwargs)[source]¶ Return embedded clock service.
Parameters: thread – Run threaded instead of as a separate process. Uses multiprocessing
by default, if available.