celery.task.strategy.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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>Common Task Strategies - celery.task.strategy &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="Loaders - celery.loaders" href="celery.loaders.html" />
  23. <link rel="prev" title="Built-in Task Classes - celery.task.builtins" href="celery.task.builtins.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.loaders.html" title="Loaders - celery.loaders"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.task.builtins.html" title="Built-in Task Classes - celery.task.builtins"
  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.task.strategy">
  50. <h1>Common Task Strategies - celery.task.strategy<a class="headerlink" href="#module-celery.task.strategy" title="Permalink to this headline">¶</a></h1>
  51. <dl class="function">
  52. <dt id="celery.task.strategy.even_time_distribution">
  53. <tt class="descclassname">celery.task.strategy.</tt><tt class="descname">even_time_distribution</tt><big>(</big><em>task</em>, <em>size</em>, <em>time_window</em>, <em>iterable</em>, <em>**apply_kwargs</em><big>)</big><a class="headerlink" href="#celery.task.strategy.even_time_distribution" title="Permalink to this definition">¶</a></dt>
  54. <dd><p>With an iterator yielding task args, kwargs tuples, evenly distribute
  55. the processing of its tasks throughout the time window available.</p>
  56. <table class="docutils field-list" frame="void" rules="none">
  57. <col class="field-name" />
  58. <col class="field-body" />
  59. <tbody valign="top">
  60. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  61. <li><em>task</em> &#8211; The kind of task (a <a title="celery.task.base.Task" class="reference external" href="celery.task.base.html#celery.task.base.Task"><tt class="xref docutils literal"><span class="pre">celery.task.base.Task</span></tt></a>.)</li>
  62. <li><em>size</em> &#8211; Total number of elements the iterator gives.</li>
  63. <li><em>time_window</em> &#8211; Total time available, in minutes.</li>
  64. <li><em>iterable</em> &#8211; Iterable yielding task args, kwargs tuples.</li>
  65. <li><em>**apply_kwargs</em> &#8211; Additional keyword arguments to be passed on to
  66. <a title="celery.execute.apply_async" class="reference external" href="celery.execute.html#celery.execute.apply_async"><tt class="xref docutils literal"><span class="pre">celery.execute.apply_async()</span></tt></a>.</li>
  67. </ul>
  68. </td>
  69. </tr>
  70. </tbody>
  71. </table>
  72. <p>Example</p>
  73. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">RefreshAllFeeds</span><span class="p">(</span><span class="n">Task</span><span class="p">):</span>
  74. <span class="gp">...</span>
  75. <span class="gp">... </span> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
  76. <span class="gp">... </span> <span class="n">feeds</span> <span class="o">=</span> <span class="n">Feed</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
  77. <span class="gp">... </span> <span class="n">total</span> <span class="o">=</span> <span class="n">feeds</span><span class="o">.</span><span class="n">count</span><span class="p">()</span>
  78. <span class="gp">...</span>
  79. <span class="gp">... </span> <span class="n">time_window</span> <span class="o">=</span> <span class="n">REFRESH_FEEDS_EVERY_INTERVAL_MINUTES</span>
  80. <span class="gp">...</span>
  81. <span class="gp">... </span> <span class="k">def</span> <span class="nf">iter_feed_task_args</span><span class="p">(</span><span class="n">iterable</span><span class="p">):</span>
  82. <span class="gp">... </span> <span class="k">for</span> <span class="n">feed</span> <span class="ow">in</span> <span class="n">iterable</span><span class="p">:</span>
  83. <span class="gp">... </span> <span class="k">yield</span> <span class="p">([</span><span class="n">feed</span><span class="o">.</span><span class="n">feed_url</span><span class="p">],</span> <span class="p">{})</span> <span class="c"># args, kwargs tuple</span>
  84. <span class="gp">...</span>
  85. <span class="gp">... </span> <span class="n">it</span> <span class="o">=</span> <span class="n">iter_feed_task_args</span><span class="p">(</span><span class="n">feeds</span><span class="o">.</span><span class="n">iterator</span><span class="p">())</span>
  86. <span class="gp">...</span>
  87. <span class="gp">... </span> <span class="n">even_time_distribution</span><span class="p">(</span><span class="n">RefreshFeedTask</span><span class="p">,</span> <span class="n">total</span><span class="p">,</span>
  88. <span class="gp">... </span> <span class="n">time_window</span><span class="p">,</span> <span class="n">it</span><span class="p">)</span>
  89. </pre></div>
  90. </div>
  91. </dd></dl>
  92. </div>
  93. </div>
  94. </div>
  95. </div>
  96. <div class="sphinxsidebar">
  97. <div class="sphinxsidebarwrapper">
  98. <h4>Previous topic</h4>
  99. <p class="topless"><a href="celery.task.builtins.html"
  100. title="previous chapter">Built-in Task Classes - celery.task.builtins</a></p>
  101. <h4>Next topic</h4>
  102. <p class="topless"><a href="celery.loaders.html"
  103. title="next chapter">Loaders - celery.loaders</a></p>
  104. <h3>This Page</h3>
  105. <ul class="this-page-menu">
  106. <li><a href="../sources/reference/celery.task.strategy.txt"
  107. rel="nofollow">Show Source</a></li>
  108. </ul>
  109. <div id="searchbox" style="display: none">
  110. <h3>Quick search</h3>
  111. <form class="search" action="../search.html" method="get">
  112. <input type="text" name="q" size="18" />
  113. <input type="submit" value="Go" />
  114. <input type="hidden" name="check_keywords" value="yes" />
  115. <input type="hidden" name="area" value="default" />
  116. </form>
  117. <p class="searchtip" style="font-size: 90%">
  118. Enter search terms or a module, class or function name.
  119. </p>
  120. </div>
  121. <script type="text/javascript">$('#searchbox').show(0);</script>
  122. </div>
  123. </div>
  124. <div class="clearer"></div>
  125. </div>
  126. <div class="related">
  127. <h3>Navigation</h3>
  128. <ul>
  129. <li class="right" style="margin-right: 10px">
  130. <a href="../genindex.html" title="General Index"
  131. >index</a></li>
  132. <li class="right" >
  133. <a href="../modindex.html" title="Global Module Index"
  134. >modules</a> |</li>
  135. <li class="right" >
  136. <a href="celery.loaders.html" title="Loaders - celery.loaders"
  137. >next</a> |</li>
  138. <li class="right" >
  139. <a href="celery.task.builtins.html" title="Built-in Task Classes - celery.task.builtins"
  140. >previous</a> |</li>
  141. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  142. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  143. </ul>
  144. </div>
  145. <div class="footer">
  146. &copy; Copyright 2009, Ask Solem.
  147. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
  148. </div>
  149. </body>
  150. </html>