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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
.. _deprecation-timeline:
==============================
Celery Deprecation Time-line
==============================
.. contents::
:local:
.. _deprecations-v5.0:
Removals for version 5.0
========================
Old Task API
------------
.. _deprecate-compat-task-modules:
Compat Task Modules
~~~~~~~~~~~~~~~~~~~
- Module ``celery.decorators`` will be removed:
This means you need to change:
.. code-block:: python
from celery.decorators import task
Into:
.. code-block:: python
from celery import task
- Module ``celery.task`` will be removed
This means you should change:
.. code-block:: python
from celery.task import task
into:
.. code-block:: python
from celery import shared_task
-- and:
.. code-block:: python
from celery import task
into:
.. code-block:: python
from celery import shared_task
-- and:
.. code-block:: python
from celery.task import Task
into:
.. code-block:: python
from celery import Task
Note that the new :class:`~celery.Task` class no longer
uses :func:`classmethod` for these methods:
- delay
- apply_async
- retry
- apply
- AsyncResult
- subtask
This also means that you can't call these methods directly
on the class, but have to instantiate the task first:
.. code-block:: pycon
>>> MyTask.delay() # NO LONGER WORKS
>>> MyTask().delay() # WORKS!
Task attributes
---------------
The task attributes:
- ``queue``
- ``exchange``
- ``exchange_type``
- ``routing_key``
- ``delivery_mode``
- ``priority``
is deprecated and must be set by :setting:`task_routes` instead.
Modules to Remove
-----------------
- ``celery.execute``
This module only contains ``send_task``: this must be replaced with
:attr:`@send_task` instead.
- ``celery.decorators``
See :ref:`deprecate-compat-task-modules`
- ``celery.log``
Use :attr:`@log` instead.
- ``celery.messaging``
Use :attr:`@amqp` instead.
- ``celery.registry``
Use :mod:`celery.app.registry` instead.
- ``celery.task.control``
Use :attr:`@control` instead.
- ``celery.task.schedules``
Use :mod:`celery.schedules` instead.
- ``celery.task.chords``
Use :func:`celery.chord` instead.
Settings
--------
``BROKER`` Settings
~~~~~~~~~~~~~~~~~~~
===================================== =====================================
**Setting name** **Replace with**
===================================== =====================================
``BROKER_HOST`` :setting:`broker_url`
``BROKER_PORT`` :setting:`broker_url`
``BROKER_USER`` :setting:`broker_url`
``BROKER_PASSWORD`` :setting:`broker_url`
``BROKER_VHOST`` :setting:`broker_url`
===================================== =====================================
``REDIS`` Result Backend Settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
===================================== =====================================
**Setting name** **Replace with**
===================================== =====================================
``CELERY_REDIS_HOST`` :setting:`result_backend`
``CELERY_REDIS_PORT`` :setting:`result_backend`
``CELERY_REDIS_DB`` :setting:`result_backend`
``CELERY_REDIS_PASSWORD`` :setting:`result_backend`
``REDIS_HOST`` :setting:`result_backend`
``REDIS_PORT`` :setting:`result_backend`
``REDIS_DB`` :setting:`result_backend`
``REDIS_PASSWORD`` :setting:`result_backend`
===================================== =====================================
Task_sent signal
----------------
The :signal:`task_sent` signal will be removed in version 4.0.
Please use the :signal:`before_task_publish` and :signal:`after_task_publish`
signals instead.
Result
------
Apply to: :class:`~celery.result.AsyncResult`,
:class:`~celery.result.EagerResult`:
- ``Result.wait()`` -> ``Result.get()``
- ``Result.task_id()`` -> ``Result.id``
- ``Result.status`` -> ``Result.state``.
.. _deprecations-v3.1:
Settings
~~~~~~~~
===================================== =====================================
**Setting name** **Replace with**
===================================== =====================================
``CELERY_AMQP_TASK_RESULT_EXPIRES`` :setting:`result_expires`
===================================== =====================================
.. _deprecations-v2.0:
Removals for version 2.0
========================
* The following settings will be removed:
===================================== =====================================
**Setting name** **Replace with**
===================================== =====================================
`CELERY_AMQP_CONSUMER_QUEUES` `task_queues`
`CELERY_AMQP_CONSUMER_QUEUES` `task_queues`
`CELERY_AMQP_EXCHANGE` `task_default_exchange`
`CELERY_AMQP_EXCHANGE_TYPE` `task_default_exchange_type`
`CELERY_AMQP_CONSUMER_ROUTING_KEY` `task_queues`
`CELERY_AMQP_PUBLISHER_ROUTING_KEY` `task_default_routing_key`
===================================== =====================================
* :envvar:`CELERY_LOADER` definitions without class name.
For example,, `celery.loaders.default`, needs to include the class name:
`celery.loaders.default.Loader`.
* :meth:`TaskSet.run`. Use :meth:`celery.task.base.TaskSet.apply_async`
instead.
|
