Rendered documentation for Github Pages.

Author: Ask Solem

changelog.html

@@ -548,7 +548,7 @@ <h3><a class="toc-backref" href="#id47">Backward incompatible changes</a><a clas
 <p>Where <tt class="docutils literal"><span class="pre">myapp.tasks.Router</span></tt> could be:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Router</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 
-    <span class="k">def</span> <span class="nf">route_for_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">route_for_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
         <span class="k">if</span> <span class="n">task</span> <span class="o">==</span> <span class="s">&quot;celery.ping&quot;</span><span class="p">:</span>
             <span class="k">return</span> <span class="s">&quot;default&quot;</span>
 </pre></div>

genindex.html

@@ -137,16 +137,17 @@ <h2 id="A">A</h2>
     <dt><a href="internals/reference/celery.datastructures.html#celery.datastructures.LimitedSet.add">add() (celery.datastructures.LimitedSet method)</a></dt>
     <dt><a href="internals/reference/celery.worker.buckets.html#celery.worker.buckets.TaskBucket.add_bucket_for_type">add_bucket_for_type() (celery.worker.buckets.TaskBucket method)</a></dt>
     <dt><a href="reference/celery.bin.celeryd_multi.html#celery.bin.celeryd_multi.NamespacedOptionParser.add_option">add_option() (celery.bin.celeryd_multi.NamespacedOptionParser method)</a></dt>
+    <dt><a href="internals/reference/celery.routes.html#celery.routes.Router.add_queue">add_queue() (celery.routes.Router method)</a></dt>
     <dt><a href="reference/celery.conf.html#celery.conf.ADMINS">ADMINS (in module celery.conf)</a></dt>
     <dt><a href="reference/celery.task.base.html#celery.task.base.Task.after_return">after_return() (celery.task.base.Task method)</a></dt>
     <dd><dl>
       <dt><a href="reference/celery.task.html#celery.task.Task.after_return">(celery.task.Task method)</a></dt>
   </dl></dd>
     <dt><a href="reference/celery.bin.celeryev.html#celery.bin.celeryev.CursesMonitor.alert">alert() (celery.bin.celeryev.CursesMonitor method)</a></dt>
     <dt><a href="reference/celery.bin.celeryev.html#celery.bin.celeryev.CursesMonitor.alert_remote_control_reply">alert_remote_control_reply() (celery.bin.celeryev.CursesMonitor method)</a></dt>
-    <dt><a href="reference/celery.events.state.html#celery.events.state.Worker.alive">alive (celery.events.state.Worker attribute)</a></dt>
 </dl></td>
   <td width="33%" valign="top"><dl>
+    <dt><a href="reference/celery.events.state.html#celery.events.state.Worker.alive">alive (celery.events.state.Worker attribute)</a></dt>
     <dt><a href="reference/celery.events.state.html#celery.events.state.State.alive_workers">alive_workers() (celery.events.state.State method)</a></dt>
     <dt><a href="reference/celery.states.html#celery.states.ALL_STATES">ALL_STATES (in module celery.states)</a></dt>
     <dt><a href="internals/reference/celery.worker.job.html#celery.worker.job.AlreadyExecutedError">AlreadyExecutedError</a></dt>
@@ -568,7 +569,7 @@ <h2 id="E">E</h2>
     <dt><a href="reference/celery.task.builtins.html#celery.task.builtins.ExecuteRemoteTask">ExecuteRemoteTask (class in celery.task.builtins)</a></dt>
     <dt><a href="internals/reference/celery.concurrency.processes.pool.html#celery.concurrency.processes.pool.Pool.Process.exitcode">exitcode (celery.concurrency.processes.pool.Pool.Process attribute)</a></dt>
     <dt><a href="reference/celery.bin.celeryd_multi.html#celery.bin.celeryd_multi.MultiTool.expand">expand() (celery.bin.celeryd_multi.MultiTool method)</a></dt>
-    <dt><a href="internals/reference/celery.routes.html#celery.routes.expand_destination">expand_destination() (in module celery.routes)</a></dt>
+    <dt><a href="internals/reference/celery.routes.html#celery.routes.Router.expand_destination">expand_destination() (celery.routes.Router method)</a></dt>
     <dt><a href="internals/reference/celery.worker.buckets.html#celery.worker.buckets.FastQueue.expected_time">expected_time() (celery.worker.buckets.FastQueue method)</a></dt>
     <dd><dl>
       <dt><a href="internals/reference/celery.worker.buckets.html#celery.worker.buckets.TokenBucketQueue.expected_time">(celery.worker.buckets.TokenBucketQueue method)</a></dt>
@@ -592,7 +593,7 @@ <h2 id="F">F</h2>
     <dt><a href="reference/celery.bin.celeryev.html#celery.bin.celeryev.CursesMonitor.find_position">find_position() (celery.bin.celeryev.CursesMonitor method)</a></dt>
     <dt><a href="internals/reference/celery.datastructures.html#celery.datastructures.LimitedSet.first">first (celery.datastructures.LimitedSet attribute)</a></dt>
     <dt><a href="internals/reference/celery.utils.html#celery.utils.first">first() (in module celery.utils)</a></dt>
-    <dt><a href="internals/reference/celery.routes.html#celery.routes.firstmatcher">firstmatcher() (in module celery.routes)</a></dt>
+    <dt><a href="internals/reference/celery.utils.html#celery.utils.firstmethod">firstmethod() (in module celery.utils)</a></dt>
     <dt><a href="internals/reference/celery.log.html#celery.log.LoggingProxy.flush">flush() (celery.log.LoggingProxy method)</a></dt>
     <dt><a href="internals/reference/celery.log.html#celery.log.ColorFormatter.format">format() (celery.log.ColorFormatter method)</a></dt>
 </dl></td>
@@ -601,8 +602,8 @@ <h2 id="F">F</h2>
     <dt><a href="internals/reference/celery.utils.info.html#celery.utils.info.format_broker_info">format_broker_info() (in module celery.utils.info)</a></dt>
     <dt><a href="reference/celery.bin.camqadm.html#celery.bin.camqadm.format_declare_queue">format_declare_queue() (in module celery.bin.camqadm)</a></dt>
     <dt><a href="reference/celery.bin.celeryd_multi.html#celery.bin.celeryd_multi.format_opt">format_opt() (in module celery.bin.celeryd_multi)</a></dt>
+    <dt><a href="internals/reference/celery.utils.info.html#celery.utils.info.format_queues">format_queues() (in module celery.utils.info)</a></dt>
     <dt><a href="reference/celery.bin.camqadm.html#celery.bin.camqadm.Spec.format_response">format_response() (celery.bin.camqadm.Spec method)</a></dt>
-    <dt><a href="internals/reference/celery.utils.info.html#celery.utils.info.format_routing_table">format_routing_table() (in module celery.utils.info)</a></dt>
     <dt><a href="reference/celery.bin.celeryev.html#celery.bin.celeryev.CursesMonitor.format_row">format_row() (celery.bin.celeryev.CursesMonitor method)</a></dt>
     <dt><a href="reference/celery.bin.camqadm.html#celery.bin.camqadm.Spec.format_signature">format_signature() (celery.bin.camqadm.Spec method)</a></dt>
     <dt><a href="reference/celery.bin.celeryev.html#celery.bin.celeryev.Dumper.format_task_event">format_task_event() (celery.bin.celeryev.Dumper method)</a></dt>
@@ -834,9 +835,9 @@ <h2 id="L">L</h2>
     <dt><a href="internals/reference/celery.worker.html#celery.worker.WorkController.listener">listener (celery.worker.WorkController attribute)</a></dt>
     <dt><a href="reference/celery.loaders.html#celery.loaders.load_settings">load_settings() (in module celery.loaders)</a></dt>
     <dt><a href="reference/celery.loaders.default.html#celery.loaders.default.Loader">Loader (class in celery.loaders.default)</a></dt>
-    <dt><a href="internals/reference/celery.datastructures.html#celery.datastructures.LocalCache">LocalCache (class in celery.datastructures)</a></dt>
 </dl></td>
   <td width="33%" valign="top"><dl>
+    <dt><a href="internals/reference/celery.datastructures.html#celery.datastructures.LocalCache">LocalCache (class in celery.datastructures)</a></dt>
     <dt><a href="reference/celery.conf.html#celery.conf.LOG_LEVELS">LOG_LEVELS (in module celery.conf)</a></dt>
     <dt><a href="internals/reference/celery.worker.html#celery.worker.WorkController.logfile">logfile (celery.worker.WorkController attribute)</a></dt>
     <dt><a href="internals/reference/celery.beat.html#celery.beat.Scheduler.logger">logger (celery.beat.Scheduler attribute)</a></dt>
@@ -847,8 +848,7 @@ <h2 id="L">L</h2>
   </dl></dd>
     <dt><a href="internals/reference/celery.log.html#celery.log.LoggingProxy">LoggingProxy (class in celery.log)</a></dt>
     <dt><a href="internals/reference/celery.worker.html#celery.worker.WorkController.loglevel">loglevel (celery.worker.WorkController attribute)</a></dt>
-    <dt><a href="internals/reference/celery.routes.html#celery.routes.lookup_disabled">lookup_disabled() (in module celery.routes)</a></dt>
-    <dt><a href="internals/reference/celery.routes.html#celery.routes.lookup_route">lookup_route() (in module celery.routes)</a></dt>
+    <dt><a href="internals/reference/celery.routes.html#celery.routes.Router.lookup_route">lookup_route() (celery.routes.Router method)</a></dt>
 </dl></td>
 </tr></table>
 
@@ -1086,9 +1086,14 @@ <h2 id="Q">Q</h2>
       <dt><a href="internals/reference/celery.worker.buckets.html#celery.worker.buckets.TokenBucketQueue.qsize">(celery.worker.buckets.TokenBucketQueue method)</a></dt>
   </dl></dd>
     <dt><a href="reference/celery.task.http.html#celery.task.http.MutableURL.query">query (celery.task.http.MutableURL attribute)</a></dt>
+    <dt><a href="reference/celery.task.base.html#celery.task.base.Task.queue">queue (celery.task.base.Task attribute)</a></dt>
+    <dd><dl>
+      <dt><a href="reference/celery.task.html#celery.task.Task.queue">(celery.task.Task attribute)</a></dt>
+      <dt><a href="internals/reference/celery.worker.scheduler.html#celery.worker.scheduler.Scheduler.queue">(celery.worker.scheduler.Scheduler attribute)</a></dt>
+  </dl></dd>
 </dl></td>
   <td width="33%" valign="top"><dl>
-    <dt><a href="internals/reference/celery.worker.scheduler.html#celery.worker.scheduler.Scheduler.queue">queue (celery.worker.scheduler.Scheduler attribute)</a></dt>
+    <dt><a href="reference/celery.exceptions.html#celery.exceptions.QueueNotFound">QueueNotFound</a></dt>
     <dt><a href="reference/celery.conf.html#celery.conf.QUEUES">QUEUES (in module celery.conf)</a></dt>
     <dt><a href="reference/celery.bin.celeryd_multi.html#celery.bin.celeryd_multi.quote">quote() (in module celery.bin.celeryd_multi)</a></dt>
 </dl></td>
@@ -1165,9 +1170,9 @@ <h2 id="R">R</h2>
       <dt><a href="reference/celery.messaging.html#celery.messaging.reply">(in module celery.messaging)</a></dt>
   </dl></dd>
     <dt><a href="reference/celery.messaging.html#celery.messaging.BroadcastPublisher.ReplyTo">ReplyTo (celery.messaging.BroadcastPublisher attribute)</a></dt>
+    <dt><a href="internals/reference/celery.worker.listener.html#celery.worker.listener.CarrotListener.reset_connection">reset_connection() (celery.worker.listener.CarrotListener method)</a></dt>
 </dl></td>
   <td width="33%" valign="top"><dl>
-    <dt><a href="internals/reference/celery.worker.listener.html#celery.worker.listener.CarrotListener.reset_connection">reset_connection() (celery.worker.listener.CarrotListener method)</a></dt>
     <dt><a href="internals/reference/celery.platform.html#celery.platform.reset_signal">reset_signal() (in module celery.platform)</a></dt>
     <dt><a href="reference/celery.bin.celeryev.html#celery.bin.celeryev.CursesMonitor.resetscreen">resetscreen() (celery.bin.celeryev.CursesMonitor method)</a></dt>
     <dt><a href="reference/celery.bin.camqadm.html#celery.bin.camqadm.AMQShell.respond">respond() (celery.bin.camqadm.AMQShell method)</a></dt>
@@ -1212,8 +1217,9 @@ <h2 id="R">R</h2>
     <dt><a href="internals/reference/celery.worker.revoke.html#revoked">revoked (built-in variable)</a></dt>
     <dt><a href="reference/celery.states.html#celery.states.REVOKED">REVOKED (in module celery.states)</a></dt>
     <dt><a href="internals/reference/celery.worker.job.html#celery.worker.job.TaskRequest.revoked">revoked() (celery.worker.job.TaskRequest method)</a></dt>
+    <dt><a href="internals/reference/celery.routes.html#celery.routes.Router.route">route() (celery.routes.Router method)</a></dt>
     <dt><a href="internals/reference/celery.routes.html#celery.routes.MapRoute.route_for_task">route_for_task() (celery.routes.MapRoute method)</a></dt>
-    <dt><a href="reference/celery.exceptions.html#celery.exceptions.RouteNotFound">RouteNotFound</a></dt>
+    <dt><a href="internals/reference/celery.routes.html#celery.routes.Router">Router (class in celery.routes)</a></dt>
     <dt><a href="reference/celery.task.base.html#celery.task.base.Task.routing_key">routing_key (celery.task.base.Task attribute)</a></dt>
     <dd><dl>
       <dt><a href="reference/celery.task.html#celery.task.Task.routing_key">(celery.task.Task attribute)</a></dt>

getting-started/index.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 10, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 11, 2010</td>
 </tr>
 </tbody>
 </table>

internals/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 10, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 11, 2010</td>
 </tr>
 </tbody>
 </table>

internals/reference/celery.backends.amqp.html

@@ -58,7 +58,7 @@ <h1>Backend: AMQP - celery.backends.amqp<a class="headerlink" href="#backend-amq
 <span class="target" id="module-celery.backends.amqp"></span><p>celery.backends.amqp</p>
 <dl class="class">
 <dt id="celery.backends.amqp.AMQPBackend">
-<em class="property">class </em><tt class="descclassname">celery.backends.amqp.</tt><tt class="descname">AMQPBackend</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.backends.amqp.</tt><tt class="descname">AMQPBackend</tt><big>(</big><em>connection=None</em>, <em>exchange=None</em>, <em>exchange_type=None</em>, <em>persistent=None</em>, <em>serializer=None</em>, <em>auto_delete=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.backends.amqp.AMQPBackend" title="Permalink to this definition">¶</a></dt>
 <dd><p>AMQP backend. Publish results by sending messages to the broker
 using the task id as routing key.</p>
 <p><strong>NOTE:</strong> Results published using this backend is read-once only.

internals/reference/celery.backends.database.html

@@ -57,7 +57,7 @@ <h3>Navigation</h3>
 <h1>Backend: SQLAlchemy Database - celery.backends.database<a class="headerlink" href="#backend-sqlalchemy-database-celery-backends-database" title="Permalink to this headline">¶</a></h1>
 <span class="target" id="module-celery.backends.database"></span><dl class="class">
 <dt id="celery.backends.database.DatabaseBackend">
-<em class="property">class </em><tt class="descclassname">celery.backends.database.</tt><tt class="descname">DatabaseBackend</tt><big>(</big><em>dburi='sqlite:///test.db'</em>, <em>engine_options=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.backends.database.DatabaseBackend" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.backends.database.</tt><tt class="descname">DatabaseBackend</tt><big>(</big><em>dburi=None</em>, <em>result_expires=None</em>, <em>engine_options=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.backends.database.DatabaseBackend" title="Permalink to this definition">¶</a></dt>
 <dd><p>The database result backend.</p>
 <dl class="method">
 <dt id="celery.backends.database.DatabaseBackend.ResultSession">

internals/reference/celery.backends.html

@@ -64,7 +64,7 @@ <h1>Backends - celery.backends<a class="headerlink" href="#backends-celery-backe
 <dd><p>An instance of <a class="reference internal" href="#celery.backends.DefaultBackend" title="celery.backends.DefaultBackend"><tt class="xref py py-class docutils literal"><span class="pre">DefaultBackend</span></tt></a>.</p>
 </dd></dl>
 
-<p>alias of <tt class="xref py py-class docutils literal"><span class="pre">DatabaseBackend</span></tt></p>
+<p>alias of <tt class="xref py py-class docutils literal"><span class="pre">AMQPBackend</span></tt></p>
 </dd></dl>
 
 <dl class="function">

internals/reference/celery.db.session.html

@@ -57,7 +57,7 @@ <h3>Navigation</h3>
 <h1>SQLAlchemy Session - celery.db.session<a class="headerlink" href="#sqlalchemy-session-celery-db-session" title="Permalink to this headline">¶</a></h1>
 <span class="target" id="module-celery.db.session"></span><dl class="function">
 <dt id="celery.db.session.ResultSession">
-<tt class="descclassname">celery.db.session.</tt><tt class="descname">ResultSession</tt><big>(</big><em>dburi='sqlite:///test.db'</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.db.session.ResultSession" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">celery.db.session.</tt><tt class="descname">ResultSession</tt><big>(</big><em>dburi=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.db.session.ResultSession" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="function">

internals/reference/celery.log.html

@@ -157,7 +157,7 @@ <h1>Logging - celery.log<a class="headerlink" href="#logging-celery-log" title="
 
 <dl class="function">
 <dt id="celery.log.get_task_logger">
-<tt class="descclassname">celery.log.</tt><tt class="descname">get_task_logger</tt><big>(</big><em>loglevel=None</em><big>)</big><a class="headerlink" href="#celery.log.get_task_logger" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">celery.log.</tt><tt class="descname">get_task_logger</tt><big>(</big><em>loglevel=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#celery.log.get_task_logger" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="function">