Skip to content

Configuration

Configuration

Configuration(
    *,
    task: TaskConfiguration | None = None,
    result: ResultBackendConfiguration | None = None,
    default_serialization_backend: SerializationBackend[
        Any
    ],
    serialization_backends: Sequence[
        SerializationBackend[Any]
    ] = (),
    extensions: Sequence[AnyExtension] = ()
)

Configuration is a semi-global object that defines behavior shared between different components, such as serialization, plugins and timeouts.

Parameters:

  • task (TaskConfiguration | None, default: None ) –

    task configuration

  • default_serialization_backend (SerializationBackend[Any]) –

    default SerializationBackend

  • serialization_backends (Sequence[SerializationBackend[Any]], default: () ) –

    list of serialization backends in order of priority

TaskConfiguration dataclass

TaskConfiguration(
    healthcheck_interval: timedelta = timedelta(
        seconds=5
    ),
    max_delivery_attempts: int = 3,
    shutdown_deadline: timedelta = timedelta(
        minutes=1
    ),
    timeout_interval: timedelta = timedelta(
        seconds=10
    ),
)

healthcheck_interval class-attribute instance-attribute

healthcheck_interval: timedelta = timedelta(seconds=5)

Interval in which worker should notify brokerthat task is being processed, if that's applicable.

timeout_interval class-attribute instance-attribute

timeout_interval: timedelta = timedelta(seconds=10)

Interval in which task is considered stuck/failed.