celery.backends.base.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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.7.0 (unstable) documentation</title>
  7. <link rel="stylesheet" href="../static/nature.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.7.0 (unstable)',
  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.7.0 (unstable) 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="related">
  27. <h3>Navigation</h3>
  28. <ul>
  29. <li class="right" style="margin-right: 10px">
  30. <a href="../genindex.html" title="General Index"
  31. accesskey="I">index</a></li>
  32. <li class="right" >
  33. <a href="../modindex.html" title="Global Module Index"
  34. accesskey="M">modules</a> |</li>
  35. <li class="right" >
  36. <a href="celery.backends.database.html" title="Backend: Database - celery.backends.database"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.backends.html" title="Backends - celery.backends"
  40. accesskey="P">previous</a> |</li>
  41. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  42. <li><a href="index.html" accesskey="U">Module API Reference</a> &raquo;</li>
  43. </ul>
  44. </div>
  45. <div class="document">
  46. <div class="documentwrapper">
  47. <div class="bodywrapper">
  48. <div class="body">
  49. <div class="section" id="module-celery.backends.base">
  50. <h1>Backend: Base - celery.backends.base<a class="headerlink" href="#module-celery.backends.base" title="Permalink to this headline">¶</a></h1>
  51. <p>celery.backends.base</p>
  52. <dl class="class">
  53. <dt id="celery.backends.base.BaseBackend">
  54. <em class="property">
  55. 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>
  56. <dd><p>The base backend class. All backends should inherit from this.</p>
  57. <dl class="exception">
  58. <dt id="celery.backends.base.BaseBackend.TimeoutError">
  59. <em class="property">
  60. exception </em><tt class="descname">TimeoutError</tt><a class="headerlink" href="#celery.backends.base.BaseBackend.TimeoutError" title="Permalink to this definition">¶</a></dt>
  61. <dd>The operation timed out.</dd></dl>
  62. <dl class="method">
  63. <dt id="celery.backends.base.BaseBackend.cleanup">
  64. <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>
  65. <dd>Backend cleanup. Is run by
  66. <tt class="xref docutils literal"><span class="pre">celery.task.DeleteExpiredTaskMetaTask</span></tt>.</dd></dl>
  67. <dl class="method">
  68. <dt id="celery.backends.base.BaseBackend.exception_to_python">
  69. <tt class="descclassname">BaseBackend.</tt><tt class="descname">exception_to_python</tt><big>(</big><em>exc</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.exception_to_python" title="Permalink to this definition">¶</a></dt>
  70. <dd>Convert serialized exception to Python exception.</dd></dl>
  71. <dl class="method">
  72. <dt id="celery.backends.base.BaseBackend.get_result">
  73. <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>
  74. <dd>Get the result of a task.</dd></dl>
  75. <dl class="method">
  76. <dt id="celery.backends.base.BaseBackend.get_status">
  77. <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>
  78. <dd>Get the status of a task.</dd></dl>
  79. <dl class="method">
  80. <dt id="celery.backends.base.BaseBackend.get_traceback">
  81. <tt class="descclassname">BaseBackend.</tt><tt class="descname">get_traceback</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.get_traceback" title="Permalink to this definition">¶</a></dt>
  82. <dd>Get the traceback for a failed task.</dd></dl>
  83. <dl class="method">
  84. <dt id="celery.backends.base.BaseBackend.is_done">
  85. <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>
  86. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task was successfully executed.</dd></dl>
  87. <dl class="method">
  88. <dt id="celery.backends.base.BaseBackend.mark_as_done">
  89. <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>
  90. <dd>Mark task as successfully executed.</dd></dl>
  91. <dl class="method">
  92. <dt id="celery.backends.base.BaseBackend.mark_as_failure">
  93. <tt class="descclassname">BaseBackend.</tt><tt class="descname">mark_as_failure</tt><big>(</big><em>task_id</em>, <em>exc</em>, <em>traceback=None</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.mark_as_failure" title="Permalink to this definition">¶</a></dt>
  94. <dd>Mark task as executed with failure. Stores the execption.</dd></dl>
  95. <dl class="method">
  96. <dt id="celery.backends.base.BaseBackend.mark_as_retry">
  97. <tt class="descclassname">BaseBackend.</tt><tt class="descname">mark_as_retry</tt><big>(</big><em>task_id</em>, <em>exc</em>, <em>traceback=None</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.mark_as_retry" title="Permalink to this definition">¶</a></dt>
  98. <dd>Mark task as being retries. Stores the current
  99. exception (if any).</dd></dl>
  100. <dl class="method">
  101. <dt id="celery.backends.base.BaseBackend.prepare_exception">
  102. <tt class="descclassname">BaseBackend.</tt><tt class="descname">prepare_exception</tt><big>(</big><em>exc</em><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.prepare_exception" title="Permalink to this definition">¶</a></dt>
  103. <dd>Prepare exception for serialization.</dd></dl>
  104. <dl class="method">
  105. <dt id="celery.backends.base.BaseBackend.prepare_result">
  106. <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>
  107. <dd>Prepare result for storage.</dd></dl>
  108. <dl class="method">
  109. <dt id="celery.backends.base.BaseBackend.process_cleanup">
  110. <tt class="descclassname">BaseBackend.</tt><tt class="descname">process_cleanup</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.backends.base.BaseBackend.process_cleanup" title="Permalink to this definition">¶</a></dt>
  111. <dd><p>Cleanup actions to do at the end of a task worker process.</p>
  112. <p>See <tt class="xref docutils literal"><span class="pre">celery.worker.jail()</span></tt>.</p>
  113. </dd></dl>
  114. <dl class="method">
  115. <dt id="celery.backends.base.BaseBackend.store_result">
  116. <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>
  117. <dd>Store the result and status of a task.</dd></dl>
  118. <dl class="method">
  119. <dt id="celery.backends.base.BaseBackend.wait_for">
  120. <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>
  121. <dd><p>Wait for task and return its result.</p>
  122. <p>If the task raises an exception, this exception
  123. 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>
  124. <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
  125. <a title="celery.exceptions.TimeoutError" class="reference external" href="celery.exceptions.html#celery.exceptions.TimeoutError"><tt class="xref docutils literal"><span class="pre">celery.exceptions.TimeoutError</span></tt></a> exception if the operation
  126. takes longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</p>
  127. </dd></dl>
  128. </dd></dl>
  129. </div>
  130. </div>
  131. </div>
  132. </div>
  133. <div class="sphinxsidebar">
  134. <div class="sphinxsidebarwrapper">
  135. <h4>Previous topic</h4>
  136. <p class="topless"><a href="celery.backends.html"
  137. title="previous chapter">Backends - celery.backends</a></p>
  138. <h4>Next topic</h4>
  139. <p class="topless"><a href="celery.backends.database.html"
  140. title="next chapter">Backend: Database - celery.backends.database</a></p>
  141. <h3>This Page</h3>
  142. <ul class="this-page-menu">
  143. <li><a href="../sources/reference/celery.backends.base.txt"
  144. rel="nofollow">Show Source</a></li>
  145. </ul>
  146. <div id="searchbox" style="display: none">
  147. <h3>Quick search</h3>
  148. <form class="search" action="../search.html" method="get">
  149. <input type="text" name="q" size="18" />
  150. <input type="submit" value="Go" />
  151. <input type="hidden" name="check_keywords" value="yes" />
  152. <input type="hidden" name="area" value="default" />
  153. </form>
  154. <p class="searchtip" style="font-size: 90%">
  155. Enter search terms or a module, class or function name.
  156. </p>
  157. </div>
  158. <script type="text/javascript">$('#searchbox').show(0);</script>
  159. </div>
  160. </div>
  161. <div class="clearer"></div>
  162. </div>
  163. <div class="related">
  164. <h3>Navigation</h3>
  165. <ul>
  166. <li class="right" style="margin-right: 10px">
  167. <a href="../genindex.html" title="General Index"
  168. >index</a></li>
  169. <li class="right" >
  170. <a href="../modindex.html" title="Global Module Index"
  171. >modules</a> |</li>
  172. <li class="right" >
  173. <a href="celery.backends.database.html" title="Backend: Database - celery.backends.database"
  174. >next</a> |</li>
  175. <li class="right" >
  176. <a href="celery.backends.html" title="Backends - celery.backends"
  177. >previous</a> |</li>
  178. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  179. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  180. </ul>
  181. </div>
  182. <div class="footer">
  183. &copy; Copyright 2009, Ask Solem.
  184. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
  185. </div>
  186. </body>
  187. </html>