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

Celery Application.

Proxies

celery.app.default_app = <Celery default:0x7ff4095f1910>

Celery application.

Parameters:

main (str) – Name of the main module if running as __main__. This is used as the prefix for auto-generated task names.

Keyword Arguments:
 
  • broker (str) – URL of the default broker used.
  • backend (Union[str, type]) –

    The result store backend class, or the name of the backend class to use.

    Default is the value of the result_backend setting.

  • autofinalize (bool) – If set to False a RuntimeError will be raised if the task registry or tasks are used before the app is finalized.
  • set_as_current (bool) – Make this the global current app.
  • include (List[str]) – List of modules every worker should import.
  • amqp (Union[str, type]) – AMQP object or class name.
  • events (Union[str, type]) – Events object or class name.
  • log (Union[str, type]) – Log object or class name.
  • control (Union[str, type]) – Control object or class name.
  • tasks (Union[str, type]) – A task registry, or the name of a registry class.
  • fixups (List[str]) – List of fix-up plug-ins (e.g., see celery.fixups.django).
  • config_source (Union[str, type]) – Take configuration from a class, or object. Attributes may include any setings described in the documentation.

Functions

celery.app.app_or_default(app=None)
celery.app.enable_trace()[source]

Enable tracing of app instances.

celery.app.disable_trace()[source]

Disable tracing of app instances.