celery.backends.base.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  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-pre3 documentation</title>
  7. <link rel="stylesheet" href="../static/agogo.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-pre3',
  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-pre3 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="header-wrapper">
  26. <div class="header">
  27. <h1><a href="../index.html">Celery v0.2.0-pre3 documentation</a></h1>
  28. <div class="rel">
  29. <a href="../genindex.html" title="General Index"
  30. accesskey="I">index</a> |
  31. <a href="../modindex.html" title="Global Module Index"
  32. accesskey="M">modules</a> |
  33. <a href="celery.backends.database.html" title="Backend: Database - celery.backends.database"
  34. accesskey="N">next</a> |
  35. <a href="celery.backends.html" title="Backends - celery.backends"
  36. accesskey="P">previous</a>
  37. </div>
  38. </div>
  39. </div>
  40. <div class="content-wrapper">
  41. <div class="content">
  42. <div class="document">
  43. <div class="documentwrapper">
  44. <div class="bodywrapper">
  45. <div class="body">
  46. <div class="section" id="module-celery.backends.base">
  47. <h1>Backend: Base - celery.backends.base<a class="headerlink" href="#module-celery.backends.base" title="Permalink to this headline">¶</a></h1>
  48. <p>celery.backends.base</p>
  49. <dl class="class">
  50. <dt id="celery.backends.base.BaseBackend">
  51. <em class="property">
  52. 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>
  53. <dd><p>The base backend class. All backends should inherit from this.</p>
  54. <dl class="exception">
  55. <dt id="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper">
  56. <em class="property">
  57. 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>
  58. <dd><p>Wraps unpickleable exceptions.</p>
  59. <table class="docutils field-list" frame="void" rules="none">
  60. <col class="field-name" />
  61. <col class="field-body" />
  62. <tbody valign="top">
  63. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  64. <li><em>exc_module</em> &#8211; 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>
  65. <li><em>exc_cls_name</em> &#8211; 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>
  66. <li><em>exc_args</em> &#8211; 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>
  67. </ul>
  68. </td>
  69. </tr>
  70. </tbody>
  71. </table>
  72. <dl class="attribute">
  73. <dt id="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_module">
  74. <tt class="descname">exc_module</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_module" title="Permalink to this definition">¶</a></dt>
  75. <dd>The module of the original exception.</dd></dl>
  76. <dl class="attribute">
  77. <dt id="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_cls_name">
  78. <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>
  79. <dd>The name of the original exception class.</dd></dl>
  80. <dl class="attribute">
  81. <dt id="celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_args">
  82. <tt class="descname">exc_args</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.UnpickleableExceptionWrapper.exc_args" title="Permalink to this definition">¶</a></dt>
  83. <dd>The arguments for the original exception.</dd></dl>
  84. <p>Example</p>
  85. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">try</span><span class="p">:</span>
  86. <span class="gp">... </span> <span class="n">something_raising_unpickleable_exc</span><span class="p">()</span>
  87. <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>
  88. <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>
  89. <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>
  90. <span class="gp">... </span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">)</span>
  91. <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>
  92. </pre></div>
  93. </div>
  94. </dd></dl>
  95. <dl class="method">
  96. <dt id="celery.backends.base.BaseBackend.cleanup">
  97. <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>
  98. <dd>Backend cleanup. Is run by
  99. <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>
  100. <dl class="method">
  101. <dt id="celery.backends.base.BaseBackend.get_result">
  102. <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>
  103. <dd>Get the result of a task.</dd></dl>
  104. <dl class="method">
  105. <dt id="celery.backends.base.BaseBackend.get_status">
  106. <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>
  107. <dd>Get the status of a task.</dd></dl>
  108. <dl class="method">
  109. <dt id="celery.backends.base.BaseBackend.is_done">
  110. <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>
  111. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task was successfully executed.</dd></dl>
  112. <dl class="method">
  113. <dt id="celery.backends.base.BaseBackend.mark_as_done">
  114. <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>
  115. <dd>Mark task as successfully executed.</dd></dl>
  116. <dl class="method">
  117. <dt id="celery.backends.base.BaseBackend.mark_as_failure">
  118. <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>
  119. <dd>Mark task as executed with failure. Stores the execption.</dd></dl>
  120. <dl class="method">
  121. <dt id="celery.backends.base.BaseBackend.mark_as_retry">
  122. <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>
  123. <dd>Mark task for retry.</dd></dl>
  124. <dl class="method">
  125. <dt id="celery.backends.base.BaseBackend.prepare_result">
  126. <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>
  127. <dd>Prepare result for storage.</dd></dl>
  128. <dl class="method">
  129. <dt id="celery.backends.base.BaseBackend.store_result">
  130. <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>
  131. <dd>Store the result and status of a task.</dd></dl>
  132. <dl class="method">
  133. <dt id="celery.backends.base.BaseBackend.wait_for">
  134. <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>
  135. <dd><p>Wait for task and return its result.</p>
  136. <p>If the task raises an exception, this exception
  137. 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>
  138. <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
  139. <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
  140. longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</p>
  141. </dd></dl>
  142. </dd></dl>
  143. <dl class="exception">
  144. <dt id="celery.backends.base.UnpickleableExceptionWrapper">
  145. <em class="property">
  146. 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>
  147. <dd><p>Wraps unpickleable exceptions.</p>
  148. <table class="docutils field-list" frame="void" rules="none">
  149. <col class="field-name" />
  150. <col class="field-body" />
  151. <tbody valign="top">
  152. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  153. <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>
  154. <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>
  155. <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>
  156. </ul>
  157. </td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <dl class="attribute">
  162. <dt id="celery.backends.base.UnpickleableExceptionWrapper.exc_module">
  163. <tt class="descname">exc_module</tt><a class="headerlink" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_module" title="Permalink to this definition">¶</a></dt>
  164. <dd>The module of the original exception.</dd></dl>
  165. <dl class="attribute">
  166. <dt id="celery.backends.base.UnpickleableExceptionWrapper.exc_cls_name">
  167. <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>
  168. <dd>The name of the original exception class.</dd></dl>
  169. <dl class="attribute">
  170. <dt id="celery.backends.base.UnpickleableExceptionWrapper.exc_args">
  171. <tt class="descname">exc_args</tt><a class="headerlink" href="#celery.backends.base.UnpickleableExceptionWrapper.exc_args" title="Permalink to this definition">¶</a></dt>
  172. <dd>The arguments for the original exception.</dd></dl>
  173. <p>Example</p>
  174. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">try</span><span class="p">:</span>
  175. <span class="gp">... </span> <span class="n">something_raising_unpickleable_exc</span><span class="p">()</span>
  176. <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>
  177. <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>
  178. <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>
  179. <span class="gp">... </span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">)</span>
  180. <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>
  181. </pre></div>
  182. </div>
  183. </dd></dl>
  184. <dl class="function">
  185. <dt id="celery.backends.base.find_nearest_pickleable_exception">
  186. <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>
  187. <dd><p>With an exception instance, iterate over its super classes (by mro)
  188. and find the first super exception that is pickleable. It does
  189. 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>,
  190. <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
  191. you should use <tt class="xref docutils literal"><span class="pre">UnpickleableException</span></tt> instead.</p>
  192. <table class="docutils field-list" frame="void" rules="none">
  193. <col class="field-name" />
  194. <col class="field-body" />
  195. <tbody valign="top">
  196. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>exc</em> &#8211; An exception instance.</td>
  197. </tr>
  198. <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,
  199. if it is it returns <tt class="xref docutils literal"><span class="pre">None</span></tt>.</td>
  200. </tr>
  201. <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>
  202. </tr>
  203. </tbody>
  204. </table>
  205. </dd></dl>
  206. </div>
  207. </div>
  208. </div>
  209. </div>
  210. </div>
  211. <div class="sidebar">
  212. <h3>Contents</h3>
  213. <ul class="current">
  214. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
  215. <li class="toctree-l1"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
  216. <li class="toctree-l1"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
  217. <li class="toctree-l1"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
  218. <li class="toctree-l1"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
  219. <li class="toctree-l1"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
  220. <li class="toctree-l1"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
  221. <li class="toctree-l1 current"><a class="current reference external" href="">Backend: Base - celery.backends.base</a></li>
  222. <li class="toctree-l1"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
  223. <li class="toctree-l1"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
  224. <li class="toctree-l1"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
  225. <li class="toctree-l1"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
  226. <li class="toctree-l1"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
  227. <li class="toctree-l1"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
  228. <li class="toctree-l1"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
  229. <li class="toctree-l1"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
  230. <li class="toctree-l1"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
  231. <li class="toctree-l1"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
  232. <li class="toctree-l1"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
  233. <li class="toctree-l1"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
  234. </ul>
  235. <h3 style="margin-top: 1.5em;">Search</h3>
  236. <form class="search" action="../search.html" method="get">
  237. <input type="text" name="q" size="18" />
  238. <input type="submit" value="Go" />
  239. <input type="hidden" name="check_keywords" value="yes" />
  240. <input type="hidden" name="area" value="default" />
  241. </form>
  242. <p class="searchtip" style="font-size: 90%">
  243. Enter search terms or a module, class or function name.
  244. </p>
  245. </div>
  246. <div class="clearer"></div>
  247. </div>
  248. </div>
  249. <div class="footer-wrapper">
  250. <div class="footer">
  251. <div class="left">
  252. <a href="../genindex.html" title="General Index"
  253. >index</a> |
  254. <a href="../modindex.html" title="Global Module Index"
  255. >modules</a> |
  256. <a href="celery.backends.database.html" title="Backend: Database - celery.backends.database"
  257. >next</a> |
  258. <a href="celery.backends.html" title="Backends - celery.backends"
  259. >previous</a>
  260. <br/>
  261. <a href="../sources/reference/celery.backends.base.txt"
  262. rel="nofollow">Show Source</a>
  263. </div>
  264. <div class="right">
  265. &copy; Copyright 2009, Ask Solem.<br/>
  266. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  267. </div>
  268. <div class="clearer"></div>
  269. </div>
  270. </div>
  271. </body>
  272. </html>