celery.result.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  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>Task Result - celery.result &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="Task Registry - celery.registry" href="celery.registry.html" />
  22. <link rel="prev" title="Tasks - celery.task" href="celery.task.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.registry.html" title="Task Registry - celery.registry"
  34. accesskey="N">next</a> |
  35. <a href="celery.task.html" title="Tasks - celery.task"
  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.result">
  47. <h1>Task Result - celery.result<a class="headerlink" href="#module-celery.result" title="Permalink to this headline">¶</a></h1>
  48. <p>Asynchronous result types.</p>
  49. <dl class="class">
  50. <dt id="celery.result.AsyncResult">
  51. <em class="property">
  52. class </em><tt class="descclassname">celery.result.</tt><tt class="descname">AsyncResult</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.result.AsyncResult" title="Permalink to this definition">¶</a></dt>
  53. <dd><p>Pending task result using the default backend.</p>
  54. <table class="docutils field-list" frame="void" rules="none">
  55. <col class="field-name" />
  56. <col class="field-body" />
  57. <tbody valign="top">
  58. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>task_id</em> &#8211; see <a title="celery.result.AsyncResult.task_id" class="reference internal" href="#celery.result.AsyncResult.task_id"><tt class="xref docutils literal"><span class="pre">task_id</span></tt></a>.</td>
  59. </tr>
  60. </tbody>
  61. </table>
  62. <dl class="attribute">
  63. <dt id="celery.result.AsyncResult.task_id">
  64. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.result.AsyncResult.task_id" title="Permalink to this definition">¶</a></dt>
  65. <dd>The unique identifier for this task.</dd></dl>
  66. <dl class="attribute">
  67. <dt id="celery.result.AsyncResult.backend">
  68. <tt class="descname">backend</tt><a class="headerlink" href="#celery.result.AsyncResult.backend" title="Permalink to this definition">¶</a></dt>
  69. <dd>Instance of <a title="celery.backends.DefaultBackend" class="reference external" href="celery.backends.html#celery.backends.DefaultBackend"><tt class="xref docutils literal"><span class="pre">celery.backends.DefaultBackend</span></tt></a>.</dd></dl>
  70. </dd></dl>
  71. <dl class="class">
  72. <dt id="celery.result.BaseAsyncResult">
  73. <em class="property">
  74. class </em><tt class="descclassname">celery.result.</tt><tt class="descname">BaseAsyncResult</tt><big>(</big><em>task_id</em>, <em>backend</em><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult" title="Permalink to this definition">¶</a></dt>
  75. <dd><p>Base class for pending result, supports custom
  76. task meta <a title="celery.result.BaseAsyncResult.backend" class="reference internal" href="#celery.result.BaseAsyncResult.backend"><tt class="xref docutils literal"><span class="pre">backend</span></tt></a></p>
  77. <table class="docutils field-list" frame="void" rules="none">
  78. <col class="field-name" />
  79. <col class="field-body" />
  80. <tbody valign="top">
  81. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  82. <li><em>task_id</em> &#8211; see <a title="celery.result.BaseAsyncResult.task_id" class="reference internal" href="#celery.result.BaseAsyncResult.task_id"><tt class="xref docutils literal"><span class="pre">task_id</span></tt></a>.</li>
  83. <li><em>backend</em> &#8211; see <a title="celery.result.BaseAsyncResult.backend" class="reference internal" href="#celery.result.BaseAsyncResult.backend"><tt class="xref docutils literal"><span class="pre">backend</span></tt></a>.</li>
  84. </ul>
  85. </td>
  86. </tr>
  87. </tbody>
  88. </table>
  89. <dl class="attribute">
  90. <dt id="celery.result.BaseAsyncResult.task_id">
  91. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.task_id" title="Permalink to this definition">¶</a></dt>
  92. <dd>The unique identifier for this task.</dd></dl>
  93. <dl class="attribute">
  94. <dt id="celery.result.BaseAsyncResult.backend">
  95. <tt class="descname">backend</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.backend" title="Permalink to this definition">¶</a></dt>
  96. <dd>The task result backend used.</dd></dl>
  97. <dl class="method">
  98. <dt id="celery.result.BaseAsyncResult.get">
  99. <tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.get" title="Permalink to this definition">¶</a></dt>
  100. <dd>Alias to <a title="celery.result.BaseAsyncResult.wait" class="reference internal" href="#celery.result.BaseAsyncResult.wait"><tt class="xref docutils literal"><span class="pre">wait()</span></tt></a>.</dd></dl>
  101. <dl class="method">
  102. <dt id="celery.result.BaseAsyncResult.is_done">
  103. <tt class="descname">is_done</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.is_done" title="Permalink to this definition">¶</a></dt>
  104. <dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully.</p>
  105. <table class="docutils field-list" frame="void" rules="none">
  106. <col class="field-name" />
  107. <col class="field-body" />
  108. <tbody valign="top">
  109. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
  110. </tr>
  111. </tbody>
  112. </table>
  113. </dd></dl>
  114. <dl class="method">
  115. <dt id="celery.result.BaseAsyncResult.ready">
  116. <tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.ready" title="Permalink to this definition">¶</a></dt>
  117. <dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully, or raised
  118. an exception. If the task is still pending, or is waiting for retry
  119. then <tt class="xref docutils literal"><span class="pre">False</span></tt> is returned.</p>
  120. <table class="docutils field-list" frame="void" rules="none">
  121. <col class="field-name" />
  122. <col class="field-body" />
  123. <tbody valign="top">
  124. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
  125. </tr>
  126. </tbody>
  127. </table>
  128. </dd></dl>
  129. <dl class="attribute">
  130. <dt id="celery.result.BaseAsyncResult.result">
  131. <tt class="descname">result</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.result" title="Permalink to this definition">¶</a></dt>
  132. <dd><p>When the task has been executed, this contains the return value.</p>
  133. <p>If the task raised an exception, this will be the exception instance.</p>
  134. </dd></dl>
  135. <dl class="attribute">
  136. <dt id="celery.result.BaseAsyncResult.status">
  137. <tt class="descname">status</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.status" title="Permalink to this definition">¶</a></dt>
  138. <dd><p>The current status of the task.</p>
  139. <p>Can be one of the following:</p>
  140. <blockquote>
  141. <p><em>PENDING</em></p>
  142. <blockquote>
  143. The task is waiting for execution.</blockquote>
  144. <p><em>RETRY</em></p>
  145. <blockquote>
  146. The task is to be retried, possibly because of failure.</blockquote>
  147. <p><em>FAILURE</em></p>
  148. <blockquote>
  149. The task raised an exception, or has been retried more times
  150. than its limit. The <a title="celery.result.BaseAsyncResult.result" class="reference internal" href="#celery.result.BaseAsyncResult.result"><tt class="xref docutils literal"><span class="pre">result</span></tt></a> attribute contains the
  151. exception raised.</blockquote>
  152. <p><em>DONE</em></p>
  153. <blockquote>
  154. The task executed successfully. The <a title="celery.result.BaseAsyncResult.result" class="reference internal" href="#celery.result.BaseAsyncResult.result"><tt class="xref docutils literal"><span class="pre">result</span></tt></a> attribute
  155. contains the resulting value.</blockquote>
  156. </blockquote>
  157. </dd></dl>
  158. <dl class="method">
  159. <dt id="celery.result.BaseAsyncResult.successful">
  160. <tt class="descname">successful</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.successful" title="Permalink to this definition">¶</a></dt>
  161. <dd>Alias to <a title="celery.result.BaseAsyncResult.is_done" class="reference internal" href="#celery.result.BaseAsyncResult.is_done"><tt class="xref docutils literal"><span class="pre">is_done()</span></tt></a>.</dd></dl>
  162. <dl class="method">
  163. <dt id="celery.result.BaseAsyncResult.wait">
  164. <tt class="descname">wait</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.wait" title="Permalink to this definition">¶</a></dt>
  165. <dd><p>Wait for task, and return the result when it arrives.</p>
  166. <table class="docutils field-list" frame="void" rules="none">
  167. <col class="field-name" />
  168. <col class="field-body" />
  169. <tbody valign="top">
  170. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>timeout</em> &#8211; How long to wait in seconds, before the
  171. operation times out.</td>
  172. </tr>
  173. <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.timer.TimeoutError" class="reference external" href="celery.timer.html#celery.timer.TimeoutError">celery.timer.TimeoutError</a>:</th></tr>
  174. <tr><td>&nbsp;</td><td class="field-body">if <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt> and
  175. the result does not arrive within <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</td>
  176. </tr>
  177. </tbody>
  178. </table>
  179. <p>If the remote call raised an exception then that
  180. exception will be re-raised.</p>
  181. </dd></dl>
  182. </dd></dl>
  183. </div>
  184. </div>
  185. </div>
  186. </div>
  187. </div>
  188. <div class="sidebar">
  189. <h3>Contents</h3>
  190. <ul class="current">
  191. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
  192. <li class="toctree-l1"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
  193. <li class="toctree-l1 current"><a class="current reference external" href="">Task Result - celery.result</a></li>
  194. <li class="toctree-l1"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
  195. <li class="toctree-l1"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
  196. <li class="toctree-l1"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
  197. <li class="toctree-l1"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
  198. <li class="toctree-l1"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
  199. <li class="toctree-l1"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
  200. <li class="toctree-l1"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
  201. <li class="toctree-l1"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
  202. <li class="toctree-l1"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
  203. <li class="toctree-l1"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
  204. <li class="toctree-l1"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
  205. <li class="toctree-l1"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
  206. <li class="toctree-l1"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
  207. <li class="toctree-l1"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
  208. <li class="toctree-l1"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
  209. <li class="toctree-l1"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
  210. <li class="toctree-l1"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
  211. </ul>
  212. <h3 style="margin-top: 1.5em;">Search</h3>
  213. <form class="search" action="../search.html" method="get">
  214. <input type="text" name="q" size="18" />
  215. <input type="submit" value="Go" />
  216. <input type="hidden" name="check_keywords" value="yes" />
  217. <input type="hidden" name="area" value="default" />
  218. </form>
  219. <p class="searchtip" style="font-size: 90%">
  220. Enter search terms or a module, class or function name.
  221. </p>
  222. </div>
  223. <div class="clearer"></div>
  224. </div>
  225. </div>
  226. <div class="footer-wrapper">
  227. <div class="footer">
  228. <div class="left">
  229. <a href="../genindex.html" title="General Index"
  230. >index</a> |
  231. <a href="../modindex.html" title="Global Module Index"
  232. >modules</a> |
  233. <a href="celery.registry.html" title="Task Registry - celery.registry"
  234. >next</a> |
  235. <a href="celery.task.html" title="Tasks - celery.task"
  236. >previous</a>
  237. <br/>
  238. <a href="../sources/reference/celery.result.txt"
  239. rel="nofollow">Show Source</a>
  240. </div>
  241. <div class="right">
  242. &copy; Copyright 2009, Ask Solem.<br/>
  243. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  244. </div>
  245. <div class="clearer"></div>
  246. </div>
  247. </div>
  248. </body>
  249. </html>