This document describes the current stable version of Celery (5.2). For development docs, go here.

celery.apps.beat

Beat command-line program.

This module is the ‘program-version’ of celery.beat.

It does everything necessary to run that module as an actual application, like installing signal handlers and so on.

class celery.apps.beat.Beat(max_interval=None, app=None, socket_timeout=30, pidfile=None, no_color=None, loglevel='WARN', logfile=None, schedule=None, scheduler=None, scheduler_cls=None, redirect_stdouts=None, redirect_stdouts_level=None, **kwargs)

Beat as a service.

class Service(app, max_interval=None, schedule_filename=None, scheduler_cls=None)

Celery periodic task service.

get_scheduler(lazy=False, extension_namespace='celery.beat_schedulers')

property scheduler

scheduler_cls

alias of PersistentScheduler

start(embedded_process=False)

stop(wait=False)

sync()

app = None

banner(service)

init_loader()

install_sync_handler(service)

Install a SIGTERM + SIGINT handler saving the schedule.

run()

set_process_title()

setup_logging(colorize=None)

start_scheduler()

startup_info(service)