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

Sending/Receiving Messages (Kombu integration).

AMQP

class celery.app.amqp.AMQP(app)

App AMQP API: app.amqp.

Connection

Broker connection class used. Default is kombu.Connection.

Consumer

Base Consumer class used. Default is kombu.Consumer.

Producer

Base Producer class used. Default is kombu.Producer.

queues

All currently defined task queues (a Queues instance).

argsrepr_maxsize

Max size of positional argument representation used for logging purposes. Default is 1024.

kwargsrepr_maxsize

Max size of keyword argument representation used for logging purposes. Default is 1024.

Queues(queues, create_missing=None, create_missing_queue_type=None, create_missing_queue_exchange_type=None, autoexchange=None, max_priority=None)

Router(queues=None, create_missing=None)

Return the current task router.

flush_routes()

create_task_message

send_task_message

default_queue

default_exchange

producer_pool

router

routes

Queues

class celery.app.amqp.Queues(queues=None, default_exchange=None, create_missing=True, create_missing_queue_type=None, create_missing_queue_exchange_type=None, autoexchange=None, max_priority=None, default_routing_key=None)

Queue name⇒ declaration mapping.

Parameters:

• queues (Iterable) – Initial list/tuple or dict of queues.

• create_missing (bool) – By default any unknown queues will be added automatically, but if this flag is disabled the occurrence of unknown queues in wanted will raise KeyError.

• create_missing_queue_type (str) – Type of queue to create for missing queues. Must be either ‘classic’ (default) or ‘quorum’. If set to ‘quorum’, the broker will declare new queues using the quorum type.

• create_missing_queue_exchange_type (str) – Type of exchange to use when creating missing queues. If not set, the default exchange type will be used. If set, the exchange type will be set to this value when creating missing queues.

• max_priority (int) – Default x-max-priority for queues with none set.

add(queue, **kwargs)

Add new queue.

The first argument can either be a kombu.Queue instance, or the name of a queue. If the former the rest of the keyword arguments are ignored, and options are simply taken from the queue instance.

Parameters:

• queue (kombu.Queue, str) – Queue to add.

• exchange (kombu.Exchange, str) – if queue is str, specifies exchange name.

• routing_key (str) – if queue is str, specifies binding key.

• exchange_type (str) – if queue is str, specifies type of exchange.

• **options (Any) – Additional declaration options used when queue is a str.

add_compat(name, **options)

property consume_from

deselect(exclude)

Deselect queues so that they won’t be consumed from.

Parameters:

exclude (Sequence[str], str) – Names of queues to avoid consuming from.

format(indent=0, indent_first=True)

Format routing table into string for log dumps.

new_missing(name)

select(include)

Select a subset of currently defined queues to consume from.

Parameters:

include (Sequence[str], str) – Names of queues to consume from.

select_add(queue, **kwargs)

Add new task queue that’ll be consumed from.

The queue will be active even when a subset has been selected using the celery worker -Q option.