Changelog 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675
  1. ================
  2. Change history
  3. ================
  4. 1.2.0 [xxxx-xx-xx xx:xx x.x xxxx]
  5. =================================
  6. Upgrading for Django-users
  7. --------------------------
  8. Django integration has been moved to a separate package: `django-celery`_.
  9. To upgrade you need to install the `django-celery`_ module and change::
  10. INSTALLED_APPS = "celery"
  11. to:
  12. INSTALLED_APPS = "djcelery"
  13. The following modules has been moved to `django-celery`_:
  14. ===================================== =====================================
  15. **Module name** **Replace with**
  16. ===================================== =====================================
  17. ``celery.models`` ``djcelery.models``
  18. ``celery.managers`` ``djcelery.managers``
  19. ``celery.views`` ``djcelery.views``
  20. ``celery.urls`` ``djcelery.url``
  21. ``celery.management`` ``djcelery.management``
  22. ``celery.loaders.djangoapp`` ``djcelery.loaders``
  23. ``celery.backends.database`` ``djcelery.backends.database``
  24. ``celery.backends.cache`` ``djcelery.backends.cache``
  25. ===================================== =====================================
  26. Importing ``djcelery`` will automatically setup celery to use the Django
  27. loader by setting the :env:`CELERY_LOADER`` environment variable (it won't
  28. change it if it's already defined).
  29. When the Django loader is used, the "database" and "cache" backend aliases
  30. will point to the ``djcelery`` backends instead of the built-in backends.
  31. .. _`django-celery`: http://pypi.python.org/pypi/django-celery
  32. Upgrading for others
  33. --------------------
  34. The database backend is now using `SQLAlchemy`_ instead of the Django ORM,
  35. see `Supported Databases`_ for a table of supported databases.
  36. The ``DATABASE_*`` settings has been replaced by a single setting:
  37. ``CELERY_RESULT_DBURI``. The value here should be an `SQLAlchemy Connection
  38. String`_, some examples include:
  39. .. code-block:: python
  40. # sqlite (filename)
  41. CELERY_RESULT_DBURI = "sqlite:///celerydb.sqlite"
  42. # mysql
  43. CELERY_RESULT_DBURI = "mysql://scott:tiger@localhost/foo"
  44. # postgresql
  45. CELERY_RESULT_DBURI = "postgresql://scott:tiger@localhost/mydatabase"
  46. # oracle
  47. CELERY_RESULT_DBURI = "oracle://scott:tiger@127.0.0.1:1521/sidname"
  48. See `SQLAlchemy Connection Strings`_ for more information about connection
  49. strings.
  50. To specify additional SQLAlchemy database engine options you can use
  51. the ``CELERY_RESULT_ENGINE_OPTIONS`` setting::
  52. # echo enables verbose logging from SQLAlchemy.
  53. CELERY_RESULT_ENGINE_OPTIONS = {"echo": True}
  54. .. _`Supported Databases`:
  55. http://www.sqlalchemy.org/docs/dbengine.html#supported-databases
  56. .. _`SQLAlchemy Connection String`:
  57. http://www.sqlalchemy.org/docs/dbengine.html#create-engine-url-arguments
  58. .. _`SQLAlchemy Connection Strings`:
  59. http://www.sqlalchemy.org/docs/dbengine.html#create-engine-url-arguments
  60. Backward incompatible changes
  61. -----------------------------
  62. * The following deprecated settings has been removed (as scheduled by
  63. the `deprecation timeline`_):
  64. ===================================== =====================================
  65. **Setting name** **Replace with**
  66. ===================================== =====================================
  67. ``CELERY_AMQP_CONSUMER_QUEUES`` ``CELERY_QUEUES``
  68. ``CELERY_AMQP_CONSUMER_QUEUES`` ``CELERY_QUEUES``
  69. ``CELERY_AMQP_EXCHANGE`` ``CELERY_DEFAULT_EXCHANGE``
  70. ``CELERY_AMQP_EXCHANGE_TYPE`` ``CELERY_DEFAULT_AMQP_EXCHANGE_TYPE``
  71. ``CELERY_AMQP_CONSUMER_ROUTING_KEY`` ``CELERY_QUEUES``
  72. ``CELERY_AMQP_PUBLISHER_ROUTING_KEY`` ``CELERY_DEFAULT_ROUTING_KEY``
  73. ===================================== =====================================
  74. .. _`deprecation timeline`:
  75. http://ask.github.com/celery/internals/deprecation.html
  76. * The ``celery.task.rest`` module has been removed, use ``celery.task.http``
  77. instead (as scheduled by the `deprecation timeline`_).
  78. * It's no longer allowed to skip the class name in loader names.
  79. (as scheduled by the `deprecation timeline`_):
  80. Assuming the implicit ``Loader`` class name is no longer supported,
  81. if you use e.g.::
  82. CELERY_LOADER = "myapp.loaders"
  83. You need to include the loader class name, like this::
  84. CELERY_LOADER = "myapp.loaders.Loader"
  85. 1.0.3 [2010-05-15 03:00 P.M CEST]
  86. =================================
  87. Important notes
  88. ---------------
  89. * Messages are now acked *just before* the task function is executed.
  90. This is the behavior we've wanted all along, but couldn't have because of
  91. limitations in the multiprocessing module.
  92. The previous behavior was not good, and the situation worsened with the
  93. release of 1.0.1, so this change will definitely improve
  94. reliability, performance and operations in general.
  95. For more information please see http://bit.ly/9hom6T
  96. * Database result backend: result now explicitly sets ``null=True`` as
  97. ``django-picklefield`` version 0.1.5 changed the default behavior
  98. right under our noses :(
  99. See: http://bit.ly/d5OwMr
  100. This means those who created their celery tables (via syncdb or
  101. celeryinit) with picklefield versions >= 0.1.5 has to alter their tables to
  102. allow the result field to be ``NULL`` manually.
  103. MySQL::
  104. ALTER TABLE celery_taskmeta MODIFY result TEXT NULL
  105. * Removed ``Task.rate_limit_queue_type``, as it was not really useful
  106. and made it harder to refactor some parts.
  107. * Now depends on carrot >= 0.10.4
  108. * Now depends on billiard >= 0.3.0
  109. News
  110. ----
  111. * AMQP backend: Added timeout support for ``result.get()`` /
  112. ``result.wait()``.
  113. * New task option: ``Task.acks_late`` (default: ``CELERY_ACKS_LATE``)
  114. Late ack means the task messages will be acknowledged **after** the task
  115. has been executed, not *just before*, which is the default behavior.
  116. Note that this means the tasks may be executed twice if the worker
  117. crashes in the middle of their execution. Not acceptable for most
  118. applications, but desirable for others.
  119. * Added crontab-like scheduling to periodic tasks.
  120. Like a cron job, you can specify units of time of when
  121. you would like the task to execute. While not a full implementation
  122. of cron's features, it should provide a fair degree of common scheduling
  123. needs.
  124. You can specify a minute (0-59), an hour (0-23), and/or a day of the
  125. week (0-6 where 0 is Sunday, or by names: sun, mon, tue, wed, thu, fri,
  126. sat).
  127. Examples:
  128. .. code-block:: python
  129. from celery.task.schedules import crontab
  130. from celery.decorators import periodic_task
  131. @periodic_task(run_every=crontab(hour=7, minute=30))
  132. def every_morning():
  133. print("Runs every morning at 7:30a.m")
  134. @periodic_task(run_every=crontab(hour=7, minute=30, day_of_week="mon"))
  135. def every_monday_morning():
  136. print("Run every monday morning at 7:30a.m")
  137. @periodic_task(run_every=crontab(minutes=30))
  138. def every_hour():
  139. print("Runs every hour on the clock. e.g. 1:30, 2:30, 3:30 etc.")
  140. Note that this a late addition. While we have unittests, due to the
  141. nature of this feature we haven't been able to completely test this
  142. in practice, so consider this experimental.
  143. * ``TaskPool.apply_async``: Now supports the ``accept_callback`` argument.
  144. * ``apply_async``: Now raises :exc:`ValueError` if task args is not a list,
  145. or kwargs is not a tuple (http://github.com/ask/celery/issues/issue/95).
  146. * ``Task.max_retries`` can now be ``None``, which means it will retry forever.
  147. * Celerybeat: Now reuses the same connection when publishing large
  148. sets of tasks.
  149. * Modified the task locking example in the documentation to use
  150. ``cache.add`` for atomic locking.
  151. * Added experimental support for a *started* status on tasks.
  152. If ``Task.track_started`` is enabled the task will report its status
  153. as "started" when the task is executed by a worker.
  154. The default value is ``False`` as the normal behaviour is to not
  155. report that level of granularity. Tasks are either pending, finished,
  156. or waiting to be retried. Having a "started" status can be useful for
  157. when there are long running tasks and there is a need to report which
  158. task is currently running.
  159. The global default can be overridden by the ``CELERY_TRACK_STARTED``
  160. setting.
  161. * User Guide: New section ``Tips and Best Practices``.
  162. Contributions welcome!
  163. Remote control commands
  164. -----------------------
  165. * Remote control commands can now send replies back to the caller.
  166. Existing commands has been improved to send replies, and the client
  167. interface in ``celery.task.control`` has new keyword arguments: ``reply``,
  168. ``timeout`` and ``limit``. Where reply means it will wait for replies,
  169. timeout is the time in seconds to stop waiting for replies, and limit
  170. is the maximum number of replies to get.
  171. By default, it will wait for as many replies as possible for one second.
  172. * rate_limit(task_name, destination=all, reply=False, timeout=1, limit=0)
  173. Worker returns ``{"ok": message}`` on success,
  174. or ``{"failure": message}`` on failure.
  175. >>> from celery.task.control import rate_limit
  176. >>> rate_limit("tasks.add", "10/s", reply=True)
  177. [{'worker1': {'ok': 'new rate limit set successfully'}},
  178. {'worker2': {'ok': 'new rate limit set successfully'}}]
  179. * ping(destination=all, reply=False, timeout=1, limit=0)
  180. Worker returns the simple message ``"pong"``.
  181. >>> from celery.task.control import ping
  182. >>> ping(reply=True)
  183. [{'worker1': 'pong'},
  184. {'worker2': 'pong'},
  185. * revoke(destination=all, reply=False, timeout=1, limit=0)
  186. Worker simply returns ``True``.
  187. >>> from celery.task.control import revoke
  188. >>> revoke("419e46eb-cf6a-4271-86a8-442b7124132c", reply=True)
  189. [{'worker1': True},
  190. {'worker2'; True}]
  191. * You can now add your own remote control commands!
  192. Remote control commands are functions registered in the command
  193. registry. Registering a command is done using
  194. :meth:`celery.worker.control.Panel.register`:
  195. .. code-block:: python
  196. from celery.task.control import Panel
  197. @Panel.register
  198. def reset_broker_connection(panel, **kwargs):
  199. panel.listener.reset_connection()
  200. return {"ok": "connection re-established"}
  201. With this module imported in the worker, you can launch the command
  202. using ``celery.task.control.broadcast``::
  203. >>> from celery.task.control import broadcast
  204. >>> broadcast("reset_broker_connection", reply=True)
  205. [{'worker1': {'ok': 'connection re-established'},
  206. {'worker2': {'ok': 'connection re-established'}}]
  207. **TIP** You can choose the worker(s) to receive the command
  208. by using the ``destination`` argument::
  209. >>> broadcast("reset_broker_connection", destination=["worker1"])
  210. [{'worker1': {'ok': 'connection re-established'}]
  211. * New remote control command: ``dump_reserved``
  212. Dumps tasks reserved by the worker, waiting to be executed::
  213. >>> from celery.task.control import broadcast
  214. >>> broadcast("dump_reserved", reply=True)
  215. [{'myworker1': [<TaskWrapper ....>]}]
  216. * New remote control command: ``dump_schedule``
  217. Dumps the workers currently registered ETA schedule.
  218. These are tasks with an ``eta`` (or ``countdown``) argument
  219. waiting to be executed by the worker.
  220. >>> from celery.task.control import broadcast
  221. >>> broadcast("dump_schedule", reply=True)
  222. [{'w1': []},
  223. {'w3': []},
  224. {'w2': ['0. 2010-05-12 11:06:00 pri0 <TaskWrapper:
  225. {name:"opalfeeds.tasks.refresh_feed_slice",
  226. id:"95b45760-4e73-4ce8-8eac-f100aa80273a",
  227. args:"(<Feeds freq_max:3600 freq_min:60
  228. start:2184.0 stop:3276.0>,)",
  229. kwargs:"{'page': 2}"}>']},
  230. {'w4': ['0. 2010-05-12 11:00:00 pri0 <TaskWrapper:
  231. {name:"opalfeeds.tasks.refresh_feed_slice",
  232. id:"c053480b-58fb-422f-ae68-8d30a464edfe",
  233. args:"(<Feeds freq_max:3600 freq_min:60
  234. start:1092.0 stop:2184.0>,)",
  235. kwargs:"{\'page\': 1}"}>',
  236. '1. 2010-05-12 11:12:00 pri0 <TaskWrapper:
  237. {name:"opalfeeds.tasks.refresh_feed_slice",
  238. id:"ab8bc59e-6cf8-44b8-88d0-f1af57789758",
  239. args:"(<Feeds freq_max:3600 freq_min:60
  240. start:3276.0 stop:4365>,)",
  241. kwargs:"{\'page\': 3}"}>']}]
  242. Fixes
  243. -----
  244. * Mediator thread no longer blocks for more than 1 second.
  245. With rate limits enabled and when there was a lot of remaining time,
  246. the mediator thread could block shutdown (and potentially block other
  247. jobs from coming in).
  248. * Remote rate limits was not properly applied
  249. (http://github.com/ask/celery/issues/issue/98)
  250. * Now handles exceptions with unicode messages correctly in
  251. ``TaskWrapper.on_failure``.
  252. * Database backend: ``TaskMeta.result``: default value should be ``None``
  253. not empty string.
  254. 1.0.2 [2010-03-31 12:50 P.M CET]
  255. ================================
  256. * Deprecated: ``CELERY_BACKEND``, please use ``CELERY_RESULT_BACKEND``
  257. instead.
  258. * We now use a custom logger in tasks. This logger supports task magic
  259. keyword arguments in formats.
  260. The default format for tasks (``CELERYD_TASK_LOG_FORMAT``) now includes
  261. the id and the name of tasks so the origin of task log messages can
  262. easily be traced.
  263. Example output::
  264. [2010-03-25 13:11:20,317: INFO/PoolWorker-1]
  265. [tasks.add(a6e1c5ad-60d9-42a0-8b24-9e39363125a4)] Hello from add
  266. To revert to the previous behavior you can set::
  267. CELERYD_TASK_LOG_FORMAT = """
  268. [%(asctime)s: %(levelname)s/%(processName)s] %(message)s
  269. """.strip()
  270. * Unittests: Don't disable the django test database teardown,
  271. instead fixed the underlying issue which was caused by modifications
  272. to the ``DATABASE_NAME`` setting (http://github.com/ask/celery/issues/82).
  273. * Django Loader: New config ``CELERY_DB_REUSE_MAX`` (max number of tasks
  274. to reuse the same database connection)
  275. The default is to use a new connection for every task.
  276. We would very much like to reuse the connection, but a safe number of
  277. reuses is not known, and we don't have any way to handle the errors
  278. that might happen, which may even be database dependent.
  279. See: http://bit.ly/94fwdd
  280. * celeryd: The worker components are now configurable: ``CELERYD_POOL``,
  281. ``CELERYD_LISTENER``, ``CELERYD_MEDIATOR``, and ``CELERYD_ETA_SCHEDULER``.
  282. The default configuration is as follows:
  283. .. code-block:: python
  284. CELERYD_POOL = "celery.worker.pool.TaskPool"
  285. CELERYD_MEDIATOR = "celery.worker.controllers.Mediator"
  286. CELERYD_ETA_SCHEDULER = "celery.worker.controllers.ScheduleController"
  287. CELERYD_LISTENER = "celery.worker.listener.CarrotListener"
  288. The ``CELERYD_POOL`` setting makes it easy to swap out the multiprocessing
  289. pool with a threaded pool, or how about a twisted/eventlet pool?
  290. Consider the competition for the first pool plug-in started!
  291. * Debian init scripts: Use ``-a`` not ``&&``
  292. (http://github.com/ask/celery/issues/82).
  293. * Debian init scripts: Now always preserves ``$CELERYD_OPTS`` from the
  294. ``/etc/default/celeryd`` and ``/etc/default/celerybeat``.
  295. * celery.beat.Scheduler: Fixed a bug where the schedule was not properly
  296. flushed to disk if the schedule had not been properly initialized.
  297. * celerybeat: Now syncs the schedule to disk when receiving the ``SIGTERM``
  298. and ``SIGINT`` signals.
  299. * Control commands: Make sure keywords arguments are not in unicode.
  300. * ETA scheduler: Was missing a logger object, so the scheduler crashed
  301. when trying to log that a task had been revoked.
  302. * management.commands.camqadm: Fixed typo ``camqpadm`` -> ``camqadm``
  303. (http://github.com/ask/celery/issues/83).
  304. * PeriodicTask.delta_resolution: Was not working for days and hours, now fixed
  305. by rounding to the nearest day/hour.
  306. * Fixed a potential infinite loop in ``BaseAsyncResult.__eq__``, although
  307. there is no evidence that it has ever been triggered.
  308. * celeryd: Now handles messages with encoding problems by acking them and
  309. emitting an error message.
  310. 1.0.1 [2010-02-24 07:05 P.M CET]
  311. ================================
  312. * Tasks are now acknowledged early instead of late.
  313. This is done because messages can only be acked within the same
  314. connection channel, so if the connection is lost we would have to refetch
  315. the message again to acknowledge it.
  316. This might or might not affect you, but mostly those running tasks with a
  317. really long execution time are affected, as all tasks that has made it
  318. all the way into the pool needs to be executed before the worker can
  319. safely terminate (this is at most the number of pool workers, multiplied
  320. by the ``CELERYD_PREFETCH_MULTIPLIER`` setting.)
  321. We multiply the prefetch count by default to increase the performance at
  322. times with bursts of tasks with a short execution time. If this doesn't
  323. apply to your use case, you should be able to set the prefetch multiplier
  324. to zero, without sacrificing performance.
  325. Please note that a patch to :mod:`multiprocessing` is currently being
  326. worked on, this patch would enable us to use a better solution, and is
  327. scheduled for inclusion in the ``1.2.0`` release.
  328. * celeryd now shutdowns cleanly when receving the ``TERM`` signal.
  329. * celeryd now does a cold shutdown if the ``INT`` signal is received (Ctrl+C),
  330. this means it tries to terminate as soon as possible.
  331. * Caching of results now moved to the base backend classes, so no need
  332. to implement this functionality in the base classes.
  333. * Caches are now also limited in size, so their memory usage doesn't grow
  334. out of control.
  335. You can set the maximum number of results the cache
  336. can hold using the ``CELERY_MAX_CACHED_RESULTS`` setting (the default
  337. is five thousand results). In addition, you can refetch already retrieved
  338. results using ``backend.reload_task_result`` +
  339. ``backend.reload_taskset_result`` (that's for those who want to send
  340. results incrementally).
  341. * ``celeryd`` now works on Windows again.
  342. Note that if running with Django,
  343. you can't use ``project.settings`` as the settings module name, but the
  344. following should work::
  345. $ python manage.py celeryd --settings=settings
  346. * Execution: ``.messaging.TaskPublisher.send_task`` now
  347. incorporates all the functionality apply_async previously did.
  348. Like converting countdowns to eta, so :func:`celery.execute.apply_async` is
  349. now simply a convenient front-end to
  350. :meth:`celery.messaging.TaskPublisher.send_task`, using
  351. the task classes default options.
  352. Also :func:`celery.execute.send_task` has been
  353. introduced, which can apply tasks using just the task name (useful
  354. if the client does not have the destination task in its task registry).
  355. Example:
  356. >>> from celery.execute import send_task
  357. >>> result = send_task("celery.ping", args=[], kwargs={})
  358. >>> result.get()
  359. 'pong'
  360. * ``camqadm``: This is a new utility for command line access to the AMQP API.
  361. Excellent for deleting queues/bindings/exchanges, experimentation and
  362. testing::
  363. $ camqadm
  364. 1> help
  365. Gives an interactive shell, type ``help`` for a list of commands.
  366. When using Django, use the management command instead::
  367. $ python manage.py camqadm
  368. 1> help
  369. * Redis result backend: To conform to recent Redis API changes, the following
  370. settings has been deprecated:
  371. * ``REDIS_TIMEOUT``
  372. * ``REDIS_CONNECT_RETRY``
  373. These will emit a ``DeprecationWarning`` if used.
  374. A ``REDIS_PASSWORD`` setting has been added, so you can use the new
  375. simple authentication mechanism in Redis.
  376. * The redis result backend no longer calls ``SAVE`` when disconnecting,
  377. as this is apparently better handled by Redis itself.
  378. * If ``settings.DEBUG`` is on, celeryd now warns about the possible
  379. memory leak it can result in.
  380. * The ETA scheduler now sleeps at most two seconds between iterations.
  381. * The ETA scheduler now deletes any revoked tasks it might encounter.
  382. As revokes are not yet persistent, this is done to make sure the task
  383. is revoked even though it's currently being hold because its eta is e.g.
  384. a week into the future.
  385. * The ``task_id`` argument is now respected even if the task is executed
  386. eagerly (either using apply, or ``CELERY_ALWAYS_EAGER``).
  387. * The internal queues are now cleared if the connection is reset.
  388. * New magic keyword argument: ``delivery_info``.
  389. Used by retry() to resend the task to its original destination using the same
  390. exchange/routing_key.
  391. * Events: Fields was not passed by ``.send()`` (fixes the uuid keyerrors
  392. in celerymon)
  393. * Added ``--schedule``/``-s`` option to celeryd, so it is possible to
  394. specify a custom schedule filename when using an embedded celerybeat
  395. server (the ``-B``/``--beat``) option.
  396. * Better Python 2.4 compatibility. The test suite now passes.
  397. * task decorators: Now preserve docstring as ``cls.__doc__``, (was previously
  398. copied to ``cls.run.__doc__``)
  399. * The ``testproj`` directory has been renamed to ``tests`` and we're now using
  400. ``nose`` + ``django-nose`` for test discovery, and ``unittest2`` for test
  401. cases.
  402. * New pip requirements files available in ``contrib/requirements``.
  403. * TaskPublisher: Declarations are now done once (per process).
  404. * Added ``Task.delivery_mode`` and the ``CELERY_DEFAULT_DELIVERY_MODE``
  405. setting.
  406. These can be used to mark messages non-persistent (i.e. so they are
  407. lost if the broker is restarted).
  408. * Now have our own ``ImproperlyConfigured`` exception, instead of using the
  409. Django one.
  410. * Improvements to the debian init scripts: Shows an error if the program is
  411. not executeable. Does not modify ``CELERYD`` when using django with
  412. virtualenv.
  413. 1.0.0 [2010-02-10 04:00 P.M CET]
  414. ================================
  415. BACKWARD INCOMPATIBLE CHANGES
  416. -----------------------------
  417. * Celery does not support detaching anymore, so you have to use the tools
  418. available on your platform, or something like supervisord to make
  419. celeryd/celerybeat/celerymon into background processes.
  420. We've had too many problems with celeryd daemonizing itself, so it was
  421. decided it has to be removed. Example startup scripts has been added to
  422. ``contrib/``:
  423. * Debian, Ubuntu, (start-stop-daemon)
  424. ``contrib/debian/init.d/celeryd``
  425. ``contrib/debian/init.d/celerybeat``
  426. * Mac OS X launchd
  427. ``contrib/mac/org.celeryq.celeryd.plist``
  428. ``contrib/mac/org.celeryq.celerybeat.plist``
  429. ``contrib/mac/org.celeryq.celerymon.plist``
  430. * Supervisord (http://supervisord.org)
  431. ``contrib/supervisord/supervisord.conf``
  432. In addition to ``--detach``, the following program arguments has been
  433. removed: ``--uid``, ``--gid``, ``--workdir``, ``--chroot``, ``--pidfile``,
  434. ``--umask``. All good daemonization tools should support equivalent
  435. functionality, so don't worry.
  436. Also the following configuration keys has been removed:
  437. ``CELERYD_PID_FILE``, ``CELERYBEAT_PID_FILE``, ``CELERYMON_PID_FILE``.
  438. * Default celeryd loglevel is now ``WARN``, to enable the previous log level
  439. start celeryd with ``--loglevel=INFO``.
  440. * Tasks are automatically registered.
  441. This means you no longer have to register your tasks manually.
  442. You don't have to change your old code right away, as it doesn't matter if
  443. a task is registered twice.
  444. If you don't want your task to be automatically registered you can set
  445. the ``abstract`` attribute
  446. .. code-block:: python
  447. class MyTask(Task):
  448. abstract = True
  449. By using ``abstract`` only tasks subclassing this task will be automatically
  450. registered (this works like the Django ORM).
  451. If you don't want subclasses to be registered either, you can set the
  452. ``autoregister`` attribute to ``False``.
  453. Incidentally, this change also fixes the problems with automatic name
  454. assignment and relative imports. So you also don't have to specify a task name
  455. anymore if you use relative imports.
  456. * You can no longer use regular functions as tasks.
  457. This change was added
  458. because it makes the internals a lot more clean and simple. However, you can
  459. now turn functions into tasks by using the ``@task`` decorator:
  460. .. code-block:: python
  461. from celery.decorators import task
  462. @task
  463. def add(x, y):
  464. return x + y
  465. See the User Guide: :doc:`userguide/tasks` for more information.
  466. * The periodic task system has been rewritten to a centralized solution.
  467. This means ``celeryd`` no longer schedules periodic tasks by default,
  468. but a new daemon has been introduced: ``celerybeat``.
  469. To launch the periodic task scheduler you have to run celerybeat::
  470. $ celerybeat
  471. Make sure this is running on one server only, if you run it twice, all
  472. periodic tasks will also be executed twice.
  473. If you only have one worker server you can embed it into celeryd like this::
  474. $ celeryd --beat # Embed celerybeat in celeryd.
  475. * The supervisor has been removed.
  476. This means the ``-S`` and ``--supervised`` options to ``celeryd`` is
  477. no longer supported. Please use something like http://supervisord.org
  478. instead.
  479. * ``TaskSet.join`` has been removed, use ``TaskSetResult.join`` instead.
  480. * The task status ``"DONE"`` has been renamed to `"SUCCESS"`.
  481. * ``AsyncResult.is_done`` has been removed, use ``AsyncResult.successful``
  482. instead.
  483. * The worker no longer stores errors if ``Task.ignore_result`` is set, to
  484. revert to the previous behaviour set
  485. ``CELERY_STORE_ERRORS_EVEN_IF_IGNORED`` to ``True``.
  486. * The staticstics functionality has been removed in favor of events,
  487. so the ``-S`` and ``--statistics`` switches has been removed.
  488. * The module ``celery.task.strategy`` has been removed.
  489. * ``celery.discovery`` has been removed, and it's ``autodiscover`` function is
  490. now in ``celery.loaders.djangoapp``. Reason: Internal API.
  491. * ``CELERY_LOADER`` now needs loader class name in addition to module name,
  492. E.g. where you previously had: ``"celery.loaders.default"``, you now need
  493. ``"celery.loaders.default.Loader"``, using the previous syntax will result
  494. in a DeprecationWarning.
  495. * Detecting the loader is now lazy, and so is not done when importing
  496. ``celery.loaders``.
  497. To make this happen ``celery.loaders.settings`` has
  498. been renamed to ``load_settings`` and is now a function returning the
  499. settings object. ``celery.loaders.current_loader`` is now also
  500. a function, returning the current loader.
  501. So::
  502. loader = current_loader
  503. needs to be changed to::
  504. loader = current_loader()
  505. DEPRECATIONS
  506. ------------
  507. * The following configuration variables has been renamed and will be
  508. deprecated in v1.2:
  509. * CELERYD_DAEMON_LOG_FORMAT -> CELERYD_LOG_FORMAT
  510. * CELERYD_DAEMON_LOG_LEVEL -> CELERYD_LOG_LEVEL
  511. * CELERY_AMQP_CONNECTION_TIMEOUT -> CELERY_BROKER_CONNECTION_TIMEOUT
  512. * CELERY_AMQP_CONNECTION_RETRY -> CELERY_BROKER_CONNECTION_RETRY
  513. * CELERY_AMQP_CONNECTION_MAX_RETRIES -> CELERY_BROKER_CONNECTION_MAX_RETRIES
  514. * SEND_CELERY_TASK_ERROR_EMAILS -> CELERY_SEND_TASK_ERROR_EMAILS
  515. * The public api names in celery.conf has also changed to a consistent naming
  516. scheme.
  517. * We now support consuming from an arbitrary number of queues.
  518. To do this we had to rename the configuration syntax. If you use any of
  519. the custom AMQP routing options (queue/exchange/routing_key, etc), you
  520. should read the new FAQ entry: http://bit.ly/aiWoH.
  521. The previous syntax is deprecated and scheduled for removal in v1.2.
  522. * ``TaskSet.run`` has been renamed to ``TaskSet.apply_async``.
  523. ``TaskSet.run`` has now been deprecated, and is scheduled for
  524. removal in v1.2.
  525. NEWS
  526. ----
  527. * Rate limiting support (per task type, or globally).
  528. * New periodic task system.
  529. * Automatic registration.
  530. * New cool task decorator syntax.
  531. * celeryd now sends events if enabled with the ``-E`` argument.
  532. Excellent for monitoring tools, one is already in the making
  533. (http://github.com/ask/celerymon).
  534. Current events include: worker-heartbeat,
  535. task-[received/succeeded/failed/retried],
  536. worker-online, worker-offline.
  537. * You can now delete (revoke) tasks that has already been applied.
  538. * You can now set the hostname celeryd identifies as using the ``--hostname``
  539. argument.
  540. * Cache backend now respects ``CELERY_TASK_RESULT_EXPIRES``.
  541. * Message format has been standardized and now uses ISO-8601 format
  542. for dates instead of datetime.
  543. * ``celeryd`` now responds to the ``HUP`` signal by restarting itself.
  544. * Periodic tasks are now scheduled on the clock.
  545. I.e. ``timedelta(hours=1)`` means every hour at :00 minutes, not every
  546. hour from the server starts. To revert to the previous behaviour you
  547. can set ``PeriodicTask.relative = True``.
  548. * Now supports passing execute options to a TaskSets list of args, e.g.:
  549. >>> ts = TaskSet(add, [([2, 2], {}, {"countdown": 1}),
  550. ... ([4, 4], {}, {"countdown": 2}),
  551. ... ([8, 8], {}, {"countdown": 3})])
  552. >>> ts.run()
  553. * Got a 3x performance gain by setting the prefetch count to four times the
  554. concurrency, (from an average task round-trip of 0.1s to 0.03s!).
  555. A new setting has been added: ``CELERYD_PREFETCH_MULTIPLIER``, which
  556. is set to ``4`` by default.
  557. * Improved support for webhook tasks.
  558. ``celery.task.rest`` is now deprecated, replaced with the new and shiny
  559. :mod:`celery.task.http`. With more reflective names, sensible interface,
  560. and it's possible to override the methods used to perform HTTP requests.
  561. * The results of tasksets are now cached by storing it in the result
  562. backend.
  563. CHANGES
  564. -------
  565. * Now depends on carrot >= 0.8.1
  566. * New dependencies: billiard, python-dateutil, django-picklefield
  567. * No longer depends on python-daemon
  568. * The ``uuid`` distribution is added as a dependency when running Python 2.4.
  569. * Now remembers the previously detected loader by keeping it in
  570. the ``CELERY_LOADER`` environment variable.
  571. This may help on windows where fork emulation is used.
  572. * ETA no longer sends datetime objects, but uses ISO 8601 date format in a
  573. string for better compatibility with other platforms.
  574. * No longer sends error mails for retried tasks.
  575. * Task can now override the backend used to store results.
  576. * Refactored the ExecuteWrapper, ``apply`` and ``CELERY_ALWAYS_EAGER`` now
  577. also executes the task callbacks and signals.
  578. * Now using a proper scheduler for the tasks with an ETA.
  579. This means waiting eta tasks are sorted by time, so we don't have
  580. to poll the whole list all the time.
  581. * Now also imports modules listed in CELERY_IMPORTS when running
  582. with django (as documented).
  583. * Loglevel for stdout/stderr changed from INFO to ERROR
  584. * ImportErrors are now properly propogated when autodiscovering tasks.
  585. * You can now use ``celery.messaging.establish_connection`` to establish a
  586. connection to the broker.
  587. * When running as a separate service the periodic task scheduler does some
  588. smart moves to not poll too regularly.
  589. If you need faster poll times you can lower the value
  590. of ``CELERYBEAT_MAX_LOOP_INTERVAL``.
  591. * You can now change periodic task intervals at runtime, by making
  592. ``run_every`` a property, or subclassing ``PeriodicTask.is_due``.
  593. * The worker now supports control commands enabled through the use of a
  594. broadcast queue, you can remotely revoke tasks or set the rate limit for
  595. a task type. See :mod:`celery.task.control`.
  596. * The services now sets informative process names (as shown in ``ps``
  597. listings) if the :mod:`setproctitle` module is installed.
  598. * :exc:`celery.exceptions.NotRegistered` now inherits from :exc:`KeyError`,
  599. and ``TaskRegistry.__getitem__``+``pop`` raises ``NotRegistered`` instead
  600. * You can set the loader via the ``CELERY_LOADER`` environment variable.
  601. * You can now set ``CELERY_IGNORE_RESULT`` to ignore task results by default
  602. (if enabled, tasks doesn't save results or errors to the backend used).
  603. * celeryd now correctly handles malformed messages by throwing away and
  604. acknowledging the message, instead of crashing.
  605. BUGS
  606. ----
  607. * Fixed a race condition that could happen while storing task results in the
  608. database.
  609. DOCUMENTATION
  610. -------------
  611. * Reference now split into two sections; API reference and internal module
  612. reference.
  613. 0.8.4 [2010-02-05 01:52 P.M CEST]
  614. ---------------------------------
  615. * Now emits a warning if the --detach argument is used.
  616. --detach should not be used anymore, as it has several not easily fixed
  617. bugs related to it. Instead, use something like start-stop-daemon,
  618. supervisord or launchd (os x).
  619. * Make sure logger class is process aware, even if running Python >= 2.6.
  620. * Error e-mails are not sent anymore when the task is retried.
  621. 0.8.3 [2009-12-22 09:43 A.M CEST]
  622. ---------------------------------
  623. * Fixed a possible race condition that could happen when storing/querying
  624. task results using the the database backend.
  625. * Now has console script entry points in the setup.py file, so tools like
  626. buildout will correctly install the programs celerybin and celeryinit.
  627. 0.8.2 [2009-11-20 03:40 P.M CEST]
  628. ---------------------------------
  629. * QOS Prefetch count was not applied properly, as it was set for every message
  630. received (which apparently behaves like, "receive one more"), instead of only
  631. set when our wanted value cahnged.
  632. 0.8.1 [2009-11-16 05:21 P.M CEST]
  633. =================================
  634. VERY IMPORTANT NOTE
  635. -------------------
  636. This release (with carrot 0.8.0) enables AMQP QoS (quality of service), which
  637. means the workers will only receive as many messages as it can handle at a
  638. time. As with any release, you should test this version upgrade on your
  639. development servers before rolling it out to production!
  640. IMPORTANT CHANGES
  641. -----------------
  642. * If you're using Python < 2.6 and you use the multiprocessing backport, then
  643. multiprocessing version 2.6.2.1 is required.
  644. * All AMQP_* settings has been renamed to BROKER_*, and in addition
  645. AMQP_SERVER has been renamed to BROKER_HOST, so before where you had::
  646. AMQP_SERVER = "localhost"
  647. AMQP_PORT = 5678
  648. AMQP_USER = "myuser"
  649. AMQP_PASSWORD = "mypassword"
  650. AMQP_VHOST = "celery"
  651. You need to change that to::
  652. BROKER_HOST = "localhost"
  653. BROKER_PORT = 5678
  654. BROKER_USER = "myuser"
  655. BROKER_PASSWORD = "mypassword"
  656. BROKER_VHOST = "celery"
  657. * Custom carrot backends now need to include the backend class name, so before
  658. where you had::
  659. CARROT_BACKEND = "mycustom.backend.module"
  660. you need to change it to::
  661. CARROT_BACKEND = "mycustom.backend.module.Backend"
  662. where ``Backend`` is the class name. This is probably ``"Backend"``, as
  663. that was the previously implied name.
  664. * New version requirement for carrot: 0.8.0
  665. CHANGES
  666. -------
  667. * Incorporated the multiprocessing backport patch that fixes the
  668. ``processName`` error.
  669. * Ignore the result of PeriodicTask's by default.
  670. * Added a Redis result store backend
  671. * Allow /etc/default/celeryd to define additional options for the celeryd init
  672. script.
  673. * MongoDB periodic tasks issue when using different time than UTC fixed.
  674. * Windows specific: Negate test for available os.fork (thanks miracle2k)
  675. * Now tried to handle broken PID files.
  676. * Added a Django test runner to contrib that sets CELERY_ALWAYS_EAGER = True for testing with the database backend
  677. * Added a CELERY_CACHE_BACKEND setting for using something other than the django-global cache backend.
  678. * Use custom implementation of functools.partial (curry) for Python 2.4 support
  679. (Probably still problems with running on 2.4, but it will eventually be
  680. supported)
  681. * Prepare exception to pickle when saving RETRY status for all backends.
  682. * SQLite no concurrency limit should only be effective if the db backend is used.
  683. 0.8.0 [2009-09-22 03:06 P.M CEST]
  684. =================================
  685. BACKWARD INCOMPATIBLE CHANGES
  686. -----------------------------
  687. * Add traceback to result value on failure.
  688. **NOTE** If you use the database backend you have to re-create the
  689. database table ``celery_taskmeta``.
  690. Contact the mailinglist or IRC channel listed in README for help
  691. doing this.
  692. * Database tables are now only created if the database backend is used,
  693. so if you change back to the database backend at some point,
  694. be sure to initialize tables (django: ``syncdb``, python: ``celeryinit``).
  695. (Note: This is only the case when using Django 1.1 or higher)
  696. * Now depends on ``carrot`` version 0.6.0.
  697. * Now depends on python-daemon 1.4.8
  698. IMPORTANT CHANGES
  699. -----------------
  700. * Celery can now be used in pure Python (outside of a Django project).
  701. This means celery is no longer Django specific.
  702. For more information see the FAQ entry
  703. `Can I use celery without Django?`_.
  704. .. _`Can I use celery without Django?`:
  705. http://ask.github.com/celery/faq.html#can-i-use-celery-without-django
  706. * Celery now supports task retries.
  707. See `Cookbook: Retrying Tasks`_ for more information.
  708. .. _`Cookbook: Retrying Tasks`:
  709. http://ask.github.com/celery/cookbook/task-retries.html
  710. * We now have an AMQP result store backend.
  711. It uses messages to publish task return value and status. And it's
  712. incredibly fast!
  713. See http://github.com/ask/celery/issues/closed#issue/6 for more info!
  714. * AMQP QoS (prefetch count) implemented:
  715. This to not receive more messages than we can handle.
  716. * Now redirects stdout/stderr to the celeryd logfile when detached
  717. * Now uses ``inspect.getargspec`` to only pass default arguments
  718. the task supports.
  719. * Add Task.on_success, .on_retry, .on_failure handlers
  720. See :meth:`celery.task.base.Task.on_success`,
  721. :meth:`celery.task.base.Task.on_retry`,
  722. :meth:`celery.task.base.Task.on_failure`,
  723. * ``celery.utils.gen_unique_id``: Workaround for
  724. http://bugs.python.org/issue4607
  725. * You can now customize what happens at worker start, at process init, etc
  726. by creating your own loaders. (see :mod:`celery.loaders.default`,
  727. :mod:`celery.loaders.djangoapp`, :mod:`celery.loaders`.)
  728. * Support for multiple AMQP exchanges and queues.
  729. This feature misses documentation and tests, so anyone interested
  730. is encouraged to improve this situation.
  731. * celeryd now survives a restart of the AMQP server!
  732. Automatically re-establish AMQP broker connection if it's lost.
  733. New settings:
  734. * AMQP_CONNECTION_RETRY
  735. Set to ``True`` to enable connection retries.
  736. * AMQP_CONNECTION_MAX_RETRIES.
  737. Maximum number of restarts before we give up. Default: ``100``.
  738. NEWS
  739. ----
  740. * Fix an incompatibility between python-daemon and multiprocessing,
  741. which resulted in the ``[Errno 10] No child processes`` problem when
  742. detaching.
  743. * Fixed a possible DjangoUnicodeDecodeError being raised when saving pickled
  744. data to Django's memcached cache backend.
  745. * Better Windows compatibility.
  746. * New version of the pickled field (taken from
  747. http://www.djangosnippets.org/snippets/513/)
  748. * New signals introduced: ``task_sent``, ``task_prerun`` and
  749. ``task_postrun``, see :mod:`celery.signals` for more information.
  750. * ``TaskSetResult.join`` caused ``TypeError`` when ``timeout=None``.
  751. Thanks Jerzy Kozera. Closes #31
  752. * ``views.apply`` should return ``HttpResponse`` instance.
  753. Thanks to Jerzy Kozera. Closes #32
  754. * ``PeriodicTask``: Save conversion of ``run_every`` from ``int``
  755. to ``timedelta`` to the class attribute instead of on the instance.
  756. * Exceptions has been moved to ``celery.exceptions``, but are still
  757. available in the previous module.
  758. * Try to rollback transaction and retry saving result if an error happens
  759. while setting task status with the database backend.
  760. * jail() refactored into :class:`celery.execute.ExecuteWrapper`.
  761. * ``views.apply`` now correctly sets mimetype to "application/json"
  762. * ``views.task_status`` now returns exception if status is RETRY
  763. * ``views.task_status`` now returns traceback if status is "FAILURE"
  764. or "RETRY"
  765. * Documented default task arguments.
  766. * Add a sensible __repr__ to ExceptionInfo for easier debugging
  767. * Fix documentation typo ``.. import map`` -> ``.. import dmap``.
  768. Thanks mikedizon
  769. 0.6.0 [2009-08-07 06:54 A.M CET]
  770. ================================
  771. IMPORTANT CHANGES
  772. -----------------
  773. * Fixed a bug where tasks raising unpickleable exceptions crashed pool
  774. workers. So if you've had pool workers mysteriously dissapearing, or
  775. problems with celeryd stopping working, this has been fixed in this
  776. version.
  777. * Fixed a race condition with periodic tasks.
  778. * The task pool is now supervised, so if a pool worker crashes,
  779. goes away or stops responding, it is automatically replaced with
  780. a new one.
  781. * Task.name is now automatically generated out of class module+name, e.g.
  782. ``"djangotwitter.tasks.UpdateStatusesTask"``. Very convenient. No idea why
  783. we didn't do this before. Some documentation is updated to not manually
  784. specify a task name.
  785. NEWS
  786. ----
  787. * Tested with Django 1.1
  788. * New Tutorial: Creating a click counter using carrot and celery
  789. * Database entries for periodic tasks are now created at ``celeryd``
  790. startup instead of for each check (which has been a forgotten TODO/XXX
  791. in the code for a long time)
  792. * New settings variable: ``CELERY_TASK_RESULT_EXPIRES``
  793. Time (in seconds, or a `datetime.timedelta` object) for when after
  794. stored task results are deleted. For the moment this only works for the
  795. database backend.
  796. * ``celeryd`` now emits a debug log message for which periodic tasks
  797. has been launched.
  798. * The periodic task table is now locked for reading while getting
  799. periodic task status. (MySQL only so far, seeking patches for other
  800. engines)
  801. * A lot more debugging information is now available by turning on the
  802. ``DEBUG`` loglevel (``--loglevel=DEBUG``).
  803. * Functions/methods with a timeout argument now works correctly.
  804. * New: ``celery.strategy.even_time_distribution``:
  805. With an iterator yielding task args, kwargs tuples, evenly distribute
  806. the processing of its tasks throughout the time window available.
  807. * Log message ``Unknown task ignored...`` now has loglevel ``ERROR``
  808. * Log message ``"Got task from broker"`` is now emitted for all tasks, even if
  809. the task has an ETA (estimated time of arrival). Also the message now
  810. includes the ETA for the task (if any).
  811. * Acknowledgement now happens in the pool callback. Can't do ack in the job
  812. target, as it's not pickleable (can't share AMQP connection, etc)).
  813. * Added note about .delay hanging in README
  814. * Tests now passing in Django 1.1
  815. * Fixed discovery to make sure app is in INSTALLED_APPS
  816. * Previously overrided pool behaviour (process reap, wait until pool worker
  817. available, etc.) is now handled by ``multiprocessing.Pool`` itself.
  818. * Convert statistics data to unicode for use as kwargs. Thanks Lucy!
  819. 0.4.1 [2009-07-02 01:42 P.M CET]
  820. ================================
  821. * Fixed a bug with parsing the message options (``mandatory``,
  822. ``routing_key``, ``priority``, ``immediate``)
  823. 0.4.0 [2009-07-01 07:29 P.M CET]
  824. ================================
  825. * Adds eager execution. ``celery.execute.apply``|``Task.apply`` executes the
  826. function blocking until the task is done, for API compatiblity it
  827. returns an ``celery.result.EagerResult`` instance. You can configure
  828. celery to always run tasks locally by setting the
  829. ``CELERY_ALWAYS_EAGER`` setting to ``True``.
  830. * Now depends on ``anyjson``.
  831. * 99% coverage using python ``coverage`` 3.0.
  832. 0.3.20 [2009-06-25 08:42 P.M CET]
  833. =================================
  834. * New arguments to ``apply_async`` (the advanced version of
  835. ``delay_task``), ``countdown`` and ``eta``;
  836. >>> # Run 10 seconds into the future.
  837. >>> res = apply_async(MyTask, countdown=10);
  838. >>> # Run 1 day from now
  839. >>> res = apply_async(MyTask, eta=datetime.now() +
  840. ... timedelta(days=1)
  841. * Now unlinks the pidfile if it's stale.
  842. * Lots of more tests.
  843. * Now compatible with carrot >= 0.5.0.
  844. * **IMPORTANT** The ``subtask_ids`` attribute on the ``TaskSetResult``
  845. instance has been removed. To get this information instead use:
  846. >>> subtask_ids = [subtask.task_id for subtask in ts_res.subtasks]
  847. * ``Taskset.run()`` now respects extra message options from the task class.
  848. * Task: Add attribute ``ignore_result``: Don't store the status and
  849. return value. This means you can't use the
  850. ``celery.result.AsyncResult`` to check if the task is
  851. done, or get its return value. Only use if you need the performance
  852. and is able live without these features. Any exceptions raised will
  853. store the return value/status as usual.
  854. * Task: Add attribute ``disable_error_emails`` to disable sending error
  855. emails for that task.
  856. * Should now work on Windows (although running in the background won't
  857. work, so using the ``--detach`` argument results in an exception
  858. being raised.)
  859. * Added support for statistics for profiling and monitoring.
  860. To start sending statistics start ``celeryd`` with the
  861. ``--statistics`` option. Then after a while you can dump the results
  862. by running ``python manage.py celerystats``. See
  863. ``celery.monitoring`` for more information.
  864. * The celery daemon can now be supervised (i.e it is automatically
  865. restarted if it crashes). To use this start celeryd with the
  866. ``--supervised`` option (or alternatively ``-S``).
  867. * views.apply: View applying a task. Example::
  868. http://e.com/celery/apply/task_name/arg1/arg2//?kwarg1=a&kwarg2=b
  869. **NOTE** Use with caution, preferably not make this publicly
  870. accessible without ensuring your code is safe!
  871. * Refactored ``celery.task``. It's now split into three modules:
  872. * celery.task
  873. Contains ``apply_async``, ``delay_task``, ``discard_all``, and task
  874. shortcuts, plus imports objects from ``celery.task.base`` and
  875. ``celery.task.builtins``
  876. * celery.task.base
  877. Contains task base classes: ``Task``, ``PeriodicTask``,
  878. ``TaskSet``, ``AsynchronousMapTask``, ``ExecuteRemoteTask``.
  879. * celery.task.builtins
  880. Built-in tasks: ``PingTask``, ``DeleteExpiredTaskMetaTask``.
  881. 0.3.7 [2008-06-16 11:41 P.M CET]
  882. --------------------------------
  883. * **IMPORTANT** Now uses AMQP's ``basic.consume`` instead of
  884. ``basic.get``. This means we're no longer polling the broker for
  885. new messages.
  886. * **IMPORTANT** Default concurrency limit is now set to the number of CPUs
  887. available on the system.
  888. * **IMPORTANT** ``tasks.register``: Renamed ``task_name`` argument to
  889. ``name``, so
  890. >>> tasks.register(func, task_name="mytask")
  891. has to be replaced with:
  892. >>> tasks.register(func, name="mytask")
  893. * The daemon now correctly runs if the pidlock is stale.
  894. * Now compatible with carrot 0.4.5
  895. * Default AMQP connnection timeout is now 4 seconds.
  896. * ``AsyncResult.read()`` was always returning ``True``.
  897. * Only use README as long_description if the file exists so easy_install
  898. doesn't break.
  899. * ``celery.view``: JSON responses now properly set its mime-type.
  900. * ``apply_async`` now has a ``connection`` keyword argument so you
  901. can re-use the same AMQP connection if you want to execute
  902. more than one task.
  903. * Handle failures in task_status view such that it won't throw 500s.
  904. * Fixed typo ``AMQP_SERVER`` in documentation to ``AMQP_HOST``.
  905. * Worker exception e-mails sent to admins now works properly.
  906. * No longer depends on ``django``, so installing ``celery`` won't affect
  907. the preferred Django version installed.
  908. * Now works with PostgreSQL (psycopg2) again by registering the
  909. ``PickledObject`` field.
  910. * ``celeryd``: Added ``--detach`` option as an alias to ``--daemon``, and
  911. it's the term used in the documentation from now on.
  912. * Make sure the pool and periodic task worker thread is terminated
  913. properly at exit. (So ``Ctrl-C`` works again).
  914. * Now depends on ``python-daemon``.
  915. * Removed dependency to ``simplejson``
  916. * Cache Backend: Re-establishes connection for every task process
  917. if the Django cache backend is memcached/libmemcached.
  918. * Tyrant Backend: Now re-establishes the connection for every task
  919. executed.
  920. 0.3.3 [2009-06-08 01:07 P.M CET]
  921. ================================
  922. * The ``PeriodicWorkController`` now sleeps for 1 second between checking
  923. for periodic tasks to execute.
  924. 0.3.2 [2009-06-08 01:07 P.M CET]
  925. ================================
  926. * celeryd: Added option ``--discard``: Discard (delete!) all waiting
  927. messages in the queue.
  928. * celeryd: The ``--wakeup-after`` option was not handled as a float.
  929. 0.3.1 [2009-06-08 01:07 P.M CET]
  930. ================================
  931. * The `PeriodicTask`` worker is now running in its own thread instead
  932. of blocking the ``TaskController`` loop.
  933. * Default ``QUEUE_WAKEUP_AFTER`` has been lowered to ``0.1`` (was ``0.3``)
  934. 0.3.0 [2009-06-08 12:41 P.M CET]
  935. ================================
  936. **NOTE** This is a development version, for the stable release, please
  937. see versions 0.2.x.
  938. **VERY IMPORTANT:** Pickle is now the encoder used for serializing task
  939. arguments, so be sure to flush your task queue before you upgrade.
  940. * **IMPORTANT** TaskSet.run() now returns a celery.result.TaskSetResult
  941. instance, which lets you inspect the status and return values of a
  942. taskset as it was a single entity.
  943. * **IMPORTANT** Celery now depends on carrot >= 0.4.1.
  944. * The celery daemon now sends task errors to the registered admin e-mails.
  945. To turn off this feature, set ``SEND_CELERY_TASK_ERROR_EMAILS`` to
  946. ``False`` in your ``settings.py``. Thanks to Grégoire Cachet.
  947. * You can now run the celery daemon by using ``manage.py``::
  948. $ python manage.py celeryd
  949. Thanks to Grégoire Cachet.
  950. * Added support for message priorities, topic exchanges, custom routing
  951. keys for tasks. This means we have introduced
  952. ``celery.task.apply_async``, a new way of executing tasks.
  953. You can use ``celery.task.delay`` and ``celery.Task.delay`` like usual, but
  954. if you want greater control over the message sent, you want
  955. ``celery.task.apply_async`` and ``celery.Task.apply_async``.
  956. This also means the AMQP configuration has changed. Some settings has
  957. been renamed, while others are new::
  958. CELERY_AMQP_EXCHANGE
  959. CELERY_AMQP_PUBLISHER_ROUTING_KEY
  960. CELERY_AMQP_CONSUMER_ROUTING_KEY
  961. CELERY_AMQP_CONSUMER_QUEUE
  962. CELERY_AMQP_EXCHANGE_TYPE
  963. See the entry `Can I send some tasks to only some servers?`_ in the
  964. `FAQ`_ for more information.
  965. .. _`Can I send some tasks to only some servers?`:
  966. http://bit.ly/celery_AMQP_routing
  967. .. _`FAQ`: http://ask.github.com/celery/faq.html
  968. * Task errors are now logged using loglevel ``ERROR`` instead of ``INFO``,
  969. and backtraces are dumped. Thanks to Grégoire Cachet.
  970. * Make every new worker process re-establish it's Django DB connection,
  971. this solving the "MySQL connection died?" exceptions.
  972. Thanks to Vitaly Babiy and Jirka Vejrazka.
  973. * **IMOPORTANT** Now using pickle to encode task arguments. This means you
  974. now can pass complex python objects to tasks as arguments.
  975. * Removed dependency to ``yadayada``.
  976. * Added a FAQ, see ``docs/faq.rst``.
  977. * Now converts any unicode keys in task ``kwargs`` to regular strings.
  978. Thanks Vitaly Babiy.
  979. * Renamed the ``TaskDaemon`` to ``WorkController``.
  980. * ``celery.datastructures.TaskProcessQueue`` is now renamed to
  981. ``celery.pool.TaskPool``.
  982. * The pool algorithm has been refactored for greater performance and
  983. stability.
  984. 0.2.0 [2009-05-20 05:14 P.M CET]
  985. ================================
  986. * Final release of 0.2.0
  987. * Compatible with carrot version 0.4.0.
  988. * Fixes some syntax errors related to fetching results
  989. from the database backend.
  990. 0.2.0-pre3 [2009-05-20 05:14 P.M CET]
  991. =====================================
  992. * *Internal release*. Improved handling of unpickled exceptions,
  993. ``get_result`` now tries to recreate something looking like the
  994. original exception.
  995. 0.2.0-pre2 [2009-05-20 01:56 P.M CET]
  996. =====================================
  997. * Now handles unpickleable exceptions (like the dynimically generated
  998. subclasses of ``django.core.exception.MultipleObjectsReturned``).
  999. 0.2.0-pre1 [2009-05-20 12:33 P.M CET]
  1000. =====================================
  1001. * It's getting quite stable, with a lot of new features, so bump
  1002. version to 0.2. This is a pre-release.
  1003. * ``celery.task.mark_as_read()`` and ``celery.task.mark_as_failure()`` has
  1004. been removed. Use ``celery.backends.default_backend.mark_as_read()``,
  1005. and ``celery.backends.default_backend.mark_as_failure()`` instead.
  1006. 0.1.15 [2009-05-19 04:13 P.M CET]
  1007. =================================
  1008. * The celery daemon was leaking AMQP connections, this should be fixed,
  1009. if you have any problems with too many files open (like ``emfile``
  1010. errors in ``rabbit.log``, please contact us!
  1011. 0.1.14 [2009-05-19 01:08 P.M CET]
  1012. =================================
  1013. * Fixed a syntax error in the ``TaskSet`` class. (No such variable
  1014. ``TimeOutError``).
  1015. 0.1.13 [2009-05-19 12:36 P.M CET]
  1016. =================================
  1017. * Forgot to add ``yadayada`` to install requirements.
  1018. * Now deletes all expired task results, not just those marked as done.
  1019. * Able to load the Tokyo Tyrant backend class without django
  1020. configuration, can specify tyrant settings directly in the class
  1021. constructor.
  1022. * Improved API documentation
  1023. * Now using the Sphinx documentation system, you can build
  1024. the html documentation by doing ::
  1025. $ cd docs
  1026. $ make html
  1027. and the result will be in ``docs/.build/html``.
  1028. 0.1.12 [2009-05-18 04:38 P.M CET]
  1029. =================================
  1030. * ``delay_task()`` etc. now returns ``celery.task.AsyncResult`` object,
  1031. which lets you check the result and any failure that might have
  1032. happened. It kind of works like the ``multiprocessing.AsyncResult``
  1033. class returned by ``multiprocessing.Pool.map_async``.
  1034. * Added dmap() and dmap_async(). This works like the
  1035. ``multiprocessing.Pool`` versions except they are tasks
  1036. distributed to the celery server. Example:
  1037. >>> from celery.task import dmap
  1038. >>> import operator
  1039. >>> dmap(operator.add, [[2, 2], [4, 4], [8, 8]])
  1040. >>> [4, 8, 16]
  1041. >>> from celery.task import dmap_async
  1042. >>> import operator
  1043. >>> result = dmap_async(operator.add, [[2, 2], [4, 4], [8, 8]])
  1044. >>> result.ready()
  1045. False
  1046. >>> time.sleep(1)
  1047. >>> result.ready()
  1048. True
  1049. >>> result.result
  1050. [4, 8, 16]
  1051. * Refactored the task metadata cache and database backends, and added
  1052. a new backend for Tokyo Tyrant. You can set the backend in your django
  1053. settings file. e.g::
  1054. CELERY_RESULT_BACKEND = "database"; # Uses the database
  1055. CELERY_RESULT_BACKEND = "cache"; # Uses the django cache framework
  1056. CELERY_RESULT_BACKEND = "tyrant"; # Uses Tokyo Tyrant
  1057. TT_HOST = "localhost"; # Hostname for the Tokyo Tyrant server.
  1058. TT_PORT = 6657; # Port of the Tokyo Tyrant server.
  1059. 0.1.11 [2009-05-12 02:08 P.M CET]
  1060. =================================
  1061. * The logging system was leaking file descriptors, resulting in
  1062. servers stopping with the EMFILES (too many open files) error. (fixed)
  1063. 0.1.10 [2009-05-11 12:46 P.M CET]
  1064. =================================
  1065. * Tasks now supports both positional arguments and keyword arguments.
  1066. * Requires carrot 0.3.8.
  1067. * The daemon now tries to reconnect if the connection is lost.
  1068. 0.1.8 [2009-05-07 12:27 P.M CET]
  1069. ================================
  1070. * Better test coverage
  1071. * More documentation
  1072. * celeryd doesn't emit ``Queue is empty`` message if
  1073. ``settings.CELERYD_EMPTY_MSG_EMIT_EVERY`` is 0.
  1074. 0.1.7 [2009-04-30 1:50 P.M CET]
  1075. ===============================
  1076. * Added some unittests
  1077. * Can now use the database for task metadata (like if the task has
  1078. been executed or not). Set ``settings.CELERY_TASK_META``
  1079. * Can now run ``python setup.py test`` to run the unittests from
  1080. within the ``tests`` project.
  1081. * Can set the AMQP exchange/routing key/queue using
  1082. ``settings.CELERY_AMQP_EXCHANGE``, ``settings.CELERY_AMQP_ROUTING_KEY``,
  1083. and ``settings.CELERY_AMQP_CONSUMER_QUEUE``.
  1084. 0.1.6 [2009-04-28 2:13 P.M CET]
  1085. ===============================
  1086. * Introducing ``TaskSet``. A set of subtasks is executed and you can
  1087. find out how many, or if all them, are done (excellent for progress
  1088. bars and such)
  1089. * Now catches all exceptions when running ``Task.__call__``, so the
  1090. daemon doesn't die. This does't happen for pure functions yet, only
  1091. ``Task`` classes.
  1092. * ``autodiscover()`` now works with zipped eggs.
  1093. * celeryd: Now adds curernt working directory to ``sys.path`` for
  1094. convenience.
  1095. * The ``run_every`` attribute of ``PeriodicTask`` classes can now be a
  1096. ``datetime.timedelta()`` object.
  1097. * celeryd: You can now set the ``DJANGO_PROJECT_DIR`` variable
  1098. for ``celeryd`` and it will add that to ``sys.path`` for easy launching.
  1099. * Can now check if a task has been executed or not via HTTP.
  1100. * You can do this by including the celery ``urls.py`` into your project,
  1101. >>> url(r'^celery/$', include("celery.urls"))
  1102. then visiting the following url,::
  1103. http://mysite/celery/$task_id/done/
  1104. this will return a JSON dictionary like e.g:
  1105. >>> {"task": {"id": $task_id, "executed": true}}
  1106. * ``delay_task`` now returns string id, not ``uuid.UUID`` instance.
  1107. * Now has ``PeriodicTasks``, to have ``cron`` like functionality.
  1108. * Project changed name from ``crunchy`` to ``celery``. The details of
  1109. the name change request is in ``docs/name_change_request.txt``.
  1110. 0.1.0 [2009-04-24 11:28 A.M CET]
  1111. ================================
  1112. * Initial release