celery.task.builtins.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  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>Built-in Task Classes - celery.task.builtins &mdash; Celery v0.3.20 (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.3.20 (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.3.20 (unstable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Task Discovery - celery.discovery" href="celery.discovery.html" />
  23. <link rel="prev" title="Task Registry - celery.registry" href="celery.registry.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.discovery.html" title="Task Discovery - celery.discovery"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.registry.html" title="Task Registry - celery.registry"
  40. accesskey="P">previous</a> |</li>
  41. <li><a href="../index.html">Celery v0.3.20 (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.builtins">
  50. <h1>Built-in Task Classes - celery.task.builtins<a class="headerlink" href="#module-celery.task.builtins" title="Permalink to this headline">¶</a></h1>
  51. <dl class="class">
  52. <dt id="celery.task.builtins.AsynchronousMapTask">
  53. <em class="property">
  54. class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">AsynchronousMapTask</tt><a class="headerlink" href="#celery.task.builtins.AsynchronousMapTask" title="Permalink to this definition">¶</a></dt>
  55. <dd><p>Task used internally by <tt class="xref docutils literal"><span class="pre">dmap_async()</span></tt> and
  56. <tt class="xref docutils literal"><span class="pre">TaskSet.map_async()</span></tt>.</p>
  57. <dl class="method">
  58. <dt id="celery.task.builtins.AsynchronousMapTask.run">
  59. <tt class="descname">run</tt><big>(</big><em>serfunc</em>, <em>args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.AsynchronousMapTask.run" title="Permalink to this definition">¶</a></dt>
  60. <dd>The method run by <tt class="docutils literal"><span class="pre">celeryd</span></tt>.</dd></dl>
  61. </dd></dl>
  62. <dl class="class">
  63. <dt id="celery.task.builtins.DeleteExpiredTaskMetaTask">
  64. <em class="property">
  65. class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">DeleteExpiredTaskMetaTask</tt><a class="headerlink" href="#celery.task.builtins.DeleteExpiredTaskMetaTask" title="Permalink to this definition">¶</a></dt>
  66. <dd><p>A periodic task that deletes expired task metadata every day.</p>
  67. <p>This runs the current backend&#8217;s
  68. <a title="celery.backends.base.BaseBackend.cleanup" class="reference external" href="celery.backends.base.html#celery.backends.base.BaseBackend.cleanup"><tt class="xref docutils literal"><span class="pre">celery.backends.base.BaseBackend.cleanup()</span></tt></a> method.</p>
  69. <dl class="method">
  70. <dt id="celery.task.builtins.DeleteExpiredTaskMetaTask.run">
  71. <tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.DeleteExpiredTaskMetaTask.run" title="Permalink to this definition">¶</a></dt>
  72. <dd>The method run by <tt class="docutils literal"><span class="pre">celeryd</span></tt>.</dd></dl>
  73. </dd></dl>
  74. <dl class="class">
  75. <dt id="celery.task.builtins.ExecuteRemoteTask">
  76. <em class="property">
  77. class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">ExecuteRemoteTask</tt><a class="headerlink" href="#celery.task.builtins.ExecuteRemoteTask" title="Permalink to this definition">¶</a></dt>
  78. <dd><p>Execute an arbitrary function or object.</p>
  79. <p><em>Note</em> You probably want <tt class="xref docutils literal"><span class="pre">execute_remote()</span></tt> instead, which this
  80. is an internal component of.</p>
  81. <p>The object must be pickleable, so you can&#8217;t use lambdas or functions
  82. defined in the REPL (that is the python shell, or <tt class="docutils literal"><span class="pre">ipython</span></tt>).</p>
  83. <dl class="method">
  84. <dt id="celery.task.builtins.ExecuteRemoteTask.run">
  85. <tt class="descname">run</tt><big>(</big><em>ser_callable</em>, <em>fargs</em>, <em>fkwargs</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.ExecuteRemoteTask.run" title="Permalink to this definition">¶</a></dt>
  86. <dd><table class="docutils field-list" frame="void" rules="none">
  87. <col class="field-name" />
  88. <col class="field-body" />
  89. <tbody valign="top">
  90. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  91. <li><em>ser_callable</em> &#8211; A pickled function or callable object.</li>
  92. <li><em>fargs</em> &#8211; Positional arguments to apply to the function.</li>
  93. <li><em>fkwargs</em> &#8211; Keyword arguments to apply to the function.</li>
  94. </ul>
  95. </td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. </dd></dl>
  100. </dd></dl>
  101. <dl class="class">
  102. <dt id="celery.task.builtins.PingTask">
  103. <em class="property">
  104. class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">PingTask</tt><a class="headerlink" href="#celery.task.builtins.PingTask" title="Permalink to this definition">¶</a></dt>
  105. <dd><p>The task used by <tt class="xref docutils literal"><span class="pre">ping()</span></tt>.</p>
  106. <dl class="method">
  107. <dt id="celery.task.builtins.PingTask.run">
  108. <tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.PingTask.run" title="Permalink to this definition">¶</a></dt>
  109. <dd><table class="docutils field-list" frame="void" rules="none">
  110. <col class="field-name" />
  111. <col class="field-body" />
  112. <tbody valign="top">
  113. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the string <tt class="docutils literal"><span class="pre">&quot;pong&quot;</span></tt>.</td>
  114. </tr>
  115. </tbody>
  116. </table>
  117. </dd></dl>
  118. </dd></dl>
  119. </div>
  120. </div>
  121. </div>
  122. </div>
  123. <div class="sphinxsidebar">
  124. <div class="sphinxsidebarwrapper">
  125. <h4>Previous topic</h4>
  126. <p class="topless"><a href="celery.registry.html"
  127. title="previous chapter">Task Registry - celery.registry</a></p>
  128. <h4>Next topic</h4>
  129. <p class="topless"><a href="celery.discovery.html"
  130. title="next chapter">Task Discovery - celery.discovery</a></p>
  131. <h3>This Page</h3>
  132. <ul class="this-page-menu">
  133. <li><a href="../sources/reference/celery.task.builtins.txt"
  134. rel="nofollow">Show Source</a></li>
  135. </ul>
  136. <div id="searchbox" style="display: none">
  137. <h3>Quick search</h3>
  138. <form class="search" action="../search.html" method="get">
  139. <input type="text" name="q" size="18" />
  140. <input type="submit" value="Go" />
  141. <input type="hidden" name="check_keywords" value="yes" />
  142. <input type="hidden" name="area" value="default" />
  143. </form>
  144. <p class="searchtip" style="font-size: 90%">
  145. Enter search terms or a module, class or function name.
  146. </p>
  147. </div>
  148. <script type="text/javascript">$('#searchbox').show(0);</script>
  149. </div>
  150. </div>
  151. <div class="clearer"></div>
  152. </div>
  153. <div class="related">
  154. <h3>Navigation</h3>
  155. <ul>
  156. <li class="right" style="margin-right: 10px">
  157. <a href="../genindex.html" title="General Index"
  158. >index</a></li>
  159. <li class="right" >
  160. <a href="../modindex.html" title="Global Module Index"
  161. >modules</a> |</li>
  162. <li class="right" >
  163. <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
  164. >next</a> |</li>
  165. <li class="right" >
  166. <a href="celery.registry.html" title="Task Registry - celery.registry"
  167. >previous</a> |</li>
  168. <li><a href="../index.html">Celery v0.3.20 (unstable) documentation</a> &raquo;</li>
  169. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  170. </ul>
  171. </div>
  172. <div class="footer">
  173. &copy; Copyright 2009, Ask Solem.
  174. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
  175. </div>
  176. </body>
  177. </html>