`concurrent.futures` — 发起并行任务 ¶

Added in version 3.2.

源代码： Lib/concurrent/futures/thread.py and Lib/concurrent/futures/process.py

The concurrent.futures 模块为异步执行可调用提供高级接口。

异步执行可以采用线程履行使用 ThreadPoolExecutor ，或单独进程使用 ProcessPoolExecutor 。两者实现相同接口，定义通过抽象 Executor 类。

可用性：非 WASI。

This module does not work or is not available on WebAssembly. See WebAssembly 平台了解更多信息。

执行器对象 ¶

class concurrent.futures. Executor ¶

提供异步执行调用的方法的抽象类。不应直接使用它，但应透过它的具体子类。

submit ( fn , / , * args , ** kwargs ) ¶

调度可调用 fn 以执行按 fn(*args, **kwargs) 并返回 Future 对象表示可调用的执行。

with ThreadPoolExecutor(max_workers=1) as executor:
    future = executor.submit(pow, 323, 1235)
    print(future.result())

map ( fn , * iterables , timeout = None , chunksize = 1 ) ¶

类似于 map(fn, *iterables) 除了：

the iterables 是立即收集的而不是惰性收集的；
fn 是异步执行的，且多次调用 fn 可能并发做出。

返回的迭代器引发 TimeoutError if __next__() is called and the result isn’t available after timeout seconds from the original call to Executor.map() . timeout can be an int or a float. If timeout 未指定或 None , there is no limit to the wait time.

若 fn 调用引发异常，那么将引发该异常，当从迭代器检索其值时。

当使用 ProcessPoolExecutor , this method chops iterables 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 chunksize to a positive integer. For very long iterables, using a large value for chunksize can significantly improve performance compared to the default size of 1. With ThreadPoolExecutor , chunksize 不起作用。

3.5 版改变：添加 chunksize 自变量。

shutdown ( wait = True , * , cancel_futures = False ) ¶

Signal the executor that it should free any resources that it is using when the currently pending futures are done executing. Calls to Executor.submit() and Executor.map() made after shutdown will raise RuntimeError .

若 wait is True 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 wait is False 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 wait , the entire Python program will not exit until all pending futures are done executing.

若 cancel_futures is True , this method will cancel all pending futures that the executor has not started running. Any futures that are completed or running won’t be cancelled, regardless of the value of cancel_futures .

If both cancel_futures and wait are True , all futures that the executor has started running will be completed prior to this method returning. The remaining futures are cancelled.

You can avoid having to call this method explicitly if you use the with statement, which will shutdown the Executor (waiting as if Executor.shutdown() were called with wait 设为 True ):

import shutil
with ThreadPoolExecutor(max_workers=4) as e:
    e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
    e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
    e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
    e.submit(shutil.copy, 'src4.txt', 'dest4.txt')

3.9 版改变：添加 cancel_futures .

ThreadPoolExecutor ¶

ThreadPoolExecutor 是 Executor 子类，使用线程池异步执行调用。

死锁会发生当可调用关联 Future waits on the results of another Future 。例如：

import time
def wait_on_b():
    time.sleep(5)
    print(b.result())  # b will never complete because it is waiting on a.
    return 5
def wait_on_a():
    time.sleep(5)
    print(a.result())  # a will never complete because it is waiting on b.
    return 6
executor = ThreadPoolExecutor(max_workers=2)
a = executor.submit(wait_on_b)
b = executor.submit(wait_on_a)

和：

def wait_on_future():
    f = executor.submit(pow, 5, 2)
    # This will never complete because there is only one worker thread and
    # it is executing this function.
    print(f.result())
executor = ThreadPoolExecutor(max_workers=1)
executor.submit(wait_on_future)

class concurrent.futures. ThreadPoolExecutor ( max_workers = None , thread_name_prefix = '' , initializer = None , initargs = () ) ¶

ThreadPoolExecutor 范例 ¶

import concurrent.futures
import urllib.request
URLS = ['http://www.foxnews.com/',
        'http://www.cnn.com/',
        'http://europe.wsj.com/',
        'http://www.bbc.co.uk/',
        'http://nonexistent-subdomain.python.org/']
# Retrieve a single page and report the URL and contents
def load_url(url, timeout):
    with urllib.request.urlopen(url, timeout=timeout) as conn:
        return conn.read()
# We can use a with statement to ensure threads are cleaned up promptly
with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor:
    # Start the load operations and mark each future with its URL
    future_to_url = {executor.submit(load_url, url, 60): url for url in URLS}
    for future in concurrent.futures.as_completed(future_to_url):
        url = future_to_url[future]
        try:
            data = future.result()
        except Exception as exc:
            print('%r generated an exception: %s' % (url, exc))
        else:
            print('%r page is %d bytes' % (url, len(data)))

ProcessPoolExecutor ¶

The ProcessPoolExecutor class is an Executor subclass that uses a pool of processes to execute calls asynchronously. ProcessPoolExecutor 使用 multiprocessing module, which allows it to side-step the 全局解释器锁 but also means that only picklable objects can be executed and returned.

The __main__ module must be importable by worker subprocesses. This means that ProcessPoolExecutor will not work in the interactive interpreter.

调用 Executor or Future methods from a callable submitted to a ProcessPoolExecutor will result in deadlock.

class concurrent.futures. ProcessPoolExecutor ( max_workers = None , mp_context = None , initializer = None , initargs = () , max_tasks_per_child = None ) ¶

An Executor subclass that executes calls asynchronously using a pool of at most max_workers processes. If max_workers is None or not given, it will default to os.process_cpu_count() 。若 max_workers <= 0 , then a ValueError will be raised. On Windows, max_workers must be less than or equal to 61 . If it is not then ValueError 会被引发。若 max_workers is None , then the default chosen will be at most 61 , even if more processors are available. mp_context 可以是 multiprocessing context or None . It will be used to launch the workers. If mp_context is None or not given, the default multiprocessing context is used. See 上下文和启动方法 .

initializer is an optional callable that is called at the start of each worker process; initargs is a tuple of arguments passed to the initializer. Should initializer raise an exception, all currently pending jobs will raise a BrokenProcessPool , as well as any attempt to submit more jobs to the pool.

max_tasks_per_child is an optional argument that specifies the maximum number of tasks a single process can execute before it will exit and be replaced with a fresh worker process. By default max_tasks_per_child is None which means worker processes will live as long as the pool. When a max is specified, the “spawn” multiprocessing start method will be used by default in absence of a mp_context parameter. This feature is incompatible with the “fork” start method.

3.3 版改变： When one of the worker processes terminates abruptly, a BrokenProcessPool error is now raised. Previously, behaviour was undefined but operations on the executor or its futures would often freeze or deadlock.

3.7 版改变： The mp_context argument was added to allow users to control the start_method for worker processes created by the pool.

添加 initializer and initargs 自变量。

注意

默认 multiprocessing start method (see 上下文和启动方法 ) will change away from fork in Python 3.14. Code that requires fork be used for their ProcessPoolExecutor should explicitly specify that by passing a mp_context=multiprocessing.get_context("fork") 参数。

3.11 版改变： The max_tasks_per_child argument was added to allow users to control the lifetime of workers in the pool.

3.12 版改变： On POSIX systems, if your application has multiple threads and the multiprocessing context uses the "fork" start method: The os.fork() function called internally to spawn workers may raise a DeprecationWarning . Pass a mp_context configured to use a different start method. See the os.fork() documentation for further explanation.

Changed in version 3.13: max_workers 使用 os.process_cpu_count() by default, instead of os.cpu_count() .

ProcessPoolExecutor 范例 ¶

import concurrent.futures
import math
PRIMES = [
    112272535095293,
    112582705942171,
    112272535095293,
    115280095190773,
    115797848077099,
    1099726899285419]
def is_prime(n):
    if n < 2:
        return False
    if n == 2:
        return True
    if n % 2 == 0:
        return False
    sqrt_n = int(math.floor(math.sqrt(n)))
    for i in range(3, sqrt_n + 1, 2):
        if n % i == 0:
            return False
    return True
def main():
    with concurrent.futures.ProcessPoolExecutor() as executor:
        for number, prime in zip(PRIMES, executor.map(is_prime, PRIMES)):
            print('%d is prime: %s' % (number, prime))
if __name__ == '__main__':
    main()

Future 对象 ¶

The Future class encapsulates the asynchronous execution of a callable. Future instances are created by Executor.submit() .

class concurrent.futures. Future ¶

Encapsulates the asynchronous execution of a callable. Future instances are created by Executor.submit() and should not be created directly except for testing.

cancel ( ) ¶: Attempt to cancel the call. If the call is currently being executed or finished running and cannot be cancelled then the method will return False , otherwise the call will be cancelled and the method will return True .

cancelled ( ) ¶: 返回 True if the call was successfully cancelled.

running ( ) ¶: 返回 True if the call is currently being executed and cannot be cancelled.

done ( ) ¶: 返回 True if the call was successfully cancelled or finished running.

result ( timeout = None ) ¶

Return the value returned by the call. If the call hasn’t yet completed then this method will wait up to timeout seconds. If the call hasn’t completed in timeout seconds, then a TimeoutError 会被引发。 timeout can be an int or float. If timeout 未指定或 None , there is no limit to the wait time.

If the future is cancelled before completing then CancelledError 会被引发。

If the call raised an exception, this method will raise the same exception.

exception ( timeout = None ) ¶

Return the exception raised by the call. If the call hasn’t yet completed then this method will wait up to timeout seconds. If the call hasn’t completed in timeout seconds, then a TimeoutError 会被引发。 timeout can be an int or float. If timeout 未指定或 None , there is no limit to the wait time.

If the future is cancelled before completing then CancelledError 会被引发。

If the call completed without raising, None 被返回。

add_done_callback ( fn ) ¶

Attaches the callable fn to the future. fn will be called, with the future as its only argument, when the future is cancelled or finishes running.

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 Exception subclass, it will be logged and ignored. If the callable raises a BaseException subclass, the behavior is undefined.

If the future has already completed or been cancelled, fn will be called immediately.

下列 Future methods are meant for use in unit tests and Executor implementations.

set_running_or_notify_cancel ( ) ¶

This method should only be called by Executor implementations before executing the work associated with the Future and by unit tests.

If the method returns False 那么 Future was cancelled, i.e. Future.cancel() was called and returned True . Any threads waiting on the Future completing (i.e. through as_completed() or wait() ) will be woken up.

If the method returns True 那么 Future was not cancelled and has been put in the running state, i.e. calls to Future.running() 将返回 True .

This method can only be called once and cannot be called after Future.set_result() or Future.set_exception() 有被调用。

set_result ( result ) ¶

Sets the result of the work associated with the Future to result .

This method should only be used by Executor implementations and unit tests.

3.8 版改变： This method raises concurrent.futures.InvalidStateError 若 Future is already done.

set_exception ( exception ) ¶

Sets the result of the work associated with the Future 到 Exception exception .

This method should only be used by Executor implementations and unit tests.

3.8 版改变： This method raises concurrent.futures.InvalidStateError 若 Future is already done.

模块函数 ¶

concurrent.futures. wait ( fs , timeout = None , return_when = ALL_COMPLETED ) ¶

等待 Future instances (possibly created by different Executor instances) given by fs to complete. Duplicate futures given to fs are removed and will be returned only once. Returns a named 2-tuple of sets. The first set, named done , contains the futures that completed (finished or cancelled futures) before the wait completed. The second set, named not_done , contains the futures that did not complete (pending or running futures).

timeout can be used to control the maximum number of seconds to wait before returning. timeout can be an int or float. If timeout 未指定或 None , there is no limit to the wait time.

return_when indicates when this function should return. It must be one of the following constants:

常量	描述
concurrent.futures. FIRST_COMPLETED ¶	The function will return when any future finishes or is cancelled.
concurrent.futures. FIRST_EXCEPTION ¶	The function will return when any future finishes by raising an exception. If no future raises an exception then it is equivalent to `ALL_COMPLETED` .
concurrent.futures. ALL_COMPLETED ¶	The function will return when all futures finish or are cancelled.

concurrent.futures. as_completed ( fs , timeout = None ) ¶: Returns an iterator over the Future instances (possibly created by different Executor instances) given by fs that yields futures as they complete (finished or cancelled futures). Any futures given by fs that are duplicated will be returned once. Any futures that completed before as_completed() is called will be yielded first. The returned iterator raises a TimeoutError if __next__() is called and the result isn’t available after timeout seconds from the original call to as_completed() . timeout can be an int or float. If timeout 未指定或 None , there is no limit to the wait time.

另请参阅

PEP 3148 – futures - execute computations asynchronously: 描述将此特征包括在 Python 标准库的提案。

异常类 ¶

exception concurrent.futures. CancelledError ¶: 引发当 future 被取消时。

exception concurrent.futures. TimeoutError ¶

被弃用别名化的 TimeoutError , raised when a future operation exceeds the given timeout.

3.11 版改变：此类是别名化的 TimeoutError .

exception concurrent.futures. BrokenExecutor ¶

Derived from RuntimeError , this exception class is raised when an executor is broken for some reason, and cannot be used to submit or execute new tasks.

3.7 版添加。

exception concurrent.futures. InvalidStateError ¶

Raised when an operation is performed on a future that is not allowed in the current state.

Added in version 3.8.

exception concurrent.futures.thread. BrokenThreadPool ¶

Derived from BrokenExecutor , this exception class is raised when one of the workers of a ThreadPoolExecutor has failed initializing.

3.7 版添加。

exception concurrent.futures.process. BrokenProcessPool ¶

Derived from BrokenExecutor (formerly RuntimeError ), this exception class is raised when one of the workers of a ProcessPoolExecutor has terminated in a non-clean fashion (for example, if it was killed from the outside).

Added in version 3.3.

内容表

上一话题

下一话题

本页

concurrent.futures — 发起并行任务 ¶

执行器对象 ¶

ThreadPoolExecutor ¶

ThreadPoolExecutor 范例 ¶

ProcessPoolExecutor ¶

ProcessPoolExecutor 范例 ¶

Future 对象 ¶

模块函数 ¶

异常类 ¶

内容表

上一话题

下一话题

本页

`concurrent.futures` — 发起并行任务 ¶