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

celery.worker.state

Internal worker state (global).

This includes the currently active and reserved tasks, statistics, and revoked tasks.

class celery.worker.state.Persistent(state, filename, clock=None)[source]

Stores worker state between restarts.

This is the persistent data stored by the worker when celery worker --statedb is enabled.

Currently only stores revoked task id’s.

close()[source]
compress(level=- 1)

Returns a bytes object containing compressed data.

data

Binary data to be compressed.

level

Compression level, in 0-9 or -1.

db[source]
decompress(wbits=15, bufsize=16384)

Returns a bytes object containing the uncompressed data.

data

Compressed data.

wbits

The window buffer size and container format.

bufsize

The initial output buffer size.

merge()[source]
open()[source]
protocol = 2
save()[source]
storage = <module 'shelve' from '/home/docs/.pyenv/versions/3.7.3/lib/python3.7/shelve.py'>
sync()[source]
celery.worker.state.SOFTWARE_INFO = {'sw_ident': 'py-celery', 'sw_sys': 'Linux', 'sw_ver': '5.0.0rc3'}

Worker software/platform information.

celery.worker.state.active_requests = <_weakrefset.WeakSet object>

set of currently active Request’s.

celery.worker.state.maybe_shutdown()[source]

Shutdown if flags have been set.

celery.worker.state.reserved_requests = <_weakrefset.WeakSet object>

set of all reserved Request’s.

celery.worker.state.revoked = <LimitedSet(0): maxlen=50000, expires=10800, minlen=0>

the list of currently revoked tasks. Persistent if statedb set.

celery.worker.state.task_accepted(request, _all_total_count=None, add_active_request=<bound method WeakSet.add of <_weakrefset.WeakSet object>>, add_to_total_count=<bound method Counter.update of Counter()>)[source]

Update global state when a task has been accepted.

celery.worker.state.task_ready(request, remove_request=<built-in method pop of dict object>, discard_active_request=<bound method WeakSet.discard of <_weakrefset.WeakSet object>>, discard_reserved_request=<bound method WeakSet.discard of <_weakrefset.WeakSet object>>)[source]

Update global state when a task is ready.

celery.worker.state.task_reserved(request, add_request=<method-wrapper '__setitem__' of dict object>, add_reserved_request=<bound method WeakSet.add of <_weakrefset.WeakSet object>>)[source]

Update global state when a task has been reserved.

celery.worker.state.total_count = {}

count of tasks accepted by the worker, sorted by type.