celery.backends.base.html 21 KB

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