Rendered documentation for Github Pages.

Author: Ask Solem

genindex.html

@@ -58,7 +58,7 @@ <h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
 <tbody valign="top">
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">1.1</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 09, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 10, 2010</td>
 </tr>
 </tbody>
 </table>

getting-started/index.html

@@ -63,6 +63,7 @@ <h1>Celery - Distributed Task Queue<a class="headerlink" href="#celery-distribut
 <li class="toctree-l2"><a class="reference internal" href="userguide/tasks.html">Tasks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="userguide/executing.html">Executing Tasks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="userguide/workers.html">Workers Guide</a></li>
+<li class="toctree-l2"><a class="reference internal" href="userguide/tasksets.html">Sets of tasks, Subtasks and Callbacks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="userguide/remote-tasks.html">HTTP Callback Tasks (Webhooks)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="userguide/routing.html">Routing Tasks</a></li>
 </ul>
@@ -108,6 +109,7 @@ <h1>Celery - Distributed Task Queue<a class="headerlink" href="#celery-distribut
 <li class="toctree-l1"><a class="reference internal" href="reference/index.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.decorators.html">Task Decorators - celery.decorators</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.task.base.html">Defining Tasks - celery.task.base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/celery.task.sets.html">Task Sets, Subtasks and Callbacks - celery.task.sets</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.execute.html">Executing Tasks - celery.execute</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.result.html">Task Result - celery.result</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.task.html">Task Information and Utilities - celery.task</a></li>

index.html

@@ -58,7 +58,7 @@ <h1>Internals<a class="headerlink" href="#internals" title="Permalink to this he
 <tbody valign="top">
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">1.1</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 09, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 10, 2010</td>
 </tr>
 </tbody>
 </table>
@@ -135,6 +135,7 @@ <h1>Internals<a class="headerlink" href="#internals" title="Permalink to this he
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.utils.compat.html">Python Compatibility - celery.utils.compat</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.utils.mail.html">Sending E-mail - celery.utils.mail</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.utils.patch.html">Compatibility Patches - celery.utils.patch</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/celery.utils.functional.html">functools compat - celery.utils.functional</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.utils.dispatch.html">Signal Dispatch - celery.utils.dispatch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.utils.dispatch.signal.html">Signals: Dispatcher - celery.utils.dispatch.signal</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/celery.utils.dispatch.saferef.html">Signals: Safe References - celery.utils.dispatch.saferef</a></li>

internals/index.html

@@ -74,6 +74,21 @@ <h1>Backend: AMQP - celery.backends.amqp<a class="headerlink" href="#backend-amq
 <tt class="descname">connection</tt><a class="headerlink" href="#celery.backends.amqp.AMQPBackend.connection" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="method">
+<dt id="celery.backends.amqp.AMQPBackend.consume">
+<tt class="descname">consume</tt><big>(</big><em>task_id</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend.consume" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="celery.backends.amqp.AMQPBackend.get_task_meta">
+<tt class="descname">get_task_meta</tt><big>(</big><em>task_id</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend.get_task_meta" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="celery.backends.amqp.AMQPBackend.poll">
+<tt class="descname">poll</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend.poll" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="method">
 <dt id="celery.backends.amqp.AMQPBackend.reload_task_result">
 <tt class="descname">reload_task_result</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend.reload_task_result" title="Permalink to this definition">¶</a></dt>
@@ -105,7 +120,7 @@ <h1>Backend: AMQP - celery.backends.amqp<a class="headerlink" href="#backend-amq
 
 <dl class="method">
 <dt id="celery.backends.amqp.AMQPBackend.wait_for">
-<tt class="descname">wait_for</tt><big>(</big><em>task_id</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend.wait_for" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">wait_for</tt><big>(</big><em>task_id</em>, <em>timeout=None</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend.wait_for" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 </dd></dl>

internals/reference/celery.backends.amqp.html

@@ -102,12 +102,6 @@ <h1>Backend: Base - celery.backends.base<a class="headerlink" href="#backend-bas
 <dd><p>Get the traceback for a failed task.</p>
 </dd></dl>
 
-<dl class="method">
-<dt id="celery.backends.base.BaseBackend.is_successful">
-<tt class="descclassname">BaseBackend.</tt><tt class="descname">is_successful</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.is_successful" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task was successfully executed.</p>
-</dd></dl>
-
 <dl class="method">
 <dt id="celery.backends.base.BaseBackend.mark_as_done">
 <tt class="descclassname">BaseBackend.</tt><tt class="descname">mark_as_done</tt><big>(</big><em>task_id</em>, <em>result</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.mark_as_done" title="Permalink to this definition">¶</a></dt>

internals/reference/celery.backends.base.html

@@ -109,7 +109,13 @@ <h1>Multiprocessing Pool Support - celery.concurrency.processes<a class="headerl
 <dl class="method">
 <dt id="celery.concurrency.processes.TaskPool.stop">
 <tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.TaskPool.stop" title="Permalink to this definition">¶</a></dt>
-<dd><p>Terminate the pool.</p>
+<dd><p>Gracefully stop the pool.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="celery.concurrency.processes.TaskPool.terminate">
+<tt class="descname">terminate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.TaskPool.terminate" title="Permalink to this definition">¶</a></dt>
+<dd><p>Force terminate the pool.</p>
 </dd></dl>
 
 </dd></dl>

internals/reference/celery.concurrency.processes.html

@@ -217,7 +217,8 @@ <h1>extended multiprocessing.pool - celery.concurrency.processes.pool<a class="h
 <dl class="method">
 <dt id="celery.concurrency.processes.pool.Pool.imap">
 <tt class="descclassname">Pool.</tt><tt class="descname">imap</tt><big>(</big><em>func</em>, <em>iterable</em>, <em>chunksize=1</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.imap" title="Permalink to this definition">¶</a></dt>
-<dd><p>Equivalent of <cite>itertools.imap()</cite> &#8211; can be MUCH slower than <cite>Pool.map()</cite></p>
+<dd><p>Equivalent of <cite>itertools.imap()</cite> &#8211; can be MUCH slower
+than <cite>Pool.map()</cite></p>
 </dd></dl>
 
 <dl class="method">

internals/reference/celery.concurrency.processes.pool.html

@@ -57,11 +57,11 @@ <h3>Navigation</h3>
 <h1>Logging - celery.log<a class="headerlink" href="#logging-celery-log" title="Permalink to this headline">¶</a></h1>
 <span class="target" id="module-celery.log"></span><p>celery.log</p>
 <dl class="class">
-<dt id="celery.log.ColourFormatter">
-<em class="property">class </em><tt class="descclassname">celery.log.</tt><tt class="descname">ColourFormatter</tt><big>(</big><em>msg</em>, <em>use_colour=True</em><big>)</big><a class="headerlink" href="#celery.log.ColourFormatter" title="Permalink to this definition">¶</a></dt>
+<dt id="celery.log.ColorFormatter">
+<em class="property">class </em><tt class="descclassname">celery.log.</tt><tt class="descname">ColorFormatter</tt><big>(</big><em>msg</em>, <em>use_color=True</em><big>)</big><a class="headerlink" href="#celery.log.ColorFormatter" title="Permalink to this definition">¶</a></dt>
 <dd><dl class="method">
-<dt id="celery.log.ColourFormatter.format">
-<tt class="descname">format</tt><big>(</big><em>record</em><big>)</big><a class="headerlink" href="#celery.log.ColourFormatter.format" title="Permalink to this definition">¶</a></dt>
+<dt id="celery.log.ColorFormatter.format">
+<tt class="descname">format</tt><big>(</big><em>record</em><big>)</big><a class="headerlink" href="#celery.log.ColorFormatter.format" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 </dd></dl>
@@ -181,15 +181,15 @@ <h1>Logging - celery.log<a class="headerlink" href="#logging-celery-log" title="
 
 <dl class="function">
 <dt id="celery.log.setup_logger">
-<tt class="descclassname">celery.log.</tt><tt class="descname">setup_logger</tt><big>(</big><em>loglevel=30</em>, <em>logfile=None</em>, <em>format='</em><span class="optional">[</span>, <em>%(asctime)s: %(levelname)s/%(processName)s</em><span class="optional">]</span>, <em>%(message)s'</em>, <em>colourize=True</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.log.setup_logger" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">celery.log.</tt><tt class="descname">setup_logger</tt><big>(</big><em>loglevel=30</em>, <em>logfile=None</em>, <em>format='</em><span class="optional">[</span>, <em>%(asctime)s: %(levelname)s/%(processName)s</em><span class="optional">]</span>, <em>%(message)s'</em>, <em>colorize=True</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.log.setup_logger" title="Permalink to this definition">¶</a></dt>
 <dd><p>Setup the <tt class="docutils literal"><span class="pre">multiprocessing</span></tt> logger. If <tt class="docutils literal"><span class="pre">logfile</span></tt> is not specified,
 then <tt class="docutils literal"><span class="pre">stderr</span></tt> is used.</p>
 <p>Returns logger object.</p>
 </dd></dl>
 
 <dl class="function">
 <dt id="celery.log.setup_task_logger">
-<tt class="descclassname">celery.log.</tt><tt class="descname">setup_task_logger</tt><big>(</big><em>loglevel=30</em>, <em>logfile=None</em>, <em>format='</em><span class="optional">[</span>, <em>%(asctime)s: %(levelname)s/%(processName)s</em><span class="optional">]</span><span class="optional">[</span>, <em>%(task_name)s(%(task_id)s)</em><span class="optional">]</span>, <em>%(message)s'</em>, <em>colourize=True</em>, <em>task_kwargs=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.log.setup_task_logger" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">celery.log.</tt><tt class="descname">setup_task_logger</tt><big>(</big><em>loglevel=30</em>, <em>logfile=None</em>, <em>format='</em><span class="optional">[</span>, <em>%(asctime)s: %(levelname)s/%(processName)s</em><span class="optional">]</span><span class="optional">[</span>, <em>%(task_name)s(%(task_id)s)</em><span class="optional">]</span>, <em>%(message)s'</em>, <em>colorize=True</em>, <em>task_kwargs=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.log.setup_task_logger" title="Permalink to this definition">¶</a></dt>
 <dd><p>Setup the task logger. If <tt class="docutils literal"><span class="pre">logfile</span></tt> is not specified, then
 <tt class="docutils literal"><span class="pre">stderr</span></tt> is used.</p>
 <p>Returns logger object.</p>

internals/reference/celery.log.html

@@ -58,7 +58,8 @@ <h1>Message Routers - celery.routes<a class="headerlink" href="#message-routers-
 <span class="target" id="module-celery.routes"></span><dl class="class">
 <dt id="celery.routes.MapRoute">
 <em class="property">class </em><tt class="descclassname">celery.routes.</tt><tt class="descname">MapRoute</tt><big>(</big><em>map</em><big>)</big><a class="headerlink" href="#celery.routes.MapRoute" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="method">
+<dd><p>Makes a router out of a <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>.</p>
+<dl class="method">
 <dt id="celery.routes.MapRoute.route_for_task">
 <tt class="descname">route_for_task</tt><big>(</big><em>task</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.routes.MapRoute.route_for_task" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
@@ -73,8 +74,8 @@ <h1>Message Routers - celery.routes<a class="headerlink" href="#message-routers-
 <dl class="function">
 <dt id="celery.routes.firstmatcher">
 <tt class="descclassname">celery.routes.</tt><tt class="descname">firstmatcher</tt><big>(</big><em>method</em><big>)</big><a class="headerlink" href="#celery.routes.firstmatcher" title="Permalink to this definition">¶</a></dt>
-<dd><p>With a list of instances, find the first instance that returns a
-value for the given method.</p>
+<dd><p>Returns a functions that with a list of instances,
+finds the first instance that returns a value for the given method.</p>
 </dd></dl>
 
 <dl class="function">