Python3 Tkinter スレッドで応答なしになる

Question

Tkinterで画面表示、別スレッドでウィジェットのステータスを変更します。

スレッドを生成、複数のウィジェットのステータスを変更します。
そこで、ウィンドウの閉じるボタンを押すと応答なしになります。

処理が多すぎるのが原因でしょうか？

time.sleep()の値を増やしたら少しは軽くなりましたが、
この値はあまり増やしたくはありません。
（スレッドをもっと生成して、処理を分散させるべき？）

対処方法はありますか？

Windowsです。

import threading
import time
import tkinter as tk


def func():
    global flag, labels
    cnt = 0
    while flag:
        for i in range(150):
            labels[i]["text"] = str(cnt)
        cnt += 1
        time.sleep(0.1)

def close():
    global flag, thread, win
    flag = False
    thread.join()
    win.destroy()


win = tk.Tk()
win.geometry("200x100")

labels = []
for i in range(15):
    for j in range(10):
        label = tk.Label(win)
        label.grid(row=i, column=j)
        labels.append(label)

flag = True
thread = threading.Thread(target=func)
thread.start()

win.protocol("WM_DELETE_WINDOW", close)
win.mainloop()

thread.join()を消すと応答なしにはなりませんが、
ウィンドウを閉じた後にスレッドの処理をしようとしてエラーになったり、
VSCodeで終わっていないような振る舞い（添付画像）をします。

after()をサブスレッドから呼び出し（これもダメか･･･）

import tkinter as tk
import threading
import queue

def func1():
    global flag, labels, win
    cnt = 0
    while flag:
        txt = str(cnt)
        win.after_idle(lambda:func2(txt))
        cnt += 1

def func2(txt):
    global labels
    for i in range(150):
        labels[i]["text"] = txt

def close():
    global flag, thread, win
    flag = False
    thread.join()
    win.destroy()

if __name__ == "__main__":

    win = tk.Tk()

    row = 15
    column = 10
    labels = []

    for i in range(row):
        for j in range(column):
            label = tk.Label(win)
            label.grid(row=i, column=j)
            labels.append(label)

    flag = True
    thread = threading.Thread(target=func1)
    thread.start()

    win.protocol("WM_DELETE_WINDOW", close)
    win.mainloop()

afterの呼び出しをサブスレッドからメインスレッドに変更
（これは上手くいっている？）

import tkinter as tk
import threading
import time
import queue

def loop():
    global data, flag
    cnt = 0
    while flag:
        data.put(str(cnt))
        cnt += 1
        time.sleep(0.1)

def disp():
    global data, flag, label1, label2
    while not data.empty():
        tmp = data.get()
        label1["text"] = tmp
        label2["text"] = tmp
    win.after(10, disp) # 指定時間[ms]はloop()の更新時間[s]より短くしないと、while not data.empty()で瞬間的に処理されてしまう

def close():
    global flag, thread, win
    flag = False
    thread.join()
    win.destroy()


win = tk.Tk()

data = queue.Queue()

label1 = tk.Label(win)
label1.grid()
label2 = tk.Label(win)
label2.grid()

flag = True
thread = threading.Thread(target=loop)
thread.start()

# winが存在する（破棄されていない）場合はdisp()を実行
win.after_idle(disp)    # labelを破棄する予定はないので、winでafter設定

win.protocol("WM_DELETE_WINDOW", close)
win.mainloop()

Answer 1

sleep のタイミングで閉じないと終了できないコードになってます。

複数の問題があるので個別に見ていきましょう。
2つの問題があります、

---

ウィジェットをたくさん作っている為、終了が遅くなる

少しは軽くなった　→　終了に時間が掛かるのは、ウィジェットの数が多い為です。

終了時に時間が掛かる問題を再現するコード

import tkinter as tk

root = tk.Tk()
for _ in range(20000): # <--- ここの値は適宜調整してください
    label = tk.Label(root)
    label.place(x=0, y=0)
    label.place_forget()
else:
    print(label)
tk.Button(root, text="destroy", command=root.destroy).pack()
tk.Button(root, text="quit", command=root.quit).pack()
root.mainloop()

• Python内での label は、次のループで上書きされますが、

tk 側ではラベルは残り続けます。

• destroy では、全てのウィジェットをプログラム終了前に破棄しようとします
• quit では先にイベントループを終了します。

これの回避策としては root.quit() の利用がありますが、
対処の方法としては、Canvas を使い独自のウィジェットを実装すると、
一つのウィジェットで済みます。

---

スレッドからGUIを操作しているので、終了時にデッドロック

• それとは別に、応答なしになって終了できなくなるのは、

　スレッド内でGUI操作を行っている為。

sleep 中に閉じないと終了できないコードになってます。

sleep を増やすと終了できるようになるのは、
sleep 中に閉じるを押す確率が上がった為です。
再現が難しくなるだけで、タイミング次第では応答なしになります。

---

わかりやすく問題を再現する為に、
ラベルを変更する前後で sleep を挟んでます。

• sleep 3秒 <--- before text: ここで閉じると
• ラベル変更 　　　　　(thread.join時は) GUIイベントが処理できないデッドロック
• sleep 3秒 <--- after text: ここで閉じると
• flag 終了チェック　　正常終了

import time
import threading
import tkinter as tk
import logging

flag = True

def worker():
    global flag
    for i in range(5):
        logging.debug("before text")
        time.sleep(3)

        # ここで閉じるとデッドロック(応答なし)
        
        # スレッド内で GUI 操作関連のコードを実行する為には
        # メインスレッドでmainloop()が稼働していないといけません。
        # 
        # しかし、メインスレッドでは thread.join でスレッドの終了を待っていて
        # サブスレッド側では、メインスレッドがイベントループに処理が戻るのを待っています。
        # どちらも待機状態のまま終わることが無い為、応答なしとなります。
        label["text"] = str(i)
        logging.debug(f"text = {i}")

        # ここで閉じると、正常終了

        logging.debug("after text")
        time.sleep(3)
        
        if not flag:
            break

logging.basicConfig(
    level=logging.DEBUG,
    format="%(threadName)s %(message)s")

root = tk.Tk()
label = tk.Label(root)
label.pack()

thread = threading.Thread(target=worker)
thread.start()

def close():
    global flag
    flag = False

    # スレッドの終了を待つブロッキング処理
    logging.debug("thread join")
    thread.join()

    # スレッドが終了するまでここは実行されない
    # thread.join により tkinter のイベントループは停止中

    logging.debug("root destroy")
    root.destroy()

root.protocol("WM_DELETE_WINDOW", close)
root.mainloop()

サブスレッドからのスレッドセーフでない操作(ラベルの更新部分)
を排他制御することで回避は出来ますが、コードは複雑化します。
キューを使うと幾分かシンプルにはなりますが。

これの対処法は、GUIのイベントループのタイマーを使い実装する事です。

基本的に、GUIの描画を更新できるのはイベントループを持つスレッドのみなので、
スレッドを増やすと解決出来る問題ではなく、
また、スレッドの用法としても適切ではありません。

スレッドでは(GUIに依存しない部分の)演算のみを行い、
描画は GUI のイベントに任せる、というのが問題の少ない使い方です。

---

Comments

[person]

回答ありがとうございます。
先ほどafter()を使って試してみたのですが、すこしかくつくものの応答なしにはなりませんでした。
GUIのイベントループで処理するのであれば、after()を使った方がいいですかね。

その場合、ラベルのテキスト内容をCSVやiniファイルから拾う場合もこれで大丈夫でしょうか。

[teamikl]

＞先ほどafter()を使って試してみたのですが、すこしかくつくものの応答なしにはなりませんでした。

もし、ゲームのような高速なアニメーションを期待してなら
タイマーの精度の問題で期待通りの描画更新速度は出ないかもしれません。

ゲーム系のコードでは、意図的にmainloop() は使わず、
任意のタイミングで 頻繁に update() / update_idletasks() を呼び、
イベントを滞らせることなくスムーズなアニメーションを実現するようです。

----

> その場合、ラベルのテキスト内容をCSVやiniファイルから拾う場合もこれで大丈夫でしょうか。

いいえ。ファイルの読み込み等はスレッドの利用が適切です。
読み込んだ値を加工まではスレッドで担当し、
表示のみメインスレッドへqueue等で渡すようにしてください。
(メインスレッド側のキューの読み出しでもタイマーを使う等、一工夫必要になります）

[teamikl]

補足で、理由の説明
tkinter のタイマーでファイルの読み書きをすると…

- ファイルやネットワークなどのIO はブロッキング操作の為、
　障害等何らかの理由で、読み込みがうまくいかない＆時間が掛かった時
　イベントループに処理が戻らず、応答なしになる可能性があります。

- CSVを after() で読み出す場合、
　1行ずつ読み込む必要があるのですが、タイマーを挟むと
　実質ループ内で time.sleep したような動作になり、
　読込速度が遅くなり、十分なパフォーマンスを得られません。

プログラムの冒頭で ini ファイルを読込など、
小規模＆用途次第では、実際の運用上問題にならない場合もあるので、
全てのファイル読み書きを別スレッドでとまではいきませんが、
CSVファイル等は、出来るなら別スレッドで処理した方が良いと思います。

追記:
題材のコードではスレッドでのラベル更新だけなので、
ここだけならタイマーでの実装が適切ですが、
実際の用途(CSVファイルの読み込み＆GUIの更新 を想定)では、

- ファイル読み込み部分をThread
- ファイルから読み込んだデータをキューに入れる
- メインスレッドからはタイマーでキューを読み出して ラベルを更新

Answer 2

意図的にmainloop() は使わず、

任意のタイミングで 頻繁に update() / update_idletasks() を呼び、
イベントを滞らせることなくスムーズなアニメーションを実現するようです

自己レスですが、動作確認用のコード投稿しておきます。
質問に対する解決策という訳ではありません

注意点: メインスレッド内でループや time.sleep() を使う
というのは、一般的なGUIプログラミング
(イベント駆動プログラミング全般)では避けた方が良いのですが。

この場合の、while True: ～はこれ自体が イベントループの役割をする為、
mainloopは使わない形になります。

もう一つ注意点:
flag でループを抜ける判定の位置について、
このイベントループ内で WM_DELETE_WINDOW の関数が呼ばれるのは
update/update_idletasks の内部です。

close() が呼ばれた後、直ぐに flag 判定が行われるように
ループの終了条件を配置します。

win.destroy() が呼ばれた後 ラベル更新しようとするとエラーになります。

import time
import tkinter as tk

def main():
    flag = True
    cnt = 0

    win = tk.Tk()
    win.geometry("200x100")

    def close():
        nonlocal flag
        flag = False
        win.destroy()

    win.protocol("WM_DELETE_WINDOW", close)

    labels = []
    for i in range(15):
        for j in range(10):
            label = tk.Label(win)
            label.grid(row=i, column=j)
            labels.append(label)

    while True:
        for i in range(150):
            if not flag:
                return
            labels[i]["text"] = cnt
            win.update_idletasks()
        else:
            win.update()
        cnt += 1
        time.sleep(0.1)


if __name__ == '__main__':
    main()

Comments

[person]

知識不足で申し訳ないのですが、
update() と update_idletasks() がどういう関数か教えていただけますか？

関数のコメントに
update()には
> Enter event loop until all pending events have been processed by Tcl.
update_idletasks()には
> Enter event loop until all idle callbacks have been called. This
will update the display of windows but not process events caused by the user.

とありますが、いまいち意味が分からなかったので･･･。

[teamikl]

描画や入力イベントの処理を行う関数です。

mainloop() と同じようなイベントループで、mainloop() との違いは
mainloop はウィンドウが閉じられる迄のループ。
update～は、待機中のイベントがなくなるとループを抜けます。

update/update_idletasksの違いは、
update_idletasks だと処理されないイベントがある点です。

上記のコードで意図してる動作は、
update_idletasks でラベルの反映
update で、それ以外のイベントの処理。
(但し、この例のコードでは他のイベントはないので update は何もしません）

よくわからない場合は、update_idletasks() で十分です、
不十分な場合のみ update() を使います。
ですが、イベント処理は そもそも mainloop へ処理を戻せばよいので、
極力、メインスレッド内では、他のループ等で処理をブロックするような操作は避けた方が良いです。

[person]

> 上記のコードで意図してる動作は、
> update_idletasks でラベルの反映
> update で、それ以外のイベントの処理。
> (但し、この例のコードでは他のイベントはないので update は何もしません）

update_idletasks()などが必要（？）なのはウィジェットの処理が多いからですか？
どういう場面に直面した時に必要かどうか判断すればいいのかわかりません。

あと、スレッドでファイル読み込み→キュー→メインスレッドでラベル変更についてはteamikl様の上記ソースコードを参考にしてみたいと思います。
今のところ、まだうまくできていないのですが、イメージ的にはこんな感じですかね（質問文に追記）？

[teamikl]

>update_idletasks()などが必要（？）なのはウィジェットの処理が多いからですか？
>どういう場面に直面した時に必要かどうか判断すればいいのかわかりません。

通常は、update ～はあまり使わずに済ませるのが良いです。
update 自身もループなので、mainloopの中でループというのは
あまり良い方法ではありません。

デバッグ時のスタックトレース情報が深くなり、
問題を探すのが複雑なる傾向になります。

このコードはスレッドを使わず
メインスレッドで mainloop の代わりに
独自にイベントループを組んでいる為、update～を使ってます。

このコード自体は、今回の質問に対する解決策としてではなく、
その後のコメントの流れで提示した例と言うのを了承ください。

上記のアプローチでのイベントループ構築は
- ゲーム系のコード
- 他のGUIの埋め込み
- 非同期ライブラリ asyncio を使ったコード

等で、mainloopを使えない(他方もイベントループを持つ)状況があるので、
そういった場合に、独自のイベントループを構築する為に用います。

他には、個人的にはお勧めな方法ではありませんが

- 「メインスレッドで」時間の掛かるループを処理したい時

for line in 大きなファイル読み込み:
　do_something(line)
　root.update() # <-- ファイル読み込み梅雨に「閉じる」等のイベントが処理されるようにする

こういった場合は、大抵スレッドで処理した方がよいです。
(update/update_idletasks 使い分けは、
他で使ってるイベント次第なので実際に試してください。）

[teamikl]

＞イメージ的にはこんな感じですかね（質問文に追記）？

この私の回答のコード (update を用いたループ) は、不要です。
普通は、mainloop を使う方法で大丈夫です。

サブスレッド→メインスレッドのキューの読み出しに関しては
いろいろな方法があるので、どの方法が適切なのかは状況次第ですが、

- after_idle を使う

queue の代わりに、サブスレッドから after_idle を使う方法
タイマーに登録された関数は、mainloop で呼び出す為、
メインスレッドで実行されます。

- 定期的にタイマーでキューを読み出す

ファイル読み込み等の用途には合いませんが、
処理速度が重要でない場合等では使える方法。
キューの読み出しでは、キューが空の時は待機してしまわないように
ノンブロッキングモード(get_nowait())にします。

- event_generate で通知する

queueにput した後に、event_generate で独自イベントを生成します。
bind で独自イベントに対して、キューから読み出しを行う関数を登録します。

# sub-thread側
queue.put(item)
root.event_generate("<<QueuePut>>")

# main-thread側
def process_queue(event):
　item = queue.get()
　...
root.bind("<<QueuePut>>", process_queue)

[person]

一旦、mainloop()を使う方法でもう少し試してみます。