Inicio Explorar Ayuda
Iniciar sesión
yangck
/
celery
1
0
Fork 0
Archivos Incidencias 0 Pull Requests 0 Wiki
Árbol: 2935a45a82
Ramas Etiquetas
celery
/
reference
/
celery.task.html

celery.task.html 31 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 
  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.1.14 documentation</title>
    9. 

  9.     <link rel="stylesheet" href="../static/default.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.1.14',
    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.1.14 documentation" href="../index.html" />
    23. 

  23.     <link rel="next" title="Task Result - celery.result" href="celery.result.html" />
    24. 

  24.     <link rel="prev" title="Welcome to Celery’s documentation!" href="../index.html" /> 
    25. 

  25.   </head>
    26. 

  26.   <body>
    27. 

  27.     <div class="related">
    28. 

  28.       <h3>Navigation</h3>
    29. 

  29.       <ul>
    30. 

  30.         <li class="right" style="margin-right: 10px">
    31. 

  31.           <a href="../genindex.html" title="General Index"
    32. 

  32.              accesskey="I">index</a></li>
    33. 

  33.         <li class="right" >
    34. 

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

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

  36.         <li class="right" >
    37. 

  37.           <a href="celery.result.html" title="Task Result - celery.result"
    38. 

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

  39.         <li class="right" >
    40. 

  40.           <a href="../index.html" title="Welcome to Celery’s documentation!"
    41. 

  41.              accesskey="P">previous</a> |</li>
    42. 

  42.         <li><a href="../index.html">Celery v0.1.14 documentation</a> &raquo;</li> 
    43. 

  43.       </ul>
    44. 

  44.     </div>  
    45. 

  45. 

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

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

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

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

  50.             
    51. 

  51.   <div class="section" id="module-celery.task">
    52. 

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

  53. <dl class="class">
    54. 

  54. <dt id="celery.task.AsynchronousMapTask">
    55. 

  55. <em class="property">
    56. 

  56. 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>
    57. 

  57. <dd>Task used internally by <tt class="docutils literal"><span class="pre">dmap_async</span></tt>.</dd></dl>
    58. 

  58. 

  59. <dl class="class">
    60. 

  60. <dt id="celery.task.DeleteExpiredTaskMetaTask">
    61. 

  61. <em class="property">
    62. 

  62. 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>
    63. 

  63. <dd><p>A periodic task that deletes expired task metadata every day.</p>
    64. 

  64. <p>This runs the current backend&#8217;s cleanup() method.</p>
    65. 

  65. </dd></dl>
    66. 

  66. 

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

  68. <dt id="celery.task.ExecuteRemoteTask">
    69. 

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

  70. 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>
    71. 

  71. <dd><p>Execute arbitrary function/object.</p>
    72. 

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

  73. defined in the REPL.</p>
    74. 

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

  75. <dt id="celery.task.ExecuteRemoteTask.run">
    76. 

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

  77. <dd>Execute the pickled <tt class="docutils literal"><span class="pre">ser_callable</span></tt>, with <tt class="docutils literal"><span class="pre">fargs</span></tt> as positional
    78. 

  78. arguments and <tt class="docutils literal"><span class="pre">fkwargs</span></tt> as keyword arguments.</dd></dl>
    79. 

  79. 

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

  81. 

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

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

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

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

  86. <dd><p>A periodic task is a task that behaves like a cron job.</p>
    87. 

  87. <p>The <tt class="docutils literal"><span class="pre">run_every</span></tt> attribute defines how often the task is run (its
    88. 

  88. interval), it can be either a <tt class="docutils literal"><span class="pre">datetime.timedelta</span></tt> object or a integer
    89. 

  89. specifying the time in seconds.</p>
    90. 

  90. <p>You have to register the periodic task in the task registry.</p>
    91. 

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

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

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

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

  95. <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>
    96. 

  96. <span class="gp">...</span>
    97. 

  97. <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>
    98. 

  98. <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>
    99. 

  99. <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>
    100. 

  100. <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>
    101. 

  101. </pre></div>
    102. 

  102. </div>
    103. 

  103. </dd></dl>
    104. 

  104. 

  105. <dl class="class">
    106. 

  106. <dt id="celery.task.Task">
    107. 

  107. <em class="property">
    108. 

  108. 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>
    109. 

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

  110. <p>All subclasses of <tt class="docutils literal"><span class="pre">Task</span></tt> has to define the <tt class="docutils literal"><span class="pre">name</span></tt> attribute, which is
    111. 

  111. the name of the task that can be passed to <tt class="docutils literal"><span class="pre">celery.task.delay_task</span></tt>,
    112. 

  112. it also has to define the <tt class="docutils literal"><span class="pre">run</span></tt> method, which is the actual method the
    113. 

  113. <tt class="docutils literal"><span class="pre">celery</span></tt> daemon executes.</p>
    114. 

  114. <p>This is a simple task just logging a message,</p>
    115. 

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

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

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

  118. <span class="gp">...</span>
    119. 

  119. <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>
    120. 

  120. <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>
    121. 

  121. <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>
    122. 

  122. <span class="gp">... </span>                    <span class="n">some_arg</span><span class="p">))</span>
    123. 

  123. <span class="gp">... </span>        <span class="k">return</span> <span class="mf">42</span>
    124. 

  124. <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>
    125. 

  125. </pre></div>
    126. 

  126. </div>
    127. 

  127. <p>You can delay the task using the classmethod <tt class="docutils literal"><span class="pre">delay</span></tt>...</p>
    128. 

  128. <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>
    129. 

  129. <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>
    130. 

  130. <span class="go">&#39;DONE&#39;</span>
    131. 

  131. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">result</span>
    132. 

  132. <span class="go">42</span>
    133. 

  133. </pre></div>
    134. 

  134. </div>
    135. 

  135. <p>...or using the <tt class="docutils literal"><span class="pre">celery.task.delay_task</span></tt> function, by passing the
    136. 

  136. name of the task.</p>
    137. 

  137. <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>
    138. 

  138. <span class="gp">&gt;&gt;&gt; </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>
    139. 

  139. </pre></div>
    140. 

  140. </div>
    141. 

  141. <dl class="classmethod">
    142. 

  142. <dt id="celery.task.Task.delay">
    143. 

  143. <em class="property">
    144. 

  144. 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>
    145. 

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

  146. <table class="docutils field-list" frame="void" rules="none">
    147. 

  147. <col class="field-name" />
    148. 

  148. <col class="field-body" />
    149. 

  149. <tbody valign="top">
    150. 

  150. <tr class="field"><th class="field-name">Return type:</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></td>
    151. 

  151. </tr>
    152. 

  152. </tbody>
    153. 

  153. </table>
    154. 

  154. </dd></dl>
    155. 

  155. 

  156. <dl class="method">
    157. 

  157. <dt id="celery.task.Task.get_consumer">
    158. 

  158. <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>
    159. 

  159. <dd>Get a celery task message consumer.</dd></dl>
    160. 

  160. 

  161. <dl class="method">
    162. 

  162. <dt id="celery.task.Task.get_logger">
    163. 

  163. <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>
    164. 

  164. <dd>Get a process-aware logger object.</dd></dl>
    165. 

  165. 

  166. <dl class="method">
    167. 

  167. <dt id="celery.task.Task.get_publisher">
    168. 

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

  169. <dd>Get a celery task message publisher.</dd></dl>
    170. 

  170. 

  171. <dl class="method">
    172. 

  172. <dt id="celery.task.Task.run">
    173. 

  173. <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>
    174. 

  174. <dd>The actual task. 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
    175. 

  175. the run method, if not a <tt class="docutils literal"><span class="pre">NotImplementedError</span></tt> exception is raised.</dd></dl>
    176. 

  176. 

  177. </dd></dl>
    178. 

  178. 

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

  180. <dt id="celery.task.TaskSet">
    181. 

  181. <em class="property">
    182. 

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

  183. <dd><p>A task containing several subtasks, making it possible
    184. 

  184. to track how many, or when all of the tasks are completed.</p>
    185. 

  185. <blockquote>
    186. 

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

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

  188. <span class="gp">... </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>
    189. 

  189. <span class="gp">... </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>
    190. 

  190. <span class="gp">... </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>
    191. 

  191. </pre></div>
    192. 

  192. </div>
    193. 

  193. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">taskset_id</span><span class="p">,</span> <span class="n">subtask_ids</span> <span class="o">=</span> <span class="n">taskset</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
    194. 

  194. </pre></div>
    195. 

  195. </div>
    196. 

  196. </blockquote>
    197. 

  197. <dl class="method">
    198. 

  198. <dt id="celery.task.TaskSet.iterate">
    199. 

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

  200. <dd><p>Iterate over the results returned after calling <tt class="docutils literal"><span class="pre">run()</span></tt>.</p>
    201. 

  201. <p>If any of the tasks raises an exception, the exception will
    202. 

  202. be reraised by <tt class="docutils literal"><span class="pre">iterate</span></tt>.</p>
    203. 

  203. </dd></dl>
    204. 

  204. 

  205. <dl class="method">
    206. 

  206. <dt id="celery.task.TaskSet.join">
    207. 

  207. <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>
    208. 

  208. <dd><p>Gather the results for all of the tasks in the taskset,
    209. 

  209. and return a list with them ordered by the order of which they
    210. 

  210. were called.</p>
    211. 

  211. <p>If any of the tasks raises an exception, the exception
    212. 

  212. will be reraised by <tt class="docutils literal"><span class="pre">join</span></tt>.</p>
    213. 

  213. <p>If <tt class="docutils literal"><span class="pre">timeout</span></tt> is not <tt class="xref docutils literal"><span class="pre">None</span></tt> and the operation takes
    214. 

  214. longer than <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds, it will raise
    215. 

  215. the <a title="celery.timer.TimeoutError" class="reference external" href="celery.timer.html#celery.timer.TimeoutError"><tt class="xref docutils literal"><span class="pre">celery.timer.TimeoutError</span></tt></a> exception.</p>
    216. 

  216. </dd></dl>
    217. 

  217. 

  218. <dl class="classmethod">
    219. 

  219. <dt id="celery.task.TaskSet.map">
    220. 

  220. <em class="property">
    221. 

  221. 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>
    222. 

  222. <dd>Distribute processing of the arguments and collect the results.</dd></dl>
    223. 

  223. 

  224. <dl class="classmethod">
    225. 

  225. <dt id="celery.task.TaskSet.map_async">
    226. 

  226. <em class="property">
    227. 

  227. 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>
    228. 

  228. <dd><p>Distribute processing of the arguments and collect the results
    229. 

  229. asynchronously.</p>
    230. 

  230. <p>Returns <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.</p>
    231. 

  231. </dd></dl>
    232. 

  232. 

  233. <dl class="classmethod">
    234. 

  234. <dt id="celery.task.TaskSet.remote_execute">
    235. 

  235. <em class="property">
    236. 

  236. 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>
    237. 

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

  238. celery server(s).</dd></dl>
    239. 

  239. 

  240. <dl class="method">
    241. 

  241. <dt id="celery.task.TaskSet.run">
    242. 

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

  243. <dd><p>Run all tasks in the taskset.</p>
    244. 

  244. <p>Returns a tuple with the taskset id, and a list of subtask id&#8217;s.</p>
    245. 

  245. <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">RefreshFeeds</span><span class="p">([</span>
    246. 

  246. <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>
    247. 

  247. <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>
    248. 

  248. <span class="gp">... </span><span class="p">)</span>
    249. 

  249. <span class="gp">&gt;&gt;&gt; </span><span class="n">taskset_id</span><span class="p">,</span> <span class="n">subtask_ids</span> <span class="o">=</span> <span class="n">ts</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
    250. 

  250. <span class="gp">&gt;&gt;&gt; </span><span class="n">taskset_id</span>
    251. 

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

  252. <span class="gp">&gt;&gt;&gt; </span><span class="n">subtask_ids</span>
    253. 

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

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

  255. <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>
    256. 

  256. <span class="gp">&gt;&gt;&gt; </span><span class="n">is_done</span><span class="p">(</span><span class="n">taskset_id</span><span class="p">)</span>
    257. 

  257. <span class="go">True</span>
    258. 

  258. </pre></div>
    259. 

  259. </div>
    260. 

  260. </dd></dl>
    261. 

  261. 

  262. </dd></dl>
    263. 

  263. 

  264. <dl class="function">
    265. 

  265. <dt id="celery.task.delay_task">
    266. 

  266. <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>
    267. 

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

  268. <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>
    269. 

  269. <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>
    270. 

  270. <span class="go">True</span>
    271. 

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

  272. <span class="go">&quot;Record was updated&quot;</span>
    273. 

  273. </pre></div>
    274. 

  274. </div>
    275. 

  275. <p>Raises <a title="celery.registry.NotRegistered" class="reference external" href="celery.registry.html#celery.registry.NotRegistered"><tt class="xref docutils literal"><span class="pre">celery.registry.NotRegistered</span></tt></a> exception if no such task 
    276. 

  276. has been registered in the task registry.</p>
    277. 

  277. <table class="docutils field-list" frame="void" rules="none">
    278. 

  278. <col class="field-name" />
    279. 

  279. <col class="field-body" />
    280. 

  280. <tbody valign="top">
    281. 

  281. <tr class="field"><th class="field-name">Return type:</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>.</td>
    282. 

  282. </tr>
    283. 

  283. </tbody>
    284. 

  284. </table>
    285. 

  285. </dd></dl>
    286. 

  286. 

  287. <dl class="function">
    288. 

  288. <dt id="celery.task.discard_all">
    289. 

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

  290. <dd><p>Discard all waiting tasks.</p>
    291. 

  291. <p>This will ignore all tasks waiting for execution, and they will
    292. 

  292. be deleted from the messaging server.</p>
    293. 

  293. <p>Returns the number of tasks discarded.</p>
    294. 

  294. <table class="docutils field-list" frame="void" rules="none">
    295. 

  295. <col class="field-name" />
    296. 

  296. <col class="field-body" />
    297. 

  297. <tbody valign="top">
    298. 

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

  299. </tr>
    300. 

  300. </tbody>
    301. 

  301. </table>
    302. 

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

  303. 

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

  305. <dt id="celery.task.dmap">
    306. 

  306. <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>
    307. 

  307. <dd><p>Distribute processing of the arguments and collect the results.</p>
    308. 

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

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

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

  311. <span class="go">[4, 8, 16]</span>
    312. 

  312. </pre></div>
    313. 

  313. </div>
    314. 

  314. </dd></dl>
    315. 

  315. 

  316. <dl class="function">
    317. 

  317. <dt id="celery.task.dmap_async">
    318. 

  318. <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>
    319. 

  319. <dd><p>Distribute processing of the arguments and collect the results
    320. 

  320. asynchronously.</p>
    321. 

  321. <p>Returns a <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.</p>
    322. 

  322. <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>
    323. 

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

  324. <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>
    325. 

  325. <span class="gp">&gt;&gt;&gt; </span><span class="n">presult</span>
    326. 

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

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

  328. <span class="go">&#39;DONE&#39;</span>
    329. 

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

  330. <span class="go">[4, 8, 16]</span>
    331. 

  331. </pre></div>
    332. 

  332. </div>
    333. 

  333. </dd></dl>
    334. 

  334. 

  335. <dl class="function">
    336. 

  336. <dt id="celery.task.execute_remote">
    337. 

  337. <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>
    338. 

  338. <dd><p>Execute arbitrary function/object remotely.</p>
    339. 

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

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

  341. <table class="docutils field-list" frame="void" rules="none">
    342. 

  342. <col class="field-name" />
    343. 

  343. <col class="field-body" />
    344. 

  344. <tbody valign="top">
    345. 

  345. <tr class="field"><th class="field-name">Return type:</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></td>
    346. 

  346. </tr>
    347. 

  347. </tbody>
    348. 

  348. </table>
    349. 

  349. </dd></dl>
    350. 

  350. 

  351. <dl class="function">
    352. 

  352. <dt id="celery.task.is_done">
    353. 

  353. <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>
    354. 

  354. <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>
    355. 

  355. <table class="docutils field-list" frame="void" rules="none">
    356. 

  356. <col class="field-name" />
    357. 

  357. <col class="field-body" />
    358. 

  358. <tbody valign="top">
    359. 

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

  360. </tr>
    361. 

  361. </tbody>
    362. 

  362. </table>
    363. 

  363. </dd></dl>
    364. 

  364. 

  365. <dl class="function">
    366. 

  366. <dt id="celery.task.mark_as_done">
    367. 

  367. <tt class="descclassname">celery.task.</tt><tt class="descname">mark_as_done</tt><big>(</big><em>task_id</em>, <em>result</em><big>)</big><a class="headerlink" href="#celery.task.mark_as_done" title="Permalink to this definition">¶</a></dt>
    368. 

  368. <dd>Mark task as done (executed).</dd></dl>
    369. 

  369. 

  370. <dl class="function">
    371. 

  371. <dt id="celery.task.mark_as_failure">
    372. 

  372. <tt class="descclassname">celery.task.</tt><tt class="descname">mark_as_failure</tt><big>(</big><em>task_id</em>, <em>exc</em><big>)</big><a class="headerlink" href="#celery.task.mark_as_failure" title="Permalink to this definition">¶</a></dt>
    373. 

  373. <dd>Mark task as done (executed).</dd></dl>
    374. 

  374. 

  375. </div>
    376. 

  376. 

  377. 

  378.           </div>
    379. 

  379.         </div>
    380. 

  380.       </div>
    381. 

  381.       <div class="sphinxsidebar">
    382. 

  382.         <div class="sphinxsidebarwrapper">
    383. 

  383.             <h4>Previous topic</h4>
    384. 

  384.             <p class="topless"><a href="../index.html"
    385. 

  385.                                   title="previous chapter">Welcome to Celery&#8217;s documentation!</a></p>
    386. 

  386.             <h4>Next topic</h4>
    387. 

  387.             <p class="topless"><a href="celery.result.html"
    388. 

  388.                                   title="next chapter">Task Result - celery.result</a></p>
    389. 

  389.             <h3>This Page</h3>
    390. 

  390.             <ul class="this-page-menu">
    391. 

  391.               <li><a href="../sources/reference/celery.task.txt"
    392. 

  392.                      rel="nofollow">Show Source</a></li>
    393. 

  393.             </ul>
    394. 

  394.           <div id="searchbox" style="display: none">
    395. 

  395.             <h3>Quick search</h3>
    396. 

  396.               <form class="search" action="../search.html" method="get">
    397. 

  397.                 <input type="text" name="q" size="18" />
    398. 

  398.                 <input type="submit" value="Go" />
    399. 

  399.                 <input type="hidden" name="check_keywords" value="yes" />
    400. 

  400.                 <input type="hidden" name="area" value="default" />
    401. 

  401.               </form>
    402. 

  402.               <p class="searchtip" style="font-size: 90%">
    403. 

  403.               Enter search terms or a module, class or function name.
    404. 

  404.               </p>
    405. 

  405.           </div>
    406. 

  406.           <script type="text/javascript">$('#searchbox').show(0);</script>
    407. 

  407.         </div>
    408. 

  408.       </div>
    409. 

  409.       <div class="clearer"></div>
    410. 

  410.     </div>
    411. 

  411.     <div class="related">
    412. 

  412.       <h3>Navigation</h3>
    413. 

  413.       <ul>
    414. 

  414.         <li class="right" style="margin-right: 10px">
    415. 

  415.           <a href="../genindex.html" title="General Index"
    416. 

  416.              >index</a></li>
    417. 

  417.         <li class="right" >
    418. 

  418.           <a href="../modindex.html" title="Global Module Index"
    419. 

  419.              >modules</a> |</li>
    420. 

  420.         <li class="right" >
    421. 

  421.           <a href="celery.result.html" title="Task Result - celery.result"
    422. 

  422.              >next</a> |</li>
    423. 

  423.         <li class="right" >
    424. 

  424.           <a href="../index.html" title="Welcome to Celery’s documentation!"
    425. 

  425.              >previous</a> |</li>
    426. 

  426.         <li><a href="../index.html">Celery v0.1.14 documentation</a> &raquo;</li> 
    427. 

  427.       </ul>
    428. 

  428.     </div>
    429. 

  429.     <div class="footer">
    430. 

  430.       &copy; Copyright 2009, Ask Solem.
    431. 

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

  432.     </div>
    433. 

  433.   </body>
    434. 

  434. </html>
    435.