Autogenerated documentation for github.

genindex.html

@@ -191,8 +191,9 @@
 <dt><a href="reference/celery.worker.html#celery.worker.EmptyQueue">EmptyQueue</a></dt>
 <dt><a href="reference/celery.timer.html#celery.timer.EventTimer.event">event (celery.timer.EventTimer attribute)</a></dt>
 <dt><a href="reference/celery.timer.html#celery.timer.EventTimer">EventTimer (class in celery.timer)</a></dt>
-<dt><a href="reference/celery.backends.base.html#celery.backends.base.UnpickleableExceptionWrapper.exc_cls_name">exc_cls_name (celery.backends.base.UnpickleableExceptionWrapper attribute)</a></dt>
-<dt><a href="reference/celery.backends.base.html#celery.backends.base.UnpickleableExceptionWrapper.exc_module">exc_module (celery.backends.base.UnpickleableExceptionWrapper attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="reference/celery.backends.base.html#celery.backends.base.UnpickleableExceptionWrapper.exc_args">exc_args (celery.backends.base.UnpickleableExceptionWrapper attribute)</a></dt>
+<dt><a href="reference/celery.backends.base.html#celery.backends.base.UnpickleableExceptionWrapper.exc_cls_name">exc_cls_name (celery.backends.base.UnpickleableExceptionWrapper attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="reference/celery.backends.base.html#celery.backends.base.UnpickleableExceptionWrapper.exc_module">exc_module (celery.backends.base.UnpickleableExceptionWrapper attribute)</a></dt>
 <dt><a href="reference/celery.worker.html#celery.worker.TaskWrapper.execute">execute() (celery.worker.TaskWrapper method)</a></dt>
 <dt><a href="reference/celery.worker.html#celery.worker.TaskDaemon.execute_next_task">execute_next_task() (celery.worker.TaskDaemon method)</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.execute_remote">execute_remote() (in module celery.task)</a></dt>
@@ -433,7 +434,8 @@
 <dl>
 
 <dt><a href="reference/celery.worker.html#celery.worker.UnknownTask">UnknownTask</a></dt>
-<dt><a href="reference/celery.backends.base.html#celery.backends.base.UnpickleableExceptionWrapper">UnpickleableExceptionWrapper</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="reference/celery.backends.base.html#celery.backends.base.UnpickleableExceptionWrapper">UnpickleableExceptionWrapper</a></dt>
+<dt><a href="reference/celery.backends.base.html#celery.backends.base.BaseBackend.UnpickleableExecptionWrapper">UnpickleableExecptionWrapper (celery.backends.base.BaseBackend attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry.unregister">unregister() (celery.registry.TaskRegistry method)</a></dt>
 </dl></td></tr></table>
 

objects.inv

@@ -43,6 +43,7 @@ celery.registry.TaskRegistry.AlreadyRegistered exception reference/celery.regist
 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.backends.base.UnpickleableExceptionWrapper.exc_args attribute reference/celery.backends.base.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
@@ -132,6 +133,7 @@ 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
 TaskMeta.date_done attribute reference/celery.models.html
+celery.backends.base.BaseBackend.UnpickleableExecptionWrapper attribute reference/celery.backends.base.html
 celery.worker.TaskDaemon.execute_next_task method reference/celery.worker.html
 celery.result.AsyncResult class reference/celery.result.html
 PeriodicTaskMeta.name attribute reference/celery.models.html

reference/celery.backends.base.html

@@ -56,6 +56,11 @@
 <em class="property">
 class </em><tt class="descclassname">celery.backends.base.</tt><tt class="descname">BaseBackend</tt><a class="headerlink" href="#celery.backends.base.BaseBackend" title="Permalink to this definition">¶</a></dt>
 <dd><p>The base backend class. All backends should inherit from this.</p>
+<dl class="attribute">
+<dt id="celery.backends.base.BaseBackend.UnpickleableExecptionWrapper">
+<tt class="descname">UnpickleableExecptionWrapper</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.UnpickleableExecptionWrapper" title="Permalink to this definition">¶</a></dt>
+<dd>alias of <a title="celery.backends.base.UnpickleableExceptionWrapper" class="reference internal" href="#celery.backends.base.UnpickleableExceptionWrapper"><tt class="xref docutils literal"><span class="pre">UnpickleableExceptionWrapper</span></tt></a></dd></dl>
+
 <dl class="method">
 <dt id="celery.backends.base.BaseBackend.cleanup">
 <tt class="descname">cleanup</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.cleanup" title="Permalink to this definition">¶</a></dt>
@@ -127,7 +132,7 @@ exception </em><tt class="descclassname">celery.backends.base.</tt><tt class="de
 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><em>exc_module</em> &#8211; see <a title="celery.backends.base.UnpickleableExceptionWrapper.exc_module" class="reference internal" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_module"><tt class="xref docutils literal"><span class="pre">exc_module</span></tt></a>.</li>
 <li><em>exc_cls_name</em> &#8211; see <a title="celery.backends.base.UnpickleableExceptionWrapper.exc_cls_name" class="reference internal" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_cls_name"><tt class="xref docutils literal"><span class="pre">exc_cls_name</span></tt></a>.</li>
-<li><em>exc_args</em> &#8211; The arguments for the original exception.</li>
+<li><em>exc_args</em> &#8211; see <a title="celery.backends.base.UnpickleableExceptionWrapper.exc_args" class="reference internal" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_args"><tt class="xref docutils literal"><span class="pre">exc_args</span></tt></a></li>
 </ul>
 </td>
 </tr>
@@ -143,6 +148,11 @@ exception </em><tt class="descclassname">celery.backends.base.</tt><tt class="de
 <tt class="descname">exc_cls_name</tt><a class="headerlink" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_cls_name" title="Permalink to this definition">¶</a></dt>
 <dd>The name of the original exception class.</dd></dl>
 
+<dl class="attribute">
+<dt id="celery.backends.base.UnpickleableExceptionWrapper.exc_args">
+<tt class="descname">exc_args</tt><a class="headerlink" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_args" title="Permalink to this definition">¶</a></dt>
+<dd>The arguments for the original exception.</dd></dl>
+
 <p>Example</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">try</span><span class="p">:</span>
 <span class="gp">... </span>    <span class="n">something_raising_unpickleable_exc</span><span class="p">()</span>
@@ -159,13 +169,19 @@ exception </em><tt class="descclassname">celery.backends.base.</tt><tt class="de
 <dt id="celery.backends.base.find_nearest_pickleable_exception">
 <tt class="descclassname">celery.backends.base.</tt><tt class="descname">find_nearest_pickleable_exception</tt><big>(</big><em>exc</em><big>)</big><a class="headerlink" href="#celery.backends.base.find_nearest_pickleable_exception" title="Permalink to this definition">¶</a></dt>
 <dd><p>With an exception instance, iterate over its super classes (by mro)
-and find the first super exception that is pickleable.</p>
+and find the first super exception that is pickleable. It does
+not go below <tt class="xref docutils literal"><span class="pre">Exception</span></tt> (i.e. it skips <tt class="xref docutils literal"><span class="pre">Exception</span></tt>,
+<tt class="xref docutils literal"><span class="pre">BaseExecption</span></tt> and <tt class="xref docutils literal"><span class="pre">object</span></tt>). If that happens
+you should use <tt class="xref docutils literal"><span class="pre">UnpickleableException</span></tt> instead.</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>exc</em> &#8211; An exception instance.</td>
 </tr>
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the nearest exception if it&#8217;s not <tt class="xref docutils literal"><span class="pre">Exception</span></tt> or below,
+if it is it returns <tt class="xref docutils literal"><span class="pre">None</span></tt>.</td>
+</tr>
 <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref docutils literal"><span class="pre">Exception</span></tt></td>
 </tr>
 </tbody>