Autogenerated documentation for github.

genindex.html

@@ -82,11 +82,13 @@
 <table width="100%" class="indextable"><tr><td width="33%" valign="top">
 <dl>
 
+<dt><a href="reference/celery.datastructures.html#celery.datastructures.TaskProcessQueue.add">add() (celery.datastructures.TaskProcessQueue method)</a></dt>
 <dt><a href="reference/celery.registry.html#celery.registry.AlreadyRegistered">AlreadyRegistered</a></dt>
 <dt><a href="reference/celery.conf.html#celery.conf.AMQP_CONSUMER_QUEUE">AMQP_CONSUMER_QUEUE (in module celery.conf)</a></dt>
 <dt><a href="reference/celery.conf.html#celery.conf.AMQP_EXCHANGE">AMQP_EXCHANGE (in module celery.conf)</a></dt>
 <dt><a href="reference/celery.conf.html#celery.conf.AMQP_ROUTING_KEY">AMQP_ROUTING_KEY (in module celery.conf)</a></dt>
-<dt><a href="reference/celery.task.html#celery.task.AsynchronousMapTask">AsynchronousMapTask (class in celery.task)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="reference/celery.task.html#celery.task.TaskSet.arguments">arguments (celery.task.TaskSet attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="reference/celery.task.html#celery.task.AsynchronousMapTask">AsynchronousMapTask (class in celery.task)</a></dt>
 <dt><a href="reference/celery.result.html#celery.result.AsyncResult">AsyncResult (class in celery.result)</a></dt>
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry.autodiscover">autodiscover() (celery.registry.TaskRegistry method)</a></dt>
   <dd><dl>
@@ -161,22 +163,22 @@
 <dt><a href="reference/celery.conf.html#celery.conf.DAEMON_PID_FILE">DAEMON_PID_FILE (in module celery.conf)</a></dt>
 <dt><a href="reference/celery.platform.html#celery.platform.daemonize">daemonize() (in module celery.platform)</a></dt>
 <dt><a href="reference/celery.models.html#TaskMeta.date_done">date_done (TaskMeta attribute)</a></dt>
-<dt><a href="reference/celery.backends.html#celery.backends.default_backend">default_backend (in module celery.backends)</a></dt>
 <dt><a href="reference/celery.backends.html#celery.backends.DefaultBackend">DefaultBackend (class in celery.backends)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.Task.delay">delay() (celery.task.Task class method)</a></dt>
   <dd><dl>
     <dt><a href="reference/celery.models.html#PeriodicTaskMeta.delay">(PeriodicTaskMeta method)</a></dt>
-  </dl></dd></dl></td><td width="33%" valign="top"><dl>
+  </dl></dd>
 <dt><a href="reference/celery.messaging.html#celery.messaging.TaskPublisher.delay_task">delay_task() (celery.messaging.TaskPublisher method)</a></dt>
   <dd><dl>
     <dt><a href="reference/celery.task.html#celery.task.delay_task">(in module celery.task)</a></dt>
-  </dl></dd>
+  </dl></dd></dl></td><td width="33%" valign="top"><dl>
 <dt><a href="reference/celery.messaging.html#celery.messaging.TaskPublisher.delay_task_in_set">delay_task_in_set() (celery.messaging.TaskPublisher method)</a></dt>
 <dt><a href="reference/celery.managers.html#celery.managers.TaskManager.delete_expired">delete_expired() (celery.managers.TaskManager method)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.DeleteExpiredTaskMetaTask">DeleteExpiredTaskMetaTask (class in celery.task)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.discard_all">discard_all() (in module celery.task)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.dmap">dmap() (in module celery.task)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.dmap_async">dmap_async() (in module celery.task)</a></dt>
+<dt><a href="reference/celery.datastructures.html#celery.datastructures.TaskProcessQueue.done_msg">done_msg (celery.datastructures.TaskProcessQueue attribute)</a></dt>
 </dl></td></tr></table>
 
 <h2 id="E">E</h2>
@@ -220,7 +222,7 @@
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry.get_all_regular">get_all_regular() (celery.registry.TaskRegistry method)</a></dt>
 <dt><a href="reference/celery.backends.html#celery.backends.get_backend_cls">get_backend_cls() (in module celery.backends)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.Task.get_consumer">get_consumer() (celery.task.Task method)</a></dt>
-<dt><a href="reference/celery.backends.html#celery.backends.get_default_backend_cls">get_default_backend_cls() (in module celery.backends)</a></dt>
+<dt><a href="reference/celery.backends.html#celery.backends.get_default_backend_cls">get_default_backend_cls (in module celery.backends)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.Task.get_logger">get_logger() (celery.task.Task method)</a></dt>
 <dt><a href="reference/celery.platform.html#celery.platform.PIDFile.get_pid">get_pid() (celery.platform.PIDFile method)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.Task.get_publisher">get_publisher() (celery.task.Task method)</a></dt>
@@ -275,10 +277,14 @@
 
 <dt><a href="reference/celery.models.html#PeriodicTaskMeta.last_run_at">last_run_at (PeriodicTaskMeta attribute)</a></dt>
 <dt><a href="reference/celery.timer.html#celery.timer.EventTimer.last_triggered">last_triggered (celery.timer.EventTimer attribute)</a></dt>
+<dt><a href="reference/celery.datastructures.html#celery.datastructures.TaskProcessQueue.limit">limit (celery.datastructures.TaskProcessQueue attribute)</a></dt>
 <dt><a href="reference/celery.conf.html#celery.conf.LOG_FORMAT">LOG_FORMAT (in module celery.conf)</a></dt>
 <dt><a href="reference/celery.conf.html#celery.conf.LOG_LEVELS">LOG_LEVELS (in module celery.conf)</a></dt></dl></td><td width="33%" valign="top"><dl>
 <dt><a href="reference/celery.worker.html#celery.worker.TaskDaemon.logfile">logfile (celery.worker.TaskDaemon attribute)</a></dt>
-<dt><a href="reference/celery.worker.html#celery.worker.TaskDaemon.logger">logger (celery.worker.TaskDaemon attribute)</a></dt>
+<dt><a href="reference/celery.datastructures.html#celery.datastructures.TaskProcessQueue.logger">logger (celery.datastructures.TaskProcessQueue attribute)</a></dt>
+  <dd><dl>
+    <dt><a href="reference/celery.worker.html#celery.worker.TaskDaemon.logger">(celery.worker.TaskDaemon attribute)</a></dt>
+  </dl></dd>
 <dt><a href="reference/celery.worker.html#celery.worker.TaskDaemon.loglevel">loglevel (celery.worker.TaskDaemon attribute)</a></dt>
 </dl></td></tr></table>
 
@@ -303,7 +309,10 @@
 <table width="100%" class="indextable"><tr><td width="33%" valign="top">
 <dl>
 
-<dt><a href="reference/celery.models.html#PeriodicTaskMeta.name">name (PeriodicTaskMeta attribute)</a></dt>
+<dt><a href="reference/celery.task.html#celery.task.Task.name">name (celery.task.Task attribute)</a></dt>
+  <dd><dl>
+    <dt><a href="reference/celery.models.html#PeriodicTaskMeta.name">(PeriodicTaskMeta attribute)</a></dt>
+  </dl></dd>
 <dt><a href="reference/celery.messaging.html#celery.messaging.NoProcessConsumer">NoProcessConsumer (class in celery.messaging)</a></dt></dl></td><td width="33%" valign="top"><dl>
 <dt><a href="reference/celery.registry.html#celery.registry.NotRegistered">NotRegistered</a></dt>
 </dl></td></tr></table>
@@ -353,6 +362,7 @@
     <dt><a href="reference/celery.task.html#celery.task.TaskSet.run">(celery.task.TaskSet method)</a></dt>
     <dt><a href="reference/celery.worker.html#celery.worker.TaskDaemon.run">(celery.worker.TaskDaemon method)</a></dt>
   </dl></dd>
+<dt><a href="reference/celery.task.html#celery.task.PeriodicTask.run_every">run_every (celery.task.PeriodicTask attribute)</a></dt>
 <dt><a href="reference/celery.worker.html#celery.worker.TaskDaemon.run_periodic_tasks">run_periodic_tasks() (celery.worker.TaskDaemon method)</a></dt>
 </dl></td></tr></table>
 
@@ -388,6 +398,7 @@
     <dt><a href="reference/celery.models.html#TaskMeta.task_id">(TaskMeta attribute)</a></dt>
     <dt><a href="reference/celery.result.html#celery.result.BaseAsyncResult.task_id">(celery.result.BaseAsyncResult attribute)</a></dt>
   </dl></dd>
+<dt><a href="reference/celery.task.html#celery.task.TaskSet.task_name">task_name (celery.task.TaskSet attribute)</a></dt>
 <dt><a href="reference/celery.models.html#TASK_STATUS_DONE">TASK_STATUS_DONE (built-in variable)</a></dt>
 <dt><a href="reference/celery.models.html#TASK_STATUS_FAILURE">TASK_STATUS_FAILURE (built-in variable)</a></dt>
 <dt><a href="reference/celery.models.html#TASK_STATUS_PENDING">TASK_STATUS_PENDING (built-in variable)</a></dt>
@@ -403,7 +414,6 @@
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry">TaskRegistry (class in celery.registry)</a></dt>
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry.AlreadyRegistered">TaskRegistry.AlreadyRegistered</a></dt>
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry.NotRegistered">TaskRegistry.NotRegistered</a></dt>
-<dt><a href="reference/celery.registry.html#celery.registry.tasks">tasks (in module celery.registry)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.TaskSet">TaskSet (class in celery.task)</a></dt>
 <dt><a href="reference/celery.worker.html#celery.worker.TaskWrapper">TaskWrapper (class in celery.worker)</a></dt>
 <dt><a href="reference/celery.timer.html#celery.timer.EventTimer.tick">tick() (celery.timer.EventTimer method)</a></dt>
@@ -414,7 +424,9 @@
 <dt><a href="reference/celery.timer.html#celery.timer.TimeoutTimer.timeout">timeout (celery.timer.TimeoutTimer attribute)</a></dt>
 <dt><a href="reference/celery.timer.html#celery.timer.TimeoutError">TimeoutError</a></dt>
 <dt><a href="reference/celery.timer.html#celery.timer.TimeoutTimer">TimeoutTimer (class in celery.timer)</a></dt>
+<dt><a href="reference/celery.task.html#celery.task.TaskSet.total">total (celery.task.TaskSet attribute)</a></dt>
 <dt><a href="reference/celery.models.html#PeriodicTaskMeta.total_run_count">total_run_count (PeriodicTaskMeta attribute)</a></dt>
+<dt><a href="reference/celery.task.html#celery.task.Task.type">type (celery.task.Task attribute)</a></dt>
 <dt><a href="reference/celery.backends.tyrant.html#celery.backends.tyrant.Backend.tyrant_host">tyrant_host (celery.backends.tyrant.Backend attribute)</a></dt>
 <dt><a href="reference/celery.backends.tyrant.html#celery.backends.tyrant.Backend.tyrant_port">tyrant_port (celery.backends.tyrant.Backend attribute)</a></dt>
 </dl></td></tr></table>

objects.inv

@@ -19,6 +19,7 @@ celery.bin.celeryd mod reference/celery.bin.celeryd.html
 celery.discovery mod reference/celery.discovery.html
 celery.timer mod reference/celery.timer.html
 celery.backends.tyrant mod reference/celery.backends.tyrant.html
+celery.task.TaskSet.task_name attribute reference/celery.task.html
 celery.log.emergency_error function reference/celery.log.html
 celery.backends.base.BaseBackend.get_result method reference/celery.backends.base.html
 celery.task.dmap function reference/celery.task.html
@@ -34,12 +35,14 @@ celery.result.BaseAsyncResult.backend attribute reference/celery.result.html
 celery.worker.TaskWrapper class reference/celery.worker.html
 celery.datastructures.PositionQueue.full method reference/celery.datastructures.html
 celery.discovery.find_related_module function reference/celery.discovery.html
+celery.task.TaskSet.join method reference/celery.task.html
 celery.result.BaseAsyncResult.ready method reference/celery.result.html
 celery.worker.EmptyQueue exception reference/celery.worker.html
 celery.worker.TaskDaemon.fetch_next_task method reference/celery.worker.html
 celery.registry.TaskRegistry.AlreadyRegistered exception reference/celery.registry.html
 celery.managers.TaskManager.delete_expired method reference/celery.managers.html
 celery.registry.TaskRegistry.filter_types method reference/celery.registry.html
+celery.worker.jail function reference/celery.worker.html
 celery.worker.TaskDaemon.receive_message method reference/celery.worker.html
 celery.conf.AMQP_CONSUMER_QUEUE data reference/celery.conf.html
 celery.task.DeleteExpiredTaskMetaTask class reference/celery.task.html
@@ -48,7 +51,7 @@ celery.managers.TaskManager.get_all_expired method reference/celery.managers.htm
 TaskMeta.task_id attribute reference/celery.models.html
 celery.discovery.autodiscover function reference/celery.discovery.html
 celery.worker.TaskDaemon class reference/celery.worker.html
-celery.backends.get_default_backend_cls function reference/celery.backends.html
+celery.backends.get_default_backend_cls data reference/celery.backends.html
 celery.backends.tyrant.Backend.get_result method reference/celery.backends.tyrant.html
 celery.task.TaskSet class reference/celery.task.html
 celery.worker.TaskDaemon.loglevel attribute reference/celery.worker.html
@@ -68,6 +71,7 @@ celery.platform.PIDFile.remove method reference/celery.platform.html
 PeriodicTaskMeta.task attribute reference/celery.models.html
 celery.log.setup_logger function reference/celery.log.html
 celery.backends.base.BaseBackend.wait_for method reference/celery.backends.base.html
+celery.task.Task.name attribute reference/celery.task.html
 celery.backends.base.BaseBackend.mark_as_done method reference/celery.backends.base.html
 celery.registry.TaskRegistry.get_all_periodic method reference/celery.registry.html
 celery.worker.TaskWrapper.extend_kwargs_with_logging method reference/celery.worker.html
@@ -93,7 +97,7 @@ celery.task.dmap_async function reference/celery.task.html
 celery.worker.TaskDaemon.receive_message_cc method reference/celery.worker.html
 celery.managers.TaskManager class reference/celery.managers.html
 celery.backends.base.BaseBackend.store_result method reference/celery.backends.base.html
-celery.worker.jail function reference/celery.worker.html
+celery.datastructures.TaskProcessQueue.logger attribute reference/celery.datastructures.html
 celery.result.AsyncResult.task_id attribute reference/celery.result.html
 celery.timer.EventTimer.interval attribute reference/celery.timer.html
 celery.result.BaseAsyncResult.successful method reference/celery.result.html
@@ -102,15 +106,16 @@ celery.conf.LOG_FORMAT data reference/celery.conf.html
 TASK_STATUSES data reference/celery.models.html
 celery.managers.TaskManager.get_task method reference/celery.managers.html
 celery.conf.AMQP_EXCHANGE data reference/celery.conf.html
-celery.registry.tasks data reference/celery.registry.html
 celery.worker.TaskDaemon.task_consumer attribute reference/celery.worker.html
 celery.conf.AMQP_ROUTING_KEY data reference/celery.conf.html
 celery.timer.TimeoutTimer.timeout attribute reference/celery.timer.html
 celery.result.AsyncResult.backend attribute reference/celery.result.html
 celery.backends.database.Backend.cleanup method reference/celery.backends.database.html
+celery.task.TaskSet.total attribute reference/celery.task.html
 celery.conf.DAEMON_LOG_LEVEL data reference/celery.conf.html
 celery.backends.database.Backend class reference/celery.backends.database.html
 celery.result.BaseAsyncResult.status attribute reference/celery.result.html
+celery.datastructures.TaskProcessQueue.limit attribute reference/celery.datastructures.html
 celery.conf.QUEUE_WAKEUP_AFTER data reference/celery.conf.html
 celery.backends.database.Backend.get_result method reference/celery.backends.database.html
 celery.backends.get_backend_cls function reference/celery.backends.html
@@ -121,6 +126,7 @@ celery.task.TaskSet.map classmethod reference/celery.task.html
 celery.backends.cache.Backend.get_result method reference/celery.backends.cache.html
 celery.task.Task.get_logger method reference/celery.task.html
 celery.conf.DAEMON_LOG_FILE data reference/celery.conf.html
+celery.datastructures.TaskProcessQueue.add method reference/celery.datastructures.html
 celery.task.PeriodicTask class reference/celery.task.html
 celery.registry.TaskRegistry.unregister method reference/celery.registry.html
 celery.task.TaskSet.remote_execute classmethod reference/celery.task.html
@@ -143,7 +149,7 @@ celery.platform.remove_pidfile function reference/celery.platform.html
 celery.platform.PIDFile class reference/celery.platform.html
 celery.managers.PeriodicTaskManager.get_waiting_tasks method reference/celery.managers.html
 celery.messaging.TaskPublisher.delay_task method reference/celery.messaging.html
-celery.task.TaskSet.join method reference/celery.task.html
+celery.datastructures.TaskProcessQueue.done_msg attribute reference/celery.datastructures.html
 celery.registry.TaskRegistry.get_all_regular method reference/celery.registry.html
 celery.worker.TaskDaemon.logger attribute reference/celery.worker.html
 celery.registry.TaskRegistry class reference/celery.registry.html
@@ -170,6 +176,7 @@ TASK_STATUS_DONE data reference/celery.models.html
 celery.worker.TaskDaemon.concurrency attribute reference/celery.worker.html
 celery.backends.cache.Backend class reference/celery.backends.cache.html
 celery.task.is_done function reference/celery.task.html
+celery.task.PeriodicTask.run_every attribute reference/celery.task.html
 celery.conf.LOG_LEVELS data reference/celery.conf.html
 celery.managers.TaskManager.is_done method reference/celery.managers.html
 celery.timer.EventTimer.tick method reference/celery.timer.html
@@ -189,7 +196,7 @@ celery.conf.DAEMON_PID_FILE data reference/celery.conf.html
 celery.task.Task class reference/celery.task.html
 celery.backends.base.BaseBackend.get_status method reference/celery.backends.base.html
 celery.registry.TaskRegistry.autodiscover method reference/celery.registry.html
-celery.backends.default_backend data reference/celery.backends.html
+celery.task.Task.type attribute reference/celery.task.html
 celery.task.TaskSet.iterate method reference/celery.task.html
 PeriodicTaskMeta.total_run_count attribute reference/celery.models.html
 celery.datastructures.PositionQueue.UnfilledPosition class reference/celery.datastructures.html
@@ -200,3 +207,4 @@ celery.platform.daemonize function reference/celery.platform.html
 celery.managers.TaskManager.store_result method reference/celery.managers.html
 TaskMeta.result attribute reference/celery.models.html
 celery.timer.TimeoutTimer.time_start attribute reference/celery.timer.html
+celery.task.TaskSet.arguments attribute reference/celery.task.html

reference/celery.backends.base.html

@@ -107,10 +107,10 @@ class </em><tt class="descclassname">celery.backends.base.</tt><tt class="descna
 <tt class="descname">wait_for</tt><big>(</big><em>task_id</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.wait_for" title="Permalink to this definition">¶</a></dt>
 <dd><p>Wait for task and return its result.</p>
 <p>If the task raises an exception, this exception
-will be re-raised by <tt class="docutils literal"><span class="pre">wait_for</span></tt>.</p>
-<p>If <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt>, this raises
-<tt class="docutils literal"><span class="pre">celery.timer.TimeoutError</span></tt> if the operation takes longer than
-<tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</p>
+will be re-raised by <a title="celery.backends.base.BaseBackend.wait_for" class="reference internal" href="#celery.backends.base.BaseBackend.wait_for"><tt class="xref docutils literal"><span class="pre">wait_for()</span></tt></a>.</p>
+<p>If <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt>, this raises the
+<a title="celery.timer.TimeoutError" class="reference external" href="celery.timer.html#celery.timer.TimeoutError"><tt class="xref docutils literal"><span class="pre">celery.timer.TimeoutError</span></tt></a> exception if the operation takes
+longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</p>
 </dd></dl>
 
 </dd></dl>

reference/celery.backends.html

@@ -55,26 +55,21 @@
 <dt id="celery.backends.get_backend_cls">
 <tt class="descclassname">celery.backends.</tt><tt class="descname">get_backend_cls</tt><big>(</big><em>backend</em><big>)</big><a class="headerlink" href="#celery.backends.get_backend_cls" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get backend class by name.</p>
-<p>If the name does not include <tt class="docutils literal"><span class="pre">.</span></tt> (is not fully qualified),
+<p>If the name does not include &#8220;<tt class="docutils literal"><span class="pre">.</span></tt>&#8221; (is not fully qualified),
 <tt class="docutils literal"><span class="pre">celery.backends.</span></tt> will be prepended to the name. e.g.
 <tt class="docutils literal"><span class="pre">database</span></tt> becomes <tt class="docutils literal"><span class="pre">celery.backends.database</span></tt>.</p>
 </dd></dl>
 
-<dl class="function">
+<dl class="data">
 <dt id="celery.backends.get_default_backend_cls">
-<tt class="descclassname">celery.backends.</tt><tt class="descname">get_default_backend_cls</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.backends.get_default_backend_cls" title="Permalink to this definition">¶</a></dt>
-<dd>Get the backend class specified in <tt class="docutils literal"><span class="pre">settings.CELERY_BACKEND</span></tt>.</dd></dl>
-
-<dl class="class">
+<tt class="descclassname">celery.backends.</tt><tt class="descname">get_default_backend_cls</tt><a class="headerlink" href="#celery.backends.get_default_backend_cls" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="class">
 <dt id="celery.backends.DefaultBackend">
 <em class="property">
 class </em><tt class="descclassname">celery.backends.</tt><tt class="descname">DefaultBackend</tt><a class="headerlink" href="#celery.backends.DefaultBackend" title="Permalink to this definition">¶</a></dt>
-<dd>The backend class specified in <tt class="docutils literal"><span class="pre">settings.CELERY_BACKEND</span></tt>.</dd></dl>
+<dd>The backend class specified in <tt class="xref docutils literal"><span class="pre">CELERY_BACKEND</span></tt>.</dd></dl>
 
-<dl class="data">
-<dt id="celery.backends.default_backend">
-<tt class="descclassname">celery.backends.</tt><tt class="descname">default_backend</tt><a class="headerlink" href="#celery.backends.default_backend" title="Permalink to this definition">¶</a></dt>
-<dd>An instance of <a title="celery.backends.DefaultBackend" class="reference internal" href="#celery.backends.DefaultBackend"><tt class="xref docutils literal"><span class="pre">DefaultBackend</span></tt></a>.</dd></dl>
+</dd></dl>
 
 </div>
 

reference/celery.datastructures.html

@@ -50,12 +50,22 @@
             
   <div class="section" id="module-celery.datastructures">
 <h1>Datastructures - celery.datastructures<a class="headerlink" href="#module-celery.datastructures" title="Permalink to this headline">¶</a></h1>
-<p>celery.datastructures</p>
+<p>Custom Datastructures</p>
 <dl class="class">
 <dt id="celery.datastructures.PositionQueue">
 <em class="property">
 class </em><tt class="descclassname">celery.datastructures.</tt><tt class="descname">PositionQueue</tt><big>(</big><em>length</em><big>)</big><a class="headerlink" href="#celery.datastructures.PositionQueue" title="Permalink to this definition">¶</a></dt>
-<dd><p>A positional queue with filled/unfilled slots.</p>
+<dd><p>A positional queue of a specific length, with slots that are either
+filled or unfilled. When all of the positions are filled, the queue
+is considered <a title="celery.datastructures.PositionQueue.full" class="reference internal" href="#celery.datastructures.PositionQueue.full"><tt class="xref docutils literal"><span class="pre">full()</span></tt></a>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>length</em> &#8211; The number of items required for the queue to be filled.</td>
+</tr>
+</tbody>
+</table>
 <dl class="class">
 <dt id="celery.datastructures.PositionQueue.UnfilledPosition">
 <em class="property">
@@ -70,7 +80,7 @@ class </em><tt class="descname">UnfilledPosition</tt><big>(</big><em>position</e
 <dl class="method">
 <dt id="celery.datastructures.PositionQueue.full">
 <tt class="descclassname">PositionQueue.</tt><tt class="descname">full</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.datastructures.PositionQueue.full" title="Permalink to this definition">¶</a></dt>
-<dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if all the positions has been filled.</dd></dl>
+<dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if all of the slots has been filled.</dd></dl>
 
 </dd></dl>
 
@@ -78,8 +88,62 @@ class </em><tt class="descname">UnfilledPosition</tt><big>(</big><em>position</e
 <dt id="celery.datastructures.TaskProcessQueue">
 <em class="property">
 class </em><tt class="descclassname">celery.datastructures.</tt><tt class="descname">TaskProcessQueue</tt><big>(</big><em>limit</em>, <em>logger=None</em>, <em>done_msg=None</em><big>)</big><a class="headerlink" href="#celery.datastructures.TaskProcessQueue" title="Permalink to this definition">¶</a></dt>
-<dd>Queue of running child processes, which starts waiting for the
-processes to finish when the queue limit is reached.</dd></dl>
+<dd><p>Queue of running child processes, which starts waiting for the
+processes to finish when the queue limit is reached.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>limit</em> &#8211; see <a title="celery.datastructures.TaskProcessQueue.limit" class="reference internal" href="#celery.datastructures.TaskProcessQueue.limit"><tt class="xref docutils literal"><span class="pre">limit</span></tt></a> attribute.</li>
+<li><em>logger</em> &#8211; see <a title="celery.datastructures.TaskProcessQueue.logger" class="reference internal" href="#celery.datastructures.TaskProcessQueue.logger"><tt class="xref docutils literal"><span class="pre">logger</span></tt></a> attribute.</li>
+<li><em>done_msg</em> &#8211; see <a title="celery.datastructures.TaskProcessQueue.done_msg" class="reference internal" href="#celery.datastructures.TaskProcessQueue.done_msg"><tt class="xref docutils literal"><span class="pre">done_msg</span></tt></a> attribute.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<dl class="attribute">
+<dt id="celery.datastructures.TaskProcessQueue.limit">
+<tt class="descname">limit</tt><a class="headerlink" href="#celery.datastructures.TaskProcessQueue.limit" title="Permalink to this definition">¶</a></dt>
+<dd>The number of processes that can run simultaneously until
+we start collecting results.</dd></dl>
+
+<dl class="attribute">
+<dt id="celery.datastructures.TaskProcessQueue.logger">
+<tt class="descname">logger</tt><a class="headerlink" href="#celery.datastructures.TaskProcessQueue.logger" title="Permalink to this definition">¶</a></dt>
+<dd>The logger used to print the <a title="celery.datastructures.TaskProcessQueue.done_msg" class="reference internal" href="#celery.datastructures.TaskProcessQueue.done_msg"><tt class="xref docutils literal"><span class="pre">done_msg</span></tt></a>.</dd></dl>
+
+<dl class="attribute">
+<dt id="celery.datastructures.TaskProcessQueue.done_msg">
+<tt class="descname">done_msg</tt><a class="headerlink" href="#celery.datastructures.TaskProcessQueue.done_msg" title="Permalink to this definition">¶</a></dt>
+<dd>Message logged when a tasks result has been collected.
+The message is logged with loglevel <tt class="xref docutils literal"><span class="pre">logging.INFO</span></tt>.</dd></dl>
+
+<dl class="method">
+<dt id="celery.datastructures.TaskProcessQueue.add">
+<tt class="descname">add</tt><big>(</big><em>result</em>, <em>task_name</em>, <em>task_id</em><big>)</big><a class="headerlink" href="#celery.datastructures.TaskProcessQueue.add" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a process to the queue.</p>
+<p>If the queue is full, it will start to collect return values from
+the tasks executed. When all return values has been collected,
+it deletes the current queue and is ready to accept new processes.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>result</em> &#8211; A <tt class="xref docutils literal"><span class="pre">multiprocessing.AsyncResult</span></tt> instance, as
+returned by <tt class="xref docutils literal"><span class="pre">multiprocessing.Pool.apply_async()</span></tt>.</li>
+<li><em>task_name</em> &#8211; Name of the task executed.</li>
+<li><em>task_id</em> &#8211; Id of the task executed.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
 
 </div>
 

reference/celery.managers.html

@@ -55,11 +55,20 @@
 <dt id="celery.managers.PeriodicTaskManager">
 <em class="property">
 class </em><tt class="descclassname">celery.managers.</tt><tt class="descname">PeriodicTaskManager</tt><a class="headerlink" href="#celery.managers.PeriodicTaskManager" title="Permalink to this definition">¶</a></dt>
-<dd><p>Manager for <tt class="docutils literal"><span class="pre">PeriodicTask</span></tt> models.</p>
+<dd><p>Manager for <tt class="xref docutils literal"><span class="pre">celery.models.PeriodicTask</span></tt> models.</p>
 <dl class="method">
 <dt id="celery.managers.PeriodicTaskManager.get_waiting_tasks">
 <tt class="descname">get_waiting_tasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.managers.PeriodicTaskManager.get_waiting_tasks" title="Permalink to this definition">¶</a></dt>
-<dd>Get all waiting periodic tasks.</dd></dl>
+<dd><p>Get all waiting periodic tasks.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of <tt class="xref docutils literal"><span class="pre">celery.models.PeriodicTaskMeta</span></tt> objects.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </dd></dl>
 
@@ -67,7 +76,7 @@ class </em><tt class="descclassname">celery.managers.</tt><tt class="descname">P
 <dt id="celery.managers.TaskManager">
 <em class="property">
 class </em><tt class="descclassname">celery.managers.</tt><tt class="descname">TaskManager</tt><a class="headerlink" href="#celery.managers.TaskManager" title="Permalink to this definition">¶</a></dt>
-<dd><p>Manager for <tt class="docutils literal"><span class="pre">Task</span></tt> models.</p>
+<dd><p>Manager for <tt class="xref docutils literal"><span class="pre">celery.models.Task</span></tt> models.</p>
 <dl class="method">
 <dt id="celery.managers.TaskManager.delete_expired">
 <tt class="descname">delete_expired</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.managers.TaskManager.delete_expired" title="Permalink to this definition">¶</a></dt>
@@ -91,7 +100,24 @@ class </em><tt class="descclassname">celery.managers.</tt><tt class="descname">T
 <dl class="method">
 <dt id="celery.managers.TaskManager.store_result">
 <tt class="descname">store_result</tt><big>(</big><em>task_id</em>, <em>result</em>, <em>status</em><big>)</big><a class="headerlink" href="#celery.managers.TaskManager.store_result" title="Permalink to this definition">¶</a></dt>
-<dd>Store the result and status of a task.</dd></dl>
+<dd><p>Store the result and status of a task.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>task_id</em> &#8211; task id</li>
+<li><em>result</em> &#8211; The return value of the task, or an exception 
+instance raised by the task.</li>
+<li><em>status</em> &#8211; Task status. See
+<tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult.get_status()</span></tt> for a list of
+possible status values.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </dd></dl>
 

reference/celery.messaging.html

@@ -50,13 +50,13 @@
             
   <div class="section" id="module-celery.messaging">
 <h1>Messaging - celery.messaging<a class="headerlink" href="#module-celery.messaging" title="Permalink to this headline">¶</a></h1>
-<p>celery.messaging</p>
+<p>Sending and Receiving Messages</p>
 <dl class="class">
 <dt id="celery.messaging.NoProcessConsumer">
 <em class="property">
 class </em><tt class="descclassname">celery.messaging.</tt><tt class="descname">NoProcessConsumer</tt><big>(</big><em>connection</em>, <em>queue=None</em>, <em>exchange=None</em>, <em>routing_key=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.messaging.NoProcessConsumer" title="Permalink to this definition">¶</a></dt>
 <dd>A consumer that raises an error if used with wait callbacks (i.e.
-it doesn&#8217;t support <tt class="docutils literal"><span class="pre">carrot.messaging.Consumer.wait</span></tt>).</dd></dl>
+it doesn&#8217;t support <tt class="xref docutils literal"><span class="pre">carrot.messaging.Consumer.wait`()</span></tt>).</dd></dl>
 
 <dl class="class">
 <dt id="celery.messaging.TaskConsumer">

reference/celery.models.html

@@ -139,8 +139,11 @@ when it should be run next.</dd></dl>
 <dl class="method">
 <dt id="PeriodicTaskMeta.delay">
 <tt class="descname">delay</tt><big>(</big><big>)</big><a class="headerlink" href="#PeriodicTaskMeta.delay" title="Permalink to this definition">¶</a></dt>
-<dd>Delay the execution of a periodic task, and increment its total
-run count.</dd></dl>
+<dt>
+<tt class="descname">Delay the execution of a periodic task, and increment its total</tt></dt>
+<dt>
+<tt class="descname">run count.</tt></dt>
+<dd></dd></dl>
 
 </dd></dl>
 

reference/celery.registry.html

@@ -50,7 +50,6 @@
             
   <div class="section" id="module-celery.registry">
 <h1>Task Registry - celery.registry<a class="headerlink" href="#module-celery.registry" title="Permalink to this headline">¶</a></h1>
-<p>celery.registry</p>
 <dl class="exception">
 <dt id="celery.registry.AlreadyRegistered">
 <em class="property">
@@ -83,7 +82,7 @@ exception </em><tt class="descclassname">TaskRegistry.</tt><tt class="descname">
 <dl class="method">
 <dt id="celery.registry.TaskRegistry.autodiscover">
 <tt class="descclassname">TaskRegistry.</tt><tt class="descname">autodiscover</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.autodiscover" title="Permalink to this definition">¶</a></dt>
-<dd>Autodiscover tasks using <tt class="docutils literal"><span class="pre">celery.discovery.autodiscover</span></tt>.</dd></dl>
+<dd>Autodiscovers tasks using <a title="celery.discovery.autodiscover" class="reference external" href="celery.discovery.html#celery.discovery.autodiscover"><tt class="xref docutils literal"><span class="pre">celery.discovery.autodiscover()</span></tt></a>.</dd></dl>
 
 <dl class="method">
 <dt id="celery.registry.TaskRegistry.filter_types">
@@ -116,23 +115,37 @@ exception </em><tt class="descclassname">TaskRegistry.</tt><tt class="descname">
 <dd><p>Register a task in the task registry.</p>
 <p>Task can either be a regular function, or a class inheriting
 from <a title="celery.task.Task" class="reference external" href="celery.task.html#celery.task.Task"><tt class="xref docutils literal"><span class="pre">celery.task.Task</span></tt></a>.</p>
-<p>If the task is a regular function, the <tt class="docutils literal"><span class="pre">task_name</span></tt> argument is
-required.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>task_name</em> &#8211; Required if the task is a regular function.</td>
+</tr>
+<tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.registry.AlreadyRegistered" class="reference internal" href="#celery.registry.AlreadyRegistered">AlreadyRegistered</a>:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">if the task is already registered.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="celery.registry.TaskRegistry.unregister">
 <tt class="descclassname">TaskRegistry.</tt><tt class="descname">unregister</tt><big>(</big><em>task_name</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.unregister" title="Permalink to this definition">¶</a></dt>
-<dd>Unregister task by name.</dd></dl>
-
+<dd><p>Unregister task by name.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>task_name</em> &#8211; name of the task to unregister.</td>
+</tr>
+<tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.registry.NotRegistered" class="reference internal" href="#celery.registry.NotRegistered">NotRegistered</a>:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">if the task has not been registered.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
-<dl class="data">
-<dt id="celery.registry.tasks">
-<tt class="descclassname">celery.registry.</tt><tt class="descname">tasks</tt><a class="headerlink" href="#celery.registry.tasks" title="Permalink to this definition">¶</a></dt>
-<dt>
-<tt class="descname">The global task registry.</tt></dt>
-<dd></dd></dl>
+</dd></dl>
 
 </div>
 

reference/celery.result.html

@@ -50,7 +50,7 @@
             
   <div class="section" id="module-celery.result">
 <h1>Task Result - celery.result<a class="headerlink" href="#module-celery.result" title="Permalink to this headline">¶</a></h1>
-<p>celery.result</p>
+<p>Asynchronous result types.</p>
 <dl class="class">
 <dt id="celery.result.AsyncResult">
 <em class="property">
@@ -64,7 +64,7 @@ class </em><tt class="descclassname">celery.result.</tt><tt class="descname">Asy
 <dl class="attribute">
 <dt id="celery.result.AsyncResult.backend">
 <tt class="descname">backend</tt><a class="headerlink" href="#celery.result.AsyncResult.backend" title="Permalink to this definition">¶</a></dt>
-<dd>Instance of <tt class="docutils literal"><span class="pre">celery.backends.DefaultBackend</span></tt>.</dd></dl>
+<dd>Instance of <a title="celery.backends.DefaultBackend" class="reference external" href="celery.backends.html#celery.backends.DefaultBackend"><tt class="xref docutils literal"><span class="pre">celery.backends.DefaultBackend</span></tt></a>.</dd></dl>
 
 </dd></dl>
 
@@ -86,7 +86,7 @@ class </em><tt class="descclassname">celery.result.</tt><tt class="descname">Bas
 <dl class="method">
 <dt id="celery.result.BaseAsyncResult.get">
 <tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.get" title="Permalink to this definition">¶</a></dt>
-<dd>Alias to <tt class="docutils literal"><span class="pre">wait</span></tt>.</dd></dl>
+<dd>Alias to <a title="celery.result.BaseAsyncResult.wait" class="reference internal" href="#celery.result.BaseAsyncResult.wait"><tt class="xref docutils literal"><span class="pre">wait()</span></tt></a>.</dd></dl>
 
 <dl class="method">
 <dt id="celery.result.BaseAsyncResult.is_done">
@@ -121,26 +121,59 @@ then <tt class="xref docutils literal"><span class="pre">False</span></tt> is re
 <dl class="attribute">
 <dt id="celery.result.BaseAsyncResult.result">
 <tt class="descname">result</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.result" title="Permalink to this definition">¶</a></dt>
-<dd>The tasks resulting value.</dd></dl>
+<dd><p>When the task is executed, this contains the return value.</p>
+<p>If the task resulted in failure, this will be the exception instance
+raised.</p>
+</dd></dl>
 
 <dl class="attribute">
 <dt id="celery.result.BaseAsyncResult.status">
 <tt class="descname">status</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.status" title="Permalink to this definition">¶</a></dt>
-<dd>The current status of the task.</dd></dl>
+<dd><p>The current status of the task.</p>
+<p>Can be one of the following:</p>
+<blockquote>
+<p><em>PENDING</em></p>
+<blockquote>
+The task is waiting for execution.</blockquote>
+<p><em>RETRY</em></p>
+<blockquote>
+The task is to be retried, possibly because of failure.</blockquote>
+<p><em>FAILURE</em></p>
+<blockquote>
+The task raised an exception, or has been retried more times
+than its limit. The <a title="celery.result.BaseAsyncResult.result" class="reference internal" href="#celery.result.BaseAsyncResult.result"><tt class="xref docutils literal"><span class="pre">result</span></tt></a> attribute contains the
+exception raised.</blockquote>
+<p><em>DONE</em></p>
+<blockquote>
+The task executed successfully. The <a title="celery.result.BaseAsyncResult.result" class="reference internal" href="#celery.result.BaseAsyncResult.result"><tt class="xref docutils literal"><span class="pre">result</span></tt></a> attribute
+contains the resulting value.</blockquote>
+</blockquote>
+</dd></dl>
 
 <dl class="method">
 <dt id="celery.result.BaseAsyncResult.successful">
 <tt class="descname">successful</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.successful" title="Permalink to this definition">¶</a></dt>
-<dd>Alias to <tt class="docutils literal"><span class="pre">is_done</span></tt>.</dd></dl>
+<dd>Alias to <a title="celery.result.BaseAsyncResult.is_done" class="reference internal" href="#celery.result.BaseAsyncResult.is_done"><tt class="xref docutils literal"><span class="pre">is_done()</span></tt></a>.</dd></dl>
 
 <dl class="method">
 <dt id="celery.result.BaseAsyncResult.wait">
 <tt class="descname">wait</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.wait" title="Permalink to this definition">¶</a></dt>
-<dd><p>Return the result when it arrives.</p>
-<p>If timeout is not <tt class="xref docutils literal"><span class="pre">None</span></tt> and the result does not arrive within
-<tt class="docutils literal"><span class="pre">timeout</span></tt> seconds then <tt class="docutils literal"><span class="pre">celery.backends.base.TimeoutError</span></tt> is
-raised. If the remote call raised an exception then that exception
-will be reraised by get().</p>
+<dd><p>Wait for task, and return the result when it arrives.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>timeout</em> &#8211; How long to wait in seconds, before the
+operation times out.</td>
+</tr>
+<tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.timer.TimeoutError" class="reference external" href="celery.timer.html#celery.timer.TimeoutError">celery.timer.TimeoutError</a>:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">if <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt> and
+the result does not arrive within <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</td>
+</tr>
+</tbody>
+</table>
+<p>If the remote call raised an exception then that
+exception will be re-raised.</p>
 </dd></dl>
 
 </dd></dl>

reference/celery.task.html

@@ -50,32 +50,49 @@
             
   <div class="section" id="module-celery.task">
 <h1>Tasks - celery.task<a class="headerlink" href="#module-celery.task" title="Permalink to this headline">¶</a></h1>
+<p>Working with tasks and task sets.</p>
 <dl class="class">
 <dt id="celery.task.AsynchronousMapTask">
 <em class="property">
 class </em><tt class="descclassname">celery.task.</tt><tt class="descname">AsynchronousMapTask</tt><a class="headerlink" href="#celery.task.AsynchronousMapTask" title="Permalink to this definition">¶</a></dt>
-<dd>Task used internally by <tt class="docutils literal"><span class="pre">dmap_async</span></tt>.</dd></dl>
+<dd>Task used internally by <a title="celery.task.dmap_async" class="reference internal" href="#celery.task.dmap_async"><tt class="xref docutils literal"><span class="pre">dmap_async()</span></tt></a> and
+<a title="celery.task.TaskSet.map_async" class="reference internal" href="#celery.task.TaskSet.map_async"><tt class="xref docutils literal"><span class="pre">TaskSet.map_async()</span></tt></a>.</dd></dl>
 
 <dl class="class">
 <dt id="celery.task.DeleteExpiredTaskMetaTask">
 <em class="property">
 class </em><tt class="descclassname">celery.task.</tt><tt class="descname">DeleteExpiredTaskMetaTask</tt><a class="headerlink" href="#celery.task.DeleteExpiredTaskMetaTask" title="Permalink to this definition">¶</a></dt>
 <dd><p>A periodic task that deletes expired task metadata every day.</p>
-<p>This runs the current backend&#8217;s cleanup() method.</p>
+<p>This runs the current backend&#8217;s
+<a title="celery.backends.base.BaseBackend.cleanup" class="reference external" href="celery.backends.base.html#celery.backends.base.BaseBackend.cleanup"><tt class="xref docutils literal"><span class="pre">celery.backends.base.BaseBackend.cleanup()</span></tt></a> method.</p>
 </dd></dl>
 
 <dl class="class">
 <dt id="celery.task.ExecuteRemoteTask">
 <em class="property">
 class </em><tt class="descclassname">celery.task.</tt><tt class="descname">ExecuteRemoteTask</tt><a class="headerlink" href="#celery.task.ExecuteRemoteTask" title="Permalink to this definition">¶</a></dt>
-<dd><p>Execute arbitrary function/object.</p>
+<dd><p>Execute an arbitrary function or object.</p>
+<p><em>Note</em> You probably want <a title="celery.task.execute_remote" class="reference internal" href="#celery.task.execute_remote"><tt class="xref docutils literal"><span class="pre">execute_remote()</span></tt></a> instead, which this
+is an internal component of.</p>
 <p>The object must be pickleable, so you can&#8217;t use lambdas or functions
-defined in the REPL.</p>
+defined in the REPL (that is the python shell, or <tt class="docutils literal"><span class="pre">ipython</span></tt>).</p>
 <dl class="method">
 <dt id="celery.task.ExecuteRemoteTask.run">
 <tt class="descname">run</tt><big>(</big><em>ser_callable</em>, <em>fargs</em>, <em>fkwargs</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.ExecuteRemoteTask.run" title="Permalink to this definition">¶</a></dt>
-<dd>Execute the pickled <tt class="docutils literal"><span class="pre">ser_callable</span></tt>, with <tt class="docutils literal"><span class="pre">fargs</span></tt> as positional
-arguments and <tt class="docutils literal"><span class="pre">fkwargs</span></tt> as keyword arguments.</dd></dl>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>ser_callable</em> &#8211; A pickled function or callable object.</li>
+<li><em>fargs</em> &#8211; Positional arguments to apply to the function.</li>
+<li><em>fkwargs</em> &#8211; Keyword arguments to apply to the function.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </dd></dl>
 
@@ -83,11 +100,26 @@ arguments and <tt class="docutils literal"><span class="pre">fkwargs</span></tt>
 <dt id="celery.task.PeriodicTask">
 <em class="property">
 class </em><tt class="descclassname">celery.task.</tt><tt class="descname">PeriodicTask</tt><a class="headerlink" href="#celery.task.PeriodicTask" title="Permalink to this definition">¶</a></dt>
-<dd><p>A periodic task is a task that behaves like a cron job.</p>
-<p>The <tt class="docutils literal"><span class="pre">run_every</span></tt> attribute defines how often the task is run (its
-interval), it can be either a <tt class="docutils literal"><span class="pre">datetime.timedelta</span></tt> object or a integer
-specifying the time in seconds.</p>
+<dd><p>A periodic task is a task that behaves like a <em>cron</em> job.</p>
+<dl class="attribute">
+<dt id="celery.task.PeriodicTask.run_every">
+<tt class="descname">run_every</tt><a class="headerlink" href="#celery.task.PeriodicTask.run_every" title="Permalink to this definition">¶</a></dt>
+<dd><em>REQUIRED</em> Defines how often the task is run (its interval),
+it can be either a <tt class="xref docutils literal"><span class="pre">datetime.timedelta</span></tt> object or an
+integer specifying the time in seconds.</dd></dl>
+
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name" colspan="2">Raises NotImplementedError:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">if the <a title="celery.task.PeriodicTask.run_every" class="reference internal" href="#celery.task.PeriodicTask.run_every"><tt class="xref docutils literal"><span class="pre">run_every</span></tt></a> attribute is
+not defined.</td>
+</tr>
+</tbody>
+</table>
 <p>You have to register the periodic task in the task registry.</p>
+<p>Example</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">tasks</span><span class="p">,</span> <span class="n">PeriodicTask</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">timedelta</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">MyPeriodicTask</span><span class="p">(</span><span class="n">PeriodicTask</span><span class="p">):</span>
@@ -107,10 +139,35 @@ specifying the time in seconds.</p>
 <em class="property">
 class </em><tt class="descclassname">celery.task.</tt><tt class="descname">Task</tt><a class="headerlink" href="#celery.task.Task" title="Permalink to this definition">¶</a></dt>
 <dd><p>A task that can be delayed for execution by the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon.</p>
-<p>All subclasses of <tt class="docutils literal"><span class="pre">Task</span></tt> has to define the <tt class="docutils literal"><span class="pre">name</span></tt> attribute, which is
-the name of the task that can be passed to <tt class="docutils literal"><span class="pre">celery.task.delay_task</span></tt>,
-it also has to define the <tt class="docutils literal"><span class="pre">run</span></tt> method, which is the actual method the
-<tt class="docutils literal"><span class="pre">celery</span></tt> daemon executes.</p>
+<p>All subclasses of <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a> must define the <a title="celery.task.Task.run" class="reference internal" href="#celery.task.Task.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a> method,
+which is the actual method the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon executes.</p>
+<p>The <a title="celery.task.Task.run" class="reference internal" href="#celery.task.Task.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a> method supports both positional, and keyword arguments.</p>
+<dl class="attribute">
+<dt id="celery.task.Task.name">
+<tt class="descname">name</tt><a class="headerlink" href="#celery.task.Task.name" title="Permalink to this definition">¶</a></dt>
+<dd><em>REQUIRED</em> All subclasses of <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a> has to define the
+<a title="celery.task.Task.name" class="reference internal" href="#celery.task.Task.name"><tt class="xref docutils literal"><span class="pre">name</span></tt></a> attribute. This is the name of the task, registered
+in the task registry, and passed to <a title="celery.task.delay_task" class="reference internal" href="#celery.task.delay_task"><tt class="xref docutils literal"><span class="pre">delay_task()</span></tt></a>.</dd></dl>
+
+<dl class="attribute">
+<dt id="celery.task.Task.type">
+<tt class="descname">type</tt><a class="headerlink" href="#celery.task.Task.type" title="Permalink to this definition">¶</a></dt>
+<dd>The type of task, currently this can be <tt class="docutils literal"><span class="pre">regular</span></tt>, or <tt class="docutils literal"><span class="pre">periodic</span></tt>,
+however if you want a periodic task, you should subclass
+<a title="celery.task.PeriodicTask" class="reference internal" href="#celery.task.PeriodicTask"><tt class="xref docutils literal"><span class="pre">PeriodicTask</span></tt></a> instead.</dd></dl>
+
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name" colspan="2">Raises NotImplementedError:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">if the <a title="celery.task.Task.name" class="reference internal" href="#celery.task.Task.name"><tt class="xref docutils literal"><span class="pre">name</span></tt></a> attribute is not set.</td>
+</tr>
+</tbody>
+</table>
+<p>The resulting class is callable, which if called will apply the
+<a title="celery.task.Task.run" class="reference internal" href="#celery.task.Task.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a> method.</p>
+<p>Examples</p>
 <p>This is a simple task just logging a message,</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">tasks</span><span class="p">,</span> <span class="n">Task</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">MyTask</span><span class="p">(</span><span class="n">Task</span><span class="p">):</span>
@@ -124,7 +181,7 @@ it also has to define the <tt class="docutils literal"><span class="pre">run</sp
 <span class="gp">... </span><span class="n">tasks</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">MyTask</span><span class="p">)</span>
 </pre></div>
 </div>
-<p>You can delay the task using the classmethod <tt class="docutils literal"><span class="pre">delay</span></tt>...</p>
+<p>You can delay the task using the classmethod <a title="celery.task.Task.delay" class="reference internal" href="#celery.task.Task.delay"><tt class="xref docutils literal"><span class="pre">delay()</span></tt></a>...</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">MyTask</span><span class="o">.</span><span class="n">delay</span><span class="p">(</span><span class="n">some_arg</span><span class="o">=</span><span class="s">&quot;foo&quot;</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">status</span> <span class="c"># after some time</span>
 <span class="go">&#39;DONE&#39;</span>
@@ -132,10 +189,10 @@ it also has to define the <tt class="docutils literal"><span class="pre">run</sp
 <span class="go">42</span>
 </pre></div>
 </div>
-<p>...or using the <tt class="docutils literal"><span class="pre">celery.task.delay_task</span></tt> function, by passing the
-name of the task.</p>
+<p>...or using the <a title="celery.task.delay_task" class="reference internal" href="#celery.task.delay_task"><tt class="xref docutils literal"><span class="pre">delay_task()</span></tt></a> function, by passing the name of
+the task.</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">delay_task</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">delay_task</span><span class="p">(</span><span class="n">MyTask</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">some_arg</span><span class="o">=</span><span class="s">&quot;foo&quot;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">delay_task</span><span class="p">(</span><span class="n">MyTask</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">some_arg</span><span class="o">=</span><span class="s">&quot;foo&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <dl class="classmethod">
@@ -147,32 +204,85 @@ classmethod </em><tt class="descname">delay</tt><big>(</big><em>*args</em>, <em>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a></td>
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><em>*args</em> &#8211; positional arguments passed on to the task.</li>
+<li><em>**kwargs</em> &#8211; keyword arguments passed on to the task.</li>
+</ul>
+</td>
+</tr>
+<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a></p>
+</td>
 </tr>
 </tbody>
 </table>
+<p>See <a title="celery.task.delay_task" class="reference internal" href="#celery.task.delay_task"><tt class="xref docutils literal"><span class="pre">delay_task()</span></tt></a>.</p>
 </dd></dl>
 
 <dl class="method">
 <dt id="celery.task.Task.get_consumer">
 <tt class="descname">get_consumer</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.Task.get_consumer" title="Permalink to this definition">¶</a></dt>
-<dd>Get a celery task message consumer.</dd></dl>
+<dd><p>Get a celery task message consumer.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a title="celery.messaging.TaskConsumer" class="reference external" href="celery.messaging.html#celery.messaging.TaskConsumer"><tt class="xref docutils literal"><span class="pre">celery.messaging.TaskConsumer</span></tt></a>.</td>
+</tr>
+</tbody>
+</table>
+<p>Please be sure to close the AMQP connection when you&#8217;re done
+with this object. i.e:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">consumer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_consumer</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="c"># do something with consumer</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">consumer</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+</pre></div>
+</div>
+</dd></dl>
 
 <dl class="method">
 <dt id="celery.task.Task.get_logger">
 <tt class="descname">get_logger</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.Task.get_logger" title="Permalink to this definition">¶</a></dt>
-<dd>Get a process-aware logger object.</dd></dl>
+<dd><p>Get process-aware logger object.</p>
+<p>See <a title="celery.log.setup_logger" class="reference external" href="celery.log.html#celery.log.setup_logger"><tt class="xref docutils literal"><span class="pre">celery.log.setup_logger()</span></tt></a>.</p>
+</dd></dl>
 
 <dl class="method">
 <dt id="celery.task.Task.get_publisher">
 <tt class="descname">get_publisher</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.Task.get_publisher" title="Permalink to this definition">¶</a></dt>
-<dd>Get a celery task message publisher.</dd></dl>
+<dd><p>Get a celery task message publisher.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a title="celery.messaging.TaskPublisher" class="reference external" href="celery.messaging.html#celery.messaging.TaskPublisher"><tt class="xref docutils literal"><span class="pre">celery.messaging.TaskPublisher</span></tt></a>.</td>
+</tr>
+</tbody>
+</table>
+<p>Please be sure to close the AMQP connection when you&#8217;re done
+with this object, i.e:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">publisher</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_publisher</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="c"># do something with publisher</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">publisher</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+</pre></div>
+</div>
+</dd></dl>
 
 <dl class="method">
 <dt id="celery.task.Task.run">
 <tt class="descname">run</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.Task.run" title="Permalink to this definition">¶</a></dt>
-<dd>The actual task. All subclasses of <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a> must define
-the run method, if not a <tt class="docutils literal"><span class="pre">NotImplementedError</span></tt> exception is raised.</dd></dl>
+<dd><p><em>REQUIRED</em> The actual task.</p>
+<p>All subclasses of <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a> must define the run method.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name" colspan="2">Raises NotImplementedError:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">by default, so you have to override
+this method in your subclass.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </dd></dl>
 
@@ -181,25 +291,56 @@ the run method, if not a <tt class="docutils literal"><span class="pre">NotImple
 <em class="property">
 class </em><tt class="descclassname">celery.task.</tt><tt class="descname">TaskSet</tt><big>(</big><em>task</em>, <em>args</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet" title="Permalink to this definition">¶</a></dt>
 <dd><p>A task containing several subtasks, making it possible
-to track how many, or when all of the tasks are completed.</p>
+to track how many, or when all of the tasks has been completed.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>task</em> &#8211; The task class or name.
+Can either be a fully qualified task name, or a task class.</li>
+<li><em>args</em> &#8211; A list of args, kwargs pairs.
+e.g. <tt class="docutils literal"><span class="pre">[[args1,</span> <span class="pre">kwargs1],</span> <span class="pre">[args2,</span> <span class="pre">kwargs2],</span> <span class="pre">...,</span> <span class="pre">[argsN,</span> <span class="pre">kwargsN]]</span></tt></li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<dl class="attribute">
+<dt id="celery.task.TaskSet.task_name">
+<tt class="descname">task_name</tt><a class="headerlink" href="#celery.task.TaskSet.task_name" title="Permalink to this definition">¶</a></dt>
+<dd>The name of the task.</dd></dl>
+
+<dl class="attribute">
+<dt id="celery.task.TaskSet.arguments">
+<tt class="descname">arguments</tt><a class="headerlink" href="#celery.task.TaskSet.arguments" title="Permalink to this definition">¶</a></dt>
+<dd>The arguments, as passed to the task set constructor.</dd></dl>
+
+<dl class="attribute">
+<dt id="celery.task.TaskSet.total">
+<tt class="descname">total</tt><a class="headerlink" href="#celery.task.TaskSet.total" title="Permalink to this definition">¶</a></dt>
+<dd>Total number of tasks in this task set.</dd></dl>
+
+<p>Example</p>
 <blockquote>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">djangofeeds.tasks</span> <span class="kn">import</span> <span class="n">RefreshFeedTask</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">taskset</span> <span class="o">=</span> <span class="n">TaskSet</span><span class="p">(</span><span class="n">RefreshFeedTask</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[</span>
-<span class="gp">... </span>                <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://cnn.com/rss&quot;</span><span class="p">},</span>
-<span class="gp">... </span>                <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://bbc.com/rss&quot;</span><span class="p">},</span>
-<span class="gp">... </span>                <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://xkcd.com/rss&quot;</span><span class="p">}])</span>
+<span class="gp">... </span>                <span class="p">[],</span> <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://cnn.com/rss&quot;</span><span class="p">},</span>
+<span class="gp">... </span>                <span class="p">[],</span> <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://bbc.com/rss&quot;</span><span class="p">},</span>
+<span class="gp">... </span>                <span class="p">[],</span> <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://xkcd.com/rss&quot;</span><span class="p">}])</span>
 </pre></div>
 </div>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">taskset_id</span><span class="p">,</span> <span class="n">subtask_ids</span> <span class="o">=</span> <span class="n">taskset</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">list_of_return_values</span> <span class="o">=</span> <span class="n">taskset</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
 </pre></div>
 </div>
 </blockquote>
 <dl class="method">
 <dt id="celery.task.TaskSet.iterate">
 <tt class="descname">iterate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.TaskSet.iterate" title="Permalink to this definition">¶</a></dt>
-<dd><p>Iterate over the results returned after calling <tt class="docutils literal"><span class="pre">run()</span></tt>.</p>
+<dd><p>Iterate over the results returned after calling <a title="celery.task.TaskSet.run" class="reference internal" href="#celery.task.TaskSet.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a>.</p>
 <p>If any of the tasks raises an exception, the exception will
-be reraised by <tt class="docutils literal"><span class="pre">iterate</span></tt>.</p>
+be re-raised.</p>
 </dd></dl>
 
 <dl class="method">
@@ -208,11 +349,29 @@ be reraised by <tt class="docutils literal"><span class="pre">iterate</span></tt
 <dd><p>Gather the results for all of the tasks in the taskset,
 and return a list with them ordered by the order of which they
 were called.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>timeout</em> &#8211; The time in seconds, how long
+it will wait for results, before the operation times out.</td>
+</tr>
+<tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.timer.TimeoutError" class="reference external" href="celery.timer.html#celery.timer.TimeoutError">celery.timer.TimeoutError</a>:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">if <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt>
+and the operation takes longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</td>
+</tr>
+</tbody>
+</table>
 <p>If any of the tasks raises an exception, the exception
-will be reraised by <tt class="docutils literal"><span class="pre">join</span></tt>.</p>
-<p>If <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt> and the operation takes
-longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds, it will raise
-the <a title="celery.timer.TimeoutError" class="reference external" href="celery.timer.html#celery.timer.TimeoutError"><tt class="xref docutils literal"><span class="pre">celery.timer.TimeoutError</span></tt></a> exception.</p>
+will be reraised by <a title="celery.task.TaskSet.join" class="reference internal" href="#celery.task.TaskSet.join"><tt class="xref docutils literal"><span class="pre">join()</span></tt></a>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of return values for all tasks in the taskset.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="classmethod">
@@ -227,7 +386,14 @@ classmethod </em><tt class="descname">map</tt><big>(</big><em>func</em>, <em>arg
 classmethod </em><tt class="descname">map_async</tt><big>(</big><em>func</em>, <em>args</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet.map_async" title="Permalink to this definition">¶</a></dt>
 <dd><p>Distribute processing of the arguments and collect the results
 asynchronously.</p>
-<p>Returns <a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a> instance.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a> instance.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="classmethod">
@@ -241,7 +407,18 @@ celery server(s).</dd></dl>
 <dt id="celery.task.TaskSet.run">
 <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.TaskSet.run" title="Permalink to this definition">¶</a></dt>
 <dd><p>Run all tasks in the taskset.</p>
-<p>Returns a tuple with the taskset id, and a list of subtask id&#8217;s.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">A tuple containing the taskset id, and a list
+of subtask ids.</td>
+</tr>
+<tr class="field"><th class="field-name">Return type:</th><td class="field-body">tuple</td>
+</tr>
+</tbody>
+</table>
+<p>Example</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">ts</span> <span class="o">=</span> <span class="n">RefreshFeeds</span><span class="p">([</span>
 <span class="gp">... </span>        <span class="p">[</span><span class="s">&quot;http://foo.com/rss&quot;</span><span class="p">,</span> <span class="p">{}],</span>
 <span class="gp">... </span>        <span class="p">[</span><span class="s">&quot;http://bar.com/rss&quot;</span><span class="p">,</span> <span class="p">{}],</span>
@@ -265,23 +442,35 @@ celery server(s).</dd></dl>
 <dt id="celery.task.delay_task">
 <tt class="descclassname">celery.task.</tt><tt class="descname">delay_task</tt><big>(</big><em>task_name</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.delay_task" title="Permalink to this definition">¶</a></dt>
 <dd><p>Delay a task for execution by the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon.</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">r</span> <span class="o">=</span> <span class="n">delay_task</span><span class="p">(</span><span class="s">&quot;update_record&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&quot;George Constanza&quot;</span><span class="p">,</span> <span class="n">age</span><span class="o">=</span><span class="mf">32</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">r</span><span class="o">.</span><span class="n">ready</span><span class="p">()</span>
-<span class="go">True</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">r</span><span class="o">.</span><span class="n">result</span>
-<span class="go">&quot;Record was updated&quot;</span>
-</pre></div>
-</div>
-<p>Raises <a title="celery.registry.NotRegistered" class="reference external" href="celery.registry.html#celery.registry.NotRegistered"><tt class="xref docutils literal"><span class="pre">celery.registry.NotRegistered</span></tt></a> exception if no such task 
-has been registered in the task registry.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a>.</td>
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><em>task_name</em> &#8211; the name of a task registered in the task registry.</li>
+<li><em>*args</em> &#8211; positional arguments to pass on to the task.</li>
+<li><em>**kwargs</em> &#8211; keyword arguments to pass on to the task.</li>
+</ul>
+</td>
+</tr>
+<tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.registry.NotRegistered" class="reference external" href="celery.registry.html#celery.registry.NotRegistered">celery.registry.NotRegistered</a>:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body"><p class="first">exception if no such task 
+has been registered in the task registry.</p>
+</td>
+</tr>
+<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a>.</p>
+</td>
 </tr>
 </tbody>
 </table>
+<p>Example</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">r</span> <span class="o">=</span> <span class="n">delay_task</span><span class="p">(</span><span class="s">&quot;update_record&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&quot;George Constanza&quot;</span><span class="p">,</span> <span class="n">age</span><span class="o">=</span><span class="mf">32</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">r</span><span class="o">.</span><span class="n">ready</span><span class="p">()</span>
+<span class="go">True</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">r</span><span class="o">.</span><span class="n">result</span>
+<span class="go">&quot;Record was updated&quot;</span>
+</pre></div>
+</div>
 </dd></dl>
 
 <dl class="function">
@@ -290,11 +479,12 @@ has been registered in the task registry.</p>
 <dd><p>Discard all waiting tasks.</p>
 <p>This will ignore all tasks waiting for execution, and they will
 be deleted from the messaging server.</p>
-<p>Returns the number of tasks discarded.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the number of tasks discarded.</td>
+</tr>
 <tr class="field"><th class="field-name">Return type:</th><td class="field-body">int</td>
 </tr>
 </tbody>
@@ -305,6 +495,7 @@ be deleted from the messaging server.</p>
 <dt id="celery.task.dmap">
 <tt class="descclassname">celery.task.</tt><tt class="descname">dmap</tt><big>(</big><em>func</em>, <em>args</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.dmap" title="Permalink to this definition">¶</a></dt>
 <dd><p>Distribute processing of the arguments and collect the results.</p>
+<p>Example</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="nb">map</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">operator</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">dmap</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[[</span><span class="mf">2</span><span class="p">,</span> <span class="mf">2</span><span class="p">],</span> <span class="p">[</span><span class="mf">4</span><span class="p">,</span> <span class="mf">4</span><span class="p">],</span> <span class="p">[</span><span class="mf">8</span><span class="p">,</span> <span class="mf">8</span><span class="p">]])</span>
@@ -318,7 +509,15 @@ be deleted from the messaging server.</p>
 <tt class="descclassname">celery.task.</tt><tt class="descname">dmap_async</tt><big>(</big><em>func</em>, <em>args</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.dmap_async" title="Permalink to this definition">¶</a></dt>
 <dd><p>Distribute processing of the arguments and collect the results
 asynchronously.</p>
-<p>Returns a <a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a> object.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a> object.</td>
+</tr>
+</tbody>
+</table>
+<p>Example</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">dmap_async</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">operator</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">presult</span> <span class="o">=</span> <span class="n">dmap_async</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[[</span><span class="mf">2</span><span class="p">,</span> <span class="mf">2</span><span class="p">],</span> <span class="p">[</span><span class="mf">4</span><span class="p">,</span> <span class="mf">4</span><span class="p">],</span> <span class="p">[</span><span class="mf">8</span><span class="p">,</span> <span class="mf">8</span><span class="p">]])</span>
@@ -336,13 +535,26 @@ asynchronously.</p>
 <dt id="celery.task.execute_remote">
 <tt class="descclassname">celery.task.</tt><tt class="descname">execute_remote</tt><big>(</big><em>func</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.execute_remote" title="Permalink to this definition">¶</a></dt>
 <dd><p>Execute arbitrary function/object remotely.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>func</em> &#8211; A callable function or object.</li>
+<li><em>*args</em> &#8211; Positional arguments to apply to the function.</li>
+<li><em>**kwargs</em> &#8211; Keyword arguments to apply to the function.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
 <p>The object must be picklable, so you can&#8217;t use lambdas or functions
 defined in the REPL (the objects must have an associated module).</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a></td>
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">class:<cite>celery.result.AsyncResult</cite>.</td>
 </tr>
 </tbody>
 </table>
@@ -365,12 +577,38 @@ defined in the REPL (the objects must have an associated module).</p>
 <dl class="function">
 <dt id="celery.task.mark_as_done">
 <tt class="descclassname">celery.task.</tt><tt class="descname">mark_as_done</tt><big>(</big><em>task_id</em>, <em>result</em><big>)</big><a class="headerlink" href="#celery.task.mark_as_done" title="Permalink to this definition">¶</a></dt>
-<dd>Mark task as done (executed).</dd></dl>
+<dd><p>Mark task as done (executed successfully).</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>task_id</em> &#8211; id of the task.</li>
+<li><em>result</em> &#8211; the return value of the task.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="function">
 <dt id="celery.task.mark_as_failure">
 <tt class="descclassname">celery.task.</tt><tt class="descname">mark_as_failure</tt><big>(</big><em>task_id</em>, <em>exc</em><big>)</big><a class="headerlink" href="#celery.task.mark_as_failure" title="Permalink to this definition">¶</a></dt>
-<dd>Mark task as done (executed).</dd></dl>
+<dd><p>Mark task as done (executed).</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>task_id</em> &#8211; id of the task.</li>
+<li><em>exc</em> &#8211; the exception instance raised by the task.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </div>
 

reference/celery.timer.html

@@ -50,7 +50,7 @@
             
   <div class="section" id="module-celery.timer">
 <h1>Timers - celery.timer<a class="headerlink" href="#module-celery.timer" title="Permalink to this headline">¶</a></h1>
-<p>celery.timer</p>
+<p>Managing time and events</p>
 <dl class="class">
 <dt id="celery.timer.EventTimer">
 <em class="property">
@@ -107,9 +107,16 @@ time has run out.</p>
 <dt id="celery.timer.TimeoutTimer.tick">
 <tt class="descname">tick</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.timer.TimeoutTimer.tick" title="Permalink to this definition">¶</a></dt>
 <dd><p>Run a timeout timer clock tick.</p>
-<p>When <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds has passed, it will raise a
-<a title="celery.timer.TimeoutTimer" class="reference internal" href="#celery.timer.TimeoutTimer"><tt class="xref docutils literal"><span class="pre">TimeoutTimer</span></tt></a> exception.
-If <tt class="docutils literal"><span class="pre">timeout</span></tt> is not set, it will never time out.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.timer.TimeoutError" class="reference internal" href="#celery.timer.TimeoutError">TimeoutError</a>:</th></tr>
+<tr><td>&nbsp;</td><td class="field-body">when <a title="celery.timer.TimeoutTimer.timeout" class="reference internal" href="#celery.timer.TimeoutTimer.timeout"><tt class="xref docutils literal"><span class="pre">timeout</span></tt></a> seconds has passed.
+If <a title="celery.timer.TimeoutTimer.timeout" class="reference internal" href="#celery.timer.TimeoutTimer.timeout"><tt class="xref docutils literal"><span class="pre">timeout</span></tt></a> is not set, it will never time out.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 </dd></dl>

reference/celery.worker.html

@@ -125,7 +125,7 @@ pool.</p>
 <dt id="celery.worker.TaskDaemon.fetch_next_task">
 <tt class="descname">fetch_next_task</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.fetch_next_task" title="Permalink to this definition">¶</a></dt>
 <dd><p>Fetch the next task from the AMQP broker.</p>
-<p>Raises :class`EmptyQueue` exception if there is no messages
+<p>Raises <a title="celery.worker.EmptyQueue" class="reference internal" href="#celery.worker.EmptyQueue"><tt class="xref docutils literal"><span class="pre">EmptyQueue</span></tt></a> exception if there is no messages
 waiting on the queue.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />

sources/reference/celery.backends.txt

@@ -6,16 +6,3 @@ Backends - celery.backends
 
 .. automodule:: celery.backends
     :members:
-
-.. function:: get_default_backend_cls()
-
-    Get the backend class specified in ``settings.CELERY_BACKEND``.
-
-.. class:: DefaultBackend
-
-    The backend class specified in ``settings.CELERY_BACKEND``.
-
-.. data:: default_backend
-
-    An instance of :class:`DefaultBackend`.
-    

sources/reference/celery.models.txt

@@ -72,6 +72,5 @@ Django Models - celery.models
         The class/function for this task.
 
     .. method:: delay()
-        
         Delay the execution of a periodic task, and increment its total
         run count.

sources/reference/celery.registry.txt

@@ -6,6 +6,3 @@ Task Registry - celery.registry
 
 .. automodule:: celery.registry
     :members:
-
-.. data:: tasks
-    The global task registry.