홈 탐색 도움말
로그인
yangck
/
celery
1
0
포크 0
파일 이슈 0 풀 리퀘스트 0 위키
트리: 5a4c085000
브랜치 태그
celery
/
reference
/
celery.task.html

celery.task.html 44 KB
히스토리 Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672 
  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.15 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.15',
    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.15 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.15 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. <p>Working with tasks and task sets.</p>
    54. 

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

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

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

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

  58. <dd>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
    59. 

  59. <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>.</dd></dl>
    60. 

  60. 

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

  62. <dt id="celery.task.DeleteExpiredTaskMetaTask">
    63. 

  63. <em class="property">
    64. 

  64. 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>
    65. 

  65. <dd><p>A periodic task that deletes expired task metadata every day.</p>
    66. 

  66. <p>This runs the current backend&#8217;s
    67. 

  67. <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>
    68. 

  68. </dd></dl>
    69. 

  69. 

  70. <dl class="class">
    71. 

  71. <dt id="celery.task.ExecuteRemoteTask">
    72. 

  72. <em class="property">
    73. 

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

  74. <dd><p>Execute an arbitrary function or object.</p>
    75. 

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

  76. is an internal component of.</p>
    77. 

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

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

  79. <dl class="method">
    80. 

  80. <dt id="celery.task.ExecuteRemoteTask.run">
    81. 

  81. <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>
    82. 

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

  83. <col class="field-name" />
    84. 

  84. <col class="field-body" />
    85. 

  85. <tbody valign="top">
    86. 

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

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

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

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

  90. </ul>
    91. 

  91. </td>
    92. 

  92. </tr>
    93. 

  93. </tbody>
    94. 

  94. </table>
    95. 

  95. </dd></dl>
    96. 

  96. 

  97. </dd></dl>
    98. 

  98. 

  99. <dl class="class">
    100. 

  100. <dt id="celery.task.PeriodicTask">
    101. 

  101. <em class="property">
    102. 

  102. 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>
    103. 

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

  104. <dl class="attribute">
    105. 

  105. <dt id="celery.task.PeriodicTask.run_every">
    106. 

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

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

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

  109. integer specifying the time in seconds.</dd></dl>
    110. 

  110. 

  111. <table class="docutils field-list" frame="void" rules="none">
    112. 

  112. <col class="field-name" />
    113. 

  113. <col class="field-body" />
    114. 

  114. <tbody valign="top">
    115. 

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

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

  117. not defined.</td>
    118. 

  118. </tr>
    119. 

  119. </tbody>
    120. 

  120. </table>
    121. 

  121. <p>You have to register the periodic task in the task registry.</p>
    122. 

  122. <p>Example</p>
    123. 

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

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

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

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

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

  128. <span class="gp">...</span>
    129. 

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

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

  131. <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>
    132. 

  132. <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>
    133. 

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

  134. </div>
    135. 

  135. </dd></dl>
    136. 

  136. 

  137. <dl class="class">
    138. 

  138. <dt id="celery.task.Task">
    139. 

  139. <em class="property">
    140. 

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

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

  142. <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,
    143. 

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

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

  145. <dl class="attribute">
    146. 

  146. <dt id="celery.task.Task.name">
    147. 

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

  148. <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
    149. 

  149. <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
    150. 

  150. 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>
    151. 

  151. 

  152. <dl class="attribute">
    153. 

  153. <dt id="celery.task.Task.type">
    154. 

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

  155. <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>,
    156. 

  156. however if you want a periodic task, you should subclass
    157. 

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

  158. 

  159. <table class="docutils field-list" frame="void" rules="none">
    160. 

  160. <col class="field-name" />
    161. 

  161. <col class="field-body" />
    162. 

  162. <tbody valign="top">
    163. 

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

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

  165. </tr>
    166. 

  166. </tbody>
    167. 

  167. </table>
    168. 

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

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

  170. <p>Examples</p>
    171. 

  171. <p>This is a simple task just logging a message,</p>
    172. 

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

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

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

  175. <span class="gp">...</span>
    176. 

  176. <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>
    177. 

  177. <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>
    178. 

  178. <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>
    179. 

  179. <span class="gp">... </span>                    <span class="n">some_arg</span><span class="p">))</span>
    180. 

  180. <span class="gp">... </span>        <span class="k">return</span> <span class="mf">42</span>
    181. 

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

  182. </pre></div>
    183. 

  183. </div>
    184. 

  184. <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>
    185. 

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

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

  187. <span class="go">&#39;DONE&#39;</span>
    188. 

  188. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">result</span>
    189. 

  189. <span class="go">42</span>
    190. 

  190. </pre></div>
    191. 

  191. </div>
    192. 

  192. <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
    193. 

  193. the task.</p>
    194. 

  194. <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>
    195. 

  195. <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>
    196. 

  196. </pre></div>
    197. 

  197. </div>
    198. 

  198. <dl class="classmethod">
    199. 

  199. <dt id="celery.task.Task.delay">
    200. 

  200. <em class="property">
    201. 

  201. 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>
    202. 

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

  203. <table class="docutils field-list" frame="void" rules="none">
    204. 

  204. <col class="field-name" />
    205. 

  205. <col class="field-body" />
    206. 

  206. <tbody valign="top">
    207. 

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

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

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

  210. </ul>
    211. 

  211. </td>
    212. 

  212. </tr>
    213. 

  213. <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>
    214. 

  214. </td>
    215. 

  215. </tr>
    216. 

  216. </tbody>
    217. 

  217. </table>
    218. 

  218. <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>
    219. 

  219. </dd></dl>
    220. 

  220. 

  221. <dl class="method">
    222. 

  222. <dt id="celery.task.Task.get_consumer">
    223. 

  223. <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>
    224. 

  224. <dd><p>Get a celery task message consumer.</p>
    225. 

  225. <table class="docutils field-list" frame="void" rules="none">
    226. 

  226. <col class="field-name" />
    227. 

  227. <col class="field-body" />
    228. 

  228. <tbody valign="top">
    229. 

  229. <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>
    230. 

  230. </tr>
    231. 

  231. </tbody>
    232. 

  232. </table>
    233. 

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

  234. with this object. i.e:</p>
    235. 

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

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

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

  238. </pre></div>
    239. 

  239. </div>
    240. 

  240. </dd></dl>
    241. 

  241. 

  242. <dl class="method">
    243. 

  243. <dt id="celery.task.Task.get_logger">
    244. 

  244. <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>
    245. 

  245. <dd><p>Get process-aware logger object.</p>
    246. 

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

  247. </dd></dl>
    248. 

  248. 

  249. <dl class="method">
    250. 

  250. <dt id="celery.task.Task.get_publisher">
    251. 

  251. <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>
    252. 

  252. <dd><p>Get a celery task message publisher.</p>
    253. 

  253. <table class="docutils field-list" frame="void" rules="none">
    254. 

  254. <col class="field-name" />
    255. 

  255. <col class="field-body" />
    256. 

  256. <tbody valign="top">
    257. 

  257. <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>
    258. 

  258. </tr>
    259. 

  259. </tbody>
    260. 

  260. </table>
    261. 

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

  262. with this object, i.e:</p>
    263. 

  263. <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>
    264. 

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

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

  266. </pre></div>
    267. 

  267. </div>
    268. 

  268. </dd></dl>
    269. 

  269. 

  270. <dl class="method">
    271. 

  271. <dt id="celery.task.Task.run">
    272. 

  272. <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>
    273. 

  273. <dd><p><em>REQUIRED</em> The actual task.</p>
    274. 

  274. <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>
    275. 

  275. <table class="docutils field-list" frame="void" rules="none">
    276. 

  276. <col class="field-name" />
    277. 

  277. <col class="field-body" />
    278. 

  278. <tbody valign="top">
    279. 

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

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

  281. this method in your subclass.</td>
    282. 

  282. </tr>
    283. 

  283. </tbody>
    284. 

  284. </table>
    285. 

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

  286. 

  287. </dd></dl>
    288. 

  288. 

  289. <dl class="class">
    290. 

  290. <dt id="celery.task.TaskSet">
    291. 

  291. <em class="property">
    292. 

  292. 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>
    293. 

  293. <dd><p>A task containing several subtasks, making it possible
    294. 

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

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

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

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

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

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

  300. <li><em>task</em> &#8211; The task class or name.
    301. 

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

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

  303. 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>
    304. 

  304. </ul>
    305. 

  305. </td>
    306. 

  306. </tr>
    307. 

  307. </tbody>
    308. 

  308. </table>
    309. 

  309. <dl class="attribute">
    310. 

  310. <dt id="celery.task.TaskSet.task_name">
    311. 

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

  312. <dd>The name of the task.</dd></dl>
    313. 

  313. 

  314. <dl class="attribute">
    315. 

  315. <dt id="celery.task.TaskSet.arguments">
    316. 

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

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

  318. 

  319. <dl class="attribute">
    320. 

  320. <dt id="celery.task.TaskSet.total">
    321. 

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

  322. <dd>Total number of tasks in this task set.</dd></dl>
    323. 

  323. 

  324. <p>Example</p>
    325. 

  325. <blockquote>
    326. 

  326. <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>
    327. 

  327. <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>
    328. 

  328. <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>
    329. 

  329. <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>
    330. 

  330. <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>
    331. 

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

  332. </div>
    333. 

  333. <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>
    334. 

  334. <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>
    335. 

  335. </pre></div>
    336. 

  336. </div>
    337. 

  337. </blockquote>
    338. 

  338. <dl class="method">
    339. 

  339. <dt id="celery.task.TaskSet.iterate">
    340. 

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

  341. <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>
    342. 

  342. <p>If any of the tasks raises an exception, the exception will
    343. 

  343. be re-raised.</p>
    344. 

  344. </dd></dl>
    345. 

  345. 

  346. <dl class="method">
    347. 

  347. <dt id="celery.task.TaskSet.join">
    348. 

  348. <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>
    349. 

  349. <dd><p>Gather the results for all of the tasks in the taskset,
    350. 

  350. and return a list with them ordered by the order of which they
    351. 

  351. were called.</p>
    352. 

  352. <table class="docutils field-list" frame="void" rules="none">
    353. 

  353. <col class="field-name" />
    354. 

  354. <col class="field-body" />
    355. 

  355. <tbody valign="top">
    356. 

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

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

  358. </tr>
    359. 

  359. <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>
    360. 

  360. <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>
    361. 

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

  362. </tr>
    363. 

  363. </tbody>
    364. 

  364. </table>
    365. 

  365. <p>If any of the tasks raises an exception, the exception
    366. 

  366. 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>
    367. 

  367. <table class="docutils field-list" frame="void" rules="none">
    368. 

  368. <col class="field-name" />
    369. 

  369. <col class="field-body" />
    370. 

  370. <tbody valign="top">
    371. 

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

  372. </tr>
    373. 

  373. </tbody>
    374. 

  374. </table>
    375. 

  375. </dd></dl>
    376. 

  376. 

  377. <dl class="classmethod">
    378. 

  378. <dt id="celery.task.TaskSet.map">
    379. 

  379. <em class="property">
    380. 

  380. 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>
    381. 

  381. <dd>Distribute processing of the arguments and collect the results.</dd></dl>
    382. 

  382. 

  383. <dl class="classmethod">
    384. 

  384. <dt id="celery.task.TaskSet.map_async">
    385. 

  385. <em class="property">
    386. 

  386. 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>
    387. 

  387. <dd><p>Distribute processing of the arguments and collect the results
    388. 

  388. asynchronously.</p>
    389. 

  389. <table class="docutils field-list" frame="void" rules="none">
    390. 

  390. <col class="field-name" />
    391. 

  391. <col class="field-body" />
    392. 

  392. <tbody valign="top">
    393. 

  393. <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>
    394. 

  394. </tr>
    395. 

  395. </tbody>
    396. 

  396. </table>
    397. 

  397. </dd></dl>
    398. 

  398. 

  399. <dl class="classmethod">
    400. 

  400. <dt id="celery.task.TaskSet.remote_execute">
    401. 

  401. <em class="property">
    402. 

  402. 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>
    403. 

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

  404. celery server(s).</dd></dl>
    405. 

  405. 

  406. <dl class="method">
    407. 

  407. <dt id="celery.task.TaskSet.run">
    408. 

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

  409. <dd><p>Run all tasks in the taskset.</p>
    410. 

  410. <table class="docutils field-list" frame="void" rules="none">
    411. 

  411. <col class="field-name" />
    412. 

  412. <col class="field-body" />
    413. 

  413. <tbody valign="top">
    414. 

  414. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">A tuple containing the taskset id, and a list
    415. 

  415. of subtask ids.</td>
    416. 

  416. </tr>
    417. 

  417. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">tuple</td>
    418. 

  418. </tr>
    419. 

  419. </tbody>
    420. 

  420. </table>
    421. 

  421. <p>Example</p>
    422. 

  422. <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>
    423. 

  423. <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>
    424. 

  424. <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>
    425. 

  425. <span class="gp">... </span><span class="p">)</span>
    426. 

  426. <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>
    427. 

  427. <span class="gp">&gt;&gt;&gt; </span><span class="n">taskset_id</span>
    428. 

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

  429. <span class="gp">&gt;&gt;&gt; </span><span class="n">subtask_ids</span>
    430. 

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

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

  432. <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>
    433. 

  433. <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>
    434. 

  434. <span class="go">True</span>
    435. 

  435. </pre></div>
    436. 

  436. </div>
    437. 

  437. </dd></dl>
    438. 

  438. 

  439. </dd></dl>
    440. 

  440. 

  441. <dl class="function">
    442. 

  442. <dt id="celery.task.delay_task">
    443. 

  443. <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>
    444. 

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

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

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

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

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

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

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

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

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

  453. </ul>
    454. 

  454. </td>
    455. 

  455. </tr>
    456. 

  456. <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>
    457. 

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

  458. has been registered in the task registry.</p>
    459. 

  459. </td>
    460. 

  460. </tr>
    461. 

  461. <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>
    462. 

  462. </td>
    463. 

  463. </tr>
    464. 

  464. </tbody>
    465. 

  465. </table>
    466. 

  466. <p>Example</p>
    467. 

  467. <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>
    468. 

  468. <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>
    469. 

  469. <span class="go">True</span>
    470. 

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

  471. <span class="go">&quot;Record was updated&quot;</span>
    472. 

  472. </pre></div>
    473. 

  473. </div>
    474. 

  474. </dd></dl>
    475. 

  475. 

  476. <dl class="function">
    477. 

  477. <dt id="celery.task.discard_all">
    478. 

  478. <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>
    479. 

  479. <dd><p>Discard all waiting tasks.</p>
    480. 

  480. <p>This will ignore all tasks waiting for execution, and they will
    481. 

  481. be deleted from the messaging server.</p>
    482. 

  482. <table class="docutils field-list" frame="void" rules="none">
    483. 

  483. <col class="field-name" />
    484. 

  484. <col class="field-body" />
    485. 

  485. <tbody valign="top">
    486. 

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

  487. </tr>
    488. 

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

  489. </tr>
    490. 

  490. </tbody>
    491. 

  491. </table>
    492. 

  492. </dd></dl>
    493. 

  493. 

  494. <dl class="function">
    495. 

  495. <dt id="celery.task.dmap">
    496. 

  496. <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>
    497. 

  497. <dd><p>Distribute processing of the arguments and collect the results.</p>
    498. 

  498. <p>Example</p>
    499. 

  499. <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>
    500. 

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

  501. <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>
    502. 

  502. <span class="go">[4, 8, 16]</span>
    503. 

  503. </pre></div>
    504. 

  504. </div>
    505. 

  505. </dd></dl>
    506. 

  506. 

  507. <dl class="function">
    508. 

  508. <dt id="celery.task.dmap_async">
    509. 

  509. <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>
    510. 

  510. <dd><p>Distribute processing of the arguments and collect the results
    511. 

  511. asynchronously.</p>
    512. 

  512. <table class="docutils field-list" frame="void" rules="none">
    513. 

  513. <col class="field-name" />
    514. 

  514. <col class="field-body" />
    515. 

  515. <tbody valign="top">
    516. 

  516. <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>
    517. 

  517. </tr>
    518. 

  518. </tbody>
    519. 

  519. </table>
    520. 

  520. <p>Example</p>
    521. 

  521. <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>
    522. 

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

  523. <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>
    524. 

  524. <span class="gp">&gt;&gt;&gt; </span><span class="n">presult</span>
    525. 

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

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

  527. <span class="go">&#39;DONE&#39;</span>
    528. 

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

  529. <span class="go">[4, 8, 16]</span>
    530. 

  530. </pre></div>
    531. 

  531. </div>
    532. 

  532. </dd></dl>
    533. 

  533. 

  534. <dl class="function">
    535. 

  535. <dt id="celery.task.execute_remote">
    536. 

  536. <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>
    537. 

  537. <dd><p>Execute arbitrary function/object remotely.</p>
    538. 

  538. <table class="docutils field-list" frame="void" rules="none">
    539. 

  539. <col class="field-name" />
    540. 

  540. <col class="field-body" />
    541. 

  541. <tbody valign="top">
    542. 

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

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

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

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

  546. </ul>
    547. 

  547. </td>
    548. 

  548. </tr>
    549. 

  549. </tbody>
    550. 

  550. </table>
    551. 

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

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

  553. <table class="docutils field-list" frame="void" rules="none">
    554. 

  554. <col class="field-name" />
    555. 

  555. <col class="field-body" />
    556. 

  556. <tbody valign="top">
    557. 

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

  558. </tr>
    559. 

  559. </tbody>
    560. 

  560. </table>
    561. 

  561. </dd></dl>
    562. 

  562. 

  563. <dl class="function">
    564. 

  564. <dt id="celery.task.is_done">
    565. 

  565. <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>
    566. 

  566. <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>
    567. 

  567. <table class="docutils field-list" frame="void" rules="none">
    568. 

  568. <col class="field-name" />
    569. 

  569. <col class="field-body" />
    570. 

  570. <tbody valign="top">
    571. 

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

  572. </tr>
    573. 

  573. </tbody>
    574. 

  574. </table>
    575. 

  575. </dd></dl>
    576. 

  576. 

  577. <dl class="function">
    578. 

  578. <dt id="celery.task.mark_as_done">
    579. 

  579. <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>
    580. 

  580. <dd><p>Mark task as done (executed successfully).</p>
    581. 

  581. <table class="docutils field-list" frame="void" rules="none">
    582. 

  582. <col class="field-name" />
    583. 

  583. <col class="field-body" />
    584. 

  584. <tbody valign="top">
    585. 

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

  586. <li><em>task_id</em> &#8211; id of the task.</li>
    587. 

  587. <li><em>result</em> &#8211; the return value of the task.</li>
    588. 

  588. </ul>
    589. 

  589. </td>
    590. 

  590. </tr>
    591. 

  591. </tbody>
    592. 

  592. </table>
    593. 

  593. </dd></dl>
    594. 

  594. 

  595. <dl class="function">
    596. 

  596. <dt id="celery.task.mark_as_failure">
    597. 

  597. <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>
    598. 

  598. <dd><p>Mark task as done (executed).</p>
    599. 

  599. <table class="docutils field-list" frame="void" rules="none">
    600. 

  600. <col class="field-name" />
    601. 

  601. <col class="field-body" />
    602. 

  602. <tbody valign="top">
    603. 

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

  604. <li><em>task_id</em> &#8211; id of the task.</li>
    605. 

  605. <li><em>exc</em> &#8211; the exception instance raised by the task.</li>
    606. 

  606. </ul>
    607. 

  607. </td>
    608. 

  608. </tr>
    609. 

  609. </tbody>
    610. 

  610. </table>
    611. 

  611. </dd></dl>
    612. 

  612. 

  613. </div>
    614. 

  614. 

  615. 

  616.           </div>
    617. 

  617.         </div>
    618. 

  618.       </div>
    619. 

  619.       <div class="sphinxsidebar">
    620. 

  620.         <div class="sphinxsidebarwrapper">
    621. 

  621.             <h4>Previous topic</h4>
    622. 

  622.             <p class="topless"><a href="../index.html"
    623. 

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

  624.             <h4>Next topic</h4>
    625. 

  625.             <p class="topless"><a href="celery.result.html"
    626. 

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

  627.             <h3>This Page</h3>
    628. 

  628.             <ul class="this-page-menu">
    629. 

  629.               <li><a href="../sources/reference/celery.task.txt"
    630. 

  630.                      rel="nofollow">Show Source</a></li>
    631. 

  631.             </ul>
    632. 

  632.           <div id="searchbox" style="display: none">
    633. 

  633.             <h3>Quick search</h3>
    634. 

  634.               <form class="search" action="../search.html" method="get">
    635. 

  635.                 <input type="text" name="q" size="18" />
    636. 

  636.                 <input type="submit" value="Go" />
    637. 

  637.                 <input type="hidden" name="check_keywords" value="yes" />
    638. 

  638.                 <input type="hidden" name="area" value="default" />
    639. 

  639.               </form>
    640. 

  640.               <p class="searchtip" style="font-size: 90%">
    641. 

  641.               Enter search terms or a module, class or function name.
    642. 

  642.               </p>
    643. 

  643.           </div>
    644. 

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

  645.         </div>
    646. 

  646.       </div>
    647. 

  647.       <div class="clearer"></div>
    648. 

  648.     </div>
    649. 

  649.     <div class="related">
    650. 

  650.       <h3>Navigation</h3>
    651. 

  651.       <ul>
    652. 

  652.         <li class="right" style="margin-right: 10px">
    653. 

  653.           <a href="../genindex.html" title="General Index"
    654. 

  654.              >index</a></li>
    655. 

  655.         <li class="right" >
    656. 

  656.           <a href="../modindex.html" title="Global Module Index"
    657. 

  657.              >modules</a> |</li>
    658. 

  658.         <li class="right" >
    659. 

  659.           <a href="celery.result.html" title="Task Result - celery.result"
    660. 

  660.              >next</a> |</li>
    661. 

  661.         <li class="right" >
    662. 

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

  663.              >previous</a> |</li>
    664. 

  664.         <li><a href="../index.html">Celery v0.1.15 documentation</a> &raquo;</li> 
    665. 

  665.       </ul>
    666. 

  666.     </div>
    667. 

  667.     <div class="footer">
    668. 

  668.       &copy; Copyright 2009, Ask Solem.
    669. 

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

  670.     </div>
    671. 

  671.   </body>
    672. 

  672. </html>
    673.