changelog-1.0.rst 56 KB

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