Home Explore Help
Sign In
yangck
/
celery
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 7a19b1c8ab
Branches Tags
celery
/
reference
/
celery.result.html

celery.result.html 24 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. <html xmlns="http://www.w3.org/1999/xhtml">
    5. 

  5.   <head>
    6. 

  6.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7.     
    8. 

  8.     <title>Task Result - celery.result &mdash; Celery v0.3.10 (unstable) documentation</title>
    9. 

  9.     <link rel="stylesheet" href="../static/agogo.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
    11. 

  11.     <script type="text/javascript">
    12. 

  12.       var DOCUMENTATION_OPTIONS = {
    13. 

  13.       URL_ROOT:    '../',
    14. 

  14.       VERSION:     '0.3.10 (unstable)',
    15. 

  15.       COLLAPSE_MODINDEX: false,
    16. 

  16.       FILE_SUFFIX: '.html',
    17. 

  17.       HAS_SOURCE:  true
    18. 

  18.       };
    19. 

  19.     </script>
    20. 

  20.     <script type="text/javascript" src="../static/jquery.js"></script>
    21. 

  21.     <script type="text/javascript" src="../static/doctools.js"></script>
    22. 

  22.     <link rel="top" title="Celery v0.3.10 (unstable) documentation" href="../index.html" />
    23. 

  23.     <link rel="up" title="Module API Reference" href="index.html" />
    24. 

  24.     <link rel="next" title="Task Registry - celery.registry" href="celery.registry.html" />
    25. 

  25.     <link rel="prev" title="Tasks - celery.task" href="celery.task.html" /> 
    26. 

  26.   </head>
    27. 

  27.   <body>
    28. 

  28. 

  29.     <div class="header-wrapper">
    30. 

  30.       <div class="header">
    31. 

  31. 	<h1><a href="../index.html">Celery v0.3.10 (unstable) documentation</a></h1>
    32. 

  32. 	<div class="rel">
    33. 

  33.           <a href="../genindex.html" title="General Index"
    34. 

  34.              accesskey="I">index</a> |
    35. 

  35.           <a href="../modindex.html" title="Global Module Index"
    36. 

  36.              accesskey="M">modules</a> |
    37. 

  37.           <a href="celery.registry.html" title="Task Registry - celery.registry"
    38. 

  38.              accesskey="N">next</a> |
    39. 

  39.           <a href="celery.task.html" title="Tasks - celery.task"
    40. 

  40.              accesskey="P">previous</a>
    41. 

  41. 	</div>
    42. 

  42.       </div>
    43. 

  43.     </div>
    44. 

  44. 

  45.     <div class="content-wrapper">
    46. 

  46.       <div class="content">
    47. 

  47. 	<div class="document">
    48. 

  48. 	  <div class="documentwrapper">
    49. 

  49. 	    <div class="bodywrapper">
    50. 

  50. 	      <div class="body">
    51. 

  51. 		
    52. 

  52.   <div class="section" id="module-celery.result">
    53. 

  53. <h1>Task Result - celery.result<a class="headerlink" href="#module-celery.result" title="Permalink to this headline">¶</a></h1>
    54. 

  54. <p>Asynchronous result types.</p>
    55. 

  55. <dl class="class">
    56. 

  56. <dt id="celery.result.AsyncResult">
    57. 

  57. <em class="property">
    58. 

  58. 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>
    59. 

  59. <dd><p>Pending task result using the default backend.</p>
    60. 

  60. <table class="docutils field-list" frame="void" rules="none">
    61. 

  61. <col class="field-name" />
    62. 

  62. <col class="field-body" />
    63. 

  63. <tbody valign="top">
    64. 

  64. <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>
    65. 

  65. </tr>
    66. 

  66. </tbody>
    67. 

  67. </table>
    68. 

  68. <dl class="attribute">
    69. 

  69. <dt id="celery.result.AsyncResult.task_id">
    70. 

  70. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.result.AsyncResult.task_id" title="Permalink to this definition">¶</a></dt>
    71. 

  71. <dd>The unique identifier for this task.</dd></dl>
    72. 

  72. 

  73. <dl class="attribute">
    74. 

  74. <dt id="celery.result.AsyncResult.backend">
    75. 

  75. <tt class="descname">backend</tt><a class="headerlink" href="#celery.result.AsyncResult.backend" title="Permalink to this definition">¶</a></dt>
    76. 

  76. <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>
    77. 

  77. 

  78. </dd></dl>
    79. 

  79. 

  80. <dl class="class">
    81. 

  81. <dt id="celery.result.BaseAsyncResult">
    82. 

  82. <em class="property">
    83. 

  83. 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>
    84. 

  84. <dd><p>Base class for pending result, supports custom
    85. 

  85. 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>
    86. 

  86. <table class="docutils field-list" frame="void" rules="none">
    87. 

  87. <col class="field-name" />
    88. 

  88. <col class="field-body" />
    89. 

  89. <tbody valign="top">
    90. 

  90. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    91. 

  91. <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>
    92. 

  92. <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>
    93. 

  93. </ul>
    94. 

  94. </td>
    95. 

  95. </tr>
    96. 

  96. </tbody>
    97. 

  97. </table>
    98. 

  98. <dl class="attribute">
    99. 

  99. <dt id="celery.result.BaseAsyncResult.task_id">
    100. 

  100. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.task_id" title="Permalink to this definition">¶</a></dt>
    101. 

  101. <dd>The unique identifier for this task.</dd></dl>
    102. 

  102. 

  103. <dl class="attribute">
    104. 

  104. <dt id="celery.result.BaseAsyncResult.backend">
    105. 

  105. <tt class="descname">backend</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.backend" title="Permalink to this definition">¶</a></dt>
    106. 

  106. <dd>The task result backend used.</dd></dl>
    107. 

  107. 

  108. <dl class="method">
    109. 

  109. <dt id="celery.result.BaseAsyncResult.get">
    110. 

  110. <tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.get" title="Permalink to this definition">¶</a></dt>
    111. 

  111. <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>
    112. 

  112. 

  113. <dl class="method">
    114. 

  114. <dt id="celery.result.BaseAsyncResult.is_done">
    115. 

  115. <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>
    116. 

  116. <dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully.</p>
    117. 

  117. <table class="docutils field-list" frame="void" rules="none">
    118. 

  118. <col class="field-name" />
    119. 

  119. <col class="field-body" />
    120. 

  120. <tbody valign="top">
    121. 

  121. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    122. 

  122. </tr>
    123. 

  123. </tbody>
    124. 

  124. </table>
    125. 

  125. </dd></dl>
    126. 

  126. 

  127. <dl class="method">
    128. 

  128. <dt id="celery.result.BaseAsyncResult.ready">
    129. 

  129. <tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.ready" title="Permalink to this definition">¶</a></dt>
    130. 

  130. <dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully, or raised
    131. 

  131. an exception. If the task is still pending, or is waiting for retry
    132. 

  132. then <tt class="xref docutils literal"><span class="pre">False</span></tt> is returned.</p>
    133. 

  133. <table class="docutils field-list" frame="void" rules="none">
    134. 

  134. <col class="field-name" />
    135. 

  135. <col class="field-body" />
    136. 

  136. <tbody valign="top">
    137. 

  137. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    138. 

  138. </tr>
    139. 

  139. </tbody>
    140. 

  140. </table>
    141. 

  141. </dd></dl>
    142. 

  142. 

  143. <dl class="attribute">
    144. 

  144. <dt id="celery.result.BaseAsyncResult.result">
    145. 

  145. <tt class="descname">result</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.result" title="Permalink to this definition">¶</a></dt>
    146. 

  146. <dd><p>When the task has been executed, this contains the return value.</p>
    147. 

  147. <p>If the task raised an exception, this will be the exception instance.</p>
    148. 

  148. </dd></dl>
    149. 

  149. 

  150. <dl class="attribute">
    151. 

  151. <dt id="celery.result.BaseAsyncResult.status">
    152. 

  152. <tt class="descname">status</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.status" title="Permalink to this definition">¶</a></dt>
    153. 

  153. <dd><p>The current status of the task.</p>
    154. 

  154. <p>Can be one of the following:</p>
    155. 

  155. <blockquote>
    156. 

  156. <p><em>PENDING</em></p>
    157. 

  157. <blockquote>
    158. 

  158. The task is waiting for execution.</blockquote>
    159. 

  159. <p><em>RETRY</em></p>
    160. 

  160. <blockquote>
    161. 

  161. The task is to be retried, possibly because of failure.</blockquote>
    162. 

  162. <p><em>FAILURE</em></p>
    163. 

  163. <blockquote>
    164. 

  164. The task raised an exception, or has been retried more times
    165. 

  165. 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
    166. 

  166. exception raised.</blockquote>
    167. 

  167. <p><em>DONE</em></p>
    168. 

  168. <blockquote>
    169. 

  169. 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
    170. 

  170. contains the resulting value.</blockquote>
    171. 

  171. </blockquote>
    172. 

  172. </dd></dl>
    173. 

  173. 

  174. <dl class="method">
    175. 

  175. <dt id="celery.result.BaseAsyncResult.successful">
    176. 

  176. <tt class="descname">successful</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.successful" title="Permalink to this definition">¶</a></dt>
    177. 

  177. <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>
    178. 

  178. 

  179. <dl class="method">
    180. 

  180. <dt id="celery.result.BaseAsyncResult.wait">
    181. 

  181. <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>
    182. 

  182. <dd><p>Wait for task, and return the result when it arrives.</p>
    183. 

  183. <table class="docutils field-list" frame="void" rules="none">
    184. 

  184. <col class="field-name" />
    185. 

  185. <col class="field-body" />
    186. 

  186. <tbody valign="top">
    187. 

  187. <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
    188. 

  188. operation times out.</td>
    189. 

  189. </tr>
    190. 

  190. <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>
    191. 

  191. <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
    192. 

  192. the result does not arrive within <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</td>
    193. 

  193. </tr>
    194. 

  194. </tbody>
    195. 

  195. </table>
    196. 

  196. <p>If the remote call raised an exception then that
    197. 

  197. exception will be re-raised.</p>
    198. 

  198. </dd></dl>
    199. 

  199. 

  200. </dd></dl>
    201. 

  201. 

  202. <dl class="class">
    203. 

  203. <dt id="celery.result.TaskSetResult">
    204. 

  204. <em class="property">
    205. 

  205. class </em><tt class="descclassname">celery.result.</tt><tt class="descname">TaskSetResult</tt><big>(</big><em>taskset_id</em>, <em>subtask_ids</em><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult" title="Permalink to this definition">¶</a></dt>
    206. 

  206. <dd><p>Working with <a title="celery.task.TaskSet" class="reference external" href="celery.task.html#celery.task.TaskSet"><tt class="xref docutils literal"><span class="pre">celery.task.TaskSet</span></tt></a> results.</p>
    207. 

  207. <p>An instance of this class is returned by <a title="celery.task.TaskSet.run" class="reference external" href="celery.task.html#celery.task.TaskSet.run"><tt class="xref docutils literal"><span class="pre">celery.task.TaskSet.run()</span></tt></a>.
    208. 

  208. It lets you inspect the status and return values of a taskset as a
    209. 

  209. single entity.</p>
    210. 

  210. <table class="docutils field-list" frame="void" rules="none">
    211. 

  211. <col class="field-name" />
    212. 

  212. <col class="field-body" />
    213. 

  213. <tbody valign="top">
    214. 

  214. <tr class="field"><th class="field-name" colspan="2">Option taskset_id:</th></tr>
    215. 

  215. <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>
    216. 

  216. </tr>
    217. 

  217. <tr class="field"><th class="field-name" colspan="2">Option subtask_ids:</th></tr>
    218. 

  218. <tr><td>&nbsp;</td><td class="field-body">see <a title="celery.result.TaskSetResult.subtask_ids" class="reference internal" href="#celery.result.TaskSetResult.subtask_ids"><tt class="xref docutils literal"><span class="pre">subtask_ids</span></tt></a>.</td>
    219. 

  219. </tr>
    220. 

  220. </tbody>
    221. 

  221. </table>
    222. 

  222. <dl class="attribute">
    223. 

  223. <dt id="celery.result.TaskSetResult.taskset_id">
    224. 

  224. <tt class="descname">taskset_id</tt><a class="headerlink" href="#celery.result.TaskSetResult.taskset_id" title="Permalink to this definition">¶</a></dt>
    225. 

  225. <dd>The UUID of the taskset itself.</dd></dl>
    226. 

  226. 

  227. <dl class="attribute">
    228. 

  228. <dt id="celery.result.TaskSetResult.subtask_ids">
    229. 

  229. <tt class="descname">subtask_ids</tt><a class="headerlink" href="#celery.result.TaskSetResult.subtask_ids" title="Permalink to this definition">¶</a></dt>
    230. 

  230. <dd>The list of task UUID&#8217;s for all of the subtasks.</dd></dl>
    231. 

  231. 

  232. <dl class="attribute">
    233. 

  233. <dt id="celery.result.TaskSetResult.subtasks">
    234. 

  234. <tt class="descname">subtasks</tt><a class="headerlink" href="#celery.result.TaskSetResult.subtasks" title="Permalink to this definition">¶</a></dt>
    235. 

  235. <dd>A list of <tt class="xref docutils literal"><span class="pre">AsyncResult`</span></tt> instances for all of the subtasks.</dd></dl>
    236. 

  236. 

  237. <dl class="method">
    238. 

  238. <dt id="celery.result.TaskSetResult.completed_count">
    239. 

  239. <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>
    240. 

  240. <dd><p>Task completion count.</p>
    241. 

  241. <table class="docutils field-list" frame="void" rules="none">
    242. 

  242. <col class="field-name" />
    243. 

  243. <col class="field-body" />
    244. 

  244. <tbody valign="top">
    245. 

  245. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the number of tasks completed.</td>
    246. 

  246. </tr>
    247. 

  247. </tbody>
    248. 

  248. </table>
    249. 

  249. </dd></dl>
    250. 

  250. 

  251. <dl class="method">
    252. 

  252. <dt id="celery.result.TaskSetResult.failed">
    253. 

  253. <tt class="descname">failed</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.failed" title="Permalink to this definition">¶</a></dt>
    254. 

  254. <dd><p>Did the taskset fail?</p>
    255. 

  255. <table class="docutils field-list" frame="void" rules="none">
    256. 

  256. <col class="field-name" />
    257. 

  257. <col class="field-body" />
    258. 

  258. <tbody valign="top">
    259. 

  259. <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.
    260. 

  260. (i.e., raised an exception)</td>
    261. 

  261. </tr>
    262. 

  262. </tbody>
    263. 

  263. </table>
    264. 

  264. </dd></dl>
    265. 

  265. 

  266. <dl class="method">
    267. 

  267. <dt id="celery.result.TaskSetResult.iterate">
    268. 

  268. <tt class="descname">iterate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.iterate" title="Permalink to this definition">¶</a></dt>
    269. 

  269. <dd><p>Iterate over the return values of the tasks as they finish
    270. 

  270. one by one.</p>
    271. 

  271. <table class="docutils field-list" frame="void" rules="none">
    272. 

  272. <col class="field-name" />
    273. 

  273. <col class="field-body" />
    274. 

  274. <tbody valign="top">
    275. 

  275. <tr class="field"><th class="field-name">Raises:</th><td class="field-body">The exception if any of the tasks raised an exception.</td>
    276. 

  276. </tr>
    277. 

  277. </tbody>
    278. 

  278. </table>
    279. 

  279. </dd></dl>
    280. 

  280. 

  281. <dl class="method">
    282. 

  282. <dt id="celery.result.TaskSetResult.itersubtasks">
    283. 

  283. <tt class="descname">itersubtasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.itersubtasks" title="Permalink to this definition">¶</a></dt>
    284. 

  284. <dd><p>Taskset subtask iterator.</p>
    285. 

  285. <table class="docutils field-list" frame="void" rules="none">
    286. 

  286. <col class="field-name" />
    287. 

  287. <col class="field-body" />
    288. 

  288. <tbody valign="top">
    289. 

  289. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">an iterator for iterating over the tasksets
    290. 

  290. <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>
    291. 

  291. </tr>
    292. 

  292. </tbody>
    293. 

  293. </table>
    294. 

  294. </dd></dl>
    295. 

  295. 

  296. <dl class="method">
    297. 

  297. <dt id="celery.result.TaskSetResult.join">
    298. 

  298. <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>
    299. 

  299. <dd><p>Gather the results for all of the tasks in the taskset,
    300. 

  300. and return a list with them ordered by the order of which they
    301. 

  301. were called.</p>
    302. 

  302. <table class="docutils field-list" frame="void" rules="none">
    303. 

  303. <col class="field-name" />
    304. 

  304. <col class="field-body" />
    305. 

  305. <tbody valign="top">
    306. 

  306. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>timeout</em> &#8211; The time in seconds, how long
    307. 

  307. it will wait for results, before the operation times out.</td>
    308. 

  308. </tr>
    309. 

  309. <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>
    310. 

  310. <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>
    311. 

  311. and the operation takes longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds.</td>
    312. 

  312. </tr>
    313. 

  313. </tbody>
    314. 

  314. </table>
    315. 

  315. <p>If any of the tasks raises an exception, the exception
    316. 

  316. 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>
    317. 

  317. <table class="docutils field-list" frame="void" rules="none">
    318. 

  318. <col class="field-name" />
    319. 

  319. <col class="field-body" />
    320. 

  320. <tbody valign="top">
    321. 

  321. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of return values for all tasks in the taskset.</td>
    322. 

  322. </tr>
    323. 

  323. </tbody>
    324. 

  324. </table>
    325. 

  325. </dd></dl>
    326. 

  326. 

  327. <dl class="method">
    328. 

  328. <dt id="celery.result.TaskSetResult.ready">
    329. 

  329. <tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.ready" title="Permalink to this definition">¶</a></dt>
    330. 

  330. <dd><p>Is the task ready?</p>
    331. 

  331. <table class="docutils field-list" frame="void" rules="none">
    332. 

  332. <col class="field-name" />
    333. 

  333. <col class="field-body" />
    334. 

  334. <tbody valign="top">
    335. 

  335. <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
    336. 

  336. executed.</td>
    337. 

  337. </tr>
    338. 

  338. </tbody>
    339. 

  339. </table>
    340. 

  340. </dd></dl>
    341. 

  341. 

  342. <dl class="method">
    343. 

  343. <dt id="celery.result.TaskSetResult.successful">
    344. 

  344. <tt class="descname">successful</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.successful" title="Permalink to this definition">¶</a></dt>
    345. 

  345. <dd><p>Was the taskset successful?</p>
    346. 

  346. <table class="docutils field-list" frame="void" rules="none">
    347. 

  347. <col class="field-name" />
    348. 

  348. <col class="field-body" />
    349. 

  349. <tbody valign="top">
    350. 

  350. <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
    351. 

  351. successfully (i.e. did not raise an exception).</td>
    352. 

  352. </tr>
    353. 

  353. </tbody>
    354. 

  354. </table>
    355. 

  355. </dd></dl>
    356. 

  356. 

  357. <dl class="attribute">
    358. 

  358. <dt id="celery.result.TaskSetResult.total">
    359. 

  359. <tt class="descname">total</tt><a class="headerlink" href="#celery.result.TaskSetResult.total" title="Permalink to this definition">¶</a></dt>
    360. 

  360. <dd>The total number of tasks in the <a title="celery.task.TaskSet" class="reference external" href="celery.task.html#celery.task.TaskSet"><tt class="xref docutils literal"><span class="pre">celery.task.TaskSet</span></tt></a>.</dd></dl>
    361. 

  361. 

  362. <dl class="method">
    363. 

  363. <dt id="celery.result.TaskSetResult.waiting">
    364. 

  364. <tt class="descname">waiting</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.TaskSetResult.waiting" title="Permalink to this definition">¶</a></dt>
    365. 

  365. <dd><p>Is the taskset waiting?</p>
    366. 

  366. <table class="docutils field-list" frame="void" rules="none">
    367. 

  367. <col class="field-name" />
    368. 

  368. <col class="field-body" />
    369. 

  369. <tbody valign="top">
    370. 

  370. <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
    371. 

  371. waiting for execution.</td>
    372. 

  372. </tr>
    373. 

  373. </tbody>
    374. 

  374. </table>
    375. 

  375. </dd></dl>
    376. 

  376. 

  377. </dd></dl>
    378. 

  378. 

  379. </div>
    380. 

  380. 

  381. 

  382. 	      </div>
    383. 

  383. 	    </div>
    384. 

  384. 	  </div>
    385. 

  385. 	</div>
    386. 

  386. 	<div class="sidebar">
    387. 

  387. 	  <h3>Contents</h3>
    388. 

  388. 	  <ul class="current">
    389. 

  389. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
    390. 

  390. <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
    391. 

  391. <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
    392. 

  392. <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
    393. 

  393. <li class="toctree-l2 current"><a class="current reference external" href="">Task Result - celery.result</a></li>
    394. 

  394. <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
    395. 

  395. <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
    396. 

  396. <li class="toctree-l2"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
    397. 

  397. <li class="toctree-l2"><a class="reference external" href="celery.pool.html">Task Pool - celery.pool</a></li>
    398. 

  398. <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
    399. 

  399. <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
    400. 

  400. <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
    401. 

  401. <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
    402. 

  402. <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
    403. 

  403. <li class="toctree-l2"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
    404. 

  404. <li class="toctree-l2"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
    405. 

  405. <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
    406. 

  406. <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
    407. 

  407. <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
    408. 

  408. <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
    409. 

  409. <li class="toctree-l2"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
    410. 

  410. <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
    411. 

  411. </ul>
    412. 

  412. </li>
    413. 

  413. <li class="toctree-l1"><a class="reference external" href="../changelog.html">Change history</a></li>
    414. 

  414. </ul>
    415. 

  415. 

  416. 	  <h3 style="margin-top: 1.5em;">Search</h3>
    417. 

  417. 	  <form class="search" action="../search.html" method="get">
    418. 

  418.             <input type="text" name="q" size="18" />
    419. 

  419.             <input type="submit" value="Go" />
    420. 

  420.             <input type="hidden" name="check_keywords" value="yes" />
    421. 

  421.             <input type="hidden" name="area" value="default" />
    422. 

  422.           </form>
    423. 

  423.           <p class="searchtip" style="font-size: 90%">
    424. 

  424.             Enter search terms or a module, class or function name.
    425. 

  425.           </p>
    426. 

  426. 	</div>
    427. 

  427. 	<div class="clearer"></div>
    428. 

  428.       </div>
    429. 

  429.     </div>
    430. 

  430. 

  431.     <div class="footer-wrapper">
    432. 

  432.       <div class="footer">
    433. 

  433. 	<div class="left">
    434. 

  434.           <a href="../genindex.html" title="General Index"
    435. 

  435.              >index</a> |
    436. 

  436.           <a href="../modindex.html" title="Global Module Index"
    437. 

  437.              >modules</a> |
    438. 

  438.           <a href="celery.registry.html" title="Task Registry - celery.registry"
    439. 

  439.              >next</a> |
    440. 

  440.           <a href="celery.task.html" title="Tasks - celery.task"
    441. 

  441.              >previous</a>
    442. 

  442.             <br/>
    443. 

  443.             <a href="../sources/reference/celery.result.txt"
    444. 

  444.                rel="nofollow">Show Source</a>
    445. 

  445. 	</div>
    446. 

  446. 

  447. 	<div class="right">
    448. 

  448. 	  &copy; Copyright 2009, Ask Solem.<br/>
    449. 

  449. 	  Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
    450. 

  450. 	</div>
    451. 

  451. 	<div class="clearer"></div>
    452. 

  452.       </div>
    453. 

  453.     </div>
    454. 

  454. 

  455.   </body>
    456. 

  456. </html>
    457.