This document describes the current stable version of Celery (3.1). For development docs,
go here.
celery.bootsteps
A directed acyclic graph of reusable components.
-
class celery.bootsteps.Blueprint(steps=None, name=None, app=None, on_start=None, on_close=None, on_stopped=None)[source]
Blueprint containing bootsteps that can be applied to objects.
Parameters: |
- steps – List of steps.
- name – Set explicit name for this blueprint.
- app – Set the Celery app for this blueprint.
- on_start – Optional callback applied after blueprint start.
- on_close – Optional callback applied before blueprint close.
- on_stopped – Optional callback applied after blueprint stopped.
|
-
GraphFormatter
alias of StepFormatter
-
alias[source]
-
apply(parent, **kwargs)[source]
Apply the steps in this blueprint to an object.
This will apply the __init__ and include methods
of each step, with the object as argument:
step = Step(obj)
...
step.include(obj)
For StartStopStep the services created
will also be added to the objects steps attribute.
-
claim_steps()[source]
-
close(parent)[source]
-
connect_with(other)[source]
-
default_steps = set([])
-
human_state()[source]
-
info(parent)[source]
-
join(timeout=None)[source]
-
load_step(step)[source]
-
name = None
-
restart(parent, method=u'stop', description=u'restarting', propagate=False)[source]
-
send_all(parent, method, description=None, reverse=True, propagate=True, args=())[source]
-
start(parent)[source]
-
started = 0
-
state = None
-
state_to_name = {0: u'initializing', 1: u'running', 2: u'closing', 3: u'terminating'}
-
stop(parent, close=True, terminate=False)[source]
-
class celery.bootsteps.Step(parent, **kwargs)[source]
A Bootstep.
The __init__() method is called when the step
is bound to a parent object, and can as such be used
to initialize attributes in the parent object at
parent instantiation-time.
-
alias[source]
-
conditional = False
Set this to true if the step is enabled based on some condition.
-
create(parent)[source]
Create the step.
-
enabled = True
This provides the default for include_if().
-
include(parent)[source]
-
include_if(parent)[source]
An optional predicate that decides whether this
step should be created.
-
info(obj)[source]
-
instantiate(name, *args, **kwargs)[source]
-
label = None
Optional short name used for graph outputs and in logs.
-
last = False
This flag is reserved for the workers Consumer,
since it is required to always be started last.
There can only be one object marked last
in every blueprint.
-
name = u'celery.bootsteps.Step'
Optional step name, will use qualname if not specified.
-
requires = ()
List of other steps that that must be started before this step.
Note that all dependencies must be in the same blueprint.
-
class celery.bootsteps.StartStopStep(parent, **kwargs)[source]
-
close(parent)[source]
-
include(parent)[source]
-
name = u'celery.bootsteps.StartStopStep'
-
obj = None
Optional obj created by the create() method.
This is used by StartStopStep to keep the
original service object.
-
requires = ()
-
start(parent)[source]
-
stop(parent)[source]
-
terminate(parent)[source]
-
class celery.bootsteps.ConsumerStep(parent, **kwargs)[source]
-
consumers = None
-
get_consumers(channel)[source]
-
name = u'celery.bootsteps.ConsumerStep'
-
requires = (u'celery.worker.consumer:Connection',)
-
shutdown(c)[source]
-
start(c)[source]
-
stop(c)[source]