Home Explore Help
Sign In
yangck
/
celery
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: e553d3578c
Branches Tags
celery
/
reference
/
celery.worker.html

celery.worker.html 26 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429 
  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>Multiprocessing Worker - celery.worker &mdash; Celery v0.2.0-pre3 documentation</title>
    9. 

  9.     <link rel="stylesheet" href="../static/agogo.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
    11. 

  11.     <script type="text/javascript">
    12. 

  12.       var DOCUMENTATION_OPTIONS = {
    13. 

  13.       URL_ROOT:    '../',
    14. 

  14.       VERSION:     '0.2.0-pre3',
    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.2.0-pre3 documentation" href="../index.html" />
    23. 

  23.     <link rel="next" title="Backends - celery.backends" href="celery.backends.html" />
    24. 

  24.     <link rel="prev" title="Task Discovery - celery.discovery" href="celery.discovery.html" /> 
    25. 

  25.   </head>
    26. 

  26.   <body>
    27. 

  27. 

  28.     <div class="header-wrapper">
    29. 

  29.       <div class="header">
    30. 

  30. 	<h1><a href="../index.html">Celery v0.2.0-pre3 documentation</a></h1>
    31. 

  31. 	<div class="rel">
    32. 

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

  33.              accesskey="I">index</a> |
    34. 

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

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

  36.           <a href="celery.backends.html" title="Backends - celery.backends"
    37. 

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

  38.           <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
    39. 

  39.              accesskey="P">previous</a>
    40. 

  40. 	</div>
    41. 

  41.       </div>
    42. 

  42.     </div>
    43. 

  43. 

  44.     <div class="content-wrapper">
    45. 

  45.       <div class="content">
    46. 

  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.worker">
    52. 

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

  53. <p>celery.worker</p>
    54. 

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

  55. <dt id="celery.worker.EmptyQueue">
    56. 

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

  57. exception </em><tt class="descclassname">celery.worker.</tt><tt class="descname">EmptyQueue</tt><a class="headerlink" href="#celery.worker.EmptyQueue" title="Permalink to this definition">¶</a></dt>
    58. 

  58. <dd>The message queue is currently empty.</dd></dl>
    59. 

  59. 

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

  61. <dt id="celery.worker.TaskDaemon">
    62. 

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

  63. class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">TaskDaemon</tt><big>(</big><em>concurrency=None</em>, <em>logfile=None</em>, <em>loglevel=None</em>, <em>queue_wakeup_after=None</em><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon" title="Permalink to this definition">¶</a></dt>
    64. 

  64. <dd><p>Executes tasks waiting in the task queue.</p>
    65. 

  65. <table class="docutils field-list" frame="void" rules="none">
    66. 

  66. <col class="field-name" />
    67. 

  67. <col class="field-body" />
    68. 

  68. <tbody valign="top">
    69. 

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

  70. <li><em>concurrency</em> &#8211; see <a title="celery.worker.TaskDaemon.concurrency" class="reference internal" href="#celery.worker.TaskDaemon.concurrency"><tt class="xref docutils literal"><span class="pre">concurrency</span></tt></a>.</li>
    71. 

  71. <li><em>logfile</em> &#8211; see <a title="celery.worker.TaskDaemon.logfile" class="reference internal" href="#celery.worker.TaskDaemon.logfile"><tt class="xref docutils literal"><span class="pre">logfile</span></tt></a>.</li>
    72. 

  72. <li><em>loglevel</em> &#8211; see <a title="celery.worker.TaskDaemon.loglevel" class="reference internal" href="#celery.worker.TaskDaemon.loglevel"><tt class="xref docutils literal"><span class="pre">loglevel</span></tt></a>.</li>
    73. 

  73. <li><em>queue_wakeup_after</em> &#8211; see <a title="celery.worker.TaskDaemon.queue_wakeup_after" class="reference internal" href="#celery.worker.TaskDaemon.queue_wakeup_after"><tt class="xref docutils literal"><span class="pre">queue_wakeup_after</span></tt></a>.</li>
    74. 

  74. </ul>
    75. 

  75. </td>
    76. 

  76. </tr>
    77. 

  77. </tbody>
    78. 

  78. </table>
    79. 

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

  80. <dt id="celery.worker.TaskDaemon.concurrency">
    81. 

  81. <tt class="descname">concurrency</tt><a class="headerlink" href="#celery.worker.TaskDaemon.concurrency" title="Permalink to this definition">¶</a></dt>
    82. 

  82. <dd>The number of simultaneous processes doing work (default:
    83. 

  83. <a title="celery.conf.DAEMON_CONCURRENCY" class="reference external" href="celery.conf.html#celery.conf.DAEMON_CONCURRENCY"><tt class="xref docutils literal"><span class="pre">celery.conf.DAEMON_CONCURRENCY</span></tt></a>)</dd></dl>
    84. 

  84. 

  85. <dl class="attribute">
    86. 

  86. <dt id="celery.worker.TaskDaemon.loglevel">
    87. 

  87. <tt class="descname">loglevel</tt><a class="headerlink" href="#celery.worker.TaskDaemon.loglevel" title="Permalink to this definition">¶</a></dt>
    88. 

  88. <dd>The loglevel used (default: <tt class="xref docutils literal"><span class="pre">logging.INFO</span></tt>)</dd></dl>
    89. 

  89. 

  90. <dl class="attribute">
    91. 

  91. <dt id="celery.worker.TaskDaemon.logfile">
    92. 

  92. <tt class="descname">logfile</tt><a class="headerlink" href="#celery.worker.TaskDaemon.logfile" title="Permalink to this definition">¶</a></dt>
    93. 

  93. <dd>The logfile used, if no logfile is specified it uses <tt class="docutils literal"><span class="pre">stderr</span></tt>
    94. 

  94. (default: <a title="celery.conf.DAEMON_LOG_FILE" class="reference external" href="celery.conf.html#celery.conf.DAEMON_LOG_FILE"><tt class="xref docutils literal"><span class="pre">celery.conf.DAEMON_LOG_FILE</span></tt></a>).</dd></dl>
    95. 

  95. 

  96. <dl class="attribute">
    97. 

  97. <dt id="celery.worker.TaskDaemon.queue_wakeup_after">
    98. 

  98. <tt class="descname">queue_wakeup_after</tt><a class="headerlink" href="#celery.worker.TaskDaemon.queue_wakeup_after" title="Permalink to this definition">¶</a></dt>
    99. 

  99. <dd>The time it takes for the daemon to wake up after the queue is empty,
    100. 

  100. so it can check for more work
    101. 

  101. (default: <a title="celery.conf.QUEUE_WAKEUP_AFTER" class="reference external" href="celery.conf.html#celery.conf.QUEUE_WAKEUP_AFTER"><tt class="xref docutils literal"><span class="pre">celery.conf.QUEUE_WAKEUP_AFTER</span></tt></a>).</dd></dl>
    102. 

  102. 

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

  104. <dt id="celery.worker.TaskDaemon.empty_msg_emit_every">
    105. 

  105. <tt class="descname">empty_msg_emit_every</tt><a class="headerlink" href="#celery.worker.TaskDaemon.empty_msg_emit_every" title="Permalink to this definition">¶</a></dt>
    106. 

  106. <dd>How often the daemon emits the <tt class="docutils literal"><span class="pre">&quot;Waiting</span> <span class="pre">for</span> <span class="pre">queue...&quot;</span></tt> message.
    107. 

  107. If this is <tt class="xref docutils literal"><span class="pre">None</span></tt>, the message will never be logged.
    108. 

  108. (default: <a title="celery.conf.EMPTY_MSG_EMIT_EVERY" class="reference external" href="celery.conf.html#celery.conf.EMPTY_MSG_EMIT_EVERY"><tt class="xref docutils literal"><span class="pre">celery.conf.EMPTY_MSG_EMIT_EVERY</span></tt></a>)</dd></dl>
    109. 

  109. 

  110. <dl class="attribute">
    111. 

  111. <dt id="celery.worker.TaskDaemon.logger">
    112. 

  112. <tt class="descname">logger</tt><a class="headerlink" href="#celery.worker.TaskDaemon.logger" title="Permalink to this definition">¶</a></dt>
    113. 

  113. <dd>The <tt class="xref docutils literal"><span class="pre">logging.Logger</span></tt> instance used for logging.</dd></dl>
    114. 

  114. 

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

  116. <dt id="celery.worker.TaskDaemon.pool">
    117. 

  117. <tt class="descname">pool</tt><a class="headerlink" href="#celery.worker.TaskDaemon.pool" title="Permalink to this definition">¶</a></dt>
    118. 

  118. <dd>The <tt class="xref docutils literal"><span class="pre">multiprocessing.Pool</span></tt> instance used.</dd></dl>
    119. 

  119. 

  120. <dl class="attribute">
    121. 

  121. <dt id="celery.worker.TaskDaemon.task_consumer">
    122. 

  122. <tt class="descname">task_consumer</tt><a class="headerlink" href="#celery.worker.TaskDaemon.task_consumer" title="Permalink to this definition">¶</a></dt>
    123. 

  123. <dd>The <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> instance used.</dd></dl>
    124. 

  124. 

  125. <dl class="method">
    126. 

  126. <dt id="celery.worker.TaskDaemon.connection_diagnostics">
    127. 

  127. <tt class="descname">connection_diagnostics</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.connection_diagnostics" title="Permalink to this definition">¶</a></dt>
    128. 

  128. <dd>Diagnose the AMQP connection, and reset connection if
    129. 

  129. necessary.</dd></dl>
    130. 

  130. 

  131. <dl class="method">
    132. 

  132. <dt id="celery.worker.TaskDaemon.execute_next_task">
    133. 

  133. <tt class="descname">execute_next_task</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.execute_next_task" title="Permalink to this definition">¶</a></dt>
    134. 

  134. <dd><p>Execute the next task on the queue using the multiprocessing pool.</p>
    135. 

  135. <p>Catches all exceptions and logs them with level
    136. 

  136. <tt class="xref docutils literal"><span class="pre">logging.CRITICAL</span></tt>.</p>
    137. 

  137. </dd></dl>
    138. 

  138. 

  139. <dl class="method">
    140. 

  140. <dt id="celery.worker.TaskDaemon.fetch_next_task">
    141. 

  141. <tt class="descname">fetch_next_task</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.fetch_next_task" title="Permalink to this definition">¶</a></dt>
    142. 

  142. <dd><p>Fetch the next task from the AMQP broker.</p>
    143. 

  143. <p>Raises <a title="celery.worker.EmptyQueue" class="reference internal" href="#celery.worker.EmptyQueue"><tt class="xref docutils literal"><span class="pre">EmptyQueue</span></tt></a> exception if there is no message
    144. 

  144. waiting on the queue.</p>
    145. 

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

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

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

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

  149. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a title="celery.worker.TaskWrapper" class="reference internal" href="#celery.worker.TaskWrapper"><tt class="xref docutils literal"><span class="pre">TaskWrapper</span></tt></a> instance.</td>
    150. 

  150. </tr>
    151. 

  151. </tbody>
    152. 

  152. </table>
    153. 

  153. </dd></dl>
    154. 

  154. 

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

  156. <dt id="celery.worker.TaskDaemon.receive_message">
    157. 

  157. <tt class="descname">receive_message</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.receive_message" title="Permalink to this definition">¶</a></dt>
    158. 

  158. <dd><p>Receive the next message from the message broker.</p>
    159. 

  159. <p>Tries to reset the AMQP connection if not available.
    160. 

  160. Returns <tt class="xref docutils literal"><span class="pre">None</span></tt> if no message is waiting on the queue.</p>
    161. 

  161. <table class="docutils field-list" frame="void" rules="none">
    162. 

  162. <col class="field-name" />
    163. 

  163. <col class="field-body" />
    164. 

  164. <tbody valign="top">
    165. 

  165. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref docutils literal"><span class="pre">carrot.messaging.Message</span></tt> instance.</td>
    166. 

  166. </tr>
    167. 

  167. </tbody>
    168. 

  168. </table>
    169. 

  169. </dd></dl>
    170. 

  170. 

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

  172. <dt id="celery.worker.TaskDaemon.reset_connection">
    173. 

  173. <tt class="descname">reset_connection</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.reset_connection" title="Permalink to this definition">¶</a></dt>
    174. 

  174. <dd><p>Reset the AMQP connection, and reinitialize the
    175. 

  175. <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> instance.</p>
    176. 

  176. <p>Resets the task consumer in <a title="celery.worker.TaskDaemon.task_consumer" class="reference internal" href="#celery.worker.TaskDaemon.task_consumer"><tt class="xref docutils literal"><span class="pre">task_consumer</span></tt></a>.</p>
    177. 

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

  178. 

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

  180. <dt id="celery.worker.TaskDaemon.run">
    181. 

  181. <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.run" title="Permalink to this definition">¶</a></dt>
    182. 

  182. <dd>Starts the workers main loop.</dd></dl>
    183. 

  183. 

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

  185. <dt id="celery.worker.TaskDaemon.run_periodic_tasks">
    186. 

  186. <tt class="descname">run_periodic_tasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.run_periodic_tasks" title="Permalink to this definition">¶</a></dt>
    187. 

  187. <dd><p>Schedule all waiting periodic tasks for execution.</p>
    188. 

  188. <table class="docutils field-list" frame="void" rules="none">
    189. 

  189. <col class="field-name" />
    190. 

  190. <col class="field-body" />
    191. 

  191. <tbody valign="top">
    192. 

  192. <tr class="field"><th class="field-name">Return type:</th><td class="field-body">list of <tt class="xref docutils literal"><span class="pre">celery.models.PeriodicTaskMeta</span></tt> objects.</td>
    193. 

  193. </tr>
    194. 

  194. </tbody>
    195. 

  195. </table>
    196. 

  196. </dd></dl>
    197. 

  197. 

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

  199. <dt id="celery.worker.TaskDaemon.schedule_retry_tasks">
    200. 

  200. <tt class="descname">schedule_retry_tasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.TaskDaemon.schedule_retry_tasks" title="Permalink to this definition">¶</a></dt>
    201. 

  201. <dd>Reschedule all requeued tasks waiting for retry.</dd></dl>
    202. 

  202. 

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

  204. 

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

  206. <dt id="celery.worker.TaskWrapper">
    207. 

  207. <em class="property">
    208. 

  208. class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">TaskWrapper</tt><big>(</big><em>task_name</em>, <em>task_id</em>, <em>task_func</em>, <em>args</em>, <em>kwargs</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper" title="Permalink to this definition">¶</a></dt>
    209. 

  209. <dd><p>Class wrapping a task to be run.</p>
    210. 

  210. <table class="docutils field-list" frame="void" rules="none">
    211. 

  211. <col class="field-name" />
    212. 

  212. <col class="field-body" />
    213. 

  213. <tbody valign="top">
    214. 

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

  215. <li><em>task_name</em> &#8211; see <a title="celery.worker.TaskWrapper.task_name" class="reference internal" href="#celery.worker.TaskWrapper.task_name"><tt class="xref docutils literal"><span class="pre">task_name</span></tt></a>.</li>
    216. 

  216. <li><em>task_id</em> &#8211; see <a title="celery.worker.TaskWrapper.task_id" class="reference internal" href="#celery.worker.TaskWrapper.task_id"><tt class="xref docutils literal"><span class="pre">task_id</span></tt></a>.</li>
    217. 

  217. <li><em>task_func</em> &#8211; see <a title="celery.worker.TaskWrapper.task_func" class="reference internal" href="#celery.worker.TaskWrapper.task_func"><tt class="xref docutils literal"><span class="pre">task_func</span></tt></a></li>
    218. 

  218. <li><em>args</em> &#8211; see <a title="celery.worker.TaskWrapper.args" class="reference internal" href="#celery.worker.TaskWrapper.args"><tt class="xref docutils literal"><span class="pre">args</span></tt></a></li>
    219. 

  219. <li><em>kwargs</em> &#8211; see <a title="celery.worker.TaskWrapper.kwargs" class="reference internal" href="#celery.worker.TaskWrapper.kwargs"><tt class="xref docutils literal"><span class="pre">kwargs</span></tt></a>.</li>
    220. 

  220. </ul>
    221. 

  221. </td>
    222. 

  222. </tr>
    223. 

  223. </tbody>
    224. 

  224. </table>
    225. 

  225. <dl class="attribute">
    226. 

  226. <dt id="celery.worker.TaskWrapper.task_name">
    227. 

  227. <tt class="descname">task_name</tt><a class="headerlink" href="#celery.worker.TaskWrapper.task_name" title="Permalink to this definition">¶</a></dt>
    228. 

  228. <dd>Kind of task. Must be a name registered in the task registry.</dd></dl>
    229. 

  229. 

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

  231. <dt id="celery.worker.TaskWrapper.task_id">
    232. 

  232. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.worker.TaskWrapper.task_id" title="Permalink to this definition">¶</a></dt>
    233. 

  233. <dd>UUID of the task.</dd></dl>
    234. 

  234. 

  235. <dl class="attribute">
    236. 

  236. <dt id="celery.worker.TaskWrapper.task_func">
    237. 

  237. <tt class="descname">task_func</tt><a class="headerlink" href="#celery.worker.TaskWrapper.task_func" title="Permalink to this definition">¶</a></dt>
    238. 

  238. <dd>The tasks callable object.</dd></dl>
    239. 

  239. 

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

  241. <dt id="celery.worker.TaskWrapper.args">
    242. 

  242. <tt class="descname">args</tt><a class="headerlink" href="#celery.worker.TaskWrapper.args" title="Permalink to this definition">¶</a></dt>
    243. 

  243. <dd>List of positional arguments to apply to the task.</dd></dl>
    244. 

  244. 

  245. <dl class="attribute">
    246. 

  246. <dt id="celery.worker.TaskWrapper.kwargs">
    247. 

  247. <tt class="descname">kwargs</tt><a class="headerlink" href="#celery.worker.TaskWrapper.kwargs" title="Permalink to this definition">¶</a></dt>
    248. 

  248. <dd>Mapping of keyword arguments to apply to the task.</dd></dl>
    249. 

  249. 

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

  251. <dt id="celery.worker.TaskWrapper.execute">
    252. 

  252. <tt class="descname">execute</tt><big>(</big><em>loglevel=None</em>, <em>logfile=None</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.execute" title="Permalink to this definition">¶</a></dt>
    253. 

  253. <dd><p>Execute the task in a <a title="celery.worker.jail" class="reference internal" href="#celery.worker.jail"><tt class="xref docutils literal"><span class="pre">jail()</span></tt></a> and store return value
    254. 

  254. and status in the task meta backend.</p>
    255. 

  255. <table class="docutils field-list" frame="void" rules="none">
    256. 

  256. <col class="field-name" />
    257. 

  257. <col class="field-body" />
    258. 

  258. <tbody valign="top">
    259. 

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

  260. <li><em>loglevel</em> &#8211; The loglevel used by the task.</li>
    261. 

  261. <li><em>logfile</em> &#8211; The logfile used by the task.</li>
    262. 

  262. </ul>
    263. 

  263. </td>
    264. 

  264. </tr>
    265. 

  265. </tbody>
    266. 

  266. </table>
    267. 

  267. </dd></dl>
    268. 

  268. 

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

  270. <dt id="celery.worker.TaskWrapper.execute_using_pool">
    271. 

  271. <tt class="descname">execute_using_pool</tt><big>(</big><em>pool</em>, <em>loglevel=None</em>, <em>logfile=None</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.execute_using_pool" title="Permalink to this definition">¶</a></dt>
    272. 

  272. <dd><p>Like <a title="celery.worker.TaskWrapper.execute" class="reference internal" href="#celery.worker.TaskWrapper.execute"><tt class="xref docutils literal"><span class="pre">execute()</span></tt></a>, but using the <tt class="xref docutils literal"><span class="pre">multiprocessing</span></tt> pool.</p>
    273. 

  273. <table class="docutils field-list" frame="void" rules="none">
    274. 

  274. <col class="field-name" />
    275. 

  275. <col class="field-body" />
    276. 

  276. <tbody valign="top">
    277. 

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

  278. <li><em>pool</em> &#8211; A <tt class="xref docutils literal"><span class="pre">multiprocessing.Pool</span></tt> instance.</li>
    279. 

  279. <li><em>loglevel</em> &#8211; The loglevel used by the task.</li>
    280. 

  280. <li><em>logfile</em> &#8211; The logfile used by the task.</li>
    281. 

  281. </ul>
    282. 

  282. </td>
    283. 

  283. </tr>
    284. 

  284. </tbody>
    285. 

  285. </table>
    286. 

  286. <p>:returns <tt class="xref docutils literal"><span class="pre">multiprocessing.AsyncResult</span></tt> instance.</p>
    287. 

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

  288. 

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

  290. <dt id="celery.worker.TaskWrapper.extend_with_default_kwargs">
    291. 

  291. <tt class="descname">extend_with_default_kwargs</tt><big>(</big><em>loglevel</em>, <em>logfile</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.extend_with_default_kwargs" title="Permalink to this definition">¶</a></dt>
    292. 

  292. <dd><p>Extend the tasks keyword arguments with standard task arguments.</p>
    293. 

  293. <p>These are <tt class="docutils literal"><span class="pre">logfile</span></tt>, <tt class="docutils literal"><span class="pre">loglevel</span></tt>, <tt class="docutils literal"><span class="pre">task_id</span></tt> and <tt class="docutils literal"><span class="pre">task_name</span></tt>.</p>
    294. 

  294. </dd></dl>
    295. 

  295. 

  296. <dl class="classmethod">
    297. 

  297. <dt id="celery.worker.TaskWrapper.from_message">
    298. 

  298. <em class="property">
    299. 

  299. classmethod </em><tt class="descname">from_message</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.from_message" title="Permalink to this definition">¶</a></dt>
    300. 

  300. <dd><p>Create a <a title="celery.worker.TaskWrapper" class="reference internal" href="#celery.worker.TaskWrapper"><tt class="xref docutils literal"><span class="pre">TaskWrapper</span></tt></a> from a task message sent by
    301. 

  301. <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>.</p>
    302. 

  302. <table class="docutils field-list" frame="void" rules="none">
    303. 

  303. <col class="field-name" />
    304. 

  304. <col class="field-body" />
    305. 

  305. <tbody valign="top">
    306. 

  306. <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.worker.UnknownTask" class="reference internal" href="#celery.worker.UnknownTask">UnknownTask</a>:</th></tr>
    307. 

  307. <tr><td>&nbsp;</td><td class="field-body">if the message does not describe a task,
    308. 

  308. the message is also rejected.</td>
    309. 

  309. </tr>
    310. 

  310. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a title="celery.worker.TaskWrapper" class="reference internal" href="#celery.worker.TaskWrapper"><tt class="xref docutils literal"><span class="pre">TaskWrapper</span></tt></a> instance.</td>
    311. 

  311. </tr>
    312. 

  312. </tbody>
    313. 

  313. </table>
    314. 

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

  315. 

  316. </dd></dl>
    317. 

  317. 

  318. <dl class="exception">
    319. 

  319. <dt id="celery.worker.UnknownTask">
    320. 

  320. <em class="property">
    321. 

  321. exception </em><tt class="descclassname">celery.worker.</tt><tt class="descname">UnknownTask</tt><a class="headerlink" href="#celery.worker.UnknownTask" title="Permalink to this definition">¶</a></dt>
    322. 

  322. <dd>Got an unknown task in the queue. The message is requeued and
    323. 

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

  324. 

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

  326. <dt id="celery.worker.jail">
    327. 

  327. <tt class="descclassname">celery.worker.</tt><tt class="descname">jail</tt><big>(</big><em>task_id</em>, <em>func</em>, <em>args</em>, <em>kwargs</em><big>)</big><a class="headerlink" href="#celery.worker.jail" title="Permalink to this definition">¶</a></dt>
    328. 

  328. <dd><p>Wraps the task in a jail, which catches all exceptions, and 
    329. 

  329. saves the status and result of the task execution to the task
    330. 

  330. meta backend.</p>
    331. 

  331. <p>If the call was successful, it saves the result to the task result
    332. 

  332. backend, and sets the task status to <tt class="docutils literal"><span class="pre">&quot;DONE&quot;</span></tt>.</p>
    333. 

  333. <p>If the call results in an exception, it saves the exception as the task
    334. 

  334. result, and sets the task status to <tt class="docutils literal"><span class="pre">&quot;FAILURE&quot;</span></tt>.</p>
    335. 

  335. <table class="docutils field-list" frame="void" rules="none">
    336. 

  336. <col class="field-name" />
    337. 

  337. <col class="field-body" />
    338. 

  338. <tbody valign="top">
    339. 

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

  340. <li><em>task_id</em> &#8211; The id of the task.</li>
    341. 

  341. <li><em>func</em> &#8211; Callable object to execute.</li>
    342. 

  342. <li><em>args</em> &#8211; List of positional args to pass on to the function.</li>
    343. 

  343. <li><em>kwargs</em> &#8211; Keyword arguments mapping to pass on to the function.</li>
    344. 

  344. </ul>
    345. 

  345. </td>
    346. 

  346. </tr>
    347. 

  347. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the function return value on success.</p>
    348. 

  348. </td>
    349. 

  349. </tr>
    350. 

  350. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the exception instance on failure.</p>
    351. 

  351. </td>
    352. 

  352. </tr>
    353. 

  353. </tbody>
    354. 

  354. </table>
    355. 

  355. </dd></dl>
    356. 

  356. 

  357. </div>
    358. 

  358. 

  359. 

  360. 	      </div>
    361. 

  361. 	    </div>
    362. 

  362. 	  </div>
    363. 

  363. 	</div>
    364. 

  364. 	<div class="sidebar">
    365. 

  365. 	  <h3>Contents</h3>
    366. 

  366. 	  <ul class="current">
    367. 

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

  368. <li class="toctree-l1"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
    369. 

  369. <li class="toctree-l1"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
    370. 

  370. <li class="toctree-l1"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
    371. 

  371. <li class="toctree-l1"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
    372. 

  372. <li class="toctree-l1 current"><a class="current reference external" href="">Multiprocessing Worker - celery.worker</a></li>
    373. 

  373. <li class="toctree-l1"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
    374. 

  374. <li class="toctree-l1"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
    375. 

  375. <li class="toctree-l1"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
    376. 

  376. <li class="toctree-l1"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
    377. 

  377. <li class="toctree-l1"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
    378. 

  378. <li class="toctree-l1"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
    379. 

  379. <li class="toctree-l1"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
    380. 

  380. <li class="toctree-l1"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
    381. 

  381. <li class="toctree-l1"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
    382. 

  382. <li class="toctree-l1"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
    383. 

  383. <li class="toctree-l1"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
    384. 

  384. <li class="toctree-l1"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
    385. 

  385. <li class="toctree-l1"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
    386. 

  386. <li class="toctree-l1"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
    387. 

  387. </ul>
    388. 

  388. 

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

  390. 	  <form class="search" action="../search.html" method="get">
    391. 

  391.             <input type="text" name="q" size="18" />
    392. 

  392.             <input type="submit" value="Go" />
    393. 

  393.             <input type="hidden" name="check_keywords" value="yes" />
    394. 

  394.             <input type="hidden" name="area" value="default" />
    395. 

  395.           </form>
    396. 

  396.           <p class="searchtip" style="font-size: 90%">
    397. 

  397.             Enter search terms or a module, class or function name.
    398. 

  398.           </p>
    399. 

  399. 	</div>
    400. 

  400. 	<div class="clearer"></div>
    401. 

  401.       </div>
    402. 

  402.     </div>
    403. 

  403. 

  404.     <div class="footer-wrapper">
    405. 

  405.       <div class="footer">
    406. 

  406. 	<div class="left">
    407. 

  407.           <a href="../genindex.html" title="General Index"
    408. 

  408.              >index</a> |
    409. 

  409.           <a href="../modindex.html" title="Global Module Index"
    410. 

  410.              >modules</a> |
    411. 

  411.           <a href="celery.backends.html" title="Backends - celery.backends"
    412. 

  412.              >next</a> |
    413. 

  413.           <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
    414. 

  414.              >previous</a>
    415. 

  415.             <br/>
    416. 

  416.             <a href="../sources/reference/celery.worker.txt"
    417. 

  417.                rel="nofollow">Show Source</a>
    418. 

  418. 	</div>
    419. 

  419. 

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

  421. 	  &copy; Copyright 2009, Ask Solem.<br/>
    422. 

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

  423. 	</div>
    424. 

  424. 	<div class="clearer"></div>
    425. 

  425.       </div>
    426. 

  426.     </div>
    427. 

  427. 

  428.   </body>
    429. 

  429. </html>
    430.