celery.backends.base.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Backend: Base - celery.backends.base &mdash; Celery v0.2.0-pre2 documentation</title>
  7. <link rel="stylesheet" href="../static/default.css" type="text/css" />
  8. <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../',
  12. VERSION: '0.2.0-pre2',
  13. COLLAPSE_MODINDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../static/jquery.js"></script>
  19. <script type="text/javascript" src="../static/doctools.js"></script>
  20. <link rel="top" title="Celery v0.2.0-pre2 documentation" href="../index.html" />
  21. <link rel="next" title="Backend: Database - celery.backends.database" href="celery.backends.database.html" />
  22. <link rel="prev" title="Backends - celery.backends" href="celery.backends.html" />
  23. </head>
  24. <body>
  25. <div class="related">
  26. <h3>Navigation</h3>
  27. <ul>
  28. <li class="right" style="margin-right: 10px">
  29. <a href="../genindex.html" title="General Index"
  30. accesskey="I">index</a></li>
  31. <li class="right" >
  32. <a href="../modindex.html" title="Global Module Index"
  33. accesskey="M">modules</a> |</li>
  34. <li class="right" >
  35. <a href="celery.backends.database.html" title="Backend: Database - celery.backends.database"
  36. accesskey="N">next</a> |</li>
  37. <li class="right" >
  38. <a href="celery.backends.html" title="Backends - celery.backends"
  39. accesskey="P">previous</a> |</li>
  40. <li><a href="../index.html">Celery v0.2.0-pre2 documentation</a> &raquo;</li>
  41. </ul>
  42. </div>
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="module-celery.backends.base">
  48. <h1>Backend: Base - celery.backends.base<a class="headerlink" href="#module-celery.backends.base" title="Permalink to this headline">¶</a></h1>
  49. <p>celery.backends.base</p>
  50. <dl class="class">
  51. <dt id="celery.backends.base.BaseBackend">
  52. <em class="property">
  53. 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>
  54. <dd><p>The base backend class. All backends should inherit from this.</p>
  55. <dl class="attribute">
  56. <dt id="celery.backends.base.BaseBackend.UnpickleableExecptionWrapper">
  57. <tt class="descname">UnpickleableExecptionWrapper</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.UnpickleableExecptionWrapper" title="Permalink to this definition">¶</a></dt>
  58. <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>
  59. <dl class="method">
  60. <dt id="celery.backends.base.BaseBackend.cleanup">
  61. <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>
  62. <dd>Backend cleanup. Is run by
  63. <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>
  64. <dl class="method">
  65. <dt id="celery.backends.base.BaseBackend.get_result">
  66. <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>
  67. <dd>Get the result of a task.</dd></dl>
  68. <dl class="method">
  69. <dt id="celery.backends.base.BaseBackend.get_status">
  70. <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>
  71. <dd>Get the status of a task.</dd></dl>
  72. <dl class="method">
  73. <dt id="celery.backends.base.BaseBackend.is_done">
  74. <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>
  75. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task was successfully executed.</dd></dl>
  76. <dl class="method">
  77. <dt id="celery.backends.base.BaseBackend.mark_as_done">
  78. <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>
  79. <dd>Mark task as successfully executed.</dd></dl>
  80. <dl class="method">
  81. <dt id="celery.backends.base.BaseBackend.mark_as_failure">
  82. <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>
  83. <dd>Mark task as executed with failure. Stores the execption.</dd></dl>
  84. <dl class="method">
  85. <dt id="celery.backends.base.BaseBackend.mark_as_retry">
  86. <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>
  87. <dd>Mark task for retry.</dd></dl>
  88. <dl class="method">
  89. <dt id="celery.backends.base.BaseBackend.prepare_result">
  90. <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>
  91. <dd>Prepare result for storage.</dd></dl>
  92. <dl class="method">
  93. <dt id="celery.backends.base.BaseBackend.store_result">
  94. <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>
  95. <dd>Store the result and status of a task.</dd></dl>
  96. <dl class="method">
  97. <dt id="celery.backends.base.BaseBackend.wait_for">
  98. <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>
  99. <dd><p>Wait for task and return its result.</p>
  100. <p>If the task raises an exception, this exception
  101. 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>
  102. <p>If <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt>, this raises the
  103. <a title="celery.timer.TimeoutError" class="reference external" href="celery.timer.html#celery.timer.TimeoutError"><tt class="xref docutils literal"><span class="pre">celery.timer.TimeoutError</span></tt></a> exception if the operation takes
  104. longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</p>
  105. </dd></dl>
  106. </dd></dl>
  107. <dl class="exception">
  108. <dt id="celery.backends.base.UnpickleableExceptionWrapper">
  109. <em class="property">
  110. exception </em><tt class="descclassname">celery.backends.base.</tt><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.UnpickleableExceptionWrapper" title="Permalink to this definition">¶</a></dt>
  111. <dd><p>Wraps unpickleable exceptions.</p>
  112. <table class="docutils field-list" frame="void" rules="none">
  113. <col class="field-name" />
  114. <col class="field-body" />
  115. <tbody valign="top">
  116. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  117. <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>
  118. <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>
  119. <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>
  120. </ul>
  121. </td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. <dl class="attribute">
  126. <dt id="celery.backends.base.UnpickleableExceptionWrapper.exc_module">
  127. <tt class="descname">exc_module</tt><a class="headerlink" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_module" title="Permalink to this definition">¶</a></dt>
  128. <dd>The module of the original exception.</dd></dl>
  129. <dl class="attribute">
  130. <dt id="celery.backends.base.UnpickleableExceptionWrapper.exc_cls_name">
  131. <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>
  132. <dd>The name of the original exception class.</dd></dl>
  133. <dl class="attribute">
  134. <dt id="celery.backends.base.UnpickleableExceptionWrapper.exc_args">
  135. <tt class="descname">exc_args</tt><a class="headerlink" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_args" title="Permalink to this definition">¶</a></dt>
  136. <dd>The arguments for the original exception.</dd></dl>
  137. <p>Example</p>
  138. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">try</span><span class="p">:</span>
  139. <span class="gp">... </span> <span class="n">something_raising_unpickleable_exc</span><span class="p">()</span>
  140. <span class="gp">&gt;&gt;&gt; </span><span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
  141. <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>
  142. <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>
  143. <span class="gp">... </span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">)</span>
  144. <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>
  145. </pre></div>
  146. </div>
  147. </dd></dl>
  148. <dl class="function">
  149. <dt id="celery.backends.base.find_nearest_pickleable_exception">
  150. <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>
  151. <dd><p>With an exception instance, iterate over its super classes (by mro)
  152. and find the first super exception that is pickleable. It does
  153. 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>,
  154. <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
  155. you should use <tt class="xref docutils literal"><span class="pre">UnpickleableException</span></tt> instead.</p>
  156. <table class="docutils field-list" frame="void" rules="none">
  157. <col class="field-name" />
  158. <col class="field-body" />
  159. <tbody valign="top">
  160. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>exc</em> &#8211; An exception instance.</td>
  161. </tr>
  162. <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,
  163. if it is it returns <tt class="xref docutils literal"><span class="pre">None</span></tt>.</td>
  164. </tr>
  165. <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>
  166. </tr>
  167. </tbody>
  168. </table>
  169. </dd></dl>
  170. </div>
  171. </div>
  172. </div>
  173. </div>
  174. <div class="sphinxsidebar">
  175. <div class="sphinxsidebarwrapper">
  176. <h4>Previous topic</h4>
  177. <p class="topless"><a href="celery.backends.html"
  178. title="previous chapter">Backends - celery.backends</a></p>
  179. <h4>Next topic</h4>
  180. <p class="topless"><a href="celery.backends.database.html"
  181. title="next chapter">Backend: Database - celery.backends.database</a></p>
  182. <h3>This Page</h3>
  183. <ul class="this-page-menu">
  184. <li><a href="../sources/reference/celery.backends.base.txt"
  185. rel="nofollow">Show Source</a></li>
  186. </ul>
  187. <div id="searchbox" style="display: none">
  188. <h3>Quick search</h3>
  189. <form class="search" action="../search.html" method="get">
  190. <input type="text" name="q" size="18" />
  191. <input type="submit" value="Go" />
  192. <input type="hidden" name="check_keywords" value="yes" />
  193. <input type="hidden" name="area" value="default" />
  194. </form>
  195. <p class="searchtip" style="font-size: 90%">
  196. Enter search terms or a module, class or function name.
  197. </p>
  198. </div>
  199. <script type="text/javascript">$('#searchbox').show(0);</script>
  200. </div>
  201. </div>
  202. <div class="clearer"></div>
  203. </div>
  204. <div class="related">
  205. <h3>Navigation</h3>
  206. <ul>
  207. <li class="right" style="margin-right: 10px">
  208. <a href="../genindex.html" title="General Index"
  209. >index</a></li>
  210. <li class="right" >
  211. <a href="../modindex.html" title="Global Module Index"
  212. >modules</a> |</li>
  213. <li class="right" >
  214. <a href="celery.backends.database.html" title="Backend: Database - celery.backends.database"
  215. >next</a> |</li>
  216. <li class="right" >
  217. <a href="celery.backends.html" title="Backends - celery.backends"
  218. >previous</a> |</li>
  219. <li><a href="../index.html">Celery v0.2.0-pre2 documentation</a> &raquo;</li>
  220. </ul>
  221. </div>
  222. <div class="footer">
  223. &copy; Copyright 2009, Ask Solem.
  224. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  225. </div>
  226. </body>
  227. </html>