celery.result.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  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.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="Task Information and Utilities - celery.task" href="celery.task.html" />
  23. <link rel="prev" title="Executing Tasks - celery.execute" href="celery.execute.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.task.html" title="Task Information and Utilities - celery.task"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.execute.html" title="Executing Tasks - celery.execute"
  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.result">
  50. <h1>Task Result - celery.result<a class="headerlink" href="#module-celery.result" title="Permalink to this headline">¶</a></h1>
  51. <p>Asynchronous result types.</p>
  52. <dl class="class">
  53. <dt id="celery.result.AsyncResult">
  54. <em class="property">
  55. 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>
  56. <dd><p>Pending task result using the default backend.</p>
  57. <table class="docutils field-list" frame="void" rules="none">
  58. <col class="field-name" />
  59. <col class="field-body" />
  60. <tbody valign="top">
  61. <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>
  62. </tr>
  63. </tbody>
  64. </table>
  65. <dl class="attribute">
  66. <dt id="celery.result.AsyncResult.task_id">
  67. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.result.AsyncResult.task_id" title="Permalink to this definition">¶</a></dt>
  68. <dd>The unique identifier for this task.</dd></dl>
  69. <dl class="attribute">
  70. <dt id="celery.result.AsyncResult.backend">
  71. <tt class="descname">backend</tt><a class="headerlink" href="#celery.result.AsyncResult.backend" title="Permalink to this definition">¶</a></dt>
  72. <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>
  73. </dd></dl>
  74. <dl class="class">
  75. <dt id="celery.result.BaseAsyncResult">
  76. <em class="property">
  77. 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>
  78. <dd><p>Base class for pending result, supports custom
  79. 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>
  80. <table class="docutils field-list" frame="void" rules="none">
  81. <col class="field-name" />
  82. <col class="field-body" />
  83. <tbody valign="top">
  84. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  85. <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>
  86. <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>
  87. </ul>
  88. </td>
  89. </tr>
  90. </tbody>
  91. </table>
  92. <dl class="attribute">
  93. <dt id="celery.result.BaseAsyncResult.task_id">
  94. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.task_id" title="Permalink to this definition">¶</a></dt>
  95. <dd>The unique identifier for this task.</dd></dl>
  96. <dl class="attribute">
  97. <dt id="celery.result.BaseAsyncResult.backend">
  98. <tt class="descname">backend</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.backend" title="Permalink to this definition">¶</a></dt>
  99. <dd>The task result backend used.</dd></dl>
  100. <dl class="exception">
  101. <dt id="celery.result.BaseAsyncResult.TimeoutError">
  102. <em class="property">
  103. exception </em><tt class="descname">TimeoutError</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.TimeoutError" title="Permalink to this definition">¶</a></dt>
  104. <dd>The operation timed out.</dd></dl>
  105. <dl class="method">
  106. <dt id="celery.result.BaseAsyncResult.get">
  107. <tt class="descclassname">BaseAsyncResult.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.get" title="Permalink to this definition">¶</a></dt>
  108. <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>
  109. <dl class="method">
  110. <dt id="celery.result.BaseAsyncResult.is_done">
  111. <tt class="descclassname">BaseAsyncResult.</tt><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>
  112. <dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully.</p>
  113. <table class="docutils field-list" frame="void" rules="none">
  114. <col class="field-name" />
  115. <col class="field-body" />
  116. <tbody valign="top">
  117. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
  118. </tr>
  119. </tbody>
  120. </table>
  121. </dd></dl>
  122. <dl class="method">
  123. <dt id="celery.result.BaseAsyncResult.ready">
  124. <tt class="descclassname">BaseAsyncResult.</tt><tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.ready" title="Permalink to this definition">¶</a></dt>
  125. <dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully, or raised
  126. an exception. If the task is still pending, or is waiting for retry
  127. then <tt class="xref docutils literal"><span class="pre">False</span></tt> is returned.</p>
  128. <table class="docutils field-list" frame="void" rules="none">
  129. <col class="field-name" />
  130. <col class="field-body" />
  131. <tbody valign="top">
  132. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
  133. </tr>
  134. </tbody>
  135. </table>
  136. </dd></dl>
  137. <dl class="attribute">
  138. <dt id="celery.result.BaseAsyncResult.result">
  139. <tt class="descclassname">BaseAsyncResult.</tt><tt class="descname">result</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.result" title="Permalink to this definition">¶</a></dt>
  140. <dd><p>When the task has been executed, this contains the return value.</p>
  141. <p>If the task raised an exception, this will be the exception instance.</p>
  142. </dd></dl>
  143. <dl class="attribute">
  144. <dt id="celery.result.BaseAsyncResult.status">
  145. <tt class="descclassname">BaseAsyncResult.</tt><tt class="descname">status</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.status" title="Permalink to this definition">¶</a></dt>
  146. <dd><p>The current status of the task.</p>
  147. <p>Can be one of the following:</p>
  148. <blockquote>
  149. <p><em>PENDING</em></p>
  150. <blockquote>
  151. The task is waiting for execution.</blockquote>
  152. <p><em>RETRY</em></p>
  153. <blockquote>
  154. The task is to be retried, possibly because of failure.</blockquote>
  155. <p><em>FAILURE</em></p>
  156. <blockquote>
  157. The task raised an exception, or has been retried more times
  158. 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
  159. exception raised.</blockquote>
  160. <p><em>DONE</em></p>
  161. <blockquote>
  162. 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
  163. contains the resulting value.</blockquote>
  164. </blockquote>
  165. </dd></dl>
  166. <dl class="method">
  167. <dt id="celery.result.BaseAsyncResult.successful">
  168. <tt class="descclassname">BaseAsyncResult.</tt><tt class="descname">successful</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.successful" title="Permalink to this definition">¶</a></dt>
  169. <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>
  170. <dl class="attribute">
  171. <dt id="celery.result.BaseAsyncResult.traceback">
  172. <tt class="descclassname">BaseAsyncResult.</tt><tt class="descname">traceback</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.traceback" title="Permalink to this definition">¶</a></dt>
  173. <dd>Get the traceback of a failed task.</dd></dl>
  174. <dl class="method">
  175. <dt id="celery.result.BaseAsyncResult.wait">
  176. <tt class="descclassname">BaseAsyncResult.</tt><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>
  177. <dd><p>Wait for task, and return the result when it arrives.</p>
  178. <table class="docutils field-list" frame="void" rules="none">
  179. <col class="field-name" />
  180. <col class="field-body" />
  181. <tbody valign="top">
  182. <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
  183. operation times out.</td>
  184. </tr>
  185. <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.result.TimeoutError" class="reference internal" href="#celery.result.TimeoutError">TimeoutError</a>:</th></tr>
  186. <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
  187. the result does not arrive within <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</td>
  188. </tr>
  189. </tbody>
  190. </table>
  191. <p>If the remote call raised an exception then that
  192. exception will be re-raised.</p>
  193. </dd></dl>
  194. </dd></dl>
  195. <dl class="class">
  196. <dt id="celery.result.EagerResult">
  197. <em class="property">
  198. class </em><tt class="descclassname">celery.result.</tt><tt class="descname">EagerResult</tt><big>(</big><em>task_id</em>, <em>ret_value</em>, <em>status</em>, <em>traceback=None</em><big>)</big><a class="headerlink" href="#celery.result.EagerResult" title="Permalink to this definition">¶</a></dt>
  199. <dd><p>Result that we know has already been executed.</p>
  200. <dl class="exception">
  201. <dt id="celery.result.EagerResult.TimeoutError">
  202. <em class="property">
  203. exception </em><tt class="descname">TimeoutError</tt><a class="headerlink" href="#celery.result.EagerResult.TimeoutError" title="Permalink to this definition">¶</a></dt>
  204. <dd>The operation timed out.</dd></dl>
  205. <dl class="method">
  206. <dt id="celery.result.EagerResult.is_done">
  207. <tt class="descclassname">EagerResult.</tt><tt class="descname">is_done</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.EagerResult.is_done" title="Permalink to this definition">¶</a></dt>
  208. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed without failure.</dd></dl>
  209. <dl class="method">
  210. <dt id="celery.result.EagerResult.is_ready">
  211. <tt class="descclassname">EagerResult.</tt><tt class="descname">is_ready</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.EagerResult.is_ready" title="Permalink to this definition">¶</a></dt>
  212. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task has been executed.</dd></dl>
  213. <dl class="attribute">
  214. <dt id="celery.result.EagerResult.result">
  215. <tt class="descclassname">EagerResult.</tt><tt class="descname">result</tt><a class="headerlink" href="#celery.result.EagerResult.result" title="Permalink to this definition">¶</a></dt>
  216. <dd>The tasks return value</dd></dl>
  217. <dl class="attribute">
  218. <dt id="celery.result.EagerResult.status">
  219. <tt class="descclassname">EagerResult.</tt><tt class="descname">status</tt><a class="headerlink" href="#celery.result.EagerResult.status" title="Permalink to this definition">¶</a></dt>
  220. <dd>The tasks status</dd></dl>
  221. <dl class="attribute">
  222. <dt id="celery.result.EagerResult.traceback">
  223. <tt class="descclassname">EagerResult.</tt><tt class="descname">traceback</tt><a class="headerlink" href="#celery.result.EagerResult.traceback" title="Permalink to this definition">¶</a></dt>
  224. <dd>The traceback if the task failed.</dd></dl>
  225. <dl class="method">
  226. <dt id="celery.result.EagerResult.wait">
  227. <tt class="descclassname">EagerResult.</tt><tt class="descname">wait</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.result.EagerResult.wait" title="Permalink to this definition">¶</a></dt>
  228. <dd>Wait until the task has been executed and return its result.</dd></dl>
  229. </dd></dl>
  230. <dl class="class">
  231. <dt id="celery.result.TaskSetResult">
  232. <em class="property">
  233. class </em><tt class="descclassname">celery.result.</tt><tt class="descname">TaskSetResult</tt><big>(</big><em>taskset_id</em>, <em>subtasks</em><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult" title="Permalink to this definition">¶</a></dt>
  234. <dd><p>Working with <tt class="xref docutils literal"><span class="pre">celery.task.TaskSet</span></tt> results.</p>
  235. <p>An instance of this class is returned by
  236. <tt class="xref docutils literal"><span class="pre">celery.task.TaskSet.run()</span></tt>. It lets you inspect the status and
  237. return values of the taskset as a single entity.</p>
  238. <table class="docutils field-list" frame="void" rules="none">
  239. <col class="field-name" />
  240. <col class="field-body" />
  241. <tbody valign="top">
  242. <tr class="field"><th class="field-name" colspan="2">Option taskset_id:</th></tr>
  243. <tr><td>&nbsp;</td><td class="field-body">see <a title="celery.result.TaskSetResult.taskset_id" class="reference internal" href="#celery.result.TaskSetResult.taskset_id"><tt class="xref docutils literal"><span class="pre">taskset_id</span></tt></a>.</td>
  244. </tr>
  245. <tr class="field"><th class="field-name" colspan="2">Option subtasks:</th></tr>
  246. <tr><td>&nbsp;</td><td class="field-body">see <a title="celery.result.TaskSetResult.subtasks" class="reference internal" href="#celery.result.TaskSetResult.subtasks"><tt class="xref docutils literal"><span class="pre">subtasks</span></tt></a>.</td>
  247. </tr>
  248. </tbody>
  249. </table>
  250. <dl class="attribute">
  251. <dt id="celery.result.TaskSetResult.taskset_id">
  252. <tt class="descname">taskset_id</tt><a class="headerlink" href="#celery.result.TaskSetResult.taskset_id" title="Permalink to this definition">¶</a></dt>
  253. <dd>The UUID of the taskset itself.</dd></dl>
  254. <dl class="attribute">
  255. <dt id="celery.result.TaskSetResult.subtasks">
  256. <tt class="descname">subtasks</tt><a class="headerlink" href="#celery.result.TaskSetResult.subtasks" title="Permalink to this definition">¶</a></dt>
  257. <dd>A list of <a title="celery.result.AsyncResult" class="reference internal" href="#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">AsyncResult</span></tt></a> instances for all of the subtasks.</dd></dl>
  258. <dl class="method">
  259. <dt id="celery.result.TaskSetResult.completed_count">
  260. <tt class="descname">completed_count</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.completed_count" title="Permalink to this definition">¶</a></dt>
  261. <dd><p>Task completion count.</p>
  262. <table class="docutils field-list" frame="void" rules="none">
  263. <col class="field-name" />
  264. <col class="field-body" />
  265. <tbody valign="top">
  266. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the number of tasks completed.</td>
  267. </tr>
  268. </tbody>
  269. </table>
  270. </dd></dl>
  271. <dl class="method">
  272. <dt id="celery.result.TaskSetResult.failed">
  273. <tt class="descname">failed</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.failed" title="Permalink to this definition">¶</a></dt>
  274. <dd><p>Did the taskset fail?</p>
  275. <table class="docutils field-list" frame="void" rules="none">
  276. <col class="field-name" />
  277. <col class="field-body" />
  278. <tbody valign="top">
  279. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><tt class="xref docutils literal"><span class="pre">True</span></tt> if any of the tasks in the taskset failed.
  280. (i.e., raised an exception)</td>
  281. </tr>
  282. </tbody>
  283. </table>
  284. </dd></dl>
  285. <dl class="method">
  286. <dt id="celery.result.TaskSetResult.iterate">
  287. <tt class="descname">iterate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.iterate" title="Permalink to this definition">¶</a></dt>
  288. <dd><p>Iterate over the return values of the tasks as they finish
  289. one by one.</p>
  290. <table class="docutils field-list" frame="void" rules="none">
  291. <col class="field-name" />
  292. <col class="field-body" />
  293. <tbody valign="top">
  294. <tr class="field"><th class="field-name">Raises:</th><td class="field-body">The exception if any of the tasks raised an exception.</td>
  295. </tr>
  296. </tbody>
  297. </table>
  298. </dd></dl>
  299. <dl class="method">
  300. <dt id="celery.result.TaskSetResult.itersubtasks">
  301. <tt class="descname">itersubtasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.itersubtasks" title="Permalink to this definition">¶</a></dt>
  302. <dd><p>Taskset subtask iterator.</p>
  303. <table class="docutils field-list" frame="void" rules="none">
  304. <col class="field-name" />
  305. <col class="field-body" />
  306. <tbody valign="top">
  307. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">an iterator for iterating over the tasksets
  308. <a title="celery.result.AsyncResult" class="reference internal" href="#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">AsyncResult</span></tt></a> objects.</td>
  309. </tr>
  310. </tbody>
  311. </table>
  312. </dd></dl>
  313. <dl class="method">
  314. <dt id="celery.result.TaskSetResult.join">
  315. <tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.join" title="Permalink to this definition">¶</a></dt>
  316. <dd><p>Gather the results for all of the tasks in the taskset,
  317. and return a list with them ordered by the order of which they
  318. were called.</p>
  319. <table class="docutils field-list" frame="void" rules="none">
  320. <col class="field-name" />
  321. <col class="field-body" />
  322. <tbody valign="top">
  323. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>timeout</em> &#8211; The time in seconds, how long
  324. it will wait for results, before the operation times out.</td>
  325. </tr>
  326. <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.result.TimeoutError" class="reference internal" href="#celery.result.TimeoutError">TimeoutError</a>:</th></tr>
  327. <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>
  328. and the operation takes longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</td>
  329. </tr>
  330. </tbody>
  331. </table>
  332. <p>If any of the tasks raises an exception, the exception
  333. will be reraised by <a title="celery.result.TaskSetResult.join" class="reference internal" href="#celery.result.TaskSetResult.join"><tt class="xref docutils literal"><span class="pre">join()</span></tt></a>.</p>
  334. <table class="docutils field-list" frame="void" rules="none">
  335. <col class="field-name" />
  336. <col class="field-body" />
  337. <tbody valign="top">
  338. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of return values for all tasks in the taskset.</td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. </dd></dl>
  343. <dl class="method">
  344. <dt id="celery.result.TaskSetResult.ready">
  345. <tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.ready" title="Permalink to this definition">¶</a></dt>
  346. <dd><p>Is the task ready?</p>
  347. <table class="docutils field-list" frame="void" rules="none">
  348. <col class="field-name" />
  349. <col class="field-body" />
  350. <tbody valign="top">
  351. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><tt class="xref docutils literal"><span class="pre">True</span></tt> if all of the tasks in the taskset has been
  352. executed.</td>
  353. </tr>
  354. </tbody>
  355. </table>
  356. </dd></dl>
  357. <dl class="method">
  358. <dt id="celery.result.TaskSetResult.successful">
  359. <tt class="descname">successful</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.successful" title="Permalink to this definition">¶</a></dt>
  360. <dd><p>Was the taskset successful?</p>
  361. <table class="docutils field-list" frame="void" rules="none">
  362. <col class="field-name" />
  363. <col class="field-body" />
  364. <tbody valign="top">
  365. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><tt class="xref docutils literal"><span class="pre">True</span></tt> if all of the tasks in the taskset finished
  366. successfully (i.e. did not raise an exception).</td>
  367. </tr>
  368. </tbody>
  369. </table>
  370. </dd></dl>
  371. <dl class="attribute">
  372. <dt id="celery.result.TaskSetResult.total">
  373. <tt class="descname">total</tt><a class="headerlink" href="#celery.result.TaskSetResult.total" title="Permalink to this definition">¶</a></dt>
  374. <dd>The total number of tasks in the <tt class="xref docutils literal"><span class="pre">celery.task.TaskSet</span></tt>.</dd></dl>
  375. <dl class="method">
  376. <dt id="celery.result.TaskSetResult.waiting">
  377. <tt class="descname">waiting</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.waiting" title="Permalink to this definition">¶</a></dt>
  378. <dd><p>Is the taskset waiting?</p>
  379. <table class="docutils field-list" frame="void" rules="none">
  380. <col class="field-name" />
  381. <col class="field-body" />
  382. <tbody valign="top">
  383. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><tt class="xref docutils literal"><span class="pre">True</span></tt> if any of the tasks in the taskset is still
  384. waiting for execution.</td>
  385. </tr>
  386. </tbody>
  387. </table>
  388. </dd></dl>
  389. </dd></dl>
  390. <dl class="exception">
  391. <dt id="celery.result.TimeoutError">
  392. <em class="property">
  393. exception </em><tt class="descclassname">celery.result.</tt><tt class="descname">TimeoutError</tt><a class="headerlink" href="#celery.result.TimeoutError" title="Permalink to this definition">¶</a></dt>
  394. <dd>The operation timed out.</dd></dl>
  395. </div>
  396. </div>
  397. </div>
  398. </div>
  399. <div class="sphinxsidebar">
  400. <div class="sphinxsidebarwrapper">
  401. <h4>Previous topic</h4>
  402. <p class="topless"><a href="celery.execute.html"
  403. title="previous chapter">Executing Tasks - celery.execute</a></p>
  404. <h4>Next topic</h4>
  405. <p class="topless"><a href="celery.task.html"
  406. title="next chapter">Task Information and Utilities - celery.task</a></p>
  407. <h3>This Page</h3>
  408. <ul class="this-page-menu">
  409. <li><a href="../sources/reference/celery.result.txt"
  410. rel="nofollow">Show Source</a></li>
  411. </ul>
  412. <div id="searchbox" style="display: none">
  413. <h3>Quick search</h3>
  414. <form class="search" action="../search.html" method="get">
  415. <input type="text" name="q" size="18" />
  416. <input type="submit" value="Go" />
  417. <input type="hidden" name="check_keywords" value="yes" />
  418. <input type="hidden" name="area" value="default" />
  419. </form>
  420. <p class="searchtip" style="font-size: 90%">
  421. Enter search terms or a module, class or function name.
  422. </p>
  423. </div>
  424. <script type="text/javascript">$('#searchbox').show(0);</script>
  425. </div>
  426. </div>
  427. <div class="clearer"></div>
  428. </div>
  429. <div class="related">
  430. <h3>Navigation</h3>
  431. <ul>
  432. <li class="right" style="margin-right: 10px">
  433. <a href="../genindex.html" title="General Index"
  434. >index</a></li>
  435. <li class="right" >
  436. <a href="../modindex.html" title="Global Module Index"
  437. >modules</a> |</li>
  438. <li class="right" >
  439. <a href="celery.task.html" title="Task Information and Utilities - celery.task"
  440. >next</a> |</li>
  441. <li class="right" >
  442. <a href="celery.execute.html" title="Executing Tasks - celery.execute"
  443. >previous</a> |</li>
  444. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  445. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  446. </ul>
  447. </div>
  448. <div class="footer">
  449. &copy; Copyright 2009, Ask Solem.
  450. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
  451. </div>
  452. </body>
  453. </html>