Changelog 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017
  1. ==============
  2. Change history
  3. ==============
  4. 1.0.0 [xxxx-xx-xx xx:xx x.x xxx]
  5. ================================
  6. BACKWARD INCOMPATIBLE CHANGES
  7. -----------------------------
  8. * Celery does not support detaching anymore, so you have to use the tools
  9. available on your platform, or something like supervisord to make
  10. celeryd/celerybeat/celerymon into background processes.
  11. We've had too many problems with celeryd daemonizing itself, so it was
  12. decided it has to be removed. Example startup scripts has been added to
  13. ``contrib/``:
  14. * Debian, Ubuntu, (start-stop-daemon)
  15. ``contrib/debian/init.d/celeryd``
  16. ``contrib/debian/init.d/celerybeat``
  17. * Mac OS X launchd
  18. ``contrib/mac/org.celeryq.celeryd.plist``
  19. ``contrib/mac/org.celeryq.celerybeat.plist``
  20. ``contrib/mac/org.celeryq.celerymon.plist``
  21. * Supervisord (http://supervisord.org)
  22. ``contrib/supervisord/supervisord.conf``
  23. In addition to ``--detach``, the following program arguments has been
  24. removed: ``--uid``, ``--gid``, ``--workdir``, ``--chroot``, ``--pidfile``,
  25. ``--umask``. All good daemonization tools should support equivalent
  26. functionality, so don't worry.
  27. Also the following configuration keys has been removed:
  28. ``CELERYD_PID_FILE``, ``CELERYBEAT_PID_FILE``, ``CELERYMON_PID_FILE``.
  29. * Default celeryd loglevel is now ``WARN``, to enable the previous log level
  30. start celeryd with ``--loglevel=INFO``.
  31. * Tasks are automatically registered.
  32. This means you no longer have to register your tasks manually.
  33. You don't have to change your old code right away, as it doesn't matter if
  34. a task is registered twice.
  35. If you don't want your task to be automatically registered you can set
  36. the ``abstract`` attribute
  37. .. code-block:: python
  38. class MyTask(Task):
  39. abstract = True
  40. By using ``abstract`` only tasks subclassing this task will be automatically
  41. registered (this works like the Django ORM).
  42. If you don't want subclasses to be registered either, you can set the
  43. ``autoregister`` attribute to ``False``.
  44. Incidentally, this change also fixes the problems with automatic name
  45. assignment and relative imports. So you also don't have to specify a task name
  46. anymore if you use relative imports.
  47. * You can no longer use regular functions as tasks. This change was added
  48. because it makes the internals a lot more clean and simple. However, you can
  49. now turn functions into tasks by using the ``@task`` decorator:
  50. .. code-block:: python
  51. from celery.decorators import task
  52. @task
  53. def add(x, y):
  54. return x + y
  55. See the User Guide: :doc:`userguide/tasks` for more information.
  56. * The periodic task system has been rewritten to a centralized solution, this
  57. means ``celeryd`` no longer schedules periodic tasks by default, but a new
  58. daemon has been introduced: ``celerybeat``.
  59. To launch the periodic task scheduler you have to run celerybeat::
  60. $ celerybeat
  61. Make sure this is running on one server only, if you run it twice, all
  62. periodic tasks will also be executed twice.
  63. If you only have one worker server you can embed it into celeryd like this::
  64. $ celeryd --beat # Embed celerybeat in celeryd.
  65. * The supervisor has been removed, please use something like
  66. http://supervisord.org instead. This means the ``-S`` and ``--supervised``
  67. options to ``celeryd`` is no longer supported.
  68. * ``TaskSet.join`` has been removed, use ``TaskSetResult.join`` instead.
  69. * The task status ``"DONE"`` has been renamed to `"SUCCESS"`.
  70. * ``AsyncResult.is_done`` has been removed, use ``AsyncResult.successful``
  71. instead.
  72. * The worker no longer stores errors if ``Task.ignore_result`` is set, to
  73. revert to the previous behaviour set
  74. ``CELERY_STORE_ERRORS_EVEN_IF_IGNORED`` to ``True``.
  75. * The staticstics functionality has been removed in favor of events,
  76. so the ``-S`` and ``--statistics`` switches has been removed.
  77. * The module ``celery.task.strategy`` has been removed.
  78. * ``celery.discovery`` has been removed, and it's ``autodiscover`` function is
  79. now in ``celery.loaders.djangoapp``. Reason: Internal API.
  80. * ``CELERY_LOADER`` now needs loader class name in addition to module name,
  81. e.g. where you previously had: ``"celery.loaders.default"``, you now need
  82. ``"celery.loaders.default.Loader"``, using the previous syntax will result
  83. in a DeprecationWarning.
  84. * Detecting the loader is now lazy, and so is not done when importing
  85. ``celery.loaders``. To make this happen ``celery.loaders.settings`` has
  86. been renamed to ``load_settings`` and is now a function returning the
  87. settings object. ``celery.loaders.current_loader`` is now also
  88. a function, returning the current loader.
  89. So::
  90. loader = current_loader
  91. needs to be changed to::
  92. loader = current_loader()
  93. DEPRECATIONS
  94. ------------
  95. * The following configuration variables has been renamed and will be
  96. deprecated in v1.2:
  97. * CELERYD_DAEMON_LOG_FORMAT -> CELERYD_LOG_FORMAT
  98. * CELERYD_DAEMON_LOG_LEVEL -> CELERYD_LOG_LEVEL
  99. * CELERY_AMQP_CONNECTION_TIMEOUT -> CELERY_BROKER_CONNECTION_TIMEOUT
  100. * CELERY_AMQP_CONNECTION_RETRY -> CELERY_BROKER_CONNECTION_RETRY
  101. * CELERY_AMQP_CONNECTION_MAX_RETRIES -> CELERY_BROKER_CONNECTION_MAX_RETRIES
  102. * SEND_CELERY_TASK_ERROR_EMAILS -> CELERY_SEND_TASK_ERROR_EMAILS
  103. * The public api names in celery.conf has also changed to a consistent naming
  104. scheme.
  105. * We now support consuming from an arbitrary number of queues, but to do this
  106. we had to rename the configuration syntax. If you use any of the custom
  107. AMQP routing options (queue/exchange/routing_key, etc), you should read the
  108. new FAQ entry: http://bit.ly/aiWoH. The previous syntax is deprecated and
  109. scheduled for removal in v1.2.
  110. * ``TaskSet.run`` has been renamed to ``TaskSet.apply_async``.
  111. ``run`` is still deprecated, and is scheduled for removal in v1.2.
  112. NEWS
  113. ----
  114. * Rate limiting support (per task type, or globally).
  115. * New periodic task system.
  116. * Automatic registration.
  117. * New cool task decorator syntax.
  118. * celeryd now sends events if enabled with the ``-E`` argument.
  119. Excellent for monitoring tools, one is already in the making
  120. (http://github.com/ask/celerymon).
  121. Current events include: worker-heartbeat,
  122. task-[received/succeeded/failed/retried],
  123. worker-online, worker-offline.
  124. * You can now delete (revoke) tasks that has already been applied.
  125. * You can now set the hostname celeryd identifies as using the ``--hostname``
  126. argument.
  127. * Cache backend now respects ``CELERY_TASK_RESULT_EXPIRES``.
  128. * Message format has been standardized and now uses ISO-8601 format
  129. for dates instead of datetime.
  130. * ``celeryd`` now responds to the ``HUP`` signal by restarting itself.
  131. * Periodic tasks are now scheduled on the clock, i.e. ``timedelta(hours=1)``
  132. means every hour at :00 minutes, not every hour from the server starts.
  133. To revert to the previous behaviour you can set
  134. ``PeriodicTask.relative = True``.
  135. * Now supports passing execute options to a TaskSets list of args, e.g.:
  136. >>> ts = TaskSet(add, [([2, 2], {}, {"countdown": 1}),
  137. ... ([4, 4], {}, {"countdown": 2}),
  138. ... ([8, 8], {}, {"countdown": 3})])
  139. >>> ts.run()
  140. * Got a 3x performance gain by setting the prefetch count to four times the
  141. concurrency, (from an average task round-trip of 0.1s to 0.03s!). A new
  142. setting has been added: ``CELERYD_PREFETCH_MULTIPLIER``, which is set
  143. to ``4`` by default.
  144. CHANGES
  145. -------
  146. * Now depends on carrot >= 0.8.1
  147. * New dependencies: billiard, python-dateutil, django-picklefield
  148. * No longer depends on python-daemon
  149. * The ``uuid`` distribution is added as a dependency when running Python 2.4.
  150. * Now remembers the previously detected loader by keeping it in
  151. the ``CELERY_LOADER`` environment variable. This may help on windows where
  152. fork emulation is used.
  153. * ETA no longer sends datetime objects, but uses ISO 8601 date format in a
  154. string for better compatibility with other platforms.
  155. * No longer sends error mails for retried tasks.
  156. * Task can now override the backend used to store results.
  157. * Refactored the ExecuteWrapper, ``apply`` and ``CELERY_ALWAYS_EAGER`` now
  158. also executes the task callbacks and signals.
  159. * Now using a proper scheduler for the tasks with an ETA. This means waiting
  160. eta tasks are sorted by time, so we don't have to poll the whole list all the
  161. time.
  162. * Now also imports modules listed in CELERY_IMPORTS when running
  163. with django (as documented).
  164. * Loglevel for stdout/stderr changed from INFO to ERROR
  165. * ImportErrors are now properly propogated when autodiscovering tasks.
  166. * You can now use ``celery.messaging.establish_connection`` to establish a
  167. connection to the broker.
  168. * When running as a separate service the periodic task scheduler does some
  169. smart moves to not poll too regularly, if you need faster poll times you
  170. can lower the value of ``CELERYBEAT_MAX_LOOP_INTERVAL``.
  171. * You can now change periodic task intervals at runtime, by making
  172. ``run_every`` a property, or subclassing ``PeriodicTask.is_due``.
  173. * The worker now supports control commands enabled through the use of a
  174. broadcast queue, you can remotely revoke tasks or set the rate limit for
  175. a task type. See :mod:`celery.task.control`.
  176. * The services now sets informative process names (as shown in ``ps``
  177. listings) if the :mod:`setproctitle` module is installed.
  178. * :exc:`celery.exceptions.NotRegistered` now inherits from :exc:`KeyError`,
  179. and ``TaskRegistry.__getitem__``+``pop`` raises ``NotRegistered`` instead
  180. * You can set the loader via the ``CELERY_LOADER`` environment variable.
  181. * You can now set ``CELERY_IGNORE_RESULT`` to ignore task results by default
  182. (if enabled, tasks doesn't save results or errors to the backend used).
  183. BUGS
  184. ----
  185. * Fixed a race condition that could happen while storing task results in the
  186. database.
  187. DOCUMENTATION
  188. -------------
  189. * Reference now split into two sections; API reference and internal module
  190. reference.
  191. 0.8.1 [2009-11-16 05:21 P.M CEST]
  192. =================================
  193. VERY IMPORTANT NOTE
  194. -------------------
  195. This release (with carrot 0.8.0) enables AMQP QoS (quality of service), which
  196. means the workers will only receive as many messages as it can handle at a
  197. time. As with any release, you should test this version upgrade on your
  198. development servers before rolling it out to production!
  199. IMPORTANT CHANGES
  200. -----------------
  201. * If you're using Python < 2.6 and you use the multiprocessing backport, then
  202. multiprocessing version 2.6.2.1 is required.
  203. * All AMQP_* settings has been renamed to BROKER_*, and in addition
  204. AMQP_SERVER has been renamed to BROKER_HOST, so before where you had::
  205. AMQP_SERVER = "localhost"
  206. AMQP_PORT = 5678
  207. AMQP_USER = "myuser"
  208. AMQP_PASSWORD = "mypassword"
  209. AMQP_VHOST = "celery"
  210. You need to change that to::
  211. BROKER_HOST = "localhost"
  212. BROKER_PORT = 5678
  213. BROKER_USER = "myuser"
  214. BROKER_PASSWORD = "mypassword"
  215. BROKER_VHOST = "celery"
  216. * Custom carrot backends now need to include the backend class name, so before
  217. where you had::
  218. CARROT_BACKEND = "mycustom.backend.module"
  219. you need to change it to::
  220. CARROT_BACKEND = "mycustom.backend.module.Backend"
  221. where ``Backend`` is the class name. This is probably ``"Backend"``, as
  222. that was the previously implied name.
  223. * New version requirement for carrot: 0.8.0
  224. CHANGES
  225. -------
  226. * Incorporated the multiprocessing backport patch that fixes the
  227. ``processName`` error.
  228. * Ignore the result of PeriodicTask's by default.
  229. * Added a Redis result store backend
  230. * Allow /etc/default/celeryd to define additional options for the celeryd init
  231. script.
  232. * MongoDB periodic tasks issue when using different time than UTC fixed.
  233. * Windows specific: Negate test for available os.fork (thanks miracle2k)
  234. * Now tried to handle broken PID files.
  235. * Added a Django test runner to contrib that sets CELERY_ALWAYS_EAGER = True for testing with the database backend
  236. * Added a CELERY_CACHE_BACKEND setting for using something other than the django-global cache backend.
  237. * Use custom implementation of functools.partial (curry) for Python 2.4 support
  238. (Probably still problems with running on 2.4, but it will eventually be
  239. supported)
  240. * Prepare exception to pickle when saving RETRY status for all backends.
  241. * SQLite no concurrency limit should only be effective if the db backend is used.
  242. 0.8.0 [2009-09-22 03:06 P.M CEST]
  243. =================================
  244. BACKWARD INCOMPATIBLE CHANGES
  245. -----------------------------
  246. * Add traceback to result value on failure.
  247. **NOTE** If you use the database backend you have to re-create the
  248. database table ``celery_taskmeta``.
  249. Contact the mailinglist or IRC channel listed in README for help
  250. doing this.
  251. * Database tables are now only created if the database backend is used,
  252. so if you change back to the database backend at some point,
  253. be sure to initialize tables (django: ``syncdb``, python: ``celeryinit``).
  254. (Note: This is only the case when using Django 1.1 or higher)
  255. * Now depends on ``carrot`` version 0.6.0.
  256. * Now depends on python-daemon 1.4.8
  257. IMPORTANT CHANGES
  258. -----------------
  259. * Celery can now be used in pure Python (outside of a Django project).
  260. This means celery is no longer Django specific.
  261. For more information see the FAQ entry
  262. `Can I use celery without Django?`_.
  263. .. _`Can I use celery without Django?`:
  264. http://ask.github.com/celery/faq.html#can-i-use-celery-without-django
  265. * Celery now supports task retries.
  266. See `Cookbook: Retrying Tasks`_ for more information.
  267. .. _`Cookbook: Retrying Tasks`:
  268. http://ask.github.com/celery/cookbook/task-retries.html
  269. * We now have an AMQP result store backend.
  270. It uses messages to publish task return value and status. And it's
  271. incredibly fast!
  272. See http://github.com/ask/celery/issues/closed#issue/6 for more info!
  273. * AMQP QoS (prefetch count) implemented:
  274. This to not receive more messages than we can handle.
  275. * Now redirects stdout/stderr to the celeryd logfile when detached
  276. * Now uses ``inspect.getargspec`` to only pass default arguments
  277. the task supports.
  278. * Add Task.on_success, .on_retry, .on_failure handlers
  279. See :meth:`celery.task.base.Task.on_success`,
  280. :meth:`celery.task.base.Task.on_retry`,
  281. :meth:`celery.task.base.Task.on_failure`,
  282. * ``celery.utils.gen_unique_id``: Workaround for
  283. http://bugs.python.org/issue4607
  284. * You can now customize what happens at worker start, at process init, etc
  285. by creating your own loaders. (see :mod:`celery.loaders.default`,
  286. :mod:`celery.loaders.djangoapp`, :mod:`celery.loaders`.)
  287. * Support for multiple AMQP exchanges and queues.
  288. This feature misses documentation and tests, so anyone interested
  289. is encouraged to improve this situation.
  290. * celeryd now survives a restart of the AMQP server!
  291. Automatically re-establish AMQP broker connection if it's lost.
  292. New settings:
  293. * AMQP_CONNECTION_RETRY
  294. Set to ``True`` to enable connection retries.
  295. * AMQP_CONNECTION_MAX_RETRIES.
  296. Maximum number of restarts before we give up. Default: ``100``.
  297. NEWS
  298. ----
  299. * Fix an incompatibility between python-daemon and multiprocessing,
  300. which resulted in the ``[Errno 10] No child processes`` problem when
  301. detaching.
  302. * Fixed a possible DjangoUnicodeDecodeError being raised when saving pickled
  303. data to Django's memcached cache backend.
  304. * Better Windows compatibility.
  305. * New version of the pickled field (taken from
  306. http://www.djangosnippets.org/snippets/513/)
  307. * New signals introduced: ``task_sent``, ``task_prerun`` and
  308. ``task_postrun``, see :mod:`celery.signals` for more information.
  309. * ``TaskSetResult.join`` caused ``TypeError`` when ``timeout=None``.
  310. Thanks Jerzy Kozera. Closes #31
  311. * ``views.apply`` should return ``HttpResponse`` instance.
  312. Thanks to Jerzy Kozera. Closes #32
  313. * ``PeriodicTask``: Save conversion of ``run_every`` from ``int``
  314. to ``timedelta`` to the class attribute instead of on the instance.
  315. * Exceptions has been moved to ``celery.exceptions``, but are still
  316. available in the previous module.
  317. * Try to rollback transaction and retry saving result if an error happens
  318. while setting task status with the database backend.
  319. * jail() refactored into :class:`celery.execute.ExecuteWrapper`.
  320. * ``views.apply`` now correctly sets mimetype to "application/json"
  321. * ``views.task_status`` now returns exception if status is RETRY
  322. * ``views.task_status`` now returns traceback if status is "FAILURE"
  323. or "RETRY"
  324. * Documented default task arguments.
  325. * Add a sensible __repr__ to ExceptionInfo for easier debugging
  326. * Fix documentation typo ``.. import map`` -> ``.. import dmap``.
  327. Thanks mikedizon
  328. 0.6.0 [2009-08-07 06:54 A.M CET]
  329. ================================
  330. IMPORTANT CHANGES
  331. -----------------
  332. * Fixed a bug where tasks raising unpickleable exceptions crashed pool
  333. workers. So if you've had pool workers mysteriously dissapearing, or
  334. problems with celeryd stopping working, this has been fixed in this
  335. version.
  336. * Fixed a race condition with periodic tasks.
  337. * The task pool is now supervised, so if a pool worker crashes,
  338. goes away or stops responding, it is automatically replaced with
  339. a new one.
  340. * Task.name is now automatically generated out of class module+name, e.g.
  341. ``"djangotwitter.tasks.UpdateStatusesTask"``. Very convenient. No idea why
  342. we didn't do this before. Some documentation is updated to not manually
  343. specify a task name.
  344. NEWS
  345. ----
  346. * Tested with Django 1.1
  347. * New Tutorial: Creating a click counter using carrot and celery
  348. * Database entries for periodic tasks are now created at ``celeryd``
  349. startup instead of for each check (which has been a forgotten TODO/XXX
  350. in the code for a long time)
  351. * New settings variable: ``CELERY_TASK_RESULT_EXPIRES``
  352. Time (in seconds, or a `datetime.timedelta` object) for when after
  353. stored task results are deleted. For the moment this only works for the
  354. database backend.
  355. * ``celeryd`` now emits a debug log message for which periodic tasks
  356. has been launched.
  357. * The periodic task table is now locked for reading while getting
  358. periodic task status. (MySQL only so far, seeking patches for other
  359. engines)
  360. * A lot more debugging information is now available by turning on the
  361. ``DEBUG`` loglevel (``--loglevel=DEBUG``).
  362. * Functions/methods with a timeout argument now works correctly.
  363. * New: ``celery.strategy.even_time_distribution``:
  364. With an iterator yielding task args, kwargs tuples, evenly distribute
  365. the processing of its tasks throughout the time window available.
  366. * Log message ``Unknown task ignored...`` now has loglevel ``ERROR``
  367. * Log message ``"Got task from broker"`` is now emitted for all tasks, even if
  368. the task has an ETA (estimated time of arrival). Also the message now
  369. includes the ETA for the task (if any).
  370. * Acknowledgement now happens in the pool callback. Can't do ack in the job
  371. target, as it's not pickleable (can't share AMQP connection, etc)).
  372. * Added note about .delay hanging in README
  373. * Tests now passing in Django 1.1
  374. * Fixed discovery to make sure app is in INSTALLED_APPS
  375. * Previously overrided pool behaviour (process reap, wait until pool worker
  376. available, etc.) is now handled by ``multiprocessing.Pool`` itself.
  377. * Convert statistics data to unicode for use as kwargs. Thanks Lucy!
  378. 0.4.1 [2009-07-02 01:42 P.M CET]
  379. ================================
  380. * Fixed a bug with parsing the message options (``mandatory``,
  381. ``routing_key``, ``priority``, ``immediate``)
  382. 0.4.0 [2009-07-01 07:29 P.M CET]
  383. ================================
  384. * Adds eager execution. ``celery.execute.apply``|``Task.apply`` executes the
  385. function blocking until the task is done, for API compatiblity it
  386. returns an ``celery.result.EagerResult`` instance. You can configure
  387. celery to always run tasks locally by setting the
  388. ``CELERY_ALWAYS_EAGER`` setting to ``True``.
  389. * Now depends on ``anyjson``.
  390. * 99% coverage using python ``coverage`` 3.0.
  391. 0.3.20 [2009-06-25 08:42 P.M CET]
  392. =================================
  393. * New arguments to ``apply_async`` (the advanced version of
  394. ``delay_task``), ``countdown`` and ``eta``;
  395. >>> # Run 10 seconds into the future.
  396. >>> res = apply_async(MyTask, countdown=10);
  397. >>> # Run 1 day from now
  398. >>> res = apply_async(MyTask, eta=datetime.now() +
  399. ... timedelta(days=1)
  400. * Now unlinks the pidfile if it's stale.
  401. * Lots of more tests.
  402. * Now compatible with carrot >= 0.5.0.
  403. * **IMPORTANT** The ``subtask_ids`` attribute on the ``TaskSetResult``
  404. instance has been removed. To get this information instead use:
  405. >>> subtask_ids = [subtask.task_id for subtask in ts_res.subtasks]
  406. * ``Taskset.run()`` now respects extra message options from the task class.
  407. * Task: Add attribute ``ignore_result``: Don't store the status and
  408. return value. This means you can't use the
  409. ``celery.result.AsyncResult`` to check if the task is
  410. done, or get its return value. Only use if you need the performance
  411. and is able live without these features. Any exceptions raised will
  412. store the return value/status as usual.
  413. * Task: Add attribute ``disable_error_emails`` to disable sending error
  414. emails for that task.
  415. * Should now work on Windows (although running in the background won't
  416. work, so using the ``--detach`` argument results in an exception
  417. being raised.)
  418. * Added support for statistics for profiling and monitoring.
  419. To start sending statistics start ``celeryd`` with the
  420. ``--statistics`` option. Then after a while you can dump the results
  421. by running ``python manage.py celerystats``. See
  422. ``celery.monitoring`` for more information.
  423. * The celery daemon can now be supervised (i.e it is automatically
  424. restarted if it crashes). To use this start celeryd with the
  425. ``--supervised`` option (or alternatively ``-S``).
  426. * views.apply: View applying a task. Example::
  427. http://e.com/celery/apply/task_name/arg1/arg2//?kwarg1=a&kwarg2=b
  428. **NOTE** Use with caution, preferably not make this publicly
  429. accessible without ensuring your code is safe!
  430. * Refactored ``celery.task``. It's now split into three modules:
  431. * celery.task
  432. Contains ``apply_async``, ``delay_task``, ``discard_all``, and task
  433. shortcuts, plus imports objects from ``celery.task.base`` and
  434. ``celery.task.builtins``
  435. * celery.task.base
  436. Contains task base classes: ``Task``, ``PeriodicTask``,
  437. ``TaskSet``, ``AsynchronousMapTask``, ``ExecuteRemoteTask``.
  438. * celery.task.builtins
  439. Built-in tasks: ``PingTask``, ``DeleteExpiredTaskMetaTask``.
  440. 0.3.7 [2008-06-16 11:41 P.M CET]
  441. --------------------------------
  442. * **IMPORTANT** Now uses AMQP's ``basic.consume`` instead of
  443. ``basic.get``. This means we're no longer polling the broker for
  444. new messages.
  445. * **IMPORTANT** Default concurrency limit is now set to the number of CPUs
  446. available on the system.
  447. * **IMPORTANT** ``tasks.register``: Renamed ``task_name`` argument to
  448. ``name``, so
  449. >>> tasks.register(func, task_name="mytask")
  450. has to be replaced with:
  451. >>> tasks.register(func, name="mytask")
  452. * The daemon now correctly runs if the pidlock is stale.
  453. * Now compatible with carrot 0.4.5
  454. * Default AMQP connnection timeout is now 4 seconds.
  455. * ``AsyncResult.read()`` was always returning ``True``.
  456. * Only use README as long_description if the file exists so easy_install
  457. doesn't break.
  458. * ``celery.view``: JSON responses now properly set its mime-type.
  459. * ``apply_async`` now has a ``connection`` keyword argument so you
  460. can re-use the same AMQP connection if you want to execute
  461. more than one task.
  462. * Handle failures in task_status view such that it won't throw 500s.
  463. * Fixed typo ``AMQP_SERVER`` in documentation to ``AMQP_HOST``.
  464. * Worker exception e-mails sent to admins now works properly.
  465. * No longer depends on ``django``, so installing ``celery`` won't affect
  466. the preferred Django version installed.
  467. * Now works with PostgreSQL (psycopg2) again by registering the
  468. ``PickledObject`` field.
  469. * ``celeryd``: Added ``--detach`` option as an alias to ``--daemon``, and
  470. it's the term used in the documentation from now on.
  471. * Make sure the pool and periodic task worker thread is terminated
  472. properly at exit. (So ``Ctrl-C`` works again).
  473. * Now depends on ``python-daemon``.
  474. * Removed dependency to ``simplejson``
  475. * Cache Backend: Re-establishes connection for every task process
  476. if the Django cache backend is memcached/libmemcached.
  477. * Tyrant Backend: Now re-establishes the connection for every task
  478. executed.
  479. 0.3.3 [2009-06-08 01:07 P.M CET]
  480. ================================
  481. * The ``PeriodicWorkController`` now sleeps for 1 second between checking
  482. for periodic tasks to execute.
  483. 0.3.2 [2009-06-08 01:07 P.M CET]
  484. ================================
  485. * celeryd: Added option ``--discard``: Discard (delete!) all waiting
  486. messages in the queue.
  487. * celeryd: The ``--wakeup-after`` option was not handled as a float.
  488. 0.3.1 [2009-06-08 01:07 P.M CET]
  489. ================================
  490. * The `PeriodicTask`` worker is now running in its own thread instead
  491. of blocking the ``TaskController`` loop.
  492. * Default ``QUEUE_WAKEUP_AFTER`` has been lowered to ``0.1`` (was ``0.3``)
  493. 0.3.0 [2009-06-08 12:41 P.M CET]
  494. ================================
  495. **NOTE** This is a development version, for the stable release, please
  496. see versions 0.2.x.
  497. **VERY IMPORTANT:** Pickle is now the encoder used for serializing task
  498. arguments, so be sure to flush your task queue before you upgrade.
  499. * **IMPORTANT** TaskSet.run() now returns a celery.result.TaskSetResult
  500. instance, which lets you inspect the status and return values of a
  501. taskset as it was a single entity.
  502. * **IMPORTANT** Celery now depends on carrot >= 0.4.1.
  503. * The celery daemon now sends task errors to the registered admin e-mails.
  504. To turn off this feature, set ``SEND_CELERY_TASK_ERROR_EMAILS`` to
  505. ``False`` in your ``settings.py``. Thanks to Grégoire Cachet.
  506. * You can now run the celery daemon by using ``manage.py``::
  507. $ python manage.py celeryd
  508. Thanks to Grégoire Cachet.
  509. * Added support for message priorities, topic exchanges, custom routing
  510. keys for tasks. This means we have introduced
  511. ``celery.task.apply_async``, a new way of executing tasks.
  512. You can use ``celery.task.delay`` and ``celery.Task.delay`` like usual, but
  513. if you want greater control over the message sent, you want
  514. ``celery.task.apply_async`` and ``celery.Task.apply_async``.
  515. This also means the AMQP configuration has changed. Some settings has
  516. been renamed, while others are new::
  517. CELERY_AMQP_EXCHANGE
  518. CELERY_AMQP_PUBLISHER_ROUTING_KEY
  519. CELERY_AMQP_CONSUMER_ROUTING_KEY
  520. CELERY_AMQP_CONSUMER_QUEUE
  521. CELERY_AMQP_EXCHANGE_TYPE
  522. See the entry `Can I send some tasks to only some servers?`_ in the
  523. `FAQ`_ for more information.
  524. .. _`Can I send some tasks to only some servers?`:
  525. http://bit.ly/celery_AMQP_routing
  526. .. _`FAQ`: http://ask.github.com/celery/faq.html
  527. * Task errors are now logged using loglevel ``ERROR`` instead of ``INFO``,
  528. and backtraces are dumped. Thanks to Grégoire Cachet.
  529. * Make every new worker process re-establish it's Django DB connection,
  530. this solving the "MySQL connection died?" exceptions.
  531. Thanks to Vitaly Babiy and Jirka Vejrazka.
  532. * **IMOPORTANT** Now using pickle to encode task arguments. This means you
  533. now can pass complex python objects to tasks as arguments.
  534. * Removed dependency to ``yadayada``.
  535. * Added a FAQ, see ``docs/faq.rst``.
  536. * Now converts any unicode keys in task ``kwargs`` to regular strings.
  537. Thanks Vitaly Babiy.
  538. * Renamed the ``TaskDaemon`` to ``WorkController``.
  539. * ``celery.datastructures.TaskProcessQueue`` is now renamed to
  540. ``celery.pool.TaskPool``.
  541. * The pool algorithm has been refactored for greater performance and
  542. stability.
  543. 0.2.0 [2009-05-20 05:14 P.M CET]
  544. ================================
  545. * Final release of 0.2.0
  546. * Compatible with carrot version 0.4.0.
  547. * Fixes some syntax errors related to fetching results
  548. from the database backend.
  549. 0.2.0-pre3 [2009-05-20 05:14 P.M CET]
  550. =====================================
  551. * *Internal release*. Improved handling of unpickled exceptions,
  552. ``get_result`` now tries to recreate something looking like the
  553. original exception.
  554. 0.2.0-pre2 [2009-05-20 01:56 P.M CET]
  555. =====================================
  556. * Now handles unpickleable exceptions (like the dynimically generated
  557. subclasses of ``django.core.exception.MultipleObjectsReturned``).
  558. 0.2.0-pre1 [2009-05-20 12:33 P.M CET]
  559. =====================================
  560. * It's getting quite stable, with a lot of new features, so bump
  561. version to 0.2. This is a pre-release.
  562. * ``celery.task.mark_as_read()`` and ``celery.task.mark_as_failure()`` has
  563. been removed. Use ``celery.backends.default_backend.mark_as_read()``,
  564. and ``celery.backends.default_backend.mark_as_failure()`` instead.
  565. 0.1.15 [2009-05-19 04:13 P.M CET]
  566. =================================
  567. * The celery daemon was leaking AMQP connections, this should be fixed,
  568. if you have any problems with too many files open (like ``emfile``
  569. errors in ``rabbit.log``, please contact us!
  570. 0.1.14 [2009-05-19 01:08 P.M CET]
  571. =================================
  572. * Fixed a syntax error in the ``TaskSet`` class. (No such variable
  573. ``TimeOutError``).
  574. 0.1.13 [2009-05-19 12:36 P.M CET]
  575. =================================
  576. * Forgot to add ``yadayada`` to install requirements.
  577. * Now deletes all expired task results, not just those marked as done.
  578. * Able to load the Tokyo Tyrant backend class without django
  579. configuration, can specify tyrant settings directly in the class
  580. constructor.
  581. * Improved API documentation
  582. * Now using the Sphinx documentation system, you can build
  583. the html documentation by doing ::
  584. $ cd docs
  585. $ make html
  586. and the result will be in ``docs/.build/html``.
  587. 0.1.12 [2009-05-18 04:38 P.M CET]
  588. =================================
  589. * ``delay_task()`` etc. now returns ``celery.task.AsyncResult`` object,
  590. which lets you check the result and any failure that might have
  591. happened. It kind of works like the ``multiprocessing.AsyncResult``
  592. class returned by ``multiprocessing.Pool.map_async``.
  593. * Added dmap() and dmap_async(). This works like the
  594. ``multiprocessing.Pool`` versions except they are tasks
  595. distributed to the celery server. Example:
  596. >>> from celery.task import dmap
  597. >>> import operator
  598. >>> dmap(operator.add, [[2, 2], [4, 4], [8, 8]])
  599. >>> [4, 8, 16]
  600. >>> from celery.task import dmap_async
  601. >>> import operator
  602. >>> result = dmap_async(operator.add, [[2, 2], [4, 4], [8, 8]])
  603. >>> result.ready()
  604. False
  605. >>> time.sleep(1)
  606. >>> result.ready()
  607. True
  608. >>> result.result
  609. [4, 8, 16]
  610. * Refactored the task metadata cache and database backends, and added
  611. a new backend for Tokyo Tyrant. You can set the backend in your django
  612. settings file. e.g::
  613. CELERY_BACKEND = "database"; # Uses the database
  614. CELERY_BACKEND = "cache"; # Uses the django cache framework
  615. CELERY_BACKEND = "tyrant"; # Uses Tokyo Tyrant
  616. TT_HOST = "localhost"; # Hostname for the Tokyo Tyrant server.
  617. TT_PORT = 6657; # Port of the Tokyo Tyrant server.
  618. 0.1.11 [2009-05-12 02:08 P.M CET]
  619. =================================
  620. * The logging system was leaking file descriptors, resulting in
  621. servers stopping with the EMFILES (too many open files) error. (fixed)
  622. 0.1.10 [2009-05-11 12:46 P.M CET]
  623. =================================
  624. * Tasks now supports both positional arguments and keyword arguments.
  625. * Requires carrot 0.3.8.
  626. * The daemon now tries to reconnect if the connection is lost.
  627. 0.1.8 [2009-05-07 12:27 P.M CET]
  628. ================================
  629. * Better test coverage
  630. * More documentation
  631. * celeryd doesn't emit ``Queue is empty`` message if
  632. ``settings.CELERYD_EMPTY_MSG_EMIT_EVERY`` is 0.
  633. 0.1.7 [2009-04-30 1:50 P.M CET]
  634. ===============================
  635. * Added some unittests
  636. * Can now use the database for task metadata (like if the task has
  637. been executed or not). Set ``settings.CELERY_TASK_META``
  638. * Can now run ``python setup.py test`` to run the unittests from
  639. within the ``testproj`` project.
  640. * Can set the AMQP exchange/routing key/queue using
  641. ``settings.CELERY_AMQP_EXCHANGE``, ``settings.CELERY_AMQP_ROUTING_KEY``,
  642. and ``settings.CELERY_AMQP_CONSUMER_QUEUE``.
  643. 0.1.6 [2009-04-28 2:13 P.M CET]
  644. ===============================
  645. * Introducing ``TaskSet``. A set of subtasks is executed and you can
  646. find out how many, or if all them, are done (excellent for progress
  647. bars and such)
  648. * Now catches all exceptions when running ``Task.__call__``, so the
  649. daemon doesn't die. This does't happen for pure functions yet, only
  650. ``Task`` classes.
  651. * ``autodiscover()`` now works with zipped eggs.
  652. * celeryd: Now adds curernt working directory to ``sys.path`` for
  653. convenience.
  654. * The ``run_every`` attribute of ``PeriodicTask`` classes can now be a
  655. ``datetime.timedelta()`` object.
  656. * celeryd: You can now set the ``DJANGO_PROJECT_DIR`` variable
  657. for ``celeryd`` and it will add that to ``sys.path`` for easy launching.
  658. * Can now check if a task has been executed or not via HTTP.
  659. * You can do this by including the celery ``urls.py`` into your project,
  660. >>> url(r'^celery/$', include("celery.urls"))
  661. then visiting the following url,::
  662. http://mysite/celery/$task_id/done/
  663. this will return a JSON dictionary like e.g:
  664. >>> {"task": {"id": $task_id, "executed": true}}
  665. * ``delay_task`` now returns string id, not ``uuid.UUID`` instance.
  666. * Now has ``PeriodicTasks``, to have ``cron`` like functionality.
  667. * Project changed name from ``crunchy`` to ``celery``. The details of
  668. the name change request is in ``docs/name_change_request.txt``.
  669. 0.1.0 [2009-04-24 11:28 A.M CET]
  670. ================================
  671. * Initial release