concurrent.futures.Executorのshutdown()におけるwait=TrueとFalseの違い

Question

class concurrent.futures.Executorのshutdown()の引数であるwaitの使い方がわからなくて下記の
公式のドキュメントを参照すると、以下のように記載されています

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

違いとしては、メソッドがすぐに返ってくるかどうかの違いのようですが、具体的になにが変わってくるのでしょうか(wait の値に関係なく、すべての未完了のフューチャの実行が完了するまで Python プログラム全体は終了しません。と書いてあるので、もはや違いが良くわからないです)

Answer 1

たとえば、下記コードで、下から2行目をwait=Trueとすると、すべてのタスクが終了してから、「すべてのタスクが完了しました」と表示されますが、
wait=Falseに変えると、先に「すべてのタスクが完了しました」と表示されてから「タスク#{num} が完了しました.」が順次表示されます。

wait=Trueにすると、shutdown()関数でいったん止まり、submitしたすべてのタスクが完了するまで（submit元のスレッドでは）処理が進みません。
一方、wait=Falseにすると、submitしたタスクの完了状態に関係なく、shutdown()関数からすぐに戻り、submit元のスレッドで処理を継続することができます。
（使い分けはどのようなプログラムにしたいかによります）

from concurrent.futures import ThreadPoolExecutor
import time
from datetime import datetime
th = ThreadPoolExecutor(max_workers=5)

def print_with_time(msg):
    print(f"[{datetime.now().strftime('%Y/%m/%d %H:%M:%S')}] {msg}")

def task(num):
    interval = num*2
    print_with_time(f"タスク#{num}: 完了まで {interval}秒")
    time.sleep(interval)
    print_with_time(f"タスク#{num} が完了しました.")

    
for i in range (5):
    th.submit(task, i+1)

th.shutdown(wait=True) #  <-- ここをFalseに変えてみましょう

print_with_time("＜＜＜すべてのタスクが完了しました＞＞＞")

Comments

[kazu25]

ありがとうございます。非常に分かりやすかったです。参考までにお聞きさせていただきたいのですが、
この情報をどのように得られたのでしょうか。(いつも公式ドキュメントの内容が抽象的過ぎて行き詰ることがよくあるため)

[sfdust]

上記に書いたwaitの違いによる挙動変化については、「○○のサイトで得た情報」というよりは、「TrueとFalseに変えて結果の違いを見るためのコード」を書いてみて、その「結果」から得られた知見、ということになります。

（上記のコード自体は自分のオリジナルです。したがって「どこからのコード」「どこからの情報」という出典を上げることもできないので・・・）

一つ上げるとすれば、ThreadPoolExecutor.shutdown()が定義されているライブラリ（thread.py）のソースコードは確認しました。（visual studio codeなら、Ctrl+クリックするだけで、ライブラリのソースコードに飛べるので）

スレッド関係については、自分でアプリを作る過程で「ThreadPoolExecutor」とか「スレッド」とかのキーワードで検索し、いろんなサイトを見てそこに書かれているコードを取り入れたりした結果、知識が多少ついたかなという感じです。

「○○サイトの記事がわかりやすいです」と具体的にご案内できればよかったのですが・・・あまり参考にならずにすみません。

[kazu25]

有益な情報をありがとうございます。

[LifeGoseon]

参考になりました！
ありがとうございます！