|
|
@@ -5,13 +5,13 @@
|
|
|
<head>
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
|
- <title>Backend: Base - celery.backends.base — Celery v0.2.0-pre2 documentation</title>
|
|
|
+ <title>Backend: Base - celery.backends.base — Celery v0.2.0-pre3 documentation</title>
|
|
|
<link rel="stylesheet" href="../static/default.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="../static/pygments.css" type="text/css" />
|
|
|
<script type="text/javascript">
|
|
|
var DOCUMENTATION_OPTIONS = {
|
|
|
URL_ROOT: '../',
|
|
|
- VERSION: '0.2.0-pre2',
|
|
|
+ VERSION: '0.2.0-pre3',
|
|
|
COLLAPSE_MODINDEX: false,
|
|
|
FILE_SUFFIX: '.html',
|
|
|
HAS_SOURCE: true
|
|
|
@@ -19,7 +19,7 @@
|
|
|
</script>
|
|
|
<script type="text/javascript" src="../static/jquery.js"></script>
|
|
|
<script type="text/javascript" src="../static/doctools.js"></script>
|
|
|
- <link rel="top" title="Celery v0.2.0-pre2 documentation" href="../index.html" />
|
|
|
+ <link rel="top" title="Celery v0.2.0-pre3 documentation" href="../index.html" />
|
|
|
<link rel="next" title="Backend: Database - celery.backends.database" href="celery.backends.database.html" />
|
|
|
<link rel="prev" title="Backends - celery.backends" href="celery.backends.html" />
|
|
|
</head>
|
|
|
@@ -39,7 +39,7 @@
|
|
|
<li class="right" >
|
|
|
<a href="celery.backends.html" title="Backends - celery.backends"
|
|
|
accesskey="P">previous</a> |</li>
|
|
|
- <li><a href="../index.html">Celery v0.2.0-pre2 documentation</a> »</li>
|
|
|
+ <li><a href="../index.html">Celery v0.2.0-pre3 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
|
|
|
@@ -56,60 +56,100 @@
|
|
|
<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="exception">
|
|
|
+<dt id="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper">
|
|
|
+<em class="property">
|
|
|
+exception </em><tt class="descname">UnpickleableExceptionWrapper</tt><big>(</big><em>exc_module</em>, <em>exc_cls_name</em>, <em>exc_args</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.UnpickleableExceptionWrapper" title="Permalink to this definition">¶</a></dt>
|
|
|
+<dd><p>Wraps unpickleable exceptions.</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>exc_module</em> – see <a title="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_module" class="reference internal" href="#celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_module"><tt class="xref docutils literal"><span class="pre">exc_module</span></tt></a>.</li>
|
|
|
+<li><em>exc_cls_name</em> – see <a title="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_cls_name" class="reference internal" href="#celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_cls_name"><tt class="xref docutils literal"><span class="pre">exc_cls_name</span></tt></a>.</li>
|
|
|
+<li><em>exc_args</em> – see <a title="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_args" class="reference internal" href="#celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_args"><tt class="xref docutils literal"><span class="pre">exc_args</span></tt></a></li>
|
|
|
+</ul>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+</tbody>
|
|
|
+</table>
|
|
|
+<dl class="attribute">
|
|
|
+<dt id="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_module">
|
|
|
+<tt class="descname">exc_module</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_module" title="Permalink to this definition">¶</a></dt>
|
|
|
+<dd>The module of the original exception.</dd></dl>
|
|
|
+
|
|
|
<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>
|
|
|
+<dt id="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_cls_name">
|
|
|
+<tt class="descname">exc_cls_name</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.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.BaseBackend.UnpickleableExceptionWrapper.exc_args">
|
|
|
+<tt class="descname">exc_args</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.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">>>> </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>
|
|
|
+<span class="gp">>>> </span><span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
|
|
|
+<span class="gp">... </span> <span class="n">exc</span> <span class="o">=</span> <span class="n">UnpickleableException</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__module__</span><span class="p">,</span>
|
|
|
+<span class="gp">... </span> <span class="n">e</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span>
|
|
|
+<span class="gp">... </span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">)</span>
|
|
|
+<span class="gp">... </span> <span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span> <span class="c"># Works fine.</span>
|
|
|
+</pre></div>
|
|
|
+</div>
|
|
|
+</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>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><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>
|
|
|
<dd>Backend cleanup. Is run by
|
|
|
<a title="celery.task.DeleteExpiredTaskMetaTask" class="reference external" href="celery.task.html#celery.task.DeleteExpiredTaskMetaTask"><tt class="xref docutils literal"><span class="pre">celery.task.DeleteExpiredTaskMetaTask</span></tt></a>.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.get_result">
|
|
|
-<tt class="descname">get_result</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.get_result" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><tt class="descname">get_result</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.get_result" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd>Get the result of a task.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.get_status">
|
|
|
-<tt class="descname">get_status</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.get_status" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><tt class="descname">get_status</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.get_status" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd>Get the status of a task.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.is_done">
|
|
|
-<tt class="descname">is_done</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.is_done" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><tt class="descname">is_done</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.is_done" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task was successfully executed.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.mark_as_done">
|
|
|
-<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>
|
|
|
+<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>
|
|
|
<dd>Mark task as successfully executed.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.mark_as_failure">
|
|
|
-<tt class="descname">mark_as_failure</tt><big>(</big><em>task_id</em>, <em>exc</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.mark_as_failure" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><tt class="descname">mark_as_failure</tt><big>(</big><em>task_id</em>, <em>exc</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.mark_as_failure" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd>Mark task as executed with failure. Stores the execption.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.mark_as_retry">
|
|
|
-<tt class="descname">mark_as_retry</tt><big>(</big><em>task_id</em>, <em>exc</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.mark_as_retry" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><tt class="descname">mark_as_retry</tt><big>(</big><em>task_id</em>, <em>exc</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.mark_as_retry" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd>Mark task for retry.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.prepare_result">
|
|
|
-<tt class="descname">prepare_result</tt><big>(</big><em>result</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.prepare_result" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><tt class="descname">prepare_result</tt><big>(</big><em>result</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.prepare_result" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd>Prepare result for storage.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.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.backends.base.BaseBackend.store_result" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><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.backends.base.BaseBackend.store_result" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd>Store the result and status of a task.</dd></dl>
|
|
|
|
|
|
<dl class="method">
|
|
|
<dt id="celery.backends.base.BaseBackend.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.base.BaseBackend.wait_for" title="Permalink to this definition">¶</a></dt>
|
|
|
+<tt class="descclassname">BaseBackend.</tt><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 <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>
|
|
|
@@ -171,7 +211,7 @@ exception </em><tt class="descclassname">celery.backends.base.</tt><tt class="de
|
|
|
<dd><p>With an exception instance, iterate over its super classes (by mro)
|
|
|
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
|
|
|
+<tt class="xref docutils literal"><span class="pre">BaseException</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" />
|
|
|
@@ -239,7 +279,7 @@ if it is it returns <tt class="xref docutils literal"><span class="pre">None</sp
|
|
|
<li class="right" >
|
|
|
<a href="celery.backends.html" title="Backends - celery.backends"
|
|
|
>previous</a> |</li>
|
|
|
- <li><a href="../index.html">Celery v0.2.0-pre2 documentation</a> »</li>
|
|
|
+ <li><a href="../index.html">Celery v0.2.0-pre3 documentation</a> »</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<div class="footer">
|
Ask Solem