1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
===========================================
:mod:`celery` --- Distributed processing
===========================================
.. currentmodule:: celery
.. module:: celery
:synopsis: Distributed processing
.. moduleauthor:: Ask Solem <ask@celeryproject.org>
.. sectionauthor:: Ask Solem <ask@celeryproject.org>
--------------
This module is the main entry-point for the Celery API.
It includes commonly needed things for calling tasks,
and creating Celery applications.
===================== ===================================================
:class:`Celery` Celery application instance
:class:`group` group tasks together
:class:`chain` chain tasks together
:class:`chord` chords enable callbacks for groups
:func:`signature` create a new task signature
:class:`Signature` object describing a task invocation
:data:`current_app` proxy to the current application instance
:data:`current_task` proxy to the currently executing task
===================== ===================================================
:class:`Celery` application objects
-----------------------------------
.. versionadded:: 2.5
.. autoclass:: Celery
.. autoattribute:: user_options
.. autoattribute:: steps
.. autoattribute:: current_task
.. autoattribute:: current_worker_task
.. autoattribute:: amqp
.. autoattribute:: backend
.. autoattribute:: loader
.. autoattribute:: control
.. autoattribute:: events
.. autoattribute:: log
.. autoattribute:: tasks
.. autoattribute:: pool
.. autoattribute:: producer_pool
.. autoattribute:: Task
.. autoattribute:: timezone
.. autoattribute:: builtin_fixups
.. autoattribute:: oid
.. automethod:: close
.. automethod:: signature
.. automethod:: bugreport
.. automethod:: config_from_object
.. automethod:: config_from_envvar
.. automethod:: autodiscover_tasks
.. automethod:: add_defaults
.. automethod:: add_periodic_task
.. automethod:: setup_security
.. automethod:: task
.. automethod:: send_task
.. automethod:: gen_task_name
.. autoattribute:: AsyncResult
.. autoattribute:: GroupResult
.. autoattribute:: Worker
.. autoattribute:: WorkController
.. autoattribute:: Beat
.. automethod:: connection_for_read
.. automethod:: connection_for_write
.. automethod:: connection
.. automethod:: connection_or_acquire
.. automethod:: producer_or_acquire
.. automethod:: select_queues
.. automethod:: now
.. automethod:: set_current
.. automethod:: set_default
.. automethod:: finalize
.. automethod:: on_init
.. automethod:: prepare_config
.. data:: on_configure
Signal sent when app is loading configuration.
.. data:: on_after_configure
Signal sent after app has prepared the configuration.
.. data:: on_after_finalize
Signal sent after app has been finalized.
.. data:: on_after_fork
Signal sent in child process after fork.
Canvas primitives
-----------------
See :ref:`guide-canvas` for more about creating task work-flows.
.. autoclass:: group
.. autoclass:: chain
.. autoclass:: chord
.. autofunction:: signature
.. autoclass:: Signature
Proxies
-------
.. data:: current_app
The currently set app for this thread.
.. data:: current_task
The task currently being executed
(only set in the worker, or when eager/apply is used).
|
