"concurrent.futures" -- 並列タスク実行
**************************************

バージョン 3.2 で追加.

**ソースコード:** Lib/concurrent/futures/thread.py および
Lib/concurrent/futures/process.py

======================================================================

"concurrent.futures" モジュールは、非同期に実行できる呼び出し可能オブ
ジェクトの高水準のインターフェースを提供します。

非同期実行は "ThreadPoolExecutor" を用いてスレッドで実行することも、
"ProcessPoolExecutor" を用いて別々のプロセスで実行することもできます.
どちらも "Executor" 抽象クラスで定義された同じインターフェースを実装し
ます。


Executor オブジェクト
=====================

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(func, *iterables, timeout=None, chunksize=1)

         Similar to "map(func, *iterables)" except:

         * the *iterables* are collected immediately rather than
           lazily;

         * *func* is executed asynchronously and several calls to
           *func* may be made concurrently.

         もし "__next__()" が呼ばれその結果が元々の呼び出しから
         *timeout* 秒経った後も利用できない場合、返されるイテレータは
         "concurrent.futures.TimeoutError" を送出します。*timeout* は
         整数または浮動小数点数です。もし *timeout* が指定されないか
         の場合、待ち時間に制限はありません。

         もし *func* の呼び出しが例外を送出した場合、その例外はイテレ
         ータから値を受け取る時に送出されます。

         When using "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* has no effect.

         バージョン 3.5 で変更: *chunksize* 引数が追加されました。

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

         executor に対して、現在保留中のフューチャーが実行された後で、
         使用中のすべての資源を解放するように伝えます。シャットダウン
         により後に "Executor.submit()" と "Executor.map()" を呼び出す
         と "RuntimeError" が送出されます。

         *wait* が "True" の場合、すべての未完了のフューチャの実行が完
         了して Executor に関連付けられたリソースが解放されるまで、こ
         のメソッドは返りません。 *wait* が "False" の場合、このメソッ
         ドはすぐに返り、すべての未完了のフューチャの実行が完了したと
         きに、 Executor に関連付けられたリソースが解放されます。
         *wait* の値に関係なく、すべての未完了のフューチャの実行が完了
         するまで Python プログラム全体は終了しません。

         If *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.

         "with" 文を使用することで、このメソッドを明示的に呼ばないよう
         にできます。 "with" 文は  "Executor" をシャットダウンします
         (*wait* を "True" にセットして "Executor.shutdown()" が呼ばれ
         たかのように待ちます)。

            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" に関連づけられた呼び出し可能オブジェクトが、別の "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=())

   最大で *max_workers* 個のスレッドを非同期実行に使う "Executor" のサ
   ブクラスです。

   All threads enqueued to "ThreadPoolExecutor" will be joined before
   the interpreter can exit. Note that the exit handler which does
   this is executed *before* any exit handlers added using "atexit".
   This means exceptions in the main thread must be caught and handled
   in order to signal threads to exit gracefully. For this reason, it
   is recommended that "ThreadPoolExecutor" not be used for long-
   running tasks.

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

   バージョン 3.5 で変更: *max_workers* が "None" か指定されない場合の
   デフォルト値はマシンのプロセッサの数に 5 を掛けたものになります。こ
   れは、 "ThreadPoolExecutor" は CPU の処理ではなく I/O をオーバーラ
   ップするのによく使用されるため、 "ProcessPoolExecutor" のワーカーの
   数よりもこのワーカーの数を増やすべきであるという想定に基づいていま
   す。

   バージョン 3.6 で追加: *thread_name_prefix* 引数が追加され、デバッ
   グしやすくなるようにプールから作られたワーカスレッド
   "threading.Thread" の名前を管理できるようになりました。

   バージョン 3.7 で変更: *initializer* と *initargs* 引数が追加されま
   した。

   バージョン 3.8 で変更: Default value of *max_workers* is changed to
   "min(32, os.cpu_count() + 4)". This default value preserves at
   least 5 workers for I/O bound tasks. It utilizes at most 32 CPU
   cores for CPU bound tasks which release the GIL. And it avoids
   using very large resources implicitly on many-core
   machines.ThreadPoolExecutor now reuses idle worker threads before
   starting *max_workers* worker threads too.


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://nonexistant-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
===================

"ProcessPoolExecutor"  はプロセスプールを使って非同期呼び出しを実施す
る "Executor" のサブクラスです。"ProcessPoolExecutor" は
"multiprocessing" モジュールを利用します。このため *Global Interpreter
Lock* を回避することができますが、pickle 化できるオブジェクトしか実行
したり返したりすることができません。

"__main__" モジュールはワーカサブプロセスでインポート可能でなければな
りません。 すなわち、 "ProcessPoolExecutor" は対話的インタープリタでは
動きません。

"ProcessPoolExecutor" に渡された呼び出し可能オブジェクトから
"Executor" や "Future" メソッドを呼ぶとデッドロックに陥ります。

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

   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 the number of processors on
   the machine. If *max_workers* is less than or equal to "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" will be
   raised. If *max_workers* is "None", then the default chosen will be
   at most "61", even if more processors are available. *mp_context*
   can be a 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.

   *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.

   バージョン 3.3 で変更: ワーカプロセスの1つが突然終了した場合、
   "BrokenProcessPool" エラーが送出されるようになりました。 以前は挙動
   は未定義でしたが、 executor や  futures がフリーズしたりデッドロッ
   クを起こすことがしばしばでした。

   バージョン 3.7 で変更: The *mp_context* argument was added to allow
   users to control the start_method for worker processes created by
   the pool.*initializer* と *initargs* 引数が追加されました。


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 オブジェクト
===================

"Future" クラスは呼び出し可能オブジェクトの非同期実行をカプセル化しま
す。 "Future" のインスタンスは "Executor.submit()" によって生成されま
す。

class concurrent.futures.Future

   呼び出し可能オブジェクトの非同期実行をカプセル化します。 "Future"
   インスタンスは "Executor.submit()" で生成され、テストを除いて直接生
   成すべきではありません。

      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" を返します。

      running()

         現在呼び出しが実行中でキャンセルできない場合 "True" を返しま
         す。

      done()

         呼び出しが正常にキャンセルされたか終了した場合 "True" を返し
         ます。

      result(timeout=None)

         呼び出しによって返された値を返します。呼び出しがまだ完了して
         いない場合、このメソッドは *timeout* 秒の間待機します。呼び出
         しが *timeout* 秒間の間に完了しない場合、
         "concurrent.futures.TimeoutError" が送出されます。 *timeout*
         にはintかfloatを指定できます。*timeout* が指定されていないか
         、 "None" である場合、待機時間に制限はありません。

         future が完了する前にキャンセルされた場合 "CancelledError" が
         送出されます。

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

      exception(timeout=None)

         呼び出しによって送出された例外を返します。呼び出しがまだ完了
         していない場合、このメソッドは *timeout* 秒だけ待機します。呼
         び出しが *timeout* 秒の間に完了しない場合、
         "concurrent.futures.TimeoutError" が送出されます。 *timeout*
         にはintかfloatを指定できます。 *timeout* が指定されていないか
         、 "None" である場合、待機時間に制限はありません。

         future が完了する前にキャンセルされた場合 "CancelledError" が
         送出されます。

         呼び出しが例外を送出することなく完了した場合、"None" を返しま
         す。

      add_done_callback(fn)

         呼び出し可能な *fn* オブジェクトを future にアタッチします。
         futureがキャンセルされたか、実行を終了した際に、future をその
         ただ一つの引数として *fn* が呼び出されます。

         追加された呼び出し可能オブジェクトは、追加された順番で呼びだ
         され、追加を行ったプロセスに属するスレッド中で呼び出されます
         。もし呼び出し可能オブジェクトが "Exception" のサブクラスを送
         出した場合、それはログに記録され無視されます。呼び出し可能オ
         ブジェクトが "BaseException" のサブクラスを送出した場合の動作
         は未定義です。

         もしfutureがすでに完了しているか、キャンセル済みであれば、
         *fn* は即座に実行されます。

   以下の "Future" メソッドは、ユニットテストでの使用と "Executor" を
   実装することを意図しています。

      set_running_or_notify_cancel()

         このメソッドは、"Future" に関連付けられたワークやユニットテス
         トによるワークの実行前に、 "Executor" の実装によってのみ呼び
         出してください。

         このメソッドが "False" を返す場合、 "Future" はキャンセルされ
         ています。つまり、 "Future.cancel()" が呼び出されて "True" が
         返っています。"Future" の完了を  ("as_completed()" または
         "wait()" により)  待機するすべてのスレッドが起動します。

         このメソッドが "True" を返す場合、 "Future" はキャンセルされ
         て、実行状態に移行されています。つまり、 "Future.running()"
         を呼び出すと "True" が返ります。

         このメソッドは、一度だけ呼び出すことができ、
         "Future.set_result()" または "Future.set_exception()" がキャ
         ンセルされた後には呼び出すことができません。

      set_result(result)

         "Future" に関連付けられたワークの結果を *result* に設定します
         。

         このメソッドは、 "Executor" の実装またはユニットテストによっ
         てのみ使用してください。

         バージョン 3.8 で変更: This method raises
         "concurrent.futures.InvalidStateError" if the "Future" is
         already done.

      set_exception(exception)

         "Future" に関連付けられたワークの結果を "Exception"
         *exception* に設定します。

         このメソッドは、 "Executor" の実装またはユニットテストによっ
         てのみ使用してください。

         バージョン 3.8 で変更: This method raises
         "concurrent.futures.InvalidStateError" if the "Future" is
         already done.


モジュール関数
==============

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

   Wait for the "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* で結果を返すまで待機する最大秒数を指定できます。*timeout*
   は整数か浮動小数点数をとります。*timeout* が指定されないか "None"
   の場合、無期限に待機します。

   *return_when* でこの関数がいつ結果を返すか指定します。指定できる値
   は以下の 定数のどれか一つです:

   +-------------------------------+------------------------------------------+
   | 定数                          | 説明                                     |
   |===============================|==========================================|
   | "FIRST_COMPLETED"             | いずれかのフューチャが終了したかキャンセ |
   |                               | ルされたときに返します。                 |
   +-------------------------------+------------------------------------------+
   | "FIRST_EXCEPTION"             | いずれかのフューチャが例外の送出で終了し |
   |                               | た場合に返します。例外を送 出したフュー  |
   |                               | チャがない場合は、"ALL_COMPLETED" と等価 |
   |                               | になります。                             |
   +-------------------------------+------------------------------------------+
   | "ALL_COMPLETED"               | すべてのフューチャが終了したかキャンセル |
   |                               | されたときに返します。                   |
   +-------------------------------+------------------------------------------+

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
   "concurrent.futures.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* is not specified or "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

   future の操作が与えられたタイムアウトを超過したときに送出されます。

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.

   バージョン 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

   "BrokenExecutor" から派生しています(以前は "RuntimeError" でした)。
   この例外クラスは "ProcessPoolExecutor" のワーカの1つが正常に終了さ
   れなかったとき (例えば外部から kill されたとき) に送出されます。

   バージョン 3.3 で追加.
