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

celery.worker.components

celery.worker.components

Default worker bootsteps.

class celery.worker.components.Timer(parent, **kwargs)

This step initializes the internal timer used by the worker.

create(w)

name = u'celery.worker.components.Timer'

on_timer_error(exc)

on_timer_tick(delay)

requires = ()

class celery.worker.components.Hub(w, **kwargs)

create(w)

include_if(w)

name = u'celery.worker.components.Hub'

requires = (step:celery.worker.components.Timer{()},)

start(w)

stop(w)

terminate(w)

class celery.worker.components.Queues(parent, **kwargs)

This bootstep initializes the internal queues used by the worker.

create(w)

label = 'Queues (intra)'

name = u'celery.worker.components.Queues'

requires = (step:celery.worker.components.Hub{(step:celery.worker.components.Timer{()},)},)

class celery.worker.components.Pool(w, autoscale=None, autoreload=None, no_execv=False, optimization=None, **kwargs)

Bootstep managing the worker pool.

Describes how to initialize the worker pool, and starts and stops the pool during worker startup/shutdown.

Adds attributes:

• autoscale
• pool
• max_concurrency
• min_concurrency

close(w)

create(w, semaphore=None, max_restarts=None)

info(w)

name = u'celery.worker.components.Pool'

register_with_event_loop(w, hub)

requires = (step:celery.worker.components.Queues{(step:celery.worker.components.Hub{(step:celery.worker.components.Timer{()},)},)},)

terminate(w)

class celery.worker.components.Beat(w, beat=False, **kwargs)

Step used to embed a beat process.

This will only be enabled if the beat argument is set.

conditional = True

create(w)

label = 'Beat'

name = u'celery.worker.components.Beat'

requires = ()

class celery.worker.components.StateDB(w, **kwargs)

This bootstep sets up the workers state db if enabled.

create(w)

name = u'celery.worker.components.StateDB'

requires = ()

class celery.worker.components.Consumer(parent, **kwargs)

create(w)

last = True

name = u'celery.worker.components.Consumer'

requires = ()