canvas.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  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>Canvas: Building Workflows &mdash; Celery 2.6.0rc4 documentation</title>
  7. <link rel="stylesheet" href="../_static/celery.css" type="text/css" />
  8. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  9. <link rel="stylesheet" href="../_static/issuetracker.css" type="text/css" />
  10. <script type="text/javascript">
  11. var DOCUMENTATION_OPTIONS = {
  12. URL_ROOT: '../',
  13. VERSION: '2.6.0rc4',
  14. COLLAPSE_INDEX: false,
  15. FILE_SUFFIX: '.html',
  16. HAS_SOURCE: true
  17. };
  18. </script>
  19. <script type="text/javascript" src="../_static/jquery.js"></script>
  20. <script type="text/javascript" src="../_static/underscore.js"></script>
  21. <script type="text/javascript" src="../_static/doctools.js"></script>
  22. <link rel="top" title="Celery 2.6.0rc4 documentation" href="../index.html" />
  23. <link rel="up" title="User Guide" href="index.html" />
  24. <link rel="next" title="HTTP Callback Tasks (Webhooks)" href="remote-tasks.html" />
  25. <link rel="prev" title="Periodic Tasks" href="periodic-tasks.html" />
  26. </head>
  27. <body>
  28. <div class="related">
  29. <h3>Navigation</h3>
  30. <ul>
  31. <li class="right" style="margin-right: 10px">
  32. <a href="../genindex.html" title="General Index"
  33. accesskey="I">index</a></li>
  34. <li class="right" >
  35. <a href="../py-modindex.html" title="Python Module Index"
  36. >modules</a> |</li>
  37. <li class="right" >
  38. <a href="remote-tasks.html" title="HTTP Callback Tasks (Webhooks)"
  39. accesskey="N">next</a> |</li>
  40. <li class="right" >
  41. <a href="periodic-tasks.html" title="Periodic Tasks"
  42. accesskey="P">previous</a> |</li>
  43. <li><a href="../index.html">Celery 2.6.0rc4 documentation</a> &raquo;</li>
  44. <li><a href="index.html" accesskey="U">User Guide</a> &raquo;</li>
  45. </ul>
  46. </div>
  47. <div class="document">
  48. <div class="documentwrapper">
  49. <div class="bodywrapper">
  50. <div class="body">
  51. <div class="deck">
  52. <p class="developmentversion">
  53. This document is for Celery's development version, which can be
  54. significantly different from previous releases. Get old docs here:
  55. <a href="http://docs.celeryproject.org/en/latest/userguide/canvas.html">2.5</a>.
  56. </p>
  57. </div>
  58. <div class="section" id="canvas-building-workflows">
  59. <span id="guide-canvas"></span><h1>Canvas: Building Workflows<a class="headerlink" href="#canvas-building-workflows" title="Permalink to this headline">¶</a></h1>
  60. <div class="contents local topic" id="contents">
  61. <ul class="simple">
  62. <li><a class="reference internal" href="#subtasks" id="id2">Subtasks</a><ul>
  63. <li><a class="reference internal" href="#callbacks" id="id3">Callbacks</a></li>
  64. </ul>
  65. </li>
  66. <li><a class="reference internal" href="#groups" id="id4">Groups</a><ul>
  67. <li><a class="reference internal" href="#group-results" id="id5">Group Results</a></li>
  68. </ul>
  69. </li>
  70. <li><a class="reference internal" href="#chords" id="id6">Chords</a><ul>
  71. <li><a class="reference internal" href="#important-notes" id="id7">Important Notes</a></li>
  72. </ul>
  73. </li>
  74. </ul>
  75. </div>
  76. <div class="section" id="subtasks">
  77. <span id="canvas-subtasks"></span><h2><a class="toc-backref" href="#id2">Subtasks</a><a class="headerlink" href="#subtasks" title="Permalink to this headline">¶</a></h2>
  78. <p class="versionadded">
  79. <span class="versionmodified">New in version 2.0.</span></p>
  80. <p>The <a class="reference internal" href="../reference/celery.html#celery.subtask" title="celery.subtask"><tt class="xref py py-class docutils literal"><span class="pre">subtask</span></tt></a> type is used to wrap the arguments and
  81. execution options for a single task invocation:</p>
  82. <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">celery</span> <span class="kn">import</span> <span class="n">subtask</span>
  83. <span class="n">subtask</span><span class="p">(</span><span class="n">task_name_or_cls</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
  84. </pre></div>
  85. </div>
  86. <p>For convenience every task also has a shortcut to create subtasks:</p>
  87. <div class="highlight-python"><div class="highlight"><pre><span class="n">task</span><span class="o">.</span><span class="n">subtask</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
  88. </pre></div>
  89. </div>
  90. <p><a class="reference internal" href="../reference/celery.html#celery.subtask" title="celery.subtask"><tt class="xref py py-class docutils literal"><span class="pre">subtask</span></tt></a> is actually a <a class="reference external" href="http://docs.python.org/dev/library/stdtypes.html#dict" title="(in Python v3.3)"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt></a> subclass,
  91. which means it can be serialized with JSON or other encodings that doesn&#8217;t
  92. support complex Python objects.</p>
  93. <p>Also it can be regarded as a type, as the following usage works:</p>
  94. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">subtask</span><span class="p">(</span><span class="s">&quot;tasks.add&quot;</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">kwargs</span><span class="o">=</span><span class="p">{})</span>
  95. <span class="gp">&gt;&gt;&gt; </span><span class="n">subtask</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">s</span><span class="p">))</span> <span class="c"># coerce dict into subtask</span>
  96. </pre></div>
  97. </div>
  98. <p>This makes it excellent as a means to pass callbacks around to tasks.</p>
  99. <div class="section" id="callbacks">
  100. <span id="canvas-callbacks"></span><h3><a class="toc-backref" href="#id3">Callbacks</a><a class="headerlink" href="#callbacks" title="Permalink to this headline">¶</a></h3>
  101. <p>Callbacks can be added to any task using the <tt class="docutils literal"><span class="pre">link</span></tt> argument
  102. to <tt class="docutils literal"><span class="pre">apply_async</span></tt>:</p>
  103. <blockquote>
  104. <div>add.apply_async((2, 2), link=other_task.subtask())</div></blockquote>
  105. <p>The callback will only be applied if the task exited successfully,
  106. and it will be applied with the return value of the parent task as argument.</p>
  107. <p>The best thing is that any arguments you add to <cite>subtask</cite>,
  108. will be prepended to the arguments specified by the subtask itself!</p>
  109. <p>If you have the subtask:</p>
  110. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="p">))</span>
  111. </pre></div>
  112. </div>
  113. <p><cite>subtask.delay(result)</cite> becomes:</p>
  114. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">add</span><span class="o">.</span><span class="n">apply_async</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
  115. </pre></div>
  116. </div>
  117. <p>...</p>
  118. <p>Now let&#8217;s call our <tt class="docutils literal"><span class="pre">add</span></tt> task with a callback using partial
  119. arguments:</p>
  120. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">add</span><span class="o">.</span><span class="n">apply_async</span><span class="p">((</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">link</span><span class="o">=</span><span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="mi">8</span><span class="p">,</span> <span class="p">)))</span>
  121. </pre></div>
  122. </div>
  123. <p>As expected this will first launch one task calculating <img class="math" src="../_images/math/2da3a5ecd44fdb54a9a30c87a48a5b1638c139b0.png" alt="2 + 2"/>, then
  124. another task calculating <img class="math" src="../_images/math/c67562ae31bb2d1017a9b0240c012edc474851c3.png" alt="4 + 8"/>.</p>
  125. </div>
  126. </div>
  127. <div class="section" id="groups">
  128. <span id="canvas-group"></span><h2><a class="toc-backref" href="#id4">Groups</a><a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h2>
  129. <p>The <a class="reference internal" href="../reference/celery.html#celery.group" title="celery.group"><tt class="xref py py-class docutils literal"><span class="pre">group</span></tt></a> enables easy invocation of several
  130. tasks at once, and is then able to join the results in the same order as the
  131. tasks were invoked.</p>
  132. <p><tt class="docutils literal"><span class="pre">group</span></tt> takes a list of <a class="reference internal" href="../reference/celery.html#celery.subtask" title="celery.subtask"><tt class="xref py py-class docutils literal"><span class="pre">subtask</span></tt></a>&#8216;s:</p>
  133. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery</span> <span class="kn">import</span> <span class="n">group</span>
  134. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">tasks</span> <span class="kn">import</span> <span class="n">add</span>
  135. <span class="gp">&gt;&gt;&gt; </span><span class="n">job</span> <span class="o">=</span> <span class="n">group</span><span class="p">([</span>
  136. <span class="gp">... </span> <span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)),</span>
  137. <span class="gp">... </span> <span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="mi">4</span><span class="p">,</span> <span class="mi">4</span><span class="p">)),</span>
  138. <span class="gp">... </span> <span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="mi">8</span><span class="p">,</span> <span class="mi">8</span><span class="p">)),</span>
  139. <span class="gp">... </span> <span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="mi">16</span><span class="p">,</span> <span class="mi">16</span><span class="p">)),</span>
  140. <span class="gp">... </span> <span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="mi">32</span><span class="p">,</span> <span class="mi">32</span><span class="p">)),</span>
  141. <span class="gp">... </span><span class="p">])</span>
  142. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">job</span><span class="o">.</span><span class="n">apply_async</span><span class="p">()</span>
  143. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">ready</span><span class="p">()</span> <span class="c"># have all subtasks completed?</span>
  144. <span class="go">True</span>
  145. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">successful</span><span class="p">()</span> <span class="c"># were all subtasks successful?</span>
  146. <span class="go">True</span>
  147. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
  148. <span class="go">[4, 8, 16, 32, 64]</span>
  149. </pre></div>
  150. </div>
  151. <p>The first argument can alternatively be an iterator, like:</p>
  152. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">group</span><span class="p">(</span><span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="n">i</span><span class="p">,</span> <span class="n">i</span><span class="p">))</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">100</span><span class="p">))</span>
  153. </pre></div>
  154. </div>
  155. <div class="section" id="group-results">
  156. <span id="canvas-group-results"></span><h3><a class="toc-backref" href="#id5">Group Results</a><a class="headerlink" href="#group-results" title="Permalink to this headline">¶</a></h3>
  157. <p>When a <a class="reference internal" href="../reference/celery.html#celery.group" title="celery.group"><tt class="xref py py-class docutils literal"><span class="pre">group</span></tt></a> is applied it returns a
  158. <a class="reference internal" href="../reference/celery.result.html#celery.result.GroupResult" title="celery.result.GroupResult"><tt class="xref py py-class docutils literal"><span class="pre">GroupResult</span></tt></a> object.</p>
  159. <p><a class="reference internal" href="../reference/celery.result.html#celery.result.GroupResult" title="celery.result.GroupResult"><tt class="xref py py-class docutils literal"><span class="pre">GroupResult</span></tt></a> takes a list of
  160. <a class="reference internal" href="../reference/celery.result.html#celery.result.AsyncResult" title="celery.result.AsyncResult"><tt class="xref py py-class docutils literal"><span class="pre">AsyncResult</span></tt></a> instances and operates on them as if it was a
  161. single task.</p>
  162. <p>It supports the following operations:</p>
  163. <ul>
  164. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">successful()</span></tt></p>
  165. <blockquote>
  166. <div><p>Returns <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> if all of the subtasks finished
  167. successfully (e.g. did not raise an exception).</p>
  168. </div></blockquote>
  169. </li>
  170. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">failed()</span></tt></p>
  171. <blockquote>
  172. <div><p>Returns <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> if any of the subtasks failed.</p>
  173. </div></blockquote>
  174. </li>
  175. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">waiting()</span></tt></p>
  176. <blockquote>
  177. <div><p>Returns <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> if any of the subtasks
  178. is not ready yet.</p>
  179. </div></blockquote>
  180. </li>
  181. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">ready()</span></tt></p>
  182. <blockquote>
  183. <div><p>Return <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt> if all of the subtasks
  184. are ready.</p>
  185. </div></blockquote>
  186. </li>
  187. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">completed_count()</span></tt></p>
  188. <blockquote>
  189. <div><p>Returns the number of completed subtasks.</p>
  190. </div></blockquote>
  191. </li>
  192. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">revoke()</span></tt></p>
  193. <blockquote>
  194. <div><p>Revokes all of the subtasks.</p>
  195. </div></blockquote>
  196. </li>
  197. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">iterate()</span></tt></p>
  198. <blockquote>
  199. <div><p>Iterates over the return values of the subtasks
  200. as they finish, one by one.</p>
  201. </div></blockquote>
  202. </li>
  203. <li><p class="first"><tt class="xref py py-meth docutils literal"><span class="pre">join()</span></tt></p>
  204. <blockquote>
  205. <div><p>Gather the results for all of the subtasks
  206. and return a list with them ordered by the order of which they
  207. were called.</p>
  208. </div></blockquote>
  209. </li>
  210. </ul>
  211. </div>
  212. </div>
  213. <div class="section" id="chords">
  214. <span id="id1"></span><h2><a class="toc-backref" href="#id6">Chords</a><a class="headerlink" href="#chords" title="Permalink to this headline">¶</a></h2>
  215. <p class="versionadded">
  216. <span class="versionmodified">New in version 2.3.</span></p>
  217. <p>A chord is a task that only executes after all of the tasks in a taskset has
  218. finished executing.</p>
  219. <p>Let&#8217;s calculate the sum of the expression
  220. <img class="math" src="../_images/math/c9bf2df3c397d6399241c37fc9887ca50bc8fa09.png" alt="1 + 1 + 2 + 2 + 3 + 3 ... n + n"/> up to a hundred digits.</p>
  221. <p>First we need two tasks, <tt class="xref py py-func docutils literal"><span class="pre">add()</span></tt> and <tt class="xref py py-func docutils literal"><span class="pre">tsum()</span></tt> (<a class="reference external" href="http://docs.python.org/dev/library/functions.html#sum" title="(in Python v3.3)"><tt class="xref py py-func docutils literal"><span class="pre">sum()</span></tt></a> is
  222. already a standard function):</p>
  223. <div class="highlight-python"><div class="highlight"><pre><span class="nd">@celery.task</span><span class="p">()</span>
  224. <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
  225. <span class="k">return</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span>
  226. <span class="nd">@celery.task</span><span class="p">()</span>
  227. <span class="k">def</span> <span class="nf">tsum</span><span class="p">(</span><span class="n">numbers</span><span class="p">):</span>
  228. <span class="k">return</span> <span class="nb">sum</span><span class="p">(</span><span class="n">numbers</span><span class="p">)</span>
  229. </pre></div>
  230. </div>
  231. <p>Now we can use a chord to calculate each addition step in parallel, and then
  232. get the sum of the resulting numbers:</p>
  233. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery</span> <span class="kn">import</span> <span class="n">chord</span>
  234. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">tasks</span> <span class="kn">import</span> <span class="n">add</span><span class="p">,</span> <span class="n">tsum</span>
  235. <span class="gp">&gt;&gt;&gt; </span><span class="n">chord</span><span class="p">(</span><span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="n">i</span><span class="p">,</span> <span class="n">i</span><span class="p">))</span>
  236. <span class="gp">... </span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">100</span><span class="p">))(</span><span class="n">tsum</span><span class="o">.</span><span class="n">subtask</span><span class="p">())</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
  237. <span class="go">9900</span>
  238. </pre></div>
  239. </div>
  240. <p>This is obviously a very contrived example, the overhead of messaging and
  241. synchronization makes this a lot slower than its Python counterpart:</p>
  242. <div class="highlight-python"><div class="highlight"><pre><span class="nb">sum</span><span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">100</span><span class="p">))</span>
  243. </pre></div>
  244. </div>
  245. <p>The synchronization step is costly, so you should avoid using chords as much
  246. as possible. Still, the chord is a powerful primitive to have in your toolbox
  247. as synchronization is a required step for many parallel algorithms.</p>
  248. <p>Let&#8217;s break the chord expression down:</p>
  249. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">callback</span> <span class="o">=</span> <span class="n">tsum</span><span class="o">.</span><span class="n">subtask</span><span class="p">()</span>
  250. <span class="gp">&gt;&gt;&gt; </span><span class="n">header</span> <span class="o">=</span> <span class="p">[</span><span class="n">add</span><span class="o">.</span><span class="n">subtask</span><span class="p">((</span><span class="n">i</span><span class="p">,</span> <span class="n">i</span><span class="p">))</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">100</span><span class="p">)]</span>
  251. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">chord</span><span class="p">(</span><span class="n">header</span><span class="p">)(</span><span class="n">callback</span><span class="p">)</span>
  252. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
  253. <span class="go">9900</span>
  254. </pre></div>
  255. </div>
  256. <p>Remember, the callback can only be executed after all of the tasks in the
  257. header has returned. Each step in the header is executed as a task, in
  258. parallel, possibly on different nodes. The callback is then applied with
  259. the return value of each task in the header. The task id returned by
  260. <tt class="xref py py-meth docutils literal"><span class="pre">chord()</span></tt> is the id of the callback, so you can wait for it to complete
  261. and get the final return value (but remember to <a class="reference internal" href="tasks.html#task-synchronous-subtasks"><em>never have a task wait
  262. for other tasks</em></a>)</p>
  263. <div class="section" id="important-notes">
  264. <span id="chord-important-notes"></span><h3><a class="toc-backref" href="#id7">Important Notes</a><a class="headerlink" href="#important-notes" title="Permalink to this headline">¶</a></h3>
  265. <p>By default the synchronization step is implemented by having a recurring task
  266. poll the completion of the taskset every second, applying the subtask when
  267. ready.</p>
  268. <p>Example implementation:</p>
  269. <div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">unlock_chord</span><span class="p">(</span><span class="n">taskset</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">max_retries</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
  270. <span class="k">if</span> <span class="n">taskset</span><span class="o">.</span><span class="n">ready</span><span class="p">():</span>
  271. <span class="k">return</span> <span class="n">subtask</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span><span class="o">.</span><span class="n">delay</span><span class="p">(</span><span class="n">taskset</span><span class="o">.</span><span class="n">join</span><span class="p">())</span>
  272. <span class="k">raise</span> <span class="n">unlock_chord</span><span class="o">.</span><span class="n">retry</span><span class="p">(</span><span class="n">countdown</span><span class="o">=</span><span class="n">interval</span><span class="p">,</span> <span class="n">max_retries</span><span class="o">=</span><span class="n">max_retries</span><span class="p">)</span>
  273. </pre></div>
  274. </div>
  275. <p>This is used by all result backends except Redis and Memcached, which increment a
  276. counter after each task in the header, then applying the callback when the
  277. counter exceeds the number of tasks in the set. <em>Note:</em> chords do not properly
  278. work with Redis before version 2.2; you will need to upgrade to at least 2.2 to
  279. use them.</p>
  280. <p>The Redis and Memcached approach is a much better solution, but not easily
  281. implemented in other backends (suggestions welcome!).</p>
  282. <div class="admonition note">
  283. <p class="first admonition-title">Note</p>
  284. <p>If you are using chords with the Redis result backend and also overriding
  285. the <tt class="xref py py-meth docutils literal"><span class="pre">Task.after_return()</span></tt> method, you need to make sure to call the
  286. super method or else the chord callback will not be applied.</p>
  287. <div class="last highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">after_return</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
  288. <span class="n">do_something</span><span class="p">()</span>
  289. <span class="nb">super</span><span class="p">(</span><span class="n">MyTask</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">after_return</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
  290. </pre></div>
  291. </div>
  292. </div>
  293. </div>
  294. </div>
  295. </div>
  296. </div>
  297. </div>
  298. </div>
  299. <div class="sphinxsidebar">
  300. <div class="sphinxsidebarwrapper"><p class="logo"><a href="../index.html">
  301. <img class="logo" src="http://cloud.github.com/downloads/celery/celery/celery_128.png" alt="Logo"/>
  302. </a></p>
  303. <h4>Previous topic</h4>
  304. <p class="topless"><a href="periodic-tasks.html"
  305. title="previous chapter">Periodic Tasks</a></p>
  306. <h4>Next topic</h4>
  307. <p class="topless"><a href="remote-tasks.html"
  308. title="next chapter">HTTP Callback Tasks (Webhooks)</a></p>
  309. <h3>This Page</h3>
  310. <ul class="this-page-menu">
  311. <li><a href="../_sources/userguide/canvas.txt"
  312. rel="nofollow">Show Source</a></li>
  313. </ul>
  314. <div id="searchbox" style="display: none">
  315. <h3>Quick search</h3>
  316. <form class="search" action="../search.html" method="get">
  317. <input type="text" name="q" />
  318. <input type="submit" value="Go" />
  319. <input type="hidden" name="check_keywords" value="yes" />
  320. <input type="hidden" name="area" value="default" />
  321. </form>
  322. <p class="searchtip" style="font-size: 90%">
  323. Enter search terms or a module, class or function name.
  324. </p>
  325. </div>
  326. <script type="text/javascript">$('#searchbox').show(0);</script>
  327. </div>
  328. </div>
  329. <div class="clearer"></div>
  330. </div>
  331. <div class="related">
  332. <h3>Navigation</h3>
  333. <ul>
  334. <li class="right" style="margin-right: 10px">
  335. <a href="../genindex.html" title="General Index"
  336. >index</a></li>
  337. <li class="right" >
  338. <a href="../py-modindex.html" title="Python Module Index"
  339. >modules</a> |</li>
  340. <li class="right" >
  341. <a href="remote-tasks.html" title="HTTP Callback Tasks (Webhooks)"
  342. >next</a> |</li>
  343. <li class="right" >
  344. <a href="periodic-tasks.html" title="Periodic Tasks"
  345. >previous</a> |</li>
  346. <li><a href="../index.html">Celery 2.6.0rc4 documentation</a> &raquo;</li>
  347. <li><a href="index.html" >User Guide</a> &raquo;</li>
  348. </ul>
  349. </div>
  350. <div class="footer">
  351. &copy; Copyright 2009-2012, Ask Solem &amp; Contributors.
  352. </div>
  353. </body>
  354. </html>