changelog-3.0.rst 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163
  1. .. _changelog:
  2. ================
  3. Change history
  4. ================
  5. .. contents::
  6. :local:
  7. If you're looking for versions prior to 3.0.x you should go to :ref:`history`.
  8. .. _version-3.0.16:
  9. 3.0.16
  10. ======
  11. :release-date: 2013-03-07 04:00:00 P.M UTC
  12. - Happy International Women's Day!
  13. We have a long way to go, so this is a chance for you to get involved in one
  14. of the organizations working for making our communities more
  15. diverse.
  16. - PyLadies — http://pyladies.com
  17. - Girls Who Code — http://www.girlswhocode.com
  18. - Women Who Code — http://www.meetup.com/Women-Who-Code-SF/
  19. - Now depends on :mod:`kombu` version 2.5.7
  20. - Now depends on :mod:`billiard` version 2.7.3.22
  21. - AMQP heartbeats are now disabled by default.
  22. Some users experiences issues with heartbeats enabled,
  23. and it's not strictly necessary to use them.
  24. If you're experiencing problems detecting connection failures,
  25. you can re-enable heartbeats by configuring the :setting:`BROKER_HEARTBEAT`
  26. setting.
  27. - Worker: Now propagates connection errors occurring in multiprocessing
  28. callbacks, so that the connection can be reset (Issue #1226).
  29. - Worker: Now propagates connection errors occurring in timer callbacks,
  30. so that the connection can be reset.
  31. - The modules in :setting:`CELERY_IMPORTS` and :setting:`CELERY_INCLUDE`
  32. are now imported in the original order (Issue #1161).
  33. The modules in :setting:`CELERY_IMPORTS` will be imported first,
  34. then continued by :setting:`CELERY_INCLUDE`.
  35. Thanks to Joey Wilhelm.
  36. - New bash completion for ``celery`` available in the git repository:
  37. https://github.com/celery/celery/tree/3.0/extra/bash-completion
  38. You can source this file or put it in ``bash_completion.d`` to
  39. get auto-completion for the ``celery`` command-line utility.
  40. - The node name of a worker can now include unicode characters (Issue #1186).
  41. - The repr of a ``crontab`` object now displays correctly (Issue #972).
  42. - ``events.State`` no longer modifies the original event dictionary.
  43. - No longer uses ``Logger.warn`` deprecated in Python 3.
  44. - Cache Backend: Now works with chords again (Issue #1094).
  45. - Chord unlock now handles errors occurring while calling the callback.
  46. - Generic worker init.d script: Status check is now performed by
  47. querying the pid of the instance instead of sending messages.
  48. Contributed by Milen Pavlov.
  49. - Improved init scripts for CentOS.
  50. - Updated to support celery 3.x conventions.
  51. - Now uses CentOS built-in ``status`` and ``killproc``
  52. - Support for multi-node / multi-pid worker services.
  53. - Standard color-coded CentOS service-init output.
  54. - A test suite.
  55. Contributed by Milen Pavlov.
  56. - ``ResultSet.join`` now always works with empty result set (Issue #1219).
  57. - A ``group`` consisting of a single task is now supported (Issue #1219).
  58. - Now supports the ``pycallgraph`` program (Issue #1051).
  59. - Fixed Jython compatibility problems.
  60. - Django tutorial: Now mentions that the example app must be added to
  61. ``INSTALLED_APPS`` (Issue #1192).
  62. .. _version-3.0.15:
  63. 3.0.15
  64. ======
  65. :release-date: 2013-02-11 04:30:00 P.M UTC
  66. - Now depends on billiard 2.7.3.21 which fixed a syntax error crash.
  67. - Fixed bug with :setting:`CELERY_SEND_TASK_SENT_EVENT`.
  68. .. _version-3.0.14:
  69. 3.0.14
  70. ======
  71. :release-date: 2013-02-08 05:00:00 P.M UTC
  72. - Now depends on Kombu 2.5.6
  73. - Now depends on billiard 2.7.3.20
  74. - ``execv`` is now disabled by default.
  75. It was causing too many problems for users, you can still enable
  76. it using the :setting:`CELERYD_FORCE_EXECV` setting.
  77. execv was only enabled when transports other than amqp/redis was used,
  78. and it's there to prevent deadlocks caused by mutexes not being released
  79. before the process forks. Sadly it also changes the environment
  80. introducing many corner case bugs that is hard to fix without adding
  81. horrible hacks. Deadlock issues are reported far less often than the
  82. bugs that execv are causing, so we now disable it by default.
  83. Work is in motion to create non-blocking versions of these transports
  84. so that execv is not necessary (which is the situation with the amqp
  85. and redis broker transports)
  86. - Chord exception behavior defined (Issue #1172).
  87. From Celery 3.1 the chord callback will change state to FAILURE
  88. when a task part of a chord raises an exception.
  89. It was never documented what happens in this case,
  90. and the actual behavior was very unsatisfactory, indeed
  91. it will just forward the exception value to the chord callback.
  92. For backward compatibility reasons we do not change to the new
  93. behavior in a bugfix release, even if the current behavior was
  94. never documented. Instead you can enable the
  95. :setting:`CELERY_CHORD_PROPAGATES` setting to get the new behavior
  96. that will be default from Celery 3.1.
  97. See more at :ref:`chord-errors`.
  98. - worker: Fixes bug with ignored and retried tasks.
  99. The ``on_chord_part_return`` and ``Task.after_return`` callbacks,
  100. nor the ``task_postrun`` signal should be called when the task was
  101. retried/ignored.
  102. Fix contributed by Vlad.
  103. - ``GroupResult.join_native`` now respects the ``propagate`` argument.
  104. - ``subtask.id`` added as an alias to ``subtask['options'].id``
  105. .. code-block:: python
  106. >>> s = add.s(2, 2)
  107. >>> s.id = 'my-id'
  108. >>> s['options']
  109. {'task_id': 'my-id'}
  110. >>> s.id
  111. 'my-id'
  112. - worker: Fixed error `Could not start worker processes` occurring
  113. when restarting after connection failure (Issue #1118).
  114. - Adds new signal :signal:`task-retried` (Issue #1169).
  115. - `celery events --dumper` now handles connection loss.
  116. - Will now retry sending the task-sent event in case of connection failure.
  117. - amqp backend: Now uses ``Message.requeue`` instead of republishing
  118. the message after poll.
  119. - New :setting:`BROKER_HEARTBEAT_CHECKRATE` setting introduced to modify the
  120. rate at which broker connection heartbeats are monitored.
  121. The default value was also changed from 3.0 to 2.0.
  122. - :class:`celery.events.state.State` is now pickleable.
  123. Fix contributed by Mher Movsisyan.
  124. - :class:`celery.datastructures.LRUCache` is now pickleable.
  125. Fix contributed by Mher Movsisyan.
  126. - The stats broadcast command now includes the workers pid.
  127. Contributed by Mher Movsisyan.
  128. - New ``conf`` remote control command to get a workers current configuration.
  129. Contributed by Mher Movsisyan.
  130. - Adds the ability to modify the chord unlock task's countdown
  131. argument (Issue #1146).
  132. Contributed by Jun Sakai
  133. - beat: The scheduler now uses the `now()`` method of the schedule,
  134. so that schedules can provide a custom way to get the current date and time.
  135. Contributed by Raphaël Slinckx
  136. - Fixed pickling of configuration modules on Windows or when execv is used
  137. (Issue #1126).
  138. - Multiprocessing logger is now configured with loglevel ``ERROR``
  139. by default.
  140. Since 3.0 the multiprocessing loggers were disabled by default
  141. (only configured when the :envvar:`MP_LOG` environment variable was set).
  142. .. _version-3.0.13:
  143. 3.0.13
  144. ======
  145. :release-date: 2013-01-07 04:00:00 P.M UTC
  146. - Now depends on Kombu 2.5
  147. - py-amqp has replaced amqplib as the default transport,
  148. gaining support for AMQP 0.9, and the RabbitMQ extensions
  149. including Consumer Cancel Notifications and heartbeats.
  150. - support for multiple connection URLs for failover.
  151. - Read more in the `Kombu 2.5 changelog`_.
  152. .. _`Kombu 2.5 changelog`:
  153. http://kombu.readthedocs.org/en/latest/changelog.html#version-2-5-0
  154. - Now depends on billiard 2.7.3.19
  155. - Fixed a deadlock issue that could occur when the producer pool
  156. inherited the connection pool instance of the parent process.
  157. - The :option:`--loader` option now works again (Issue #1066).
  158. - :program:`celery` umbrella command: All subcommands now supports
  159. the :option:`--workdir` option (Issue #1063).
  160. - Groups included in chains now give GroupResults (Issue #1057)
  161. Previously it would incorrectly add a regular result instead of a group
  162. result, but now this works:
  163. .. code-block:: python
  164. # [4 + 4, 4 + 8, 16 + 8]
  165. >>> res = (add.s(2, 2) | group(add.s(4), add.s(8), add.s(16)))()
  166. >>> res
  167. <GroupResult: a0acf905-c704-499e-b03a-8d445e6398f7 [
  168. 4346501c-cb99-4ad8-8577-12256c7a22b1,
  169. b12ead10-a622-4d44-86e9-3193a778f345,
  170. 26c7a420-11f3-4b33-8fac-66cd3b62abfd]>
  171. - Chains can now chain other chains and use partial arguments (Issue #1057).
  172. Example:
  173. .. code-block:: python
  174. >>> c1 = (add.s(2) | add.s(4))
  175. >>> c2 = (add.s(8) | add.s(16))
  176. >>> c3 = (c1 | c2)
  177. # 8 + 2 + 4 + 8 + 16
  178. >>> assert c3(8).get() == 38
  179. - Subtasks can now be used with unregistered tasks.
  180. You can specify subtasks even if you just have the name::
  181. >>> s = subtask(task_name, args=(), kwargs=())
  182. >>> s.delay()
  183. - The :program:`celery shell` command now always adds the current
  184. directory to the module path.
  185. - The worker will now properly handle the :exc:`pytz.AmbiguousTimeError`
  186. exception raised when an ETA/countdown is prepared while being in DST
  187. transition (Issue #1061).
  188. - force_execv: Now makes sure that task symbols in the original
  189. task modules will always use the correct app instance (Issue #1072).
  190. - AMQP Backend: Now republishes result messages that have been polled
  191. (using ``result.ready()`` and friends, ``result.get()`` will not do this
  192. in this version).
  193. - Crontab schedule values can now "wrap around"
  194. This means that values like ``11-1`` translates to ``[11, 12, 1]``.
  195. Contributed by Loren Abrams.
  196. - multi stopwait command now shows the pid of processes.
  197. Contributed by Loren Abrams.
  198. - Handling of ETA/countdown fixed when the :setting:`CELERY_ENABLE_UTC`
  199. setting is disabled (Issue #1065).
  200. - A number of uneeded properties were included in messages,
  201. caused by accidentally passing ``Queue.as_dict`` as message properties.
  202. - Rate limit values can now be float
  203. This also extends the string format so that values like ``"0.5/s"`` works.
  204. Contributed by Christoph Krybus
  205. - Fixed a typo in the broadcast routing documentation (Issue #1026).
  206. - Rewrote confusing section about idempotence in the task user guide.
  207. - Fixed typo in the daemonization tutorial (Issue #1055).
  208. - Fixed several typos in the documentation.
  209. Contributed by Marius Gedminas.
  210. - Batches: Now works when using the eventlet pool.
  211. Fix contributed by Thomas Grainger.
  212. - Batches: Added example sending results to :mod:`celery.contrib.batches`.
  213. Contributed by Thomas Grainger.
  214. - Mongodb backend: Connection ``max_pool_size`` can now be set in
  215. :setting:`CELERY_MONGODB_BACKEND_SETTINGS`.
  216. Contributed by Craig Younkins.
  217. - Fixed problem when using earlier versions of :mod:`pytz`.
  218. Fix contributed by Vlad.
  219. - Docs updated to include the default value for the
  220. :setting:`CELERY_TASK_RESULT_EXPIRES` setting.
  221. - Improvements to the django-celery tutorial.
  222. Contributed by Locker537.
  223. - The ``add_consumer`` control command did not properly persist
  224. the addition of new queues so that they survived connection failure
  225. (Issue #1079).
  226. 3.0.12
  227. ======
  228. :release-date: 2012-11-06 02:00 P.M UTC
  229. - Now depends on kombu 2.4.8
  230. - [Redis] New and improved fair queue cycle algorithm (Kevin McCarthy).
  231. - [Redis] Now uses a Redis-based mutex when restoring messages.
  232. - [Redis] Number of messages that can be restored in one interval is no
  233. longer limited (but can be set using the
  234. ``unacked_restore_limit``
  235. :setting:`transport option <BROKER_TRANSPORT_OPTIONS>`.)
  236. - Heartbeat value can be specified in broker URLs (Mher Movsisyan).
  237. - Fixed problem with msgpack on Python 3 (Jasper Bryant-Greene).
  238. - Now depends on billiard 2.7.3.18
  239. - Celery can now be used with static analysis tools like PyDev/PyCharm/pylint
  240. etc.
  241. - Development documentation has moved to Read The Docs.
  242. The new URL is: http://docs.celeryproject.org/en/master
  243. - New :setting:`CELERY_QUEUE_HA_POLICY` setting used to set the default
  244. HA policy for queues when using RabbitMQ.
  245. - New method ``Task.subtask_from_request`` returns a subtask using the current
  246. request.
  247. - Results get_many method did not respect timeout argument.
  248. Fix contributed by Remigiusz Modrzejewski
  249. - generic_init.d scripts now support setting :envvar:`CELERY_CREATE_DIRS` to
  250. always create log and pid directories (Issue #1045).
  251. This can be set in your :file:`/etc/default/celeryd`.
  252. - Fixed strange kombu import problem on Python 3.2 (Issue #1034).
  253. - Worker: ETA scheduler now uses millisecond precision (Issue #1040).
  254. - The ``--config`` argument to programs is now supported by all loaders.
  255. - The :setting:`CASSANDRA_OPTIONS` setting has now been documented.
  256. Contributed by Jared Biel.
  257. - Task methods (:mod:`celery.contrib.methods`) cannot be used with the old
  258. task base class, the task decorator in that module now inherits from the new.
  259. - An optimization was too eager and caused some logging messages to never emit.
  260. - :mod:`celery.contrib.batches` now works again.
  261. - Fixed missing whitespace in ``bdist_rpm`` requirements (Issue #1046).
  262. - Event state's ``tasks_by_name`` applied limit before filtering by name.
  263. Fix contributed by Alexander A. Sosnovskiy.
  264. .. _version-3.0.11:
  265. 3.0.11
  266. ======
  267. :release-date: 2012-09-26 04:00 P.M UTC
  268. - [security:low] generic-init.d scripts changed permissions of /var/log & /var/run
  269. In the daemonization tutorial the recommended directories were as follows:
  270. .. code-block:: bash
  271. CELERYD_LOG_FILE="/var/log/celery/%n.log"
  272. CELERYD_PID_FILE="/var/run/celery/%n.pid"
  273. But in the scripts themselves the default files were ``/var/log/celery%n.log``
  274. and ``/var/run/celery%n.pid``, so if the user did not change the location
  275. by configuration, the directories ``/var/log`` and ``/var/run`` would be
  276. created - and worse have their permissions and owners changed.
  277. This change means that:
  278. - Default pid file is ``/var/run/celery/%n.pid``
  279. - Default log file is ``/var/log/celery/%n.log``
  280. - The directories are only created and have their permissions
  281. changed if *no custom locations are set*.
  282. Users can force paths to be created by calling the ``create-paths``
  283. subcommand:
  284. .. code-block:: bash
  285. $ sudo /etc/init.d/celeryd create-paths
  286. .. admonition:: Upgrading Celery will not update init scripts
  287. To update the init scripts you have to re-download
  288. the files from source control and update them manually.
  289. You can find the init scripts for version 3.0.x at:
  290. http://github.com/celery/celery/tree/3.0/extra/generic-init.d
  291. - Now depends on billiard 2.7.3.17
  292. - Fixes request stack protection when app is initialized more than
  293. once (Issue #1003).
  294. - ETA tasks now properly works when system timezone is not the same
  295. as the configured timezone (Issue #1004).
  296. - Terminating a task now works if the task has been sent to the
  297. pool but not yet acknowledged by a pool process (Issue #1007).
  298. Fix contributed by Alexey Zatelepin
  299. - Terminating a task now properly updates the state of the task to revoked,
  300. and sends a ``task-revoked`` event.
  301. - Generic worker init script now waits for workers to shutdown by default.
  302. - Multi: No longer parses --app option (Issue #1008).
  303. - Multi: stop_verify command renamed to stopwait.
  304. - Daemonization: Now delays trying to create pidfile/logfile until after
  305. the working directory has been changed into.
  306. - :program:`celery worker` and :program:`celery beat` commands now respects
  307. the :option:`--no-color` option (Issue #999).
  308. - Fixed typos in eventlet examples (Issue #1000)
  309. Fix contributed by Bryan Bishop.
  310. Congratulations on opening bug #1000!
  311. - Tasks that raise :exc:`~celery.exceptions.Ignore` are now acknowledged.
  312. - Beat: Now shows the name of the entry in ``sending due task`` logs.
  313. .. _version-3.0.10:
  314. 3.0.10
  315. ======
  316. :release-date: 2012-09-20 05:30 P.M BST
  317. - Now depends on kombu 2.4.7
  318. - Now depends on billiard 2.7.3.14
  319. - Fixes crash at startup when using Django and pre-1.4 projects
  320. (setup_environ).
  321. - Hard time limits now sends the KILL signal shortly after TERM,
  322. to terminate processes that have signal handlers blocked by C extensions.
  323. - Billiard now installs even if the C extension cannot be built.
  324. It's still recommended to build the C extension if you are using
  325. a transport other than rabbitmq/redis (or use forced execv for some
  326. other reason).
  327. - Pool now sets a ``current_process().index`` attribute that can be used to create
  328. as many log files as there are processes in the pool.
  329. - Canvas: chord/group/chain no longer modifies the state when called
  330. Previously calling a chord/group/chain would modify the ids of subtasks
  331. so that:
  332. .. code-block:: python
  333. >>> c = chord([add.s(2, 2), add.s(4, 4)], xsum.s())
  334. >>> c()
  335. >>> c() <-- call again
  336. at the second time the ids for the tasks would be the same as in the
  337. previous invocation. This is now fixed, so that calling a subtask
  338. won't mutate any options.
  339. - Canvas: Chaining a chord to another task now works (Issue #965).
  340. - Worker: Fixed a bug where the request stack could be corrupted if
  341. relative imports are used.
  342. Problem usually manifested itself as an exception while trying to
  343. send a failed task result (``NoneType does not have id attribute``).
  344. Fix contributed by Sam Cooke.
  345. - Tasks can now raise :exc:`~celery.exceptions.Ignore` to skip updating states
  346. or events after return.
  347. Example:
  348. .. code-block:: python
  349. from celery.exceptions import Ignore
  350. @task
  351. def custom_revokes():
  352. if redis.sismember('tasks.revoked', custom_revokes.request.id):
  353. raise Ignore()
  354. - The worker now makes sure the request/task stacks are not modified
  355. by the initial ``Task.__call__``.
  356. This would previously be a problem if a custom task class defined
  357. ``__call__`` and also called ``super()``.
  358. - Because of problems the fast local optimization has been disabled,
  359. and can only be enabled by setting the :envvar:`USE_FAST_LOCALS` attribute.
  360. - Worker: Now sets a default socket timeout of 5 seconds at shutdown
  361. so that broken socket reads do not hinder proper shutdown (Issue #975).
  362. - More fixes related to late eventlet/gevent patching.
  363. - Documentation for settings out of sync with reality:
  364. - :setting:`CELERY_TASK_PUBLISH_RETRY`
  365. Documented as disabled by default, but it was enabled by default
  366. since 2.5 as stated by the 2.5 changelog.
  367. - :setting:`CELERY_TASK_PUBLISH_RETRY_POLICY`
  368. The default max_retries had been set to 100, but documented as being
  369. 3, and the interval_max was set to 1 but documented as 0.2.
  370. The default setting are now set to 3 and 0.2 as it was originally
  371. documented.
  372. Fix contributed by Matt Long.
  373. - Worker: Log messages when connection established and lost have been improved.
  374. - The repr of a crontab schedule value of '0' should be '*' (Issue #972).
  375. - Revoked tasks are now removed from reserved/active state in the worker
  376. (Issue #969)
  377. Fix contributed by Alexey Zatelepin.
  378. - gevent: Now supports hard time limits using ``gevent.Timeout``.
  379. - Documentation: Links to init scripts now point to the 3.0 branch instead
  380. of the development branch (master).
  381. - Documentation: Fixed typo in signals user guide (Issue #986).
  382. ``instance.app.queues`` -> ``instance.app.amqp.queues``.
  383. - Eventlet/gevent: The worker did not properly set the custom app
  384. for new greenlets.
  385. - Eventlet/gevent: Fixed a bug where the worker could not recover
  386. from connection loss (Issue #959).
  387. Also, because of a suspected bug in gevent the
  388. :setting:`BROKER_CONNECTION_TIMEOUT` setting has been disabled
  389. when using gevent
  390. 3.0.9
  391. =====
  392. :release-date: 2012-08-31 06:00 P.M BST
  393. - Important note for users of Django and the database scheduler!
  394. Recently a timezone issue has been fixed for periodic tasks,
  395. but erroneous timezones could have already been stored in the
  396. database, so for the fix to work you need to reset
  397. the ``last_run_at`` fields.
  398. You can do this by executing the following command:
  399. .. code-block:: bash
  400. $ python manage.py shell
  401. >>> from djcelery.models import PeriodicTask
  402. >>> PeriodicTask.objects.update(last_run_at=None)
  403. You also have to do this if you change the timezone or
  404. :setting:`CELERY_ENABLE_UTC` setting.
  405. - Note about the :setting:`CELERY_ENABLE_UTC` setting.
  406. If you previously disabled this just to force periodic tasks to work with
  407. your timezone, then you are now *encouraged to re-enable it*.
  408. - Now depends on Kombu 2.4.5 which fixes PyPy + Jython installation.
  409. - Fixed bug with timezones when :setting:`CELERY_ENABLE_UTC` is disabled
  410. (Issue #952).
  411. - Fixed a typo in the celerybeat upgrade mechanism (Issue #951).
  412. - Make sure the `exc_info` argument to logging is resolved (Issue #899).
  413. - Fixed problem with Python 3.2 and thread join timeout overflow (Issue #796).
  414. - A test case was occasionally broken for Python 2.5.
  415. - Unit test suite now passes for PyPy 1.9.
  416. - App instances now supports the with statement.
  417. This calls the new :meth:`~celery.Celery.close` method at exit, which
  418. cleans up after the app like closing pool connections.
  419. Note that this is only necessary when dynamically creating apps,
  420. e.g. for "temporary" apps.
  421. - Support for piping a subtask to a chain.
  422. For example:
  423. .. code-block:: python
  424. pipe = sometask.s() | othertask.s()
  425. new_pipe = mytask.s() | pipe
  426. Contributed by Steve Morin.
  427. - Fixed problem with group results on non-pickle serializers.
  428. Fix contributed by Steeve Morin.
  429. .. _version-3.0.8:
  430. 3.0.8
  431. =====
  432. :release-date: 2012-08-29 05:00 P.M BST
  433. - Now depends on Kombu 2.4.4
  434. - Fixed problem with amqplib and receiving larger message payloads
  435. (Issue #922).
  436. The problem would manifest itself as either the worker hanging,
  437. or occasionally a ``Framing error`` exception appearing.
  438. Users of the new ``pyamqp://`` transport must upgrade to
  439. :mod:`amqp` 0.9.3.
  440. - Beat: Fixed another timezone bug with interval and crontab schedules
  441. (Issue #943).
  442. - Beat: The schedule file is now automatically cleared if the timezone
  443. is changed.
  444. The schedule is also cleared when you upgrade to 3.0.8 from an earlier
  445. version, this to register the initial timezone info.
  446. - Events: The :event:`worker-heartbeat` event now include processed and active
  447. count fields.
  448. Contributed by Mher Movsisyan.
  449. - Fixed error with error email and new task classes (Issue #931).
  450. - ``BaseTask.__call__`` is no longer optimized away if it has been monkey
  451. patched.
  452. - Fixed shutdown issue when using gevent (Issue #911 & Issue #936).
  453. Fix contributed by Thomas Meson.
  454. .. _version-3.0.7:
  455. 3.0.7
  456. =====
  457. :release-date: 2012-08-24 05:00 P.M BST
  458. - Fixes several problems with periodic tasks and timezones (Issue #937).
  459. - Now depends on kombu 2.4.2
  460. - Redis: Fixes a race condition crash
  461. - Fixes an infinite loop that could happen when retrying establishing
  462. the broker connection.
  463. - Daemons now redirect standard file descriptors to :file:`/dev/null`
  464. Though by default the standard outs are also redirected
  465. to the logger instead, but you can disable this by changing
  466. the :setting:`CELERY_REDIRECT_STDOUTS` setting.
  467. - Fixes possible problems when eventlet/gevent is patched too late.
  468. - ``LoggingProxy`` no longer defines ``fileno()`` (Issue #928).
  469. - Results are now ignored for the chord unlock task.
  470. Fix contributed by Steeve Morin.
  471. - Cassandra backend now works if result expiry is disabled.
  472. Fix contributed by Steeve Morin.
  473. - The traceback object is now passed to signal handlers instead
  474. of the string representation.
  475. Fix contributed by Adam DePue.
  476. - Celery command: Extensions are now sorted by name.
  477. - A regression caused the :event:`task-failed` event to be sent
  478. with the exception object instead of its string representation.
  479. - The worker daemon would try to create the pid file before daemonizing
  480. to catch errors, but this file was not immediately released (Issue #923).
  481. - Fixes Jython compatibility.
  482. - ``billiard.forking_enable`` was called by all pools not just the
  483. processes pool, which would result in a useless warning if the billiard
  484. C extensions were not installed.
  485. .. _version-3.0.6:
  486. 3.0.6
  487. =====
  488. :release-date: 2012-08-17 11:00 P.M BST
  489. - Now depends on kombu 2.4.0
  490. - Now depends on billiard 2.7.3.12
  491. - Redis: Celery now tries to restore messages whenever there are no messages
  492. in the queue.
  493. - Crontab schedules now properly respects :setting:`CELERY_TIMEZONE` setting.
  494. It's important to note that crontab schedules uses UTC time by default
  495. unless this setting is set.
  496. Issue #904 and django-celery #150.
  497. - ``billiard.enable_forking`` is now only set by the processes pool.
  498. - The transport is now properly shown by :program:`celery report`
  499. (Issue #913).
  500. - The `--app` argument now works if the last part is a module name
  501. (Issue #921).
  502. - Fixed problem with unpickleable exceptions (billiard #12).
  503. - Adds ``task_name`` attribute to ``EagerResult`` which is always
  504. :const:`None` (Issue #907).
  505. - Old Task class in :mod:`celery.task` no longer accepts magic kwargs by
  506. default (Issue #918).
  507. A regression long ago disabled magic kwargs for these, and since
  508. no one has complained about it we don't have any incentive to fix it now.
  509. - The ``inspect reserved`` control command did not work properly.
  510. - Should now play better with static analyzation tools by explicitly
  511. specifying dynamically created attributes in the :mod:`celery` and
  512. :mod:`celery.task` modules.
  513. - Terminating a task now results in
  514. :exc:`~celery.exceptions.RevokedTaskError` instead of a ``WorkerLostError``.
  515. - ``AsyncResult.revoke`` now accepts ``terminate`` and ``signal`` arguments.
  516. - The :event:`task-revoked` event now includes new fields: ``terminated``,
  517. ``signum``, and ``expired``.
  518. - The argument to :class:`~celery.exceptions.TaskRevokedError` is now one
  519. of the reasons ``revoked``, ``expired`` or ``terminated``.
  520. - Old Task class does no longer use classmethods for push_request and
  521. pop_request (Issue #912).
  522. - ``GroupResult`` now supports the ``children`` attribute (Issue #916).
  523. - ``AsyncResult.collect`` now respects the ``intermediate`` argument
  524. (Issue #917).
  525. - Fixes example task in documentation (Issue #902).
  526. - Eventlet fixed so that the environment is patched as soon as possible.
  527. - eventlet: Now warns if celery related modules that depends on threads
  528. are imported before eventlet is patched.
  529. - Improved event and camera examples in the monitoring guide.
  530. - Disables celery command setuptools entrypoints if the command can't be
  531. loaded.
  532. - Fixed broken ``dump_request`` example in the tasks guide.
  533. .. _version-3.0.5:
  534. 3.0.5
  535. =====
  536. :release-date: 2012-08-01 04:00 P.M BST
  537. - Now depends on kombu 2.3.1 + billiard 2.7.3.11
  538. - Fixed a bug with the -B option (``cannot pickle thread.lock objects``)
  539. (Issue #894 + Issue #892, + django-celery #154).
  540. - The :control:`restart_pool` control command now requires the
  541. :setting:`CELERYD_POOL_RESTARTS` setting to be enabled
  542. This change was necessary as the multiprocessing event that the restart
  543. command depends on is responsible for creating many semaphores/file
  544. descriptors, resulting in problems in some environments.
  545. - ``chain.apply`` now passes args to the first task (Issue #889).
  546. - Documented previously secret options to the Django-Celery monitor
  547. in the monitoring userguide (Issue #396).
  548. - Old changelog are now organized in separate documents for each series,
  549. see :ref:`history`.
  550. .. _version-3.0.4:
  551. 3.0.4
  552. =====
  553. :release-date: 2012-07-26 07:00 P.M BST
  554. - Now depends on Kombu 2.3
  555. - New experimental standalone Celery monitor: Flower
  556. See :ref:`monitoring-flower` to read more about it!
  557. Contributed by Mher Movsisyan.
  558. - Now supports AMQP heartbeats if using the new ``pyamqp://`` transport.
  559. - The py-amqp transport requires the :mod:`amqp` library to be installed::
  560. $ pip install amqp
  561. - Then you need to set the transport URL prefix to ``pyamqp://``.
  562. - The default heartbeat value is 10 seconds, but this can be changed using
  563. the :setting:`BROKER_HEARTBEAT` setting::
  564. BROKER_HEARTBEAT = 5.0
  565. - If the broker heartbeat is set to 10 seconds, the heartbeats will be
  566. monitored every 5 seconds (double the hertbeat rate).
  567. See the `Kombu 2.3 changelog`_ for more information.
  568. .. _`Kombu 2.3 changelog`:
  569. http://kombu.readthedocs.org/en/latest/changelog.html#version-2-3-0
  570. - Now supports RabbitMQ Consumer Cancel Notifications, using the ``pyamqp://``
  571. transport.
  572. This is essential when running RabbitMQ in a cluster.
  573. See the `Kombu 2.3 changelog`_ for more information.
  574. - Delivery info is no longer passed directly through.
  575. It was discovered that the SQS transport adds objects that can't
  576. be pickled to the delivery info mapping, so we had to go back
  577. to using the whitelist again.
  578. Fixing this bug also means that the SQS transport is now working again.
  579. - The semaphore was not properly released when a task was revoked (Issue #877).
  580. This could lead to tasks being swallowed and not released until a worker
  581. restart.
  582. Thanks to Hynek Schlawack for debugging the issue.
  583. - Retrying a task now also forwards any linked tasks.
  584. This means that if a task is part of a chain (or linked in some other
  585. way) and that even if the task is retried, then the next task in the chain
  586. will be executed when the retry succeeds.
  587. - Chords: Now supports setting the interval and other keyword arguments
  588. to the chord unlock task.
  589. - The interval can now be set as part of the chord subtasks kwargs::
  590. chord(header)(body, interval=10.0)
  591. - In addition the chord unlock task now honors the Task.default_retry_delay
  592. option, used when none is specified, which also means that the default
  593. interval can also be changed using annotations:
  594. .. code-block:: python
  595. CELERY_ANNOTATIONS = {
  596. 'celery.chord_unlock': {
  597. 'default_retry_delay': 10.0,
  598. }
  599. }
  600. - New :meth:`@Celery.add_defaults` method can add new default configuration
  601. dicts to the applications configuration.
  602. For example::
  603. config = {'FOO': 10}
  604. celery.add_defaults(config)
  605. is the same as ``celery.conf.update(config)`` except that data will not be
  606. copied, and that it will not be pickled when the worker spawns child
  607. processes.
  608. In addition the method accepts a callable::
  609. def initialize_config():
  610. # insert heavy stuff that can't be done at import time here.
  611. celery.add_defaults(initialize_config)
  612. which means the same as the above except that it will not happen
  613. until the celery configuration is actually used.
  614. As an example, Celery can lazily use the configuration of a Flask app::
  615. flask_app = Flask()
  616. celery = Celery()
  617. celery.add_defaults(lambda: flask_app.config)
  618. - Revoked tasks were not marked as revoked in the result backend (Issue #871).
  619. Fix contributed by Hynek Schlawack.
  620. - Eventloop now properly handles the case when the epoll poller object
  621. has been closed (Issue #882).
  622. - Fixed syntax error in ``funtests/test_leak.py``
  623. Fix contributed by Catalin Iacob.
  624. - group/chunks: Now accepts empty task list (Issue #873).
  625. - New method names:
  626. - ``Celery.default_connection()`` ➠ :meth:`~@Celery.connection_or_acquire`.
  627. - ``Celery.default_producer()`` ➠ :meth:`~@Celery.producer_or_acquire`.
  628. The old names still work for backward compatibility.
  629. .. _version-3.0.3:
  630. 3.0.3
  631. =====
  632. :release-date: 2012-07-20 09:17 P.M BST
  633. :by: Ask Solem
  634. - amqplib passes the channel object as part of the delivery_info
  635. and it's not pickleable, so we now remove it.
  636. .. _version-3.0.2:
  637. 3.0.2
  638. =====
  639. :release-date: 2012-07-20 04:00 P.M BST
  640. :by: Ask Solem
  641. - A bug caused the following task options to not take defaults from the
  642. configuration (Issue #867 + Issue #858)
  643. The following settings were affected:
  644. - :setting:`CELERY_IGNORE_RESULT`
  645. - :setting:`CELERYD_SEND_TASK_ERROR_EMAILS`
  646. - :setting:`CELERY_TRACK_STARTED`
  647. - :setting:`CElERY_STORE_ERRORS_EVEN_IF_IGNORED`
  648. Fix contributed by John Watson.
  649. - Task Request: ``delivery_info`` is now passed through as-is (Issue #807).
  650. - The eta argument now supports datetime's with a timezone set (Issue #855).
  651. - The worker's banner displayed the autoscale settings in the wrong order
  652. (Issue #859).
  653. - Extension commands are now loaded after concurrency is set up
  654. so that they don't interfere with e.g. eventlet patching.
  655. - Fixed bug in the threaded pool (Issue #863)
  656. - The task failure handler mixed up the fields in :func:`sys.exc_info`.
  657. Fix contributed by Rinat Shigapov.
  658. - Fixed typos and wording in the docs.
  659. Fix contributed by Paul McMillan
  660. - New setting: :setting:`CELERY_WORKER_DIRECT`
  661. If enabled each worker will consume from their own dedicated queue
  662. which can be used to route tasks to specific workers.
  663. - Fixed several edge case bugs in the add consumer remote control command.
  664. - :mod:`~celery.contrib.migrate`: Can now filter and move tasks to specific
  665. workers if :setting:`CELERY_WORKER_DIRECT` is enabled.
  666. Among other improvements, the following functions have been added:
  667. * ``move_direct(filterfun, **opts)``
  668. * ``move_direct_by_id(task_id, worker_hostname, **opts)``
  669. * ``move_direct_by_idmap({task_id: worker_hostname, ...}, **opts)``
  670. * ``move_direct_by_taskmap({task_name: worker_hostname, ...}, **opts)``
  671. - :meth:`~celery.Celery.default_connection` now accepts a pool argument that
  672. if set to false causes a new connection to be created instead of acquiring
  673. one from the pool.
  674. - New signal: :signal:`celeryd_after_setup`.
  675. - Default loader now keeps lowercase attributes from the configuration module.
  676. .. _version-3.0.1:
  677. 3.0.1
  678. =====
  679. :release-date: 2012-07-10 06:00 P.M BST
  680. :by: Ask Solem
  681. - Now depends on kombu 2.2.5
  682. - inspect now supports limit argument::
  683. myapp.control.inspect(limit=1).ping()
  684. - Beat: now works with timezone aware datetime's.
  685. - Task classes inheriting ``from celery import Task``
  686. mistakingly enabled ``accept_magic_kwargs``.
  687. - Fixed bug in ``inspect scheduled`` (Issue #829).
  688. - Beat: Now resets the schedule to upgrade to UTC.
  689. - The :program:`celery worker` command now works with eventlet/gevent.
  690. Previously it would not patch the environment early enough.
  691. - The :program:`celery` command now supports extension commands
  692. using setuptools entry-points.
  693. Libraries can add additional commands to the :program:`celery`
  694. command by adding an entry-point like::
  695. setup(
  696. entry_points=[
  697. 'celery.commands': [
  698. 'foo = my.module:Command',
  699. ],
  700. ],
  701. ...)
  702. The command must then support the interface of
  703. :class:`celery.bin.base.Command`.
  704. - contrib.migrate: New utilities to move tasks from one queue to another.
  705. - :func:`~celery.contrib.migrate.move_tasks`
  706. - :func:`~celery.contrib.migrate.move_task_by_id`
  707. - The :event:`task-sent` event now contains ``exchange`` and ``routing_key``
  708. fields.
  709. - Fixes bug with installing on Python 3.
  710. Fix contributed by Jed Smith.
  711. .. _version-3.0.0:
  712. 3.0.0 (Chiastic Slide)
  713. ======================
  714. :release-date: 2012-07-07 01:30 P.M BST
  715. :by: Ask Solem
  716. See :ref:`whatsnew-3.0`.