This document describes the current stable version of Celery (5.2). 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)

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()

compress(level=-1, wbits=15)

Returns a bytes object containing compressed data.

data

Binary data to be compressed.

level

Compression level, in 0-9 or -1.

wbits

The window buffer size and container format.

property db

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()

open()

protocol = 4

save()

storage = <module 'shelve' from '/usr/lib/python3.11/shelve.py'>

sync()

celery.worker.state.SOFTWARE_INFO = {'sw_ident': 'py-celery', 'sw_sys': 'Linux', 'sw_ver': '5.2.6'}

Worker software/platform information.

celery.worker.state.active_requests = set()

set of currently active Request’s.

celery.worker.state.maybe_shutdown()

Shutdown if flags have been set.

celery.worker.state.reserved_requests = set()

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 set()>, add_to_total_count=<bound method Counter.update of Counter()>)

Update global state when a task has been accepted.

celery.worker.state.task_ready(request, successful=False, remove_request=<built-in method pop of dict object>, discard_active_request=<bound method WeakSet.discard of set()>, discard_reserved_request=<bound method WeakSet.discard of set()>)

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 set()>)

Update global state when a task has been reserved.

celery.worker.state.total_count = {}

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