Kezdőlap Felfedezés Súgó
Bejelentkezés
yangck
/
celery
1
0
Másolás 0
Fájlok Problémák 0 Beolvasztási kérések 0 Wiki
Fa: 20bddcdb3c
Branch-ok Tag-ek
celery
/
reference
/
celery.task.html

celery.task.html 51 KB
Előzmények Nyers

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757 
  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>Tasks - celery.task &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 Result - celery.result" href="celery.result.html" />
    25. 

  25.     <link rel="prev" title="Module API Reference" href="index.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.result.html" title="Task Result - celery.result"
    38. 

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

  39.           <a href="index.html" title="Module API Reference"
    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.task">
    53. 

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

  54. <p>Working with tasks and task sets.</p>
    55. 

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

  56. <dt id="celery.task.AsynchronousMapTask">
    57. 

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

  58. class </em><tt class="descclassname">celery.task.</tt><tt class="descname">AsynchronousMapTask</tt><a class="headerlink" href="#celery.task.AsynchronousMapTask" title="Permalink to this definition">¶</a></dt>
    59. 

  59. <dd><p>Task used internally by <a title="celery.task.dmap_async" class="reference internal" href="#celery.task.dmap_async"><tt class="xref docutils literal"><span class="pre">dmap_async()</span></tt></a> and
    60. 

  60. <a title="celery.task.TaskSet.map_async" class="reference internal" href="#celery.task.TaskSet.map_async"><tt class="xref docutils literal"><span class="pre">TaskSet.map_async()</span></tt></a>.</p>
    61. 

  61. <dl class="method">
    62. 

  62. <dt id="celery.task.AsynchronousMapTask.run">
    63. 

  63. <tt class="descname">run</tt><big>(</big><em>serfunc</em>, <em>args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.AsynchronousMapTask.run" title="Permalink to this definition">¶</a></dt>
    64. 

  64. <dd>The method run by <tt class="docutils literal"><span class="pre">celeryd</span></tt>.</dd></dl>
    65. 

  65. 

  66. </dd></dl>
    67. 

  67. 

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

  69. <dt id="celery.task.DeleteExpiredTaskMetaTask">
    70. 

  70. <em class="property">
    71. 

  71. class </em><tt class="descclassname">celery.task.</tt><tt class="descname">DeleteExpiredTaskMetaTask</tt><a class="headerlink" href="#celery.task.DeleteExpiredTaskMetaTask" title="Permalink to this definition">¶</a></dt>
    72. 

  72. <dd><p>A periodic task that deletes expired task metadata every day.</p>
    73. 

  73. <p>This runs the current backend&#8217;s
    74. 

  74. <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>
    75. 

  75. <dl class="method">
    76. 

  76. <dt id="celery.task.DeleteExpiredTaskMetaTask.run">
    77. 

  77. <tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.DeleteExpiredTaskMetaTask.run" title="Permalink to this definition">¶</a></dt>
    78. 

  78. <dd>The method run by <tt class="docutils literal"><span class="pre">celeryd</span></tt>.</dd></dl>
    79. 

  79. 

  80. </dd></dl>
    81. 

  81. 

  82. <dl class="class">
    83. 

  83. <dt id="celery.task.ExecuteRemoteTask">
    84. 

  84. <em class="property">
    85. 

  85. class </em><tt class="descclassname">celery.task.</tt><tt class="descname">ExecuteRemoteTask</tt><a class="headerlink" href="#celery.task.ExecuteRemoteTask" title="Permalink to this definition">¶</a></dt>
    86. 

  86. <dd><p>Execute an arbitrary function or object.</p>
    87. 

  87. <p><em>Note</em> You probably want <a title="celery.task.execute_remote" class="reference internal" href="#celery.task.execute_remote"><tt class="xref docutils literal"><span class="pre">execute_remote()</span></tt></a> instead, which this
    88. 

  88. is an internal component of.</p>
    89. 

  89. <p>The object must be pickleable, so you can&#8217;t use lambdas or functions
    90. 

  90. defined in the REPL (that is the python shell, or <tt class="docutils literal"><span class="pre">ipython</span></tt>).</p>
    91. 

  91. <dl class="method">
    92. 

  92. <dt id="celery.task.ExecuteRemoteTask.run">
    93. 

  93. <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.ExecuteRemoteTask.run" title="Permalink to this definition">¶</a></dt>
    94. 

  94. <dd><table class="docutils field-list" frame="void" rules="none">
    95. 

  95. <col class="field-name" />
    96. 

  96. <col class="field-body" />
    97. 

  97. <tbody valign="top">
    98. 

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

  99. <li><em>ser_callable</em> &#8211; A pickled function or callable object.</li>
    100. 

  100. <li><em>fargs</em> &#8211; Positional arguments to apply to the function.</li>
    101. 

  101. <li><em>fkwargs</em> &#8211; Keyword arguments to apply to the function.</li>
    102. 

  102. </ul>
    103. 

  103. </td>
    104. 

  104. </tr>
    105. 

  105. </tbody>
    106. 

  106. </table>
    107. 

  107. </dd></dl>
    108. 

  108. 

  109. </dd></dl>
    110. 

  110. 

  111. <dl class="class">
    112. 

  112. <dt id="celery.task.PeriodicTask">
    113. 

  113. <em class="property">
    114. 

  114. class </em><tt class="descclassname">celery.task.</tt><tt class="descname">PeriodicTask</tt><a class="headerlink" href="#celery.task.PeriodicTask" title="Permalink to this definition">¶</a></dt>
    115. 

  115. <dd><p>A periodic task is a task that behaves like a <em>cron</em> job.</p>
    116. 

  116. <dl class="attribute">
    117. 

  117. <dt id="celery.task.PeriodicTask.run_every">
    118. 

  118. <tt class="descname">run_every</tt><a class="headerlink" href="#celery.task.PeriodicTask.run_every" title="Permalink to this definition">¶</a></dt>
    119. 

  119. <dd><em>REQUIRED</em> Defines how often the task is run (its interval),
    120. 

  120. it can be either a <tt class="xref docutils literal"><span class="pre">datetime.timedelta</span></tt> object or an
    121. 

  121. integer specifying the time in seconds.</dd></dl>
    122. 

  122. 

  123. <table class="docutils field-list" frame="void" rules="none">
    124. 

  124. <col class="field-name" />
    125. 

  125. <col class="field-body" />
    126. 

  126. <tbody valign="top">
    127. 

  127. <tr class="field"><th class="field-name" colspan="2">Raises NotImplementedError:</th></tr>
    128. 

  128. <tr><td>&nbsp;</td><td class="field-body">if the <a title="celery.task.PeriodicTask.run_every" class="reference internal" href="#celery.task.PeriodicTask.run_every"><tt class="xref docutils literal"><span class="pre">run_every</span></tt></a> attribute is
    129. 

  129. not defined.</td>
    130. 

  130. </tr>
    131. 

  131. </tbody>
    132. 

  132. </table>
    133. 

  133. <p>You have to register the periodic task in the task registry.</p>
    134. 

  134. <p>Example</p>
    135. 

  135. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">tasks</span><span class="p">,</span> <span class="n">PeriodicTask</span>
    136. 

  136. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">timedelta</span>
    137. 

  137. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">MyPeriodicTask</span><span class="p">(</span><span class="n">PeriodicTask</span><span class="p">):</span>
    138. 

  138. <span class="gp">... </span>    <span class="n">name</span> <span class="o">=</span> <span class="s">&quot;my_periodic_task&quot;</span>
    139. 

  139. <span class="gp">... </span>    <span class="n">run_every</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">seconds</span><span class="o">=</span><span class="mf">30</span><span class="p">)</span>
    140. 

  140. <span class="gp">...</span>
    141. 

  141. <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>
    142. 

  142. <span class="gp">... </span>        <span class="n">logger</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_logger</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
    143. 

  143. <span class="gp">... </span>        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Running MyPeriodicTask&quot;</span><span class="p">)</span>
    144. 

  144. <span class="gp">&gt;&gt;&gt; </span><span class="n">tasks</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">MyPeriodicTask</span><span class="p">)</span>
    145. 

  145. </pre></div>
    146. 

  146. </div>
    147. 

  147. </dd></dl>
    148. 

  148. 

  149. <dl class="class">
    150. 

  150. <dt id="celery.task.PingTask">
    151. 

  151. <em class="property">
    152. 

  152. class </em><tt class="descclassname">celery.task.</tt><tt class="descname">PingTask</tt><a class="headerlink" href="#celery.task.PingTask" title="Permalink to this definition">¶</a></dt>
    153. 

  153. <dd><p>The task used by <a title="celery.task.ping" class="reference internal" href="#celery.task.ping"><tt class="xref docutils literal"><span class="pre">ping()</span></tt></a>.</p>
    154. 

  154. <dl class="method">
    155. 

  155. <dt id="celery.task.PingTask.run">
    156. 

  156. <tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.PingTask.run" title="Permalink to this definition">¶</a></dt>
    157. 

  157. <dd><table class="docutils field-list" frame="void" rules="none">
    158. 

  158. <col class="field-name" />
    159. 

  159. <col class="field-body" />
    160. 

  160. <tbody valign="top">
    161. 

  161. <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>
    162. 

  162. </tr>
    163. 

  163. </tbody>
    164. 

  164. </table>
    165. 

  165. </dd></dl>
    166. 

  166. 

  167. </dd></dl>
    168. 

  168. 

  169. <dl class="class">
    170. 

  170. <dt id="celery.task.Task">
    171. 

  171. <em class="property">
    172. 

  172. class </em><tt class="descclassname">celery.task.</tt><tt class="descname">Task</tt><a class="headerlink" href="#celery.task.Task" title="Permalink to this definition">¶</a></dt>
    173. 

  173. <dd><p>A task that can be delayed for execution by the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon.</p>
    174. 

  174. <p>All subclasses of <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a> must define the <a title="celery.task.Task.run" class="reference internal" href="#celery.task.Task.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a> method,
    175. 

  175. which is the actual method the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon executes.</p>
    176. 

  176. <p>The <a title="celery.task.Task.run" class="reference internal" href="#celery.task.Task.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a> method supports both positional, and keyword arguments.</p>
    177. 

  177. <dl class="attribute">
    178. 

  178. <dt id="celery.task.Task.name">
    179. 

  179. <tt class="descname">name</tt><a class="headerlink" href="#celery.task.Task.name" title="Permalink to this definition">¶</a></dt>
    180. 

  180. <dd><em>REQUIRED</em> All subclasses of <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a> has to define the
    181. 

  181. <a title="celery.task.Task.name" class="reference internal" href="#celery.task.Task.name"><tt class="xref docutils literal"><span class="pre">name</span></tt></a> attribute. This is the name of the task, registered
    182. 

  182. in the task registry, and passed to <a title="celery.task.delay_task" class="reference internal" href="#celery.task.delay_task"><tt class="xref docutils literal"><span class="pre">delay_task()</span></tt></a>.</dd></dl>
    183. 

  183. 

  184. <dl class="attribute">
    185. 

  185. <dt id="celery.task.Task.type">
    186. 

  186. <tt class="descname">type</tt><a class="headerlink" href="#celery.task.Task.type" title="Permalink to this definition">¶</a></dt>
    187. 

  187. <dd>The type of task, currently this can be <tt class="docutils literal"><span class="pre">regular</span></tt>, or <tt class="docutils literal"><span class="pre">periodic</span></tt>,
    188. 

  188. however if you want a periodic task, you should subclass
    189. 

  189. <a title="celery.task.PeriodicTask" class="reference internal" href="#celery.task.PeriodicTask"><tt class="xref docutils literal"><span class="pre">PeriodicTask</span></tt></a> instead.</dd></dl>
    190. 

  190. 

  191. <table class="docutils field-list" frame="void" rules="none">
    192. 

  192. <col class="field-name" />
    193. 

  193. <col class="field-body" />
    194. 

  194. <tbody valign="top">
    195. 

  195. <tr class="field"><th class="field-name" colspan="2">Raises NotImplementedError:</th></tr>
    196. 

  196. <tr><td>&nbsp;</td><td class="field-body">if the <a title="celery.task.Task.name" class="reference internal" href="#celery.task.Task.name"><tt class="xref docutils literal"><span class="pre">name</span></tt></a> attribute is not set.</td>
    197. 

  197. </tr>
    198. 

  198. </tbody>
    199. 

  199. </table>
    200. 

  200. <p>The resulting class is callable, which if called will apply the
    201. 

  201. <a title="celery.task.Task.run" class="reference internal" href="#celery.task.Task.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a> method.</p>
    202. 

  202. <p>Examples</p>
    203. 

  203. <p>This is a simple task just logging a message,</p>
    204. 

  204. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">tasks</span><span class="p">,</span> <span class="n">Task</span>
    205. 

  205. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">MyTask</span><span class="p">(</span><span class="n">Task</span><span class="p">):</span>
    206. 

  206. <span class="gp">... </span>    <span class="n">name</span> <span class="o">=</span> <span class="s">&quot;mytask&quot;</span>
    207. 

  207. <span class="gp">...</span>
    208. 

  208. <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="n">some_arg</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    209. 

  209. <span class="gp">... </span>        <span class="n">logger</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_logger</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
    210. 

  210. <span class="gp">... </span>        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Running MyTask with arg some_arg=</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>
    211. 

  211. <span class="gp">... </span>                    <span class="n">some_arg</span><span class="p">))</span>
    212. 

  212. <span class="gp">... </span>        <span class="k">return</span> <span class="mf">42</span>
    213. 

  213. <span class="gp">... </span><span class="n">tasks</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">MyTask</span><span class="p">)</span>
    214. 

  214. </pre></div>
    215. 

  215. </div>
    216. 

  216. <p>You can delay the task using the classmethod <a title="celery.task.Task.delay" class="reference internal" href="#celery.task.Task.delay"><tt class="xref docutils literal"><span class="pre">delay()</span></tt></a>...</p>
    217. 

  217. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">MyTask</span><span class="o">.</span><span class="n">delay</span><span class="p">(</span><span class="n">some_arg</span><span class="o">=</span><span class="s">&quot;foo&quot;</span><span class="p">)</span>
    218. 

  218. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">status</span> <span class="c"># after some time</span>
    219. 

  219. <span class="go">&#39;DONE&#39;</span>
    220. 

  220. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">result</span>
    221. 

  221. <span class="go">42</span>
    222. 

  222. </pre></div>
    223. 

  223. </div>
    224. 

  224. <p>...or using the <a title="celery.task.delay_task" class="reference internal" href="#celery.task.delay_task"><tt class="xref docutils literal"><span class="pre">delay_task()</span></tt></a> function, by passing the name of
    225. 

  225. the task.</p>
    226. 

  226. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">delay_task</span>
    227. 

  227. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">delay_task</span><span class="p">(</span><span class="n">MyTask</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">some_arg</span><span class="o">=</span><span class="s">&quot;foo&quot;</span><span class="p">)</span>
    228. 

  228. </pre></div>
    229. 

  229. </div>
    230. 

  230. <dl class="classmethod">
    231. 

  231. <dt id="celery.task.Task.apply_async">
    232. 

  232. <em class="property">
    233. 

  233. classmethod </em><tt class="descname">apply_async</tt><big>(</big><em>args=None</em>, <em>kwargs=None</em>, <em>**options</em><big>)</big><a class="headerlink" href="#celery.task.Task.apply_async" title="Permalink to this definition">¶</a></dt>
    234. 

  234. <dd><p>Delay this task for execution by the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon(s).</p>
    235. 

  235. <table class="docutils field-list" frame="void" rules="none">
    236. 

  236. <col class="field-name" />
    237. 

  237. <col class="field-body" />
    238. 

  238. <tbody valign="top">
    239. 

  239. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    240. 

  240. <li><em>args</em> &#8211; positional arguments passed on to the task.</li>
    241. 

  241. <li><em>kwargs</em> &#8211; keyword arguments passed on to the task.</li>
    242. 

  242. </ul>
    243. 

  243. </td>
    244. 

  244. </tr>
    245. 

  245. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a></p>
    246. 

  246. </td>
    247. 

  247. </tr>
    248. 

  248. </tbody>
    249. 

  249. </table>
    250. 

  250. <p>See <a title="celery.task.apply_async" class="reference internal" href="#celery.task.apply_async"><tt class="xref docutils literal"><span class="pre">apply_async()</span></tt></a>.</p>
    251. 

  251. </dd></dl>
    252. 

  252. 

  253. <dl class="classmethod">
    254. 

  254. <dt id="celery.task.Task.delay">
    255. 

  255. <em class="property">
    256. 

  256. classmethod </em><tt class="descname">delay</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.Task.delay" title="Permalink to this definition">¶</a></dt>
    257. 

  257. <dd><p>Delay this task for execution by the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon(s).</p>
    258. 

  258. <table class="docutils field-list" frame="void" rules="none">
    259. 

  259. <col class="field-name" />
    260. 

  260. <col class="field-body" />
    261. 

  261. <tbody valign="top">
    262. 

  262. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    263. 

  263. <li><em>*args</em> &#8211; positional arguments passed on to the task.</li>
    264. 

  264. <li><em>**kwargs</em> &#8211; keyword arguments passed on to the task.</li>
    265. 

  265. </ul>
    266. 

  266. </td>
    267. 

  267. </tr>
    268. 

  268. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a></p>
    269. 

  269. </td>
    270. 

  270. </tr>
    271. 

  271. </tbody>
    272. 

  272. </table>
    273. 

  273. <p>See <a title="celery.task.delay_task" class="reference internal" href="#celery.task.delay_task"><tt class="xref docutils literal"><span class="pre">delay_task()</span></tt></a>.</p>
    274. 

  274. </dd></dl>
    275. 

  275. 

  276. <dl class="method">
    277. 

  277. <dt id="celery.task.Task.get_consumer">
    278. 

  278. <tt class="descname">get_consumer</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.Task.get_consumer" title="Permalink to this definition">¶</a></dt>
    279. 

  279. <dd><p>Get a celery task message consumer.</p>
    280. 

  280. <table class="docutils field-list" frame="void" rules="none">
    281. 

  281. <col class="field-name" />
    282. 

  282. <col class="field-body" />
    283. 

  283. <tbody valign="top">
    284. 

  284. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a title="celery.messaging.TaskConsumer" class="reference external" href="celery.messaging.html#celery.messaging.TaskConsumer"><tt class="xref docutils literal"><span class="pre">celery.messaging.TaskConsumer</span></tt></a>.</td>
    285. 

  285. </tr>
    286. 

  286. </tbody>
    287. 

  287. </table>
    288. 

  288. <p>Please be sure to close the AMQP connection when you&#8217;re done
    289. 

  289. with this object. i.e.:</p>
    290. 

  290. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">consumer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_consumer</span><span class="p">()</span>
    291. 

  291. <span class="gp">&gt;&gt;&gt; </span><span class="c"># do something with consumer</span>
    292. 

  292. <span class="gp">&gt;&gt;&gt; </span><span class="n">consumer</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    293. 

  293. </pre></div>
    294. 

  294. </div>
    295. 

  295. </dd></dl>
    296. 

  296. 

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

  298. <dt id="celery.task.Task.get_logger">
    299. 

  299. <tt class="descname">get_logger</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.Task.get_logger" title="Permalink to this definition">¶</a></dt>
    300. 

  300. <dd><p>Get process-aware logger object.</p>
    301. 

  301. <p>See <a title="celery.log.setup_logger" class="reference external" href="celery.log.html#celery.log.setup_logger"><tt class="xref docutils literal"><span class="pre">celery.log.setup_logger()</span></tt></a>.</p>
    302. 

  302. </dd></dl>
    303. 

  303. 

  304. <dl class="method">
    305. 

  305. <dt id="celery.task.Task.get_publisher">
    306. 

  306. <tt class="descname">get_publisher</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.Task.get_publisher" title="Permalink to this definition">¶</a></dt>
    307. 

  307. <dd><p>Get a celery task message publisher.</p>
    308. 

  308. <table class="docutils field-list" frame="void" rules="none">
    309. 

  309. <col class="field-name" />
    310. 

  310. <col class="field-body" />
    311. 

  311. <tbody valign="top">
    312. 

  312. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a title="celery.messaging.TaskPublisher" class="reference external" href="celery.messaging.html#celery.messaging.TaskPublisher"><tt class="xref docutils literal"><span class="pre">celery.messaging.TaskPublisher</span></tt></a>.</td>
    313. 

  313. </tr>
    314. 

  314. </tbody>
    315. 

  315. </table>
    316. 

  316. <p>Please be sure to close the AMQP connection when you&#8217;re done
    317. 

  317. with this object, i.e.:</p>
    318. 

  318. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">publisher</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_publisher</span><span class="p">()</span>
    319. 

  319. <span class="gp">&gt;&gt;&gt; </span><span class="c"># do something with publisher</span>
    320. 

  320. <span class="gp">&gt;&gt;&gt; </span><span class="n">publisher</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    321. 

  321. </pre></div>
    322. 

  322. </div>
    323. 

  323. </dd></dl>
    324. 

  324. 

  325. <dl class="method">
    326. 

  326. <dt id="celery.task.Task.run">
    327. 

  327. <tt class="descname">run</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.Task.run" title="Permalink to this definition">¶</a></dt>
    328. 

  328. <dd><p><em>REQUIRED</em> The actual task.</p>
    329. 

  329. <p>All subclasses of <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a> must define the run method.</p>
    330. 

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

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

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

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

  334. <tr class="field"><th class="field-name" colspan="2">Raises NotImplementedError:</th></tr>
    335. 

  335. <tr><td>&nbsp;</td><td class="field-body">by default, so you have to override
    336. 

  336. this method in your subclass.</td>
    337. 

  337. </tr>
    338. 

  338. </tbody>
    339. 

  339. </table>
    340. 

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

  341. 

  342. </dd></dl>
    343. 

  343. 

  344. <dl class="class">
    345. 

  345. <dt id="celery.task.TaskSet">
    346. 

  346. <em class="property">
    347. 

  347. class </em><tt class="descclassname">celery.task.</tt><tt class="descname">TaskSet</tt><big>(</big><em>task</em>, <em>args</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet" title="Permalink to this definition">¶</a></dt>
    348. 

  348. <dd><p>A task containing several subtasks, making it possible
    349. 

  349. to track how many, or when all of the tasks has been completed.</p>
    350. 

  350. <table class="docutils field-list" frame="void" rules="none">
    351. 

  351. <col class="field-name" />
    352. 

  352. <col class="field-body" />
    353. 

  353. <tbody valign="top">
    354. 

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

  355. <li><em>task</em> &#8211; The task class or name.
    356. 

  356. Can either be a fully qualified task name, or a task class.</li>
    357. 

  357. <li><em>args</em> &#8211; A list of args, kwargs pairs.
    358. 

  358. e.g. <tt class="docutils literal"><span class="pre">[[args1,</span> <span class="pre">kwargs1],</span> <span class="pre">[args2,</span> <span class="pre">kwargs2],</span> <span class="pre">...,</span> <span class="pre">[argsN,</span> <span class="pre">kwargsN]]</span></tt></li>
    359. 

  359. </ul>
    360. 

  360. </td>
    361. 

  361. </tr>
    362. 

  362. </tbody>
    363. 

  363. </table>
    364. 

  364. <dl class="attribute">
    365. 

  365. <dt id="celery.task.TaskSet.task_name">
    366. 

  366. <tt class="descname">task_name</tt><a class="headerlink" href="#celery.task.TaskSet.task_name" title="Permalink to this definition">¶</a></dt>
    367. 

  367. <dd>The name of the task.</dd></dl>
    368. 

  368. 

  369. <dl class="attribute">
    370. 

  370. <dt id="celery.task.TaskSet.arguments">
    371. 

  371. <tt class="descname">arguments</tt><a class="headerlink" href="#celery.task.TaskSet.arguments" title="Permalink to this definition">¶</a></dt>
    372. 

  372. <dd>The arguments, as passed to the task set constructor.</dd></dl>
    373. 

  373. 

  374. <dl class="attribute">
    375. 

  375. <dt id="celery.task.TaskSet.total">
    376. 

  376. <tt class="descname">total</tt><a class="headerlink" href="#celery.task.TaskSet.total" title="Permalink to this definition">¶</a></dt>
    377. 

  377. <dd>Total number of tasks in this task set.</dd></dl>
    378. 

  378. 

  379. <p>Example</p>
    380. 

  380. <blockquote>
    381. 

  381. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">djangofeeds.tasks</span> <span class="kn">import</span> <span class="n">RefreshFeedTask</span>
    382. 

  382. <span class="gp">&gt;&gt;&gt; </span><span class="n">taskset</span> <span class="o">=</span> <span class="n">TaskSet</span><span class="p">(</span><span class="n">RefreshFeedTask</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[</span>
    383. 

  383. <span class="gp">... </span>                <span class="p">[],</span> <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://cnn.com/rss&quot;</span><span class="p">},</span>
    384. 

  384. <span class="gp">... </span>                <span class="p">[],</span> <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://bbc.com/rss&quot;</span><span class="p">},</span>
    385. 

  385. <span class="gp">... </span>                <span class="p">[],</span> <span class="p">{</span><span class="s">&quot;feed_url&quot;</span><span class="p">:</span> <span class="s">&quot;http://xkcd.com/rss&quot;</span><span class="p">}])</span>
    386. 

  386. </pre></div>
    387. 

  387. </div>
    388. 

  388. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">taskset_result</span> <span class="o">=</span> <span class="n">taskset</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
    389. 

  389. <span class="gp">&gt;&gt;&gt; </span><span class="n">list_of_return_values</span> <span class="o">=</span> <span class="n">taskset</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
    390. 

  390. </pre></div>
    391. 

  391. </div>
    392. 

  392. </blockquote>
    393. 

  393. <dl class="method">
    394. 

  394. <dt id="celery.task.TaskSet.iterate">
    395. 

  395. <tt class="descname">iterate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.TaskSet.iterate" title="Permalink to this definition">¶</a></dt>
    396. 

  396. <dd><p>Iterate over the results returned after calling <a title="celery.task.TaskSet.run" class="reference internal" href="#celery.task.TaskSet.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a>.</p>
    397. 

  397. <p>If any of the tasks raises an exception, the exception will
    398. 

  398. be re-raised.</p>
    399. 

  399. </dd></dl>
    400. 

  400. 

  401. <dl class="method">
    402. 

  402. <dt id="celery.task.TaskSet.join">
    403. 

  403. <tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet.join" title="Permalink to this definition">¶</a></dt>
    404. 

  404. <dd><p>Gather the results for all of the tasks in the taskset,
    405. 

  405. and return a list with them ordered by the order of which they
    406. 

  406. were called.</p>
    407. 

  407. <table class="docutils field-list" frame="void" rules="none">
    408. 

  408. <col class="field-name" />
    409. 

  409. <col class="field-body" />
    410. 

  410. <tbody valign="top">
    411. 

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

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

  413. </tr>
    414. 

  414. <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>
    415. 

  415. <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>
    416. 

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

  417. </tr>
    418. 

  418. </tbody>
    419. 

  419. </table>
    420. 

  420. <p>If any of the tasks raises an exception, the exception
    421. 

  421. will be reraised by <a title="celery.task.TaskSet.join" class="reference internal" href="#celery.task.TaskSet.join"><tt class="xref docutils literal"><span class="pre">join()</span></tt></a>.</p>
    422. 

  422. <table class="docutils field-list" frame="void" rules="none">
    423. 

  423. <col class="field-name" />
    424. 

  424. <col class="field-body" />
    425. 

  425. <tbody valign="top">
    426. 

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

  427. </tr>
    428. 

  428. </tbody>
    429. 

  429. </table>
    430. 

  430. </dd></dl>
    431. 

  431. 

  432. <dl class="classmethod">
    433. 

  433. <dt id="celery.task.TaskSet.map">
    434. 

  434. <em class="property">
    435. 

  435. classmethod </em><tt class="descname">map</tt><big>(</big><em>func</em>, <em>args</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet.map" title="Permalink to this definition">¶</a></dt>
    436. 

  436. <dd>Distribute processing of the arguments and collect the results.</dd></dl>
    437. 

  437. 

  438. <dl class="classmethod">
    439. 

  439. <dt id="celery.task.TaskSet.map_async">
    440. 

  440. <em class="property">
    441. 

  441. classmethod </em><tt class="descname">map_async</tt><big>(</big><em>func</em>, <em>args</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet.map_async" title="Permalink to this definition">¶</a></dt>
    442. 

  442. <dd><p>Distribute processing of the arguments and collect the results
    443. 

  443. asynchronously.</p>
    444. 

  444. <table class="docutils field-list" frame="void" rules="none">
    445. 

  445. <col class="field-name" />
    446. 

  446. <col class="field-body" />
    447. 

  447. <tbody valign="top">
    448. 

  448. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a> instance.</td>
    449. 

  449. </tr>
    450. 

  450. </tbody>
    451. 

  451. </table>
    452. 

  452. </dd></dl>
    453. 

  453. 

  454. <dl class="classmethod">
    455. 

  455. <dt id="celery.task.TaskSet.remote_execute">
    456. 

  456. <em class="property">
    457. 

  457. classmethod </em><tt class="descname">remote_execute</tt><big>(</big><em>func</em>, <em>args</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet.remote_execute" title="Permalink to this definition">¶</a></dt>
    458. 

  458. <dd>Apply <tt class="docutils literal"><span class="pre">args</span></tt> to function by distributing the args to the
    459. 

  459. celery server(s).</dd></dl>
    460. 

  460. 

  461. <dl class="method">
    462. 

  462. <dt id="celery.task.TaskSet.run">
    463. 

  463. <tt class="descname">run</tt><big>(</big><em>connect_timeout=4</em><big>)</big><a class="headerlink" href="#celery.task.TaskSet.run" title="Permalink to this definition">¶</a></dt>
    464. 

  464. <dd><p>Run all tasks in the taskset.</p>
    465. 

  465. <table class="docutils field-list" frame="void" rules="none">
    466. 

  466. <col class="field-name" />
    467. 

  467. <col class="field-body" />
    468. 

  468. <tbody valign="top">
    469. 

  469. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">A <a title="celery.result.TaskSetResult" class="reference external" href="celery.result.html#celery.result.TaskSetResult"><tt class="xref docutils literal"><span class="pre">celery.result.TaskSetResult</span></tt></a> instance.</td>
    470. 

  470. </tr>
    471. 

  471. </tbody>
    472. 

  472. </table>
    473. 

  473. <p>Example</p>
    474. 

  474. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">ts</span> <span class="o">=</span> <span class="n">TaskSet</span><span class="p">(</span><span class="n">RefreshFeedTask</span><span class="p">,</span> <span class="p">[</span>
    475. 

  475. <span class="gp">... </span>        <span class="p">[</span><span class="s">&quot;http://foo.com/rss&quot;</span><span class="p">,</span> <span class="p">{}],</span>
    476. 

  476. <span class="gp">... </span>        <span class="p">[</span><span class="s">&quot;http://bar.com/rss&quot;</span><span class="p">,</span> <span class="p">{}],</span>
    477. 

  477. <span class="gp">... </span><span class="p">)</span>
    478. 

  478. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">ts</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
    479. 

  479. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">taskset_id</span>
    480. 

  480. <span class="go">&quot;d2c9b261-8eff-4bfb-8459-1e1b72063514&quot;</span>
    481. 

  481. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">subtask_ids</span>
    482. 

  482. <span class="go">[&quot;b4996460-d959-49c8-aeb9-39c530dcde25&quot;,</span>
    483. 

  483. <span class="go">&quot;598d2d18-ab86-45ca-8b4f-0779f5d6a3cb&quot;]</span>
    484. 

  484. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">waiting</span><span class="p">()</span>
    485. 

  485. <span class="go">True</span>
    486. 

  486. <span class="gp">&gt;&gt;&gt; </span><span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">10</span><span class="p">)</span>
    487. 

  487. <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>
    488. 

  488. <span class="go">True</span>
    489. 

  489. <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>
    490. 

  490. <span class="go">True</span>
    491. 

  491. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">failed</span><span class="p">()</span>
    492. 

  492. <span class="go">False</span>
    493. 

  493. <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>
    494. 

  494. <span class="go">[True, True]</span>
    495. 

  495. </pre></div>
    496. 

  496. </div>
    497. 

  497. </dd></dl>
    498. 

  498. 

  499. </dd></dl>
    500. 

  500. 

  501. <dl class="function">
    502. 

  502. <dt id="celery.task.apply_async">
    503. 

  503. <tt class="descclassname">celery.task.</tt><tt class="descname">apply_async</tt><big>(</big><em>task</em>, <em>args=None</em>, <em>kwargs=None</em>, <em>routing_key=None</em>, <em>immediate=None</em>, <em>mandatory=None</em>, <em>connection=None</em>, <em>connect_timeout=4</em>, <em>priority=None</em><big>)</big><a class="headerlink" href="#celery.task.apply_async" title="Permalink to this definition">¶</a></dt>
    504. 

  504. <dd><p>Run a task asynchronously by the celery daemon(s).</p>
    505. 

  505. <table class="docutils field-list" frame="void" rules="none">
    506. 

  506. <col class="field-name" />
    507. 

  507. <col class="field-body" />
    508. 

  508. <tbody valign="top">
    509. 

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

  510. <li><em>task</em> &#8211; The task to run (a callable object, or a <a title="celery.task.Task" class="reference internal" href="#celery.task.Task"><tt class="xref docutils literal"><span class="pre">Task</span></tt></a>
    511. 

  511. instance</li>
    512. 

  512. <li><em>args</em> &#8211; The positional arguments to pass on to the task (a <tt class="docutils literal"><span class="pre">list</span></tt>).</li>
    513. 

  513. <li><em>kwargs</em> &#8211; The keyword arguments to pass on to the task (a <tt class="docutils literal"><span class="pre">dict</span></tt>)</li>
    514. 

  514. <li><em>routing_key</em> &#8211; The routing key used to route the task to a worker
    515. 

  515. server.</li>
    516. 

  516. <li><em>immediate</em> &#8211; Request immediate delivery. Will raise an exception
    517. 

  517. if the task cannot be routed to a worker immediately.</li>
    518. 

  518. <li><em>mandatory</em> &#8211; Mandatory routing. Raises an exception if there&#8217;s
    519. 

  519. no running workers able to take on this task.</li>
    520. 

  520. <li><em>connection</em> &#8211; Re-use existing AMQP connection.
    521. 

  521. The <tt class="docutils literal"><span class="pre">connect_timeout</span></tt> argument is not respected if this is set.</li>
    522. 

  522. <li><em>connect_timeout</em> &#8211; The timeout in seconds, before we give up
    523. 

  523. on establishing a connection to the AMQP server.</li>
    524. 

  524. <li><em>priority</em> &#8211; The task priority, a number between <tt class="docutils literal"><span class="pre">0</span></tt> and <tt class="docutils literal"><span class="pre">9</span></tt>.</li>
    525. 

  525. </ul>
    526. 

  526. </td>
    527. 

  527. </tr>
    528. 

  528. </tbody>
    529. 

  529. </table>
    530. 

  530. </dd></dl>
    531. 

  531. 

  532. <dl class="function">
    533. 

  533. <dt id="celery.task.delay_task">
    534. 

  534. <tt class="descclassname">celery.task.</tt><tt class="descname">delay_task</tt><big>(</big><em>task_name</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.delay_task" title="Permalink to this definition">¶</a></dt>
    535. 

  535. <dd><p>Delay a task for execution by the <tt class="docutils literal"><span class="pre">celery</span></tt> daemon.</p>
    536. 

  536. <table class="docutils field-list" frame="void" rules="none">
    537. 

  537. <col class="field-name" />
    538. 

  538. <col class="field-body" />
    539. 

  539. <tbody valign="top">
    540. 

  540. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    541. 

  541. <li><em>task_name</em> &#8211; the name of a task registered in the task registry.</li>
    542. 

  542. <li><em>*args</em> &#8211; positional arguments to pass on to the task.</li>
    543. 

  543. <li><em>**kwargs</em> &#8211; keyword arguments to pass on to the task.</li>
    544. 

  544. </ul>
    545. 

  545. </td>
    546. 

  546. </tr>
    547. 

  547. <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.registry.NotRegistered" class="reference external" href="celery.registry.html#celery.registry.NotRegistered">celery.registry.NotRegistered</a>:</th></tr>
    548. 

  548. <tr><td>&nbsp;</td><td class="field-body"><p class="first">exception if no such task
    549. 

  549. has been registered in the task registry.</p>
    550. 

  550. </td>
    551. 

  551. </tr>
    552. 

  552. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a>.</p>
    553. 

  553. </td>
    554. 

  554. </tr>
    555. 

  555. </tbody>
    556. 

  556. </table>
    557. 

  557. <p>Example</p>
    558. 

  558. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">r</span> <span class="o">=</span> <span class="n">delay_task</span><span class="p">(</span><span class="s">&quot;update_record&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">&quot;George Constanza&quot;</span><span class="p">,</span> <span class="n">age</span><span class="o">=</span><span class="mf">32</span><span class="p">)</span>
    559. 

  559. <span class="gp">&gt;&gt;&gt; </span><span class="n">r</span><span class="o">.</span><span class="n">ready</span><span class="p">()</span>
    560. 

  560. <span class="go">True</span>
    561. 

  561. <span class="gp">&gt;&gt;&gt; </span><span class="n">r</span><span class="o">.</span><span class="n">result</span>
    562. 

  562. <span class="go">&quot;Record was updated&quot;</span>
    563. 

  563. </pre></div>
    564. 

  564. </div>
    565. 

  565. </dd></dl>
    566. 

  566. 

  567. <dl class="function">
    568. 

  568. <dt id="celery.task.discard_all">
    569. 

  569. <tt class="descclassname">celery.task.</tt><tt class="descname">discard_all</tt><big>(</big><em>connect_timeout=4</em><big>)</big><a class="headerlink" href="#celery.task.discard_all" title="Permalink to this definition">¶</a></dt>
    570. 

  570. <dd><p>Discard all waiting tasks.</p>
    571. 

  571. <p>This will ignore all tasks waiting for execution, and they will
    572. 

  572. be deleted from the messaging server.</p>
    573. 

  573. <table class="docutils field-list" frame="void" rules="none">
    574. 

  574. <col class="field-name" />
    575. 

  575. <col class="field-body" />
    576. 

  576. <tbody valign="top">
    577. 

  577. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the number of tasks discarded.</td>
    578. 

  578. </tr>
    579. 

  579. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">int</td>
    580. 

  580. </tr>
    581. 

  581. </tbody>
    582. 

  582. </table>
    583. 

  583. </dd></dl>
    584. 

  584. 

  585. <dl class="function">
    586. 

  586. <dt id="celery.task.dmap">
    587. 

  587. <tt class="descclassname">celery.task.</tt><tt class="descname">dmap</tt><big>(</big><em>func</em>, <em>args</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.dmap" title="Permalink to this definition">¶</a></dt>
    588. 

  588. <dd><p>Distribute processing of the arguments and collect the results.</p>
    589. 

  589. <p>Example</p>
    590. 

  590. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="nb">map</span>
    591. 

  591. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">operator</span>
    592. 

  592. <span class="gp">&gt;&gt;&gt; </span><span class="n">dmap</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[[</span><span class="mf">2</span><span class="p">,</span> <span class="mf">2</span><span class="p">],</span> <span class="p">[</span><span class="mf">4</span><span class="p">,</span> <span class="mf">4</span><span class="p">],</span> <span class="p">[</span><span class="mf">8</span><span class="p">,</span> <span class="mf">8</span><span class="p">]])</span>
    593. 

  593. <span class="go">[4, 8, 16]</span>
    594. 

  594. </pre></div>
    595. 

  595. </div>
    596. 

  596. </dd></dl>
    597. 

  597. 

  598. <dl class="function">
    599. 

  599. <dt id="celery.task.dmap_async">
    600. 

  600. <tt class="descclassname">celery.task.</tt><tt class="descname">dmap_async</tt><big>(</big><em>func</em>, <em>args</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.task.dmap_async" title="Permalink to this definition">¶</a></dt>
    601. 

  601. <dd><p>Distribute processing of the arguments and collect the results
    602. 

  602. asynchronously.</p>
    603. 

  603. <table class="docutils field-list" frame="void" rules="none">
    604. 

  604. <col class="field-name" />
    605. 

  605. <col class="field-body" />
    606. 

  606. <tbody valign="top">
    607. 

  607. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a title="celery.result.AsyncResult" class="reference external" href="celery.result.html#celery.result.AsyncResult"><tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult</span></tt></a> object.</td>
    608. 

  608. </tr>
    609. 

  609. </tbody>
    610. 

  610. </table>
    611. 

  611. <p>Example</p>
    612. 

  612. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">dmap_async</span>
    613. 

  613. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">operator</span>
    614. 

  614. <span class="gp">&gt;&gt;&gt; </span><span class="n">presult</span> <span class="o">=</span> <span class="n">dmap_async</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span> <span class="p">[[</span><span class="mf">2</span><span class="p">,</span> <span class="mf">2</span><span class="p">],</span> <span class="p">[</span><span class="mf">4</span><span class="p">,</span> <span class="mf">4</span><span class="p">],</span> <span class="p">[</span><span class="mf">8</span><span class="p">,</span> <span class="mf">8</span><span class="p">]])</span>
    615. 

  615. <span class="gp">&gt;&gt;&gt; </span><span class="n">presult</span>
    616. 

  616. <span class="go">&lt;AsyncResult: 373550e8-b9a0-4666-bc61-ace01fa4f91d&gt;</span>
    617. 

  617. <span class="gp">&gt;&gt;&gt; </span><span class="n">presult</span><span class="o">.</span><span class="n">status</span>
    618. 

  618. <span class="go">&#39;DONE&#39;</span>
    619. 

  619. <span class="gp">&gt;&gt;&gt; </span><span class="n">presult</span><span class="o">.</span><span class="n">result</span>
    620. 

  620. <span class="go">[4, 8, 16]</span>
    621. 

  621. </pre></div>
    622. 

  622. </div>
    623. 

  623. </dd></dl>
    624. 

  624. 

  625. <dl class="function">
    626. 

  626. <dt id="celery.task.execute_remote">
    627. 

  627. <tt class="descclassname">celery.task.</tt><tt class="descname">execute_remote</tt><big>(</big><em>func</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.execute_remote" title="Permalink to this definition">¶</a></dt>
    628. 

  628. <dd><p>Execute arbitrary function/object remotely.</p>
    629. 

  629. <table class="docutils field-list" frame="void" rules="none">
    630. 

  630. <col class="field-name" />
    631. 

  631. <col class="field-body" />
    632. 

  632. <tbody valign="top">
    633. 

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

  634. <li><em>func</em> &#8211; A callable function or object.</li>
    635. 

  635. <li><em>*args</em> &#8211; Positional arguments to apply to the function.</li>
    636. 

  636. <li><em>**kwargs</em> &#8211; Keyword arguments to apply to the function.</li>
    637. 

  637. </ul>
    638. 

  638. </td>
    639. 

  639. </tr>
    640. 

  640. </tbody>
    641. 

  641. </table>
    642. 

  642. <p>The object must be picklable, so you can&#8217;t use lambdas or functions
    643. 

  643. defined in the REPL (the objects must have an associated module).</p>
    644. 

  644. <table class="docutils field-list" frame="void" rules="none">
    645. 

  645. <col class="field-name" />
    646. 

  646. <col class="field-body" />
    647. 

  647. <tbody valign="top">
    648. 

  648. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">class:<cite>celery.result.AsyncResult</cite>.</td>
    649. 

  649. </tr>
    650. 

  650. </tbody>
    651. 

  651. </table>
    652. 

  652. </dd></dl>
    653. 

  653. 

  654. <dl class="function">
    655. 

  655. <dt id="celery.task.is_done">
    656. 

  656. <tt class="descclassname">celery.task.</tt><tt class="descname">is_done</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.task.is_done" title="Permalink to this definition">¶</a></dt>
    657. 

  657. <dd><p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if task with <tt class="docutils literal"><span class="pre">task_id</span></tt> has been executed.</p>
    658. 

  658. <table class="docutils field-list" frame="void" rules="none">
    659. 

  659. <col class="field-name" />
    660. 

  660. <col class="field-body" />
    661. 

  661. <tbody valign="top">
    662. 

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

  663. </tr>
    664. 

  664. </tbody>
    665. 

  665. </table>
    666. 

  666. </dd></dl>
    667. 

  667. 

  668. <dl class="function">
    669. 

  669. <dt id="celery.task.ping">
    670. 

  670. <tt class="descclassname">celery.task.</tt><tt class="descname">ping</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.task.ping" title="Permalink to this definition">¶</a></dt>
    671. 

  671. <dd><p>Test if the server is alive.</p>
    672. 

  672. <p>Example:</p>
    673. 

  673. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">celery.task</span> <span class="kn">import</span> <span class="n">ping</span>
    674. 

  674. <span class="gp">&gt;&gt;&gt; </span><span class="n">ping</span><span class="p">()</span>
    675. 

  675. <span class="go">&#39;pong&#39;</span>
    676. 

  676. </pre></div>
    677. 

  677. </div>
    678. 

  678. </dd></dl>
    679. 

  679. 

  680. </div>
    681. 

  681. 

  682. 

  683. 	      </div>
    684. 

  684. 	    </div>
    685. 

  685. 	  </div>
    686. 

  686. 	</div>
    687. 

  687. 	<div class="sidebar">
    688. 

  688. 	  <h3>Contents</h3>
    689. 

  689. 	  <ul class="current">
    690. 

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

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

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

  693. <li class="toctree-l2 current"><a class="current reference external" href="">Tasks - celery.task</a></li>
    694. 

  694. <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
    695. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  712. </ul>
    713. 

  713. </li>
    714. 

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

  715. </ul>
    716. 

  716. 

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

  718. 	  <form class="search" action="../search.html" method="get">
    719. 

  719.             <input type="text" name="q" size="18" />
    720. 

  720.             <input type="submit" value="Go" />
    721. 

  721.             <input type="hidden" name="check_keywords" value="yes" />
    722. 

  722.             <input type="hidden" name="area" value="default" />
    723. 

  723.           </form>
    724. 

  724.           <p class="searchtip" style="font-size: 90%">
    725. 

  725.             Enter search terms or a module, class or function name.
    726. 

  726.           </p>
    727. 

  727. 	</div>
    728. 

  728. 	<div class="clearer"></div>
    729. 

  729.       </div>
    730. 

  730.     </div>
    731. 

  731. 

  732.     <div class="footer-wrapper">
    733. 

  733.       <div class="footer">
    734. 

  734. 	<div class="left">
    735. 

  735.           <a href="../genindex.html" title="General Index"
    736. 

  736.              >index</a> |
    737. 

  737.           <a href="../modindex.html" title="Global Module Index"
    738. 

  738.              >modules</a> |
    739. 

  739.           <a href="celery.result.html" title="Task Result - celery.result"
    740. 

  740.              >next</a> |
    741. 

  741.           <a href="index.html" title="Module API Reference"
    742. 

  742.              >previous</a>
    743. 

  743.             <br/>
    744. 

  744.             <a href="../sources/reference/celery.task.txt"
    745. 

  745.                rel="nofollow">Show Source</a>
    746. 

  746. 	</div>
    747. 

  747. 

  748. 	<div class="right">
    749. 

  749. 	  &copy; Copyright 2009, Ask Solem.<br/>
    750. 

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

  751. 	</div>
    752. 

  752. 	<div class="clearer"></div>
    753. 

  753.       </div>
    754. 

  754.     </div>
    755. 

  755. 

  756.   </body>
    757. 

  757. </html>
    758.