X7ROOT File Manager
Current Path:
/usr/share/doc/python3-docs/html/library
usr
/
share
/
doc
/
python3-docs
/
html
/
library
/
π
..
π
2to3.html
(60.26 KB)
π
__future__.html
(15.42 KB)
π
__main__.html
(8.81 KB)
π
_dummy_thread.html
(8.98 KB)
π
_thread.html
(22.06 KB)
π
abc.html
(40.42 KB)
π
aifc.html
(27.46 KB)
π
allos.html
(31.48 KB)
π
archiving.html
(11.71 KB)
π
argparse.html
(268.54 KB)
π
array.html
(32.76 KB)
π
ast.html
(38.67 KB)
π
asynchat.html
(31.78 KB)
π
asyncio-dev.html
(50.65 KB)
π
asyncio-eventloop.html
(108.61 KB)
π
asyncio-eventloops.html
(32.25 KB)
π
asyncio-protocol.html
(85.38 KB)
π
asyncio-queue.html
(23.4 KB)
π
asyncio-stream.html
(59.58 KB)
π
asyncio-subprocess.html
(56.66 KB)
π
asyncio-sync.html
(34.84 KB)
π
asyncio-task.html
(82 KB)
π
asyncio.html
(27.37 KB)
π
asyncore.html
(41.71 KB)
π
atexit.html
(18 KB)
π
audioop.html
(34.61 KB)
π
base64.html
(35.6 KB)
π
bdb.html
(42.41 KB)
π
binary.html
(12.42 KB)
π
binascii.html
(24.17 KB)
π
binhex.html
(11.4 KB)
π
bisect.html
(25 KB)
π
builtins.html
(11.33 KB)
π
bz2.html
(32.58 KB)
π
calendar.html
(38.61 KB)
π
cgi.html
(54.57 KB)
π
cgitb.html
(12.47 KB)
π
chunk.html
(16.48 KB)
π
cmath.html
(33.37 KB)
π
cmd.html
(42.78 KB)
π
code.html
(27.23 KB)
π
codecs.html
(130.93 KB)
π
codeop.html
(13.97 KB)
π
collections.abc.html
(59.48 KB)
π
collections.html
(151.31 KB)
π
colorsys.html
(12.33 KB)
π
compileall.html
(27.6 KB)
π
concurrency.html
(20.71 KB)
π
concurrent.futures.html
(59.24 KB)
π
concurrent.html
(7.77 KB)
π
configparser.html
(137.75 KB)
π
constants.html
(17.09 KB)
π
contextlib.html
(86.72 KB)
π
copy.html
(13.52 KB)
π
copyreg.html
(14.38 KB)
π
crypt.html
(19.85 KB)
π
crypto.html
(10.66 KB)
π
csv.html
(67.42 KB)
π
ctypes.html
(258.33 KB)
π
curses.ascii.html
(24.61 KB)
π
curses.html
(171.44 KB)
π
curses.panel.html
(16.31 KB)
π
custominterp.html
(8.53 KB)
π
datatypes.html
(23.39 KB)
π
datetime.html
(299.25 KB)
π
dbm.html
(42.11 KB)
π
debug.html
(13.66 KB)
π
decimal.html
(228.01 KB)
π
development.html
(24.53 KB)
π
difflib.html
(93.9 KB)
π
dis.html
(103.7 KB)
π
distribution.html
(10.26 KB)
π
distutils.html
(10.63 KB)
π
doctest.html
(175.54 KB)
π
dummy_threading.html
(9.1 KB)
π
email.charset.html
(25.81 KB)
π
email.compat32-message.html
(84.13 KB)
π
email.contentmanager.html
(29.32 KB)
π
email.encoders.html
(13.92 KB)
π
email.errors.html
(19.24 KB)
π
email.examples.html
(56.52 KB)
π
email.generator.html
(40.82 KB)
π
email.header.html
(30.49 KB)
π
email.headerregistry.html
(56.32 KB)
π
email.html
(27.09 KB)
π
email.iterators.html
(13.21 KB)
π
email.message.html
(85.17 KB)
π
email.mime.html
(35.24 KB)
π
email.parser.html
(46.32 KB)
π
email.policy.html
(73.48 KB)
π
email.util.html
(33.06 KB)
π
ensurepip.html
(18.26 KB)
π
enum.html
(130.81 KB)
π
errno.html
(40.36 KB)
π
exceptions.html
(83.16 KB)
π
faulthandler.html
(22.85 KB)
π
fcntl.html
(26.68 KB)
π
filecmp.html
(24.45 KB)
π
fileformats.html
(10.87 KB)
π
fileinput.html
(29.33 KB)
π
filesys.html
(13.1 KB)
π
fnmatch.html
(16.59 KB)
π
formatter.html
(36.78 KB)
π
fpectl.html
(17.13 KB)
π
fractions.html
(29.22 KB)
π
frameworks.html
(13.16 KB)
π
ftplib.html
(53.15 KB)
π
functional.html
(8.79 KB)
π
functions.html
(196.76 KB)
π
functools.html
(63.43 KB)
π
gc.html
(28.83 KB)
π
getopt.html
(24.76 KB)
π
getpass.html
(11.78 KB)
π
gettext.html
(74.84 KB)
π
glob.html
(18 KB)
π
grp.html
(12.09 KB)
π
gzip.html
(31.9 KB)
π
hashlib.html
(77.69 KB)
π
heapq.html
(34.7 KB)
π
hmac.html
(17.41 KB)
π
html.entities.html
(11.09 KB)
π
html.html
(10.85 KB)
π
html.parser.html
(40.86 KB)
π
http.client.html
(63.72 KB)
π
http.cookiejar.html
(93.94 KB)
π
http.cookies.html
(38.41 KB)
π
http.html
(36.72 KB)
π
http.server.html
(56.83 KB)
π
i18n.html
(10.22 KB)
π
idle.html
(47.28 KB)
π
imaplib.html
(65.76 KB)
π
imghdr.html
(13.14 KB)
π
imp.html
(47.02 KB)
π
importlib.html
(169.05 KB)
π
index.html
(66.18 KB)
π
inspect.html
(127.3 KB)
π
internet.html
(30.36 KB)
π
intro.html
(9.67 KB)
π
io.html
(119.81 KB)
π
ipaddress.html
(103.39 KB)
π
ipc.html
(32.95 KB)
π
itertools.html
(129.71 KB)
π
json.html
(79.18 KB)
π
keyword.html
(8.71 KB)
π
language.html
(13.33 KB)
π
linecache.html
(13.18 KB)
π
locale.html
(60.1 KB)
π
logging.config.html
(83.49 KB)
π
logging.handlers.html
(109.76 KB)
π
logging.html
(131.69 KB)
π
lzma.html
(55.16 KB)
π
macpath.html
(9.04 KB)
π
mailbox.html
(153.63 KB)
π
mailcap.html
(14.33 KB)
π
markup.html
(18.9 KB)
π
marshal.html
(17.89 KB)
π
math.html
(52.4 KB)
π
mimetypes.html
(30.67 KB)
π
misc.html
(7.93 KB)
π
mm.html
(9.79 KB)
π
mmap.html
(33.49 KB)
π
modulefinder.html
(18.12 KB)
π
modules.html
(10.66 KB)
π
msilib.html
(55.86 KB)
π
msvcrt.html
(21.47 KB)
π
multiprocessing.html
(356.92 KB)
π
netdata.html
(17.06 KB)
π
netrc.html
(14.23 KB)
π
nis.html
(11.39 KB)
π
nntplib.html
(67.97 KB)
π
numbers.html
(40.46 KB)
π
numeric.html
(15.17 KB)
π
operator.html
(79.55 KB)
π
optparse.html
(244.08 KB)
π
os.html
(388.71 KB)
π
os.path.html
(52.56 KB)
π
ossaudiodev.html
(46.82 KB)
π
othergui.html
(10.02 KB)
π
parser.html
(41.41 KB)
π
pathlib.html
(113.99 KB)
π
pdb.html
(51.43 KB)
π
persistence.html
(14.92 KB)
π
pickle.html
(112.36 KB)
π
pickletools.html
(16.69 KB)
π
pipes.html
(15.62 KB)
π
pkgutil.html
(31.13 KB)
π
platform.html
(32.94 KB)
π
plistlib.html
(28.6 KB)
π
poplib.html
(30.21 KB)
π
posix.html
(17.2 KB)
π
pprint.html
(40.99 KB)
π
profile.html
(70.16 KB)
π
pty.html
(17.18 KB)
π
pwd.html
(12.79 KB)
π
py_compile.html
(15.14 KB)
π
pyclbr.html
(16.13 KB)
π
pydoc.html
(15.62 KB)
π
pyexpat.html
(86.85 KB)
π
python.html
(16.73 KB)
π
queue.html
(27.54 KB)
π
quopri.html
(13.53 KB)
π
random.html
(59.22 KB)
π
re.html
(186.7 KB)
π
readline.html
(41.15 KB)
π
reprlib.html
(24.38 KB)
π
resource.html
(35.7 KB)
π
rlcompleter.html
(14.05 KB)
π
runpy.html
(25.98 KB)
π
sched.html
(19.56 KB)
π
secrets.html
(24.15 KB)
π
select.html
(61.35 KB)
π
selectors.html
(35 KB)
π
shelve.html
(28.1 KB)
π
shlex.html
(47.83 KB)
π
shutil.html
(72.47 KB)
π
signal.html
(53.77 KB)
π
site.html
(31.49 KB)
π
smtpd.html
(35.05 KB)
π
smtplib.html
(66.83 KB)
π
sndhdr.html
(12.15 KB)
π
socket.html
(191.48 KB)
π
socketserver.html
(80 KB)
π
spwd.html
(12.04 KB)
π
sqlite3.html
(158.08 KB)
π
ssl.html
(260.08 KB)
π
stat.html
(43.67 KB)
π
statistics.html
(48.88 KB)
π
stdtypes.html
(454.74 KB)
π
string.html
(93.03 KB)
π
stringprep.html
(18.22 KB)
π
struct.html
(49.9 KB)
π
subprocess.html
(138.6 KB)
π
sunau.html
(31.01 KB)
π
superseded.html
(13.46 KB)
π
symbol.html
(8.64 KB)
π
symtable.html
(25.5 KB)
π
sys.html
(138.35 KB)
π
sysconfig.html
(29.55 KB)
π
syslog.html
(20.53 KB)
π
tabnanny.html
(11.98 KB)
π
tarfile.html
(94.49 KB)
π
telnetlib.html
(29.7 KB)
π
tempfile.html
(40.42 KB)
π
termios.html
(17.75 KB)
π
test.html
(76.71 KB)
π
text.html
(13.46 KB)
π
textwrap.html
(37.11 KB)
π
threading.html
(101.04 KB)
π
time.html
(77.76 KB)
π
timeit.html
(44.19 KB)
π
tk.html
(22.75 KB)
π
tkinter.html
(80.99 KB)
π
tkinter.scrolledtext.html
(9.72 KB)
π
tkinter.tix.html
(50.64 KB)
π
tkinter.ttk.html
(108.08 KB)
π
token.html
(22.13 KB)
π
tokenize.html
(31.4 KB)
π
trace.html
(28.46 KB)
π
traceback.html
(56.24 KB)
π
tracemalloc.html
(98.77 KB)
π
tty.html
(10.29 KB)
π
turtle.html
(244.5 KB)
π
types.html
(36.19 KB)
π
typing.html
(135.91 KB)
π
undoc.html
(8.97 KB)
π
unicodedata.html
(20.61 KB)
π
unittest.html
(244.81 KB)
π
unittest.mock-examples.html
(164.2 KB)
π
unittest.mock.html
(293.06 KB)
π
unix.html
(11.5 KB)
π
urllib.error.html
(14.13 KB)
π
urllib.html
(9.34 KB)
π
urllib.parse.html
(74.54 KB)
π
urllib.request.html
(173.05 KB)
π
urllib.robotparser.html
(16.75 KB)
π
uu.html
(11.92 KB)
π
uuid.html
(31.21 KB)
π
venv.html
(72.18 KB)
π
warnings.html
(49.14 KB)
π
wave.html
(29.17 KB)
π
weakref.html
(63.76 KB)
π
webbrowser.html
(26.27 KB)
π
windows.html
(10.38 KB)
π
winreg.html
(65.17 KB)
π
winsound.html
(20.77 KB)
π
wsgiref.html
(92.28 KB)
π
xdrlib.html
(32.96 KB)
π
xml.dom.html
(95.28 KB)
π
xml.dom.minidom.html
(40.51 KB)
π
xml.dom.pulldom.html
(23.65 KB)
π
xml.etree.elementtree.html
(132.32 KB)
π
xml.html
(18.81 KB)
π
xml.sax.handler.html
(41.66 KB)
π
xml.sax.html
(24.92 KB)
π
xml.sax.reader.html
(44.79 KB)
π
xml.sax.utils.html
(16.53 KB)
π
xmlrpc.client.html
(70.26 KB)
π
xmlrpc.html
(8.33 KB)
π
xmlrpc.server.html
(48.04 KB)
π
zipapp.html
(44.05 KB)
π
zipfile.html
(78.16 KB)
π
zipimport.html
(22.51 KB)
π
zlib.html
(33.75 KB)
Editing: concurrent.futures.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>17.4. concurrent.futures β Launching parallel tasks — Python 3.6.7 documentation</title> <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 3.6.7 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="17.5. subprocess β Subprocess management" href="subprocess.html" /> <link rel="prev" title="17.3. The concurrent package" href="concurrent.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="https://docs.python.org/3/library/concurrent.futures.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="subprocess.html" title="17.5. subprocess β Subprocess management" accesskey="N">next</a> |</li> <li class="right" > <a href="concurrent.html" title="17.3. The concurrent package" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">3.6.7 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="concurrency.html" accesskey="U">17. Concurrent Execution</a> »</li> <li class="right"> <div class="inline-search" style="display: none" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('.inline-search').show(0);</script> | </li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-concurrent.futures"> <span id="concurrent-futures-launching-parallel-tasks"></span><h1>17.4. <a class="reference internal" href="#module-concurrent.futures" title="concurrent.futures: Execute computations concurrently using threads or processes."><code class="xref py py-mod docutils literal notranslate"><span class="pre">concurrent.futures</span></code></a> β Launching parallel tasks<a class="headerlink" href="#module-concurrent.futures" title="Permalink to this headline">ΒΆ</a></h1> <div class="versionadded"> <p><span class="versionmodified">New in version 3.2.</span></p> </div> <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.6/Lib/concurrent/futures/thread.py">Lib/concurrent/futures/thread.py</a> and <a class="reference external" href="https://github.com/python/cpython/tree/3.6/Lib/concurrent/futures/process.py">Lib/concurrent/futures/process.py</a></p> <hr class="docutils" /> <p>The <a class="reference internal" href="#module-concurrent.futures" title="concurrent.futures: Execute computations concurrently using threads or processes."><code class="xref py py-mod docutils literal notranslate"><span class="pre">concurrent.futures</span></code></a> module provides a high-level interface for asynchronously executing callables.</p> <p>The asynchronous execution can be performed with threads, using <a class="reference internal" href="#concurrent.futures.ThreadPoolExecutor" title="concurrent.futures.ThreadPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThreadPoolExecutor</span></code></a>, or separate processes, using <a class="reference internal" href="#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code></a>. Both implement the same interface, which is defined by the abstract <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> class.</p> <div class="section" id="executor-objects"> <h2>17.4.1. Executor Objects<a class="headerlink" href="#executor-objects" title="Permalink to this headline">ΒΆ</a></h2> <dl class="class"> <dt id="concurrent.futures.Executor"> <em class="property">class </em><code class="descclassname">concurrent.futures.</code><code class="descname">Executor</code><a class="headerlink" href="#concurrent.futures.Executor" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>An abstract class that provides methods to execute calls asynchronously. It should not be used directly, but through its concrete subclasses.</p> <blockquote> <div><dl class="method"> <dt id="concurrent.futures.Executor.submit"> <code class="descname">submit</code><span class="sig-paren">(</span><em>fn</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Executor.submit" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Schedules the callable, <em>fn</em>, to be executed as <code class="docutils literal notranslate"><span class="pre">fn(*args</span> <span class="pre">**kwargs)</span></code> and returns a <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> object representing the execution of the callable.</p> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">as</span> <span class="n">executor</span><span class="p">:</span> <span class="n">future</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="nb">pow</span><span class="p">,</span> <span class="mi">323</span><span class="p">,</span> <span class="mi">1235</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">future</span><span class="o">.</span><span class="n">result</span><span class="p">())</span> </pre></div> </div> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Executor.map"> <code class="descname">map</code><span class="sig-paren">(</span><em>func</em>, <em>*iterables</em>, <em>timeout=None</em>, <em>chunksize=1</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Executor.map" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Similar to <a class="reference internal" href="functions.html#map" title="map"><code class="xref py py-func docutils literal notranslate"><span class="pre">map(func,</span> <span class="pre">*iterables)</span></code></a> except:</p> <ul class="simple"> <li>the <em>iterables</em> are collected immediately rather than lazily;</li> <li><em>func</em> is executed asynchronously and several calls to <em>func</em> may be made concurrently.</li> </ul> <p>The returned iterator raises a <a class="reference internal" href="#concurrent.futures.TimeoutError" title="concurrent.futures.TimeoutError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">concurrent.futures.TimeoutError</span></code></a> if <a class="reference internal" href="stdtypes.html#iterator.__next__" title="iterator.__next__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__next__()</span></code></a> is called and the result isnβt available after <em>timeout</em> seconds from the original call to <a class="reference internal" href="#concurrent.futures.Executor.map" title="concurrent.futures.Executor.map"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Executor.map()</span></code></a>. <em>timeout</em> can be an int or a float. If <em>timeout</em> is not specified or <code class="docutils literal notranslate"><span class="pre">None</span></code>, there is no limit to the wait time.</p> <p>If a <em>func</em> call raises an exception, then that exception will be raised when its value is retrieved from the iterator.</p> <p>When using <a class="reference internal" href="#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code></a>, this method chops <em>iterables</em> into a number of chunks which it submits to the pool as separate tasks. The (approximate) size of these chunks can be specified by setting <em>chunksize</em> to a positive integer. For very long iterables, using a large value for <em>chunksize</em> can significantly improve performance compared to the default size of 1. With <a class="reference internal" href="#concurrent.futures.ThreadPoolExecutor" title="concurrent.futures.ThreadPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThreadPoolExecutor</span></code></a>, <em>chunksize</em> has no effect.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.5: </span>Added the <em>chunksize</em> argument.</p> </div> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Executor.shutdown"> <code class="descname">shutdown</code><span class="sig-paren">(</span><em>wait=True</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Executor.shutdown" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Signal the executor that it should free any resources that it is using when the currently pending futures are done executing. Calls to <a class="reference internal" href="#concurrent.futures.Executor.submit" title="concurrent.futures.Executor.submit"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Executor.submit()</span></code></a> and <a class="reference internal" href="#concurrent.futures.Executor.map" title="concurrent.futures.Executor.map"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Executor.map()</span></code></a> made after shutdown will raise <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a>.</p> <p>If <em>wait</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> then this method will not return until all the pending futures are done executing and the resources associated with the executor have been freed. If <em>wait</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code> then this method will return immediately and the resources associated with the executor will be freed when all pending futures are done executing. Regardless of the value of <em>wait</em>, the entire Python program will not exit until all pending futures are done executing.</p> <p>You can avoid having to call this method explicitly if you use the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement, which will shutdown the <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> (waiting as if <a class="reference internal" href="#concurrent.futures.Executor.shutdown" title="concurrent.futures.Executor.shutdown"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Executor.shutdown()</span></code></a> were called with <em>wait</em> set to <code class="docutils literal notranslate"><span class="pre">True</span></code>):</p> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">shutil</span> <span class="k">with</span> <span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="n">e</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">,</span> <span class="s1">'src1.txt'</span><span class="p">,</span> <span class="s1">'dest1.txt'</span><span class="p">)</span> <span class="n">e</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">,</span> <span class="s1">'src2.txt'</span><span class="p">,</span> <span class="s1">'dest2.txt'</span><span class="p">)</span> <span class="n">e</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">,</span> <span class="s1">'src3.txt'</span><span class="p">,</span> <span class="s1">'dest3.txt'</span><span class="p">)</span> <span class="n">e</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">,</span> <span class="s1">'src4.txt'</span><span class="p">,</span> <span class="s1">'dest4.txt'</span><span class="p">)</span> </pre></div> </div> </dd></dl> </div></blockquote> </dd></dl> </div> <div class="section" id="threadpoolexecutor"> <h2>17.4.2. ThreadPoolExecutor<a class="headerlink" href="#threadpoolexecutor" title="Permalink to this headline">ΒΆ</a></h2> <p><a class="reference internal" href="#concurrent.futures.ThreadPoolExecutor" title="concurrent.futures.ThreadPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThreadPoolExecutor</span></code></a> is an <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> subclass that uses a pool of threads to execute calls asynchronously.</p> <p>Deadlocks can occur when the callable associated with a <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> waits on the results of another <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a>. For example:</p> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span> <span class="k">def</span> <span class="nf">wait_on_b</span><span class="p">():</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">b</span><span class="o">.</span><span class="n">result</span><span class="p">())</span> <span class="c1"># b will never complete because it is waiting on a.</span> <span class="k">return</span> <span class="mi">5</span> <span class="k">def</span> <span class="nf">wait_on_a</span><span class="p">():</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">result</span><span class="p">())</span> <span class="c1"># a will never complete because it is waiting on b.</span> <span class="k">return</span> <span class="mi">6</span> <span class="n">executor</span> <span class="o">=</span> <span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="n">a</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">wait_on_b</span><span class="p">)</span> <span class="n">b</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">wait_on_a</span><span class="p">)</span> </pre></div> </div> <p>And:</p> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">wait_on_future</span><span class="p">():</span> <span class="n">f</span> <span class="o">=</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="nb">pow</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="c1"># This will never complete because there is only one worker thread and</span> <span class="c1"># it is executing this function.</span> <span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">result</span><span class="p">())</span> <span class="n">executor</span> <span class="o">=</span> <span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">wait_on_future</span><span class="p">)</span> </pre></div> </div> <dl class="class"> <dt id="concurrent.futures.ThreadPoolExecutor"> <em class="property">class </em><code class="descclassname">concurrent.futures.</code><code class="descname">ThreadPoolExecutor</code><span class="sig-paren">(</span><em>max_workers=None</em>, <em>thread_name_prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.ThreadPoolExecutor" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>An <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> subclass that uses a pool of at most <em>max_workers</em> threads to execute calls asynchronously.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.5: </span>If <em>max_workers</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code> or not given, it will default to the number of processors on the machine, multiplied by <code class="docutils literal notranslate"><span class="pre">5</span></code>, assuming that <a class="reference internal" href="#concurrent.futures.ThreadPoolExecutor" title="concurrent.futures.ThreadPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThreadPoolExecutor</span></code></a> is often used to overlap I/O instead of CPU work and the number of workers should be higher than the number of workers for <a class="reference internal" href="#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code></a>.</p> </div> <div class="versionadded"> <p><span class="versionmodified">New in version 3.6: </span>The <em>thread_name_prefix</em> argument was added to allow users to control the threading.Thread names for worker threads created by the pool for easier debugging.</p> </div> </dd></dl> <div class="section" id="threadpoolexecutor-example"> <span id="id1"></span><h3>17.4.2.1. ThreadPoolExecutor Example<a class="headerlink" href="#threadpoolexecutor-example" title="Permalink to this headline">ΒΆ</a></h3> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">concurrent.futures</span> <span class="kn">import</span> <span class="nn">urllib.request</span> <span class="n">URLS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'http://www.foxnews.com/'</span><span class="p">,</span> <span class="s1">'http://www.cnn.com/'</span><span class="p">,</span> <span class="s1">'http://europe.wsj.com/'</span><span class="p">,</span> <span class="s1">'http://www.bbc.co.uk/'</span><span class="p">,</span> <span class="s1">'http://some-made-up-domain.com/'</span><span class="p">]</span> <span class="c1"># Retrieve a single page and report the URL and contents</span> <span class="k">def</span> <span class="nf">load_url</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span> <span class="k">with</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span> <span class="k">return</span> <span class="n">conn</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> <span class="c1"># We can use a with statement to ensure threads are cleaned up promptly</span> <span class="k">with</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span> <span class="k">as</span> <span class="n">executor</span><span class="p">:</span> <span class="c1"># Start the load operations and mark each future with its URL</span> <span class="n">future_to_url</span> <span class="o">=</span> <span class="p">{</span><span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">load_url</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="mi">60</span><span class="p">):</span> <span class="n">url</span> <span class="k">for</span> <span class="n">url</span> <span class="ow">in</span> <span class="n">URLS</span><span class="p">}</span> <span class="k">for</span> <span class="n">future</span> <span class="ow">in</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">as_completed</span><span class="p">(</span><span class="n">future_to_url</span><span class="p">):</span> <span class="n">url</span> <span class="o">=</span> <span class="n">future_to_url</span><span class="p">[</span><span class="n">future</span><span class="p">]</span> <span class="k">try</span><span class="p">:</span> <span class="n">data</span> <span class="o">=</span> <span class="n">future</span><span class="o">.</span><span class="n">result</span><span class="p">()</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">%r</span><span class="s1"> generated an exception: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">exc</span><span class="p">))</span> <span class="k">else</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">%r</span><span class="s1"> page is </span><span class="si">%d</span><span class="s1"> bytes'</span> <span class="o">%</span> <span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)))</span> </pre></div> </div> </div> </div> <div class="section" id="processpoolexecutor"> <h2>17.4.3. ProcessPoolExecutor<a class="headerlink" href="#processpoolexecutor" title="Permalink to this headline">ΒΆ</a></h2> <p>The <a class="reference internal" href="#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code></a> class is an <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> subclass that uses a pool of processes to execute calls asynchronously. <a class="reference internal" href="#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code></a> uses the <a class="reference internal" href="multiprocessing.html#module-multiprocessing" title="multiprocessing: Process-based parallelism."><code class="xref py py-mod docutils literal notranslate"><span class="pre">multiprocessing</span></code></a> module, which allows it to side-step the <a class="reference internal" href="../glossary.html#term-global-interpreter-lock"><span class="xref std std-term">Global Interpreter Lock</span></a> but also means that only picklable objects can be executed and returned.</p> <p>The <code class="docutils literal notranslate"><span class="pre">__main__</span></code> module must be importable by worker subprocesses. This means that <a class="reference internal" href="#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code></a> will not work in the interactive interpreter.</p> <p>Calling <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> or <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> methods from a callable submitted to a <a class="reference internal" href="#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code></a> will result in deadlock.</p> <dl class="class"> <dt id="concurrent.futures.ProcessPoolExecutor"> <em class="property">class </em><code class="descclassname">concurrent.futures.</code><code class="descname">ProcessPoolExecutor</code><span class="sig-paren">(</span><em>max_workers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.ProcessPoolExecutor" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>An <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> subclass that executes calls asynchronously using a pool of at most <em>max_workers</em> processes. If <em>max_workers</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code> or not given, it will default to the number of processors on the machine. If <em>max_workers</em> is lower or equal to <code class="docutils literal notranslate"><span class="pre">0</span></code>, then a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> will be raised.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.3: </span>When one of the worker processes terminates abruptly, a <code class="xref py py-exc docutils literal notranslate"><span class="pre">BrokenProcessPool</span></code> error is now raised. Previously, behaviour was undefined but operations on the executor or its futures would often freeze or deadlock.</p> </div> </dd></dl> <div class="section" id="processpoolexecutor-example"> <span id="id2"></span><h3>17.4.3.1. ProcessPoolExecutor Example<a class="headerlink" href="#processpoolexecutor-example" title="Permalink to this headline">ΒΆ</a></h3> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">concurrent.futures</span> <span class="kn">import</span> <span class="nn">math</span> <span class="n">PRIMES</span> <span class="o">=</span> <span class="p">[</span> <span class="mi">112272535095293</span><span class="p">,</span> <span class="mi">112582705942171</span><span class="p">,</span> <span class="mi">112272535095293</span><span class="p">,</span> <span class="mi">115280095190773</span><span class="p">,</span> <span class="mi">115797848077099</span><span class="p">,</span> <span class="mi">1099726899285419</span><span class="p">]</span> <span class="k">def</span> <span class="nf">is_prime</span><span class="p">(</span><span class="n">n</span><span class="p">):</span> <span class="k">if</span> <span class="n">n</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="k">return</span> <span class="kc">False</span> <span class="n">sqrt_n</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">math</span><span class="o">.</span><span class="n">floor</span><span class="p">(</span><span class="n">math</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">n</span><span class="p">)))</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="n">sqrt_n</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">):</span> <span class="k">if</span> <span class="n">n</span> <span class="o">%</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="k">return</span> <span class="kc">False</span> <span class="k">return</span> <span class="kc">True</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="k">with</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">ProcessPoolExecutor</span><span class="p">()</span> <span class="k">as</span> <span class="n">executor</span><span class="p">:</span> <span class="k">for</span> <span class="n">number</span><span class="p">,</span> <span class="n">prime</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">PRIMES</span><span class="p">,</span> <span class="n">executor</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="n">is_prime</span><span class="p">,</span> <span class="n">PRIMES</span><span class="p">)):</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">%d</span><span class="s1"> is prime: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">number</span><span class="p">,</span> <span class="n">prime</span><span class="p">))</span> <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span> <span class="n">main</span><span class="p">()</span> </pre></div> </div> </div> </div> <div class="section" id="future-objects"> <h2>17.4.4. Future Objects<a class="headerlink" href="#future-objects" title="Permalink to this headline">ΒΆ</a></h2> <p>The <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> class encapsulates the asynchronous execution of a callable. <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> instances are created by <a class="reference internal" href="#concurrent.futures.Executor.submit" title="concurrent.futures.Executor.submit"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Executor.submit()</span></code></a>.</p> <dl class="class"> <dt id="concurrent.futures.Future"> <em class="property">class </em><code class="descclassname">concurrent.futures.</code><code class="descname">Future</code><a class="headerlink" href="#concurrent.futures.Future" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Encapsulates the asynchronous execution of a callable. <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> instances are created by <a class="reference internal" href="#concurrent.futures.Executor.submit" title="concurrent.futures.Executor.submit"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Executor.submit()</span></code></a> and should not be created directly except for testing.</p> <blockquote> <div><dl class="method"> <dt id="concurrent.futures.Future.cancel"> <code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.cancel" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Attempt to cancel the call. If the call is currently being executed and cannot be cancelled then the method will return <code class="docutils literal notranslate"><span class="pre">False</span></code>, otherwise the call will be cancelled and the method will return <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.cancelled"> <code class="descname">cancelled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.cancelled" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the call was successfully cancelled.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.running"> <code class="descname">running</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.running" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the call is currently being executed and cannot be cancelled.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.done"> <code class="descname">done</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.done" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the call was successfully cancelled or finished running.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.result"> <code class="descname">result</code><span class="sig-paren">(</span><em>timeout=None</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.result" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return the value returned by the call. If the call hasnβt yet completed then this method will wait up to <em>timeout</em> seconds. If the call hasnβt completed in <em>timeout</em> seconds, then a <a class="reference internal" href="#concurrent.futures.TimeoutError" title="concurrent.futures.TimeoutError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">concurrent.futures.TimeoutError</span></code></a> will be raised. <em>timeout</em> can be an int or float. If <em>timeout</em> is not specified or <code class="docutils literal notranslate"><span class="pre">None</span></code>, there is no limit to the wait time.</p> <p>If the future is cancelled before completing then <a class="reference internal" href="#concurrent.futures.CancelledError" title="concurrent.futures.CancelledError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">CancelledError</span></code></a> will be raised.</p> <p>If the call raised, this method will raise the same exception.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.exception"> <code class="descname">exception</code><span class="sig-paren">(</span><em>timeout=None</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.exception" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return the exception raised by the call. If the call hasnβt yet completed then this method will wait up to <em>timeout</em> seconds. If the call hasnβt completed in <em>timeout</em> seconds, then a <a class="reference internal" href="#concurrent.futures.TimeoutError" title="concurrent.futures.TimeoutError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">concurrent.futures.TimeoutError</span></code></a> will be raised. <em>timeout</em> can be an int or float. If <em>timeout</em> is not specified or <code class="docutils literal notranslate"><span class="pre">None</span></code>, there is no limit to the wait time.</p> <p>If the future is cancelled before completing then <a class="reference internal" href="#concurrent.futures.CancelledError" title="concurrent.futures.CancelledError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">CancelledError</span></code></a> will be raised.</p> <p>If the call completed without raising, <code class="docutils literal notranslate"><span class="pre">None</span></code> is returned.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.add_done_callback"> <code class="descname">add_done_callback</code><span class="sig-paren">(</span><em>fn</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.add_done_callback" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Attaches the callable <em>fn</em> to the future. <em>fn</em> will be called, with the future as its only argument, when the future is cancelled or finishes running.</p> <p>Added callables are called in the order that they were added and are always called in a thread belonging to the process that added them. If the callable raises an <a class="reference internal" href="exceptions.html#Exception" title="Exception"><code class="xref py py-exc docutils literal notranslate"><span class="pre">Exception</span></code></a> subclass, it will be logged and ignored. If the callable raises a <a class="reference internal" href="exceptions.html#BaseException" title="BaseException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">BaseException</span></code></a> subclass, the behavior is undefined.</p> <p>If the future has already completed or been cancelled, <em>fn</em> will be called immediately.</p> </dd></dl> </div></blockquote> <p>The following <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> methods are meant for use in unit tests and <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> implementations.</p> <blockquote> <div><dl class="method"> <dt id="concurrent.futures.Future.set_running_or_notify_cancel"> <code class="descname">set_running_or_notify_cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.set_running_or_notify_cancel" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>This method should only be called by <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> implementations before executing the work associated with the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> and by unit tests.</p> <p>If the method returns <code class="docutils literal notranslate"><span class="pre">False</span></code> then the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> was cancelled, i.e. <a class="reference internal" href="#concurrent.futures.Future.cancel" title="concurrent.futures.Future.cancel"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Future.cancel()</span></code></a> was called and returned <cite>True</cite>. Any threads waiting on the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> completing (i.e. through <a class="reference internal" href="#concurrent.futures.as_completed" title="concurrent.futures.as_completed"><code class="xref py py-func docutils literal notranslate"><span class="pre">as_completed()</span></code></a> or <a class="reference internal" href="#concurrent.futures.wait" title="concurrent.futures.wait"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait()</span></code></a>) will be woken up.</p> <p>If the method returns <code class="docutils literal notranslate"><span class="pre">True</span></code> then the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> was not cancelled and has been put in the running state, i.e. calls to <a class="reference internal" href="#concurrent.futures.Future.running" title="concurrent.futures.Future.running"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Future.running()</span></code></a> will return <cite>True</cite>.</p> <p>This method can only be called once and cannot be called after <a class="reference internal" href="#concurrent.futures.Future.set_result" title="concurrent.futures.Future.set_result"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Future.set_result()</span></code></a> or <a class="reference internal" href="#concurrent.futures.Future.set_exception" title="concurrent.futures.Future.set_exception"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Future.set_exception()</span></code></a> have been called.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.set_result"> <code class="descname">set_result</code><span class="sig-paren">(</span><em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.set_result" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Sets the result of the work associated with the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> to <em>result</em>.</p> <p>This method should only be used by <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> implementations and unit tests.</p> </dd></dl> <dl class="method"> <dt id="concurrent.futures.Future.set_exception"> <code class="descname">set_exception</code><span class="sig-paren">(</span><em>exception</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.Future.set_exception" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Sets the result of the work associated with the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> to the <a class="reference internal" href="exceptions.html#Exception" title="Exception"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a> <em>exception</em>.</p> <p>This method should only be used by <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> implementations and unit tests.</p> </dd></dl> </div></blockquote> </dd></dl> </div> <div class="section" id="module-functions"> <h2>17.4.5. Module Functions<a class="headerlink" href="#module-functions" title="Permalink to this headline">ΒΆ</a></h2> <dl class="function"> <dt id="concurrent.futures.wait"> <code class="descclassname">concurrent.futures.</code><code class="descname">wait</code><span class="sig-paren">(</span><em>fs</em>, <em>timeout=None</em>, <em>return_when=ALL_COMPLETED</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.wait" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Wait for the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> instances (possibly created by different <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> instances) given by <em>fs</em> to complete. Returns a named 2-tuple of sets. The first set, named <code class="docutils literal notranslate"><span class="pre">done</span></code>, contains the futures that completed (finished or were cancelled) before the wait completed. The second set, named <code class="docutils literal notranslate"><span class="pre">not_done</span></code>, contains uncompleted futures.</p> <p><em>timeout</em> can be used to control the maximum number of seconds to wait before returning. <em>timeout</em> can be an int or float. If <em>timeout</em> is not specified or <code class="docutils literal notranslate"><span class="pre">None</span></code>, there is no limit to the wait time.</p> <p><em>return_when</em> indicates when this function should return. It must be one of the following constants:</p> <table border="1" class="docutils"> <colgroup> <col width="42%" /> <col width="58%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Constant</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="xref py py-const docutils literal notranslate"><span class="pre">FIRST_COMPLETED</span></code></td> <td>The function will return when any future finishes or is cancelled.</td> </tr> <tr class="row-odd"><td><code class="xref py py-const docutils literal notranslate"><span class="pre">FIRST_EXCEPTION</span></code></td> <td>The function will return when any future finishes by raising an exception. If no future raises an exception then it is equivalent to <code class="xref py py-const docutils literal notranslate"><span class="pre">ALL_COMPLETED</span></code>.</td> </tr> <tr class="row-even"><td><code class="xref py py-const docutils literal notranslate"><span class="pre">ALL_COMPLETED</span></code></td> <td>The function will return when all futures finish or are cancelled.</td> </tr> </tbody> </table> </dd></dl> <dl class="function"> <dt id="concurrent.futures.as_completed"> <code class="descclassname">concurrent.futures.</code><code class="descname">as_completed</code><span class="sig-paren">(</span><em>fs</em>, <em>timeout=None</em><span class="sig-paren">)</span><a class="headerlink" href="#concurrent.futures.as_completed" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Returns an iterator over the <a class="reference internal" href="#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">Future</span></code></a> instances (possibly created by different <a class="reference internal" href="#concurrent.futures.Executor" title="concurrent.futures.Executor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Executor</span></code></a> instances) given by <em>fs</em> that yields futures as they complete (finished or were cancelled). Any futures given by <em>fs</em> that are duplicated will be returned once. Any futures that completed before <a class="reference internal" href="#concurrent.futures.as_completed" title="concurrent.futures.as_completed"><code class="xref py py-func docutils literal notranslate"><span class="pre">as_completed()</span></code></a> is called will be yielded first. The returned iterator raises a <a class="reference internal" href="#concurrent.futures.TimeoutError" title="concurrent.futures.TimeoutError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">concurrent.futures.TimeoutError</span></code></a> if <a class="reference internal" href="stdtypes.html#iterator.__next__" title="iterator.__next__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__next__()</span></code></a> is called and the result isnβt available after <em>timeout</em> seconds from the original call to <a class="reference internal" href="#concurrent.futures.as_completed" title="concurrent.futures.as_completed"><code class="xref py py-func docutils literal notranslate"><span class="pre">as_completed()</span></code></a>. <em>timeout</em> can be an int or float. If <em>timeout</em> is not specified or <code class="docutils literal notranslate"><span class="pre">None</span></code>, there is no limit to the wait time.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt><span class="target" id="index-0"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-3148"><strong>PEP 3148</strong></a> β futures - execute computations asynchronously</dt> <dd>The proposal which described this feature for inclusion in the Python standard library.</dd> </dl> </div> </div> <div class="section" id="exception-classes"> <h2>17.4.6. Exception classes<a class="headerlink" href="#exception-classes" title="Permalink to this headline">ΒΆ</a></h2> <dl class="exception"> <dt id="concurrent.futures.CancelledError"> <em class="property">exception </em><code class="descclassname">concurrent.futures.</code><code class="descname">CancelledError</code><a class="headerlink" href="#concurrent.futures.CancelledError" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Raised when a future is cancelled.</p> </dd></dl> <dl class="exception"> <dt id="concurrent.futures.TimeoutError"> <em class="property">exception </em><code class="descclassname">concurrent.futures.</code><code class="descname">TimeoutError</code><a class="headerlink" href="#concurrent.futures.TimeoutError" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Raised when a future operation exceeds the given timeout.</p> </dd></dl> <dl class="exception"> <dt id="concurrent.futures.process.BrokenProcessPool"> <em class="property">exception </em><code class="descclassname">concurrent.futures.process.</code><code class="descname">BrokenProcessPool</code><a class="headerlink" href="#concurrent.futures.process.BrokenProcessPool" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Derived from <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a>, this exception class is raised when one of the workers of a <code class="xref py py-class docutils literal notranslate"><span class="pre">ProcessPoolExecutor</span></code> has terminated in a non-clean fashion (for example, if it was killed from the outside).</p> <div class="versionadded"> <p><span class="versionmodified">New in version 3.3.</span></p> </div> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">17.4. <code class="docutils literal notranslate"><span class="pre">concurrent.futures</span></code> β Launching parallel tasks</a><ul> <li><a class="reference internal" href="#executor-objects">17.4.1. Executor Objects</a></li> <li><a class="reference internal" href="#threadpoolexecutor">17.4.2. ThreadPoolExecutor</a><ul> <li><a class="reference internal" href="#threadpoolexecutor-example">17.4.2.1. ThreadPoolExecutor Example</a></li> </ul> </li> <li><a class="reference internal" href="#processpoolexecutor">17.4.3. ProcessPoolExecutor</a><ul> <li><a class="reference internal" href="#processpoolexecutor-example">17.4.3.1. ProcessPoolExecutor Example</a></li> </ul> </li> <li><a class="reference internal" href="#future-objects">17.4.4. Future Objects</a></li> <li><a class="reference internal" href="#module-functions">17.4.5. Module Functions</a></li> <li><a class="reference internal" href="#exception-classes">17.4.6. Exception classes</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="concurrent.html" title="previous chapter">17.3. The <code class="docutils literal notranslate"><span class="pre">concurrent</span></code> package</a></p> <h4>Next topic</h4> <p class="topless"><a href="subprocess.html" title="next chapter">17.5. <code class="docutils literal notranslate"><span class="pre">subprocess</span></code> β Subprocess management</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li> <a href="https://github.com/python/cpython/blob/3.6/Doc/library/concurrent.futures.rst" rel="nofollow">Show Source </a> </li> </ul> </div> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="subprocess.html" title="17.5. subprocess β Subprocess management" >next</a> |</li> <li class="right" > <a href="concurrent.html" title="17.3. The concurrent package" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">3.6.7 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="concurrency.html" >17. Concurrent Execution</a> »</li> <li class="right"> <div class="inline-search" style="display: none" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('.inline-search').show(0);</script> | </li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 2001-2023, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Dec 18, 2023. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6. </div> </body> </html>
Upload File
Create Folder