Skip to content

Commit 0e39fbb

Browse files
author
Ask Solem
committed
Github Pages: Added celery.concurrency.processes.pool.html
1 parent 977e7cb commit 0e39fbb

File tree

2 files changed

+323
-0
lines changed

2 files changed

+323
-0
lines changed

‎internals/reference/celery.concurrency.processes.pool.html‎

Lines changed: 314 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,314 @@
1+
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
5+
<html xmlns="http://www.w3.org/1999/xhtml">
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
9+
<title>extended multiprocessing.pool - celery.concurrency.processes.pool &mdash; Celery v1.1.1 (unstable) documentation</title>
10+
<link rel="stylesheet" href="../../static/adctheme.css" type="text/css" />
11+
<link rel="stylesheet" href="../../static/pygments.css" type="text/css" />
12+
<script type="text/javascript">
13+
var DOCUMENTATION_OPTIONS = {
14+
URL_ROOT: '../../',
15+
VERSION: '1.1.1 (unstable)',
16+
COLLAPSE_INDEX: false,
17+
FILE_SUFFIX: '.html',
18+
HAS_SOURCE: true
19+
};
20+
</script>
21+
<script type="text/javascript" src="../../static/jquery.js"></script>
22+
<script type="text/javascript" src="../../static/underscore.js"></script>
23+
<script type="text/javascript" src="../../static/doctools.js"></script>
24+
<link rel="top" title="Celery v1.1.1 (unstable) documentation" href="../../index.html" />
25+
<link rel="up" title="Internal Module Reference" href="index.html" />
26+
<link rel="next" title="Thread Pool Support EXPERIMENTAL - celery.concurrency.threads" href="celery.concurrency.threads.html" />
27+
<link rel="prev" title="Multiprocessing Pool Support - celery.concurrency.processes" href="celery.concurrency.processes.html" />
28+
<link media="only screen and (max-device-width: 480px)" href="../../static/mobile.css" type="text/css" rel="stylesheet" />
29+
</head>
30+
<body>
31+
<div id="docstitle">
32+
<p>Celery v1.1.1 (unstable) documentation</p>
33+
</div>
34+
<div id="header">
35+
<div id="title"><h1>extended multiprocessing.pool - celery.concurrency.processes.pool</h1></div>
36+
<ul id="headerButtons">
37+
<li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
38+
<li id="page_buttons">
39+
<div class="headerButton"><a href="../../genindex.html" title="General Index" accesskey="I">index</a></div>
40+
<div class="headerButton"><a href="../../py-modindex.html" title="Python Module Index" >modules</a></div>
41+
<div class="headerButton"><a href="celery.concurrency.threads.html" title="Thread Pool Support EXPERIMENTAL - celery.concurrency.threads" accesskey="N">next</a></div>
42+
<div class="headerButton"><a href="celery.concurrency.processes.html" title="Multiprocessing Pool Support - celery.concurrency.processes" accesskey="P">previous</a></div>
43+
</li>
44+
</ul>
45+
</div>
46+
47+
<div id="sphinxsidebar">
48+
<div class="sphinxsidebarwrapper">
49+
<ul><li class="toctree-l1"><a href="../../index.html">Main Page</a></li></ul>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../../getting-started/index.html">Getting Started</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../../userguide/index.html">User Guide</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="../../configuration.html">Configuration and defaults</a></li>
54+
<li class="toctree-l1"><a class="reference internal" href="../../cookbook/index.html">Cookbook</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/index.html">Tutorials</a></li>
56+
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Frequently Asked Questions</a></li>
57+
<li class="toctree-l1"><a class="reference internal" href="../../reference/index.html">API Reference</a></li>
58+
<li class="toctree-l1"><a class="reference internal" href="../index.html">Internals</a></li>
59+
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Change history</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="../../links.html">Interesting Links</a></li>
61+
</ul>
62+
63+
<h3>This Page</h3>
64+
<ul class="this-page-menu">
65+
<li><a href="../../sources/internals/reference/celery.concurrency.processes.pool.txt"
66+
rel="nofollow">Show Source</a></li>
67+
</ul>
68+
<div id="searchbox" style="display: none">
69+
70+
<form class="search" action="../../search.html" method="get">
71+
<div class="search-wrapper">
72+
<span class="search-left"></span>
73+
<input class="prettysearch" type="text" name="q" size="18" />
74+
<span class="search-right">&nbsp;</span>
75+
</div>
76+
<input type="submit" value="Search" class="searchbutton" />
77+
<input type="hidden" name="check_keywords" value="yes" />
78+
<input type="hidden" name="area" value="default" />
79+
</form>
80+
<p class="searchtip" style="font-size: 90%">
81+
Enter search terms or a module, class or function name.
82+
</p>
83+
</div>
84+
<script type="text/javascript">$('#searchbox').show(0);</script>
85+
</div>
86+
</div>
87+
88+
89+
90+
<div class="document">
91+
<div class="documentwrapper">
92+
<div class="bodywrapper">
93+
<div class="body">
94+
95+
<div class="section" id="module-celery.concurrency.processes.pool">
96+
<span id="extended-multiprocessing-pool-celery-concurrency-processes-pool"></span><h1>extended multiprocessing.pool - celery.concurrency.processes.pool<a class="headerlink" href="#module-celery.concurrency.processes.pool" title="Permalink to this headline"></a></h1>
97+
<dl class="class">
98+
<dt id="celery.concurrency.processes.pool.Pool">
99+
<em class="property">class </em><tt class="descclassname">celery.concurrency.processes.pool.</tt><tt class="descname">Pool</tt><big>(</big><em>processes=None</em>, <em>initializer=None</em>, <em>initargs=()</em>, <em>maxtasksperchild=None</em>, <em>timeout=None</em>, <em>soft_timeout=None</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool" title="Permalink to this definition"></a></dt>
100+
<dd><p>Class which supports an async version of the <cite>apply()</cite> builtin</p>
101+
<dl class="class">
102+
<dt id="celery.concurrency.processes.pool.Pool.AckHandler">
103+
<em class="property">class </em><tt class="descname">AckHandler</tt><big>(</big><em>ackqueue</em>, <em>get</em>, <em>cache</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.AckHandler" title="Permalink to this definition"></a></dt>
104+
<dd><dl class="method">
105+
<dt id="celery.concurrency.processes.pool.Pool.AckHandler.run">
106+
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.AckHandler.run" title="Permalink to this definition"></a></dt>
107+
<dd></dd></dl>
108+
109+
</dd></dl>
110+
111+
<dl class="class">
112+
<dt id="celery.concurrency.processes.pool.Pool.Process">
113+
<em class="property">class </em><tt class="descclassname">Pool.</tt><tt class="descname">Process</tt><big>(</big><em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>args=()</em>, <em>kwargs={}</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process" title="Permalink to this definition"></a></dt>
114+
<dd><p>Process objects represent activity that is run in a separate process</p>
115+
<p>The class is analagous to <cite>threading.Thread</cite></p>
116+
<dl class="attribute">
117+
<dt id="celery.concurrency.processes.pool.Pool.Process.authkey">
118+
<tt class="descname">authkey</tt><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.authkey" title="Permalink to this definition"></a></dt>
119+
<dd></dd></dl>
120+
121+
<dl class="attribute">
122+
<dt id="celery.concurrency.processes.pool.Pool.Process.daemon">
123+
<tt class="descname">daemon</tt><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.daemon" title="Permalink to this definition"></a></dt>
124+
<dd><p>Return whether process is a daemon</p>
125+
</dd></dl>
126+
127+
<dl class="attribute">
128+
<dt id="celery.concurrency.processes.pool.Pool.Process.exitcode">
129+
<tt class="descname">exitcode</tt><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.exitcode" title="Permalink to this definition"></a></dt>
130+
<dd><p>Return exit code of process or <cite>None</cite> if it has yet to stop</p>
131+
</dd></dl>
132+
133+
<dl class="attribute">
134+
<dt id="celery.concurrency.processes.pool.Pool.Process.ident">
135+
<tt class="descname">ident</tt><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.ident" title="Permalink to this definition"></a></dt>
136+
<dd><p>Return indentifier (PID) of process or <cite>None</cite> if it has yet to start</p>
137+
</dd></dl>
138+
139+
<dl class="method">
140+
<dt id="celery.concurrency.processes.pool.Pool.Process.is_alive">
141+
<tt class="descname">is_alive</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.is_alive" title="Permalink to this definition"></a></dt>
142+
<dd><p>Return whether process is alive</p>
143+
</dd></dl>
144+
145+
<dl class="method">
146+
<dt id="celery.concurrency.processes.pool.Pool.Process.join">
147+
<tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.join" title="Permalink to this definition"></a></dt>
148+
<dd><p>Wait until child process terminates</p>
149+
</dd></dl>
150+
151+
<dl class="attribute">
152+
<dt id="celery.concurrency.processes.pool.Pool.Process.name">
153+
<tt class="descname">name</tt><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.name" title="Permalink to this definition"></a></dt>
154+
<dd></dd></dl>
155+
156+
<dl class="attribute">
157+
<dt id="celery.concurrency.processes.pool.Pool.Process.pid">
158+
<tt class="descname">pid</tt><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.pid" title="Permalink to this definition"></a></dt>
159+
<dd><p>Return indentifier (PID) of process or <cite>None</cite> if it has yet to start</p>
160+
</dd></dl>
161+
162+
<dl class="method">
163+
<dt id="celery.concurrency.processes.pool.Pool.Process.run">
164+
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.run" title="Permalink to this definition"></a></dt>
165+
<dd><p>Method to be run in sub-process; can be overridden in sub-class</p>
166+
</dd></dl>
167+
168+
<dl class="method">
169+
<dt id="celery.concurrency.processes.pool.Pool.Process.start">
170+
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.start" title="Permalink to this definition"></a></dt>
171+
<dd><p>Start child process</p>
172+
</dd></dl>
173+
174+
<dl class="method">
175+
<dt id="celery.concurrency.processes.pool.Pool.Process.terminate">
176+
<tt class="descname">terminate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Process.terminate" title="Permalink to this definition"></a></dt>
177+
<dd><p>Terminate process; sends SIGTERM signal or uses TerminateProcess()</p>
178+
</dd></dl>
179+
180+
</dd></dl>
181+
182+
<dl class="class">
183+
<dt id="celery.concurrency.processes.pool.Pool.ResultHandler">
184+
<em class="property">class </em><tt class="descclassname">Pool.</tt><tt class="descname">ResultHandler</tt><big>(</big><em>outqueue</em>, <em>get</em>, <em>cache</em>, <em>putlock</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.ResultHandler" title="Permalink to this definition"></a></dt>
185+
<dd><dl class="method">
186+
<dt id="celery.concurrency.processes.pool.Pool.ResultHandler.run">
187+
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.ResultHandler.run" title="Permalink to this definition"></a></dt>
188+
<dd></dd></dl>
189+
190+
</dd></dl>
191+
192+
<dl class="exception">
193+
<dt id="celery.concurrency.processes.pool.Pool.SoftTimeLimitExceeded">
194+
<em class="property">exception </em><tt class="descclassname">Pool.</tt><tt class="descname">SoftTimeLimitExceeded</tt><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.SoftTimeLimitExceeded" title="Permalink to this definition"></a></dt>
195+
<dd><p>The soft time limit has been exceeded. This exception is raised
196+
to give the task a chance to clean up.</p>
197+
</dd></dl>
198+
199+
<dl class="class">
200+
<dt id="celery.concurrency.processes.pool.Pool.Supervisor">
201+
<em class="property">class </em><tt class="descclassname">Pool.</tt><tt class="descname">Supervisor</tt><big>(</big><em>pool</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Supervisor" title="Permalink to this definition"></a></dt>
202+
<dd><dl class="method">
203+
<dt id="celery.concurrency.processes.pool.Pool.Supervisor.run">
204+
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.Supervisor.run" title="Permalink to this definition"></a></dt>
205+
<dd></dd></dl>
206+
207+
</dd></dl>
208+
209+
<dl class="class">
210+
<dt id="celery.concurrency.processes.pool.Pool.TaskHandler">
211+
<em class="property">class </em><tt class="descclassname">Pool.</tt><tt class="descname">TaskHandler</tt><big>(</big><em>taskqueue</em>, <em>put</em>, <em>outqueue</em>, <em>pool</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.TaskHandler" title="Permalink to this definition"></a></dt>
212+
<dd><dl class="method">
213+
<dt id="celery.concurrency.processes.pool.Pool.TaskHandler.run">
214+
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.TaskHandler.run" title="Permalink to this definition"></a></dt>
215+
<dd></dd></dl>
216+
217+
</dd></dl>
218+
219+
<dl class="class">
220+
<dt id="celery.concurrency.processes.pool.Pool.TimeoutHandler">
221+
<em class="property">class </em><tt class="descclassname">Pool.</tt><tt class="descname">TimeoutHandler</tt><big>(</big><em>processes</em>, <em>sentinel_event</em>, <em>cache</em>, <em>t_soft</em>, <em>t_hard</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.TimeoutHandler" title="Permalink to this definition"></a></dt>
222+
<dd><dl class="method">
223+
<dt id="celery.concurrency.processes.pool.Pool.TimeoutHandler.run">
224+
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.TimeoutHandler.run" title="Permalink to this definition"></a></dt>
225+
<dd></dd></dl>
226+
227+
</dd></dl>
228+
229+
<dl class="method">
230+
<dt id="celery.concurrency.processes.pool.Pool.apply">
231+
<tt class="descclassname">Pool.</tt><tt class="descname">apply</tt><big>(</big><em>func</em>, <em>args=()</em>, <em>kwds={}</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.apply" title="Permalink to this definition"></a></dt>
232+
<dd><p>Equivalent of <cite>apply()</cite> builtin</p>
233+
</dd></dl>
234+
235+
<dl class="method">
236+
<dt id="celery.concurrency.processes.pool.Pool.apply_async">
237+
<tt class="descclassname">Pool.</tt><tt class="descname">apply_async</tt><big>(</big><em>func</em>, <em>args=()</em>, <em>kwds={}</em>, <em>callback=None</em>, <em>accept_callback=None</em>, <em>timeout_callback=None</em>, <em>waitforslot=False</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.apply_async" title="Permalink to this definition"></a></dt>
238+
<dd><p>Asynchronous equivalent of <cite>apply()</cite> builtin.</p>
239+
<p>Callback is called when the functions return value is ready.
240+
The accept callback is called when the job is accepted to be executed.</p>
241+
<p>Simplified the flow is like this:</p>
242+
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">if</span> <span class="n">accept_callback</span><span class="p">:</span>
243+
<span class="gp">... </span> <span class="n">accept_callback</span><span class="p">()</span>
244+
<span class="gp">&gt;&gt;&gt; </span><span class="n">retval</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">)</span>
245+
<span class="gp">&gt;&gt;&gt; </span><span class="k">if</span> <span class="n">callback</span><span class="p">:</span>
246+
<span class="gp">... </span> <span class="n">callback</span><span class="p">(</span><span class="n">retval</span><span class="p">)</span>
247+
</pre></div>
248+
</div>
249+
</dd></dl>
250+
251+
<dl class="method">
252+
<dt id="celery.concurrency.processes.pool.Pool.close">
253+
<tt class="descclassname">Pool.</tt><tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.close" title="Permalink to this definition"></a></dt>
254+
<dd></dd></dl>
255+
256+
<dl class="method">
257+
<dt id="celery.concurrency.processes.pool.Pool.imap">
258+
<tt class="descclassname">Pool.</tt><tt class="descname">imap</tt><big>(</big><em>func</em>, <em>iterable</em>, <em>chunksize=1</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.imap" title="Permalink to this definition"></a></dt>
259+
<dd><p>Equivalent of <cite>itertools.imap()</cite> &#8211; can be MUCH slower than <cite>Pool.map()</cite></p>
260+
</dd></dl>
261+
262+
<dl class="method">
263+
<dt id="celery.concurrency.processes.pool.Pool.imap_unordered">
264+
<tt class="descclassname">Pool.</tt><tt class="descname">imap_unordered</tt><big>(</big><em>func</em>, <em>iterable</em>, <em>chunksize=1</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.imap_unordered" title="Permalink to this definition"></a></dt>
265+
<dd><p>Like <cite>imap()</cite> method but ordering of results is arbitrary</p>
266+
</dd></dl>
267+
268+
<dl class="method">
269+
<dt id="celery.concurrency.processes.pool.Pool.join">
270+
<tt class="descclassname">Pool.</tt><tt class="descname">join</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.join" title="Permalink to this definition"></a></dt>
271+
<dd></dd></dl>
272+
273+
<dl class="method">
274+
<dt id="celery.concurrency.processes.pool.Pool.map">
275+
<tt class="descclassname">Pool.</tt><tt class="descname">map</tt><big>(</big><em>func</em>, <em>iterable</em>, <em>chunksize=None</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.map" title="Permalink to this definition"></a></dt>
276+
<dd><p>Equivalent of <cite>map()</cite> builtin</p>
277+
</dd></dl>
278+
279+
<dl class="method">
280+
<dt id="celery.concurrency.processes.pool.Pool.map_async">
281+
<tt class="descclassname">Pool.</tt><tt class="descname">map_async</tt><big>(</big><em>func</em>, <em>iterable</em>, <em>chunksize=None</em>, <em>callback=None</em><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.map_async" title="Permalink to this definition"></a></dt>
282+
<dd><p>Asynchronous equivalent of <cite>map()</cite> builtin</p>
283+
</dd></dl>
284+
285+
<dl class="method">
286+
<dt id="celery.concurrency.processes.pool.Pool.terminate">
287+
<tt class="descclassname">Pool.</tt><tt class="descname">terminate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.concurrency.processes.pool.Pool.terminate" title="Permalink to this definition"></a></dt>
288+
<dd></dd></dl>
289+
290+
</dd></dl>
291+
292+
</div>
293+
294+
295+
</div>
296+
</div>
297+
</div>
298+
<div class="footer">
299+
<p>
300+
&copy; Copyright 2009, Ask Solem.
301+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b2.
302+
</p>
303+
</div>
304+
<div class="clearer"></div>
305+
</div>
306+
<div id="breadcrumbs">
307+
<a href="../index.html" accesskey="U">Internals</a><img src="../../static/triangle_closed.png" height="9" width="9" alt="&gt;">
308+
<a href="index.html" >Internal Module Reference</a><img src="../../static/triangle_closed.png" height="9" width="9" alt="&gt;">
309+
extended multiprocessing.pool - celery.concurrency.processes.pool
310+
</ul>
311+
</div>
312+
<script type="text/javascript" charset="utf-8" src="../../static/toc.js"></script>
313+
</body>
314+
</html>

‎sources/internals/reference/celery.concurrency.processes.pool.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
===================================================================
2+
extended multiprocessing.pool - celery.concurrency.processes.pool
3+
===================================================================
4+
5+
.. currentmodule:: celery.concurrency.processes.pool
6+
7+
.. automodule:: celery.concurrency.processes.pool
8+
:members:
9+
:undoc-members:

0 commit comments

Comments
 (0)