Rendered documentation for Github Pages.

Author: Ask Solem

changelog.html

@@ -795,6 +795,9 @@ <h3>Important notes<a class="headerlink" href="#important-notes" title="Permalin
 <p>MySQL:</p>
 <div class="highlight-python"><pre>ALTER TABLE celery_taskmeta MODIFY result TEXT NULL</pre>
 </div>
+<p>PostgreSQL:</p>
+<div class="highlight-python"><pre>ALTER TABLE celery_taskmeta ALTER COLUMN result DROP NOT NULL</pre>
+</div>
 </blockquote>
 </li>
 <li><p class="first">Removed <tt class="docutils literal"><span class="pre">Task.rate_limit_queue_type</span></tt>, as it was not really useful

internals/reference/celery.backends.database.html

@@ -96,7 +96,7 @@ <h3>This Page</h3>
 <span id="backend-sqlalchemy-database-celery-backends-database"></span><h1>Backend: SQLAlchemy Database - celery.backends.database<a class="headerlink" href="#module-celery.backends.database" title="Permalink to this headline">¶</a></h1>
 <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>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

@@ -103,7 +103,7 @@ <h3>This Page</h3>
 <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

@@ -96,7 +96,7 @@ <h3>This Page</h3>
 <span id="sqlalchemy-session-celery-db-session"></span><h1>SQLAlchemy Session - celery.db.session<a class="headerlink" href="#module-celery.db.session" title="Permalink to this headline">¶</a></h1>
 <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.utils.compat.html

@@ -144,7 +144,7 @@ <h3>This Page</h3>
 
 <dl class="method">
 <dt id="celery.utils.compat.OrderedDict.pop">
-<tt class="descname">pop</tt><big>(</big><em>key</em>, <em>default=&lt;object object at 0x103d38a10&gt;</em><big>)</big><a class="headerlink" href="#celery.utils.compat.OrderedDict.pop" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">pop</tt><big>(</big><em>key</em>, <em>default=&lt;object object at 0x103bbf580&gt;</em><big>)</big><a class="headerlink" href="#celery.utils.compat.OrderedDict.pop" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="method">

internals/reference/celery.utils.html

@@ -257,7 +257,7 @@ <h3>This Page</h3>
 
 <dl class="function">
 <dt id="celery.utils.retry_over_time">
-<tt class="descclassname">celery.utils.</tt><tt class="descname">retry_over_time</tt><big>(</big><em>fun</em>, <em>catch</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>kwargs={}</em>, <em>errback=&lt;function noop at 0x101238b90&gt;</em>, <em>max_retries=None</em>, <em>interval_start=2</em>, <em>interval_step=2</em>, <em>interval_max=30</em><big>)</big><a class="headerlink" href="#celery.utils.retry_over_time" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">celery.utils.</tt><tt class="descname">retry_over_time</tt><big>(</big><em>fun</em>, <em>catch</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>kwargs={}</em>, <em>errback=&lt;function noop at 0x1041672a8&gt;</em>, <em>max_retries=None</em>, <em>interval_start=2</em>, <em>interval_step=2</em>, <em>interval_max=30</em><big>)</big><a class="headerlink" href="#celery.utils.retry_over_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Retry the function over and over until max retries is exceeded.</p>
 <p>For each retry we sleep a for a while before we try again, this interval
 is increased for every retry until the max seconds is reached.</p>

internals/reference/celery.worker.html

@@ -97,7 +97,7 @@ <h3>This Page</h3>
 <p>The Multiprocessing Worker Server</p>
 <dl class="class">
 <dt id="celery.worker.WorkController">
-<em class="property">class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">WorkController</tt><big>(</big><em>concurrency=None</em>, <em>logfile=None</em>, <em>loglevel=None</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>ready_callback=&lt;function noop at 0x101238b90&gt;</em>, <em>embed_clockservice=False</em>, <em>pool_cls='celery.concurrency.processes.TaskPool'</em>, <em>listener_cls='celery.worker.listener.CarrotListener'</em>, <em>mediator_cls='celery.worker.controllers.Mediator'</em>, <em>eta_scheduler_cls='celery.worker.controllers.ScheduleController'</em>, <em>schedule_filename='celerybeat-schedule'</em>, <em>task_time_limit=None</em>, <em>task_soft_time_limit=None</em>, <em>max_tasks_per_child=None</em>, <em>pool_putlocks=True</em><big>)</big><a class="headerlink" href="#celery.worker.WorkController" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">WorkController</tt><big>(</big><em>concurrency=None</em>, <em>logfile=None</em>, <em>loglevel=None</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>ready_callback=&lt;function noop at 0x1041672a8&gt;</em>, <em>embed_clockservice=False</em>, <em>pool_cls='celery.concurrency.processes.TaskPool'</em>, <em>listener_cls='celery.worker.listener.CarrotListener'</em>, <em>mediator_cls='celery.worker.controllers.Mediator'</em>, <em>eta_scheduler_cls='celery.worker.controllers.ScheduleController'</em>, <em>schedule_filename='celerybeat-schedule'</em>, <em>task_time_limit=None</em>, <em>task_soft_time_limit=None</em>, <em>max_tasks_per_child=None</em>, <em>pool_putlocks=True</em><big>)</big><a class="headerlink" href="#celery.worker.WorkController" title="Permalink to this definition">¶</a></dt>
 <dd><p>Executes tasks waiting in the task queue.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />

internals/reference/celery.worker.job.html

@@ -110,7 +110,7 @@ <h3>This Page</h3>
 
 <dl class="class">
 <dt id="celery.worker.job.TaskRequest">
-<em class="property">class </em><tt class="descclassname">celery.worker.job.</tt><tt class="descname">TaskRequest</tt><big>(</big><em>task_name</em>, <em>task_id</em>, <em>args</em>, <em>kwargs</em>, <em>on_ack=&lt;function noop at 0x101238b90&gt;</em>, <em>retries=0</em>, <em>delivery_info=None</em>, <em>**opts</em><big>)</big><a class="headerlink" href="#celery.worker.job.TaskRequest" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.worker.job.</tt><tt class="descname">TaskRequest</tt><big>(</big><em>task_name</em>, <em>task_id</em>, <em>args</em>, <em>kwargs</em>, <em>on_ack=&lt;function noop at 0x1041672a8&gt;</em>, <em>retries=0</em>, <em>delivery_info=None</em>, <em>**opts</em><big>)</big><a class="headerlink" href="#celery.worker.job.TaskRequest" title="Permalink to this definition">¶</a></dt>
 <dd><p>A request for task execution.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />

internals/reference/celery.worker.listener.html

@@ -103,17 +103,18 @@ <h3>This Page</h3>
 connection is lost) it calls <a class="reference internal" href="#celery.worker.listener.CarrotListener.reset_connection" title="celery.worker.listener.CarrotListener.reset_connection"><tt class="xref py py-meth docutils literal"><span class="pre">reset_connection()</span></tt></a>,
 and starts the consumer by calling <a class="reference internal" href="#celery.worker.listener.CarrotListener.consume_messages" title="celery.worker.listener.CarrotListener.consume_messages"><tt class="xref py py-meth docutils literal"><span class="pre">consume_messages()</span></tt></a>.</p>
 </li>
-<li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">reset_connection`()</span></tt>, clears the internal queues,
-establishes a new connection to the broker, sets up the task queues (+ QoS),
-the broadcast remote control command consumer, the event dispatcher and the
-heartbeat.</p>
+<li><p class="first"><a class="reference internal" href="#celery.worker.listener.CarrotListener.reset_connection" title="celery.worker.listener.CarrotListener.reset_connection"><tt class="xref py py-meth docutils literal"><span class="pre">reset_connection()</span></tt></a>, clears the internal queues,
+establishes a new connection to the broker, sets up the task
+consumer (+ QoS), and the broadcast remote control command consumer.</p>
+<p>Also if events are enabled it configures the event dispatcher and starts
+up the hartbeat thread.</p>
 </li>
 <li><p class="first">Finally it can consume messages. <a class="reference internal" href="#celery.worker.listener.CarrotListener.consume_messages" title="celery.worker.listener.CarrotListener.consume_messages"><tt class="xref py py-meth docutils literal"><span class="pre">consume_messages()</span></tt></a>
 is simply an infinite loop waiting for events on the AMQP channels.</p>
 <p>Both the task consumer and the broadcast consumer uses the same
 callback: <a class="reference internal" href="#celery.worker.listener.CarrotListener.receive_message" title="celery.worker.listener.CarrotListener.receive_message"><tt class="xref py py-meth docutils literal"><span class="pre">receive_message()</span></tt></a>.
-The reason for this is that not all carrot backends supports receiving
-on different channels, so we use a little nasty trick
+The reason is that some carrot backends doesn&#8217;t support consuming
+from several channels simultaneously, so we use a little nasty trick
 (<tt class="xref py py-meth docutils literal"><span class="pre">_detect_wait_method()</span></tt>) to select the best
 possible channel distribution depending on the functionality supported
 by the carrot backend.</p>
@@ -126,20 +127,20 @@ <h3>This Page</h3>
 it to <a class="reference internal" href="#celery.worker.listener.CarrotListener.on_task" title="celery.worker.listener.CarrotListener.on_task"><tt class="xref py py-meth docutils literal"><span class="pre">on_task()</span></tt></a>.</p>
 <p>If the message is a control command the message is passed to
 <a class="reference internal" href="#celery.worker.listener.CarrotListener.on_control" title="celery.worker.listener.CarrotListener.on_control"><tt class="xref py py-meth docutils literal"><span class="pre">on_control()</span></tt></a>, which in turn dispatches
-the control command using the <tt class="xref py py-attr docutils literal"><span class="pre">control_dispatcher</span></tt>.</p>
-<p>It also tried to handle malformed or invalid messages properly,
+the control command using the control dispatcher.</p>
+<p>It also tries to handle malformed or invalid messages properly,
 so the worker doesn&#8217;t choke on them and die. Any invalid messages
 are acknowledged immediately and logged, so the message is not resent
-again and again.</p>
+again, and again.</p>
 </li>
 <li><p class="first">If the task has an ETA/countdown, the task is moved to the <tt class="docutils literal"><span class="pre">eta_schedule</span></tt>
-so the <a class="reference internal" href="celery.worker.scheduler.html#celery.worker.scheduler.Scheduler" title="celery.worker.scheduler.Scheduler"><tt class="xref py py-class docutils literal"><span class="pre">celery.worker.scheduler.Scheduler</span></tt></a> can schedule it at its
-deadline. Tasks without eta are moved immediately to the <tt class="docutils literal"><span class="pre">ready_queue</span></tt>,
-so it can be picked up by the <a class="reference internal" href="celery.worker.controllers.html#celery.worker.controllers.Mediator" title="celery.worker.controllers.Mediator"><tt class="xref py py-class docutils literal"><span class="pre">celery.worker.controllers.Mediator</span></tt></a>
-and sent to the pool.</p>
+so the <a class="reference internal" href="celery.worker.scheduler.html#celery.worker.scheduler.Scheduler" title="celery.worker.scheduler.Scheduler"><tt class="xref py py-class docutils literal"><span class="pre">Scheduler</span></tt></a> can schedule it at its
+deadline. Tasks without an eta are moved immediately to the <tt class="docutils literal"><span class="pre">ready_queue</span></tt>,
+so they can be picked up by the <a class="reference internal" href="celery.worker.controllers.html#celery.worker.controllers.Mediator" title="celery.worker.controllers.Mediator"><tt class="xref py py-class docutils literal"><span class="pre">Mediator</span></tt></a>
+to be sent to the pool.</p>
 </li>
 <li><p class="first">When a task with an ETA is received the QoS prefetch count is also
-incremented so we can reserve another message. When the ETA is met
+incremented, so another message can be reserved. When the ETA is met
 the prefetch count is decremented again, though this cannot happen
 immediately because amqplib doesn&#8217;t support doing broker requests
 across threads. Instead the current prefetch count is kept as a
@@ -161,7 +162,7 @@ <h3>This Page</h3>
 </ul>
 <dl class="class">
 <dt id="celery.worker.listener.CarrotListener">
-<em class="property">class </em><tt class="descclassname">celery.worker.listener.</tt><tt class="descname">CarrotListener</tt><big>(</big><em>ready_queue</em>, <em>eta_schedule</em>, <em>logger</em>, <em>init_callback=&lt;function noop at 0x1034dd398&gt;</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>initial_prefetch_count=2</em><big>)</big><a class="headerlink" href="#celery.worker.listener.CarrotListener" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">celery.worker.listener.</tt><tt class="descname">CarrotListener</tt><big>(</big><em>ready_queue</em>, <em>eta_schedule</em>, <em>logger</em>, <em>init_callback=&lt;function noop at 0x1041672a8&gt;</em>, <em>send_events=False</em>, <em>hostname=None</em>, <em>initial_prefetch_count=2</em><big>)</big><a class="headerlink" href="#celery.worker.listener.CarrotListener" title="Permalink to this definition">¶</a></dt>
 <dd><p>Listen for messages received from the broker and
 move them the the ready queue for task processing.</p>
 <table class="docutils field-list" frame="void" rules="none">