Tcl_AsyncDelete: async handler deleted by the wrong thread 対策

Question

前提・実現したいこと

GUIを「停止」ボタンを押さずに右上の×で閉じると、ループが動作し続けてしまうので、
×を押すと停止するようにさせたい。
また、スレッドが並列で立ち上がっているからなのか、何回か実行を繰り返していると、
下記エラーが発生しカーネルが停止してしまうので対策を立てたい。

Tcl_AsyncDelete: async handler deleted by the wrong thread

該当のソースコード

# -*- coding: utf-8 -*-
import tkinter as tk
import threading

class MainWin(tk.Frame):
    def __init__(self,master):
        super().__init__(master)
        self.grid()
        self.master.geometry("100x50")
        self.master.title("MainWindow")
        self.create_widgets()
        self._resetbutton()
        
    def create_widgets(self):
        # 実行ボタンの作成
        self.button_run = tk.Button(self, text="実行", command=self.mainstart) 
        self.button_run.grid(row=0, column=0)
        # 停止ボタンの作成
        self.button_stop = tk.Button(self, text="停止", command=self._resetbutton) 
        self.button_stop.grid(row=0, column=1)

    def _resetbutton(self):
        self.running = False
        self.button_run.config(text="実行", command=self.startthread,state=tk.NORMAL)
        
    def startthread(self):
        self.running = True
        newthread = threading.Thread(target=self.mainstart)
        newthread.start()
        self.button_run.config(text="実行", state=tk.DISABLED)
        self.button_stop.config(text="停止", command=self._resetbutton)

    def mainstart(self):
        while self.running:
            print("start")
            print("stop")
          
def main():
    root = tk.Tk()
    app = MainWin(master=root)
    app.mainloop()

if __name__ == "__main__":
    main()

補足情報（FW/ツールのバージョンなど）

Python 3.8.3
Spyder 4.1.4

Answer 1

エラーについては再現できませんが、
スレッドで実行してる関数内で、tkinter にアクセスしてませんか？

---

簡単な回避策: デーモンスレッドにする

スレッド内でリソース等の後始末が不要な場合にのみ使えます。

newthread = threading.Thread(target=self.mainstart, daemon=True)

他のスレッドがなくなった場合、自動的に破棄されるようになるので、
単純なケースでは、プログラム終了時に破棄されます。

但し、mainstart の内容次第では、適切な解決策でない場合もあり。

---

解決策: スレッドをインスタンス変数に格納し、後始末をきちんとする。

右上のボタンを押したときの挙動については

root.protocol("WM_DELETE_WINDOW", cload_callback_func)

で終了前に呼び出す関数を登録できます。

スレッドの後始末の手順は、

• 準備: 別のメソッドからもスレッドを参照したいので、

　スレッドをインスタンス変数にしておく newthread -> self.thread

• ループ終了フラグを変更して
• スレッドをjoin() で完了を待つ

　但し、thread.join はメインスレッドで実行することになりますが、
GUI が稼働中に呼び出すとGUIがフリーズするので、呼び出すタイミングには注意。

※ 例えば、停止処理の _resetbutton() は tk のボタンを参照してるので、
後始末処理の中では呼び出してはいけません。
スレッドの完了を待っている間は GUI は動かない。

Tcl_AsyncDelete については、
サブスレッドでの処理の内容や後始末の仕方次第では起こり得ますが、
（再現できなかったため詳細は解りません）

質問の右上のウィンドウを閉じて終了した場合の対策は、以上で出来るはずです。

---

--- main.py	2021-04-09 16:45:01.292878500 +0900
+++ test03.py	2021-04-09 17:11:24.982730000 +0900
@@ -5,6 +5,7 @@
 class MainWin(tk.Frame):
     def __init__(self,master):
         super().__init__(master)
+        self.thread = None
         self.grid()
         self.master.geometry("100x50")
         self.master.title("MainWindow")
@@ -13,7 +14,7 @@
 
     def create_widgets(self):
         # 実行ボタンの作成
-        self.button_run = tk.Button(self, text="実行", command=self.mainstart) 
+        self.button_run = tk.Button(self, text="実行", command=self.startthread) 
         self.button_run.grid(row=0, column=0)
         # 停止ボタンの作成
         self.button_stop = tk.Button(self, text="停止", command=self._resetbutton) 
@@ -21,23 +22,32 @@
 
     def _resetbutton(self):
         self.running = False
-        self.button_run.config(text="実行", command=self.startthread,state=tk.NORMAL)
+        self.button_run.config(state=tk.NORMAL)
 
     def startthread(self):
         self.running = True
-        newthread = threading.Thread(target=self.mainstart, daemon=True)
+        newthread = threading.Thread(target=self.mainstart)
         newthread.start()
-        self.button_run.config(text="実行", state=tk.DISABLED)
-        self.button_stop.config(text="停止", command=self._resetbutton)
+        self.thread = newthread
+        self.button_run.config(state=tk.DISABLED)
+        self.button_stop.config(state=tk.NORMAL)
 
     def mainstart(self):
         while self.running:
             print("start")
             print("stop")
 
+    def cleanup(self):
+        if self.thread:
+            self.running = False
+            self.thread.join()
+            self.thread = None
+        self.master.destroy() # self.master must be root object
+
 def main():
     root = tk.Tk()
     app = MainWin(master=root)
+    root.protocol("WM_DELETE_WINDOW", app.cleanup)
     app.mainloop()
 
 if __name__ == "__main__":

Comments

[sobagome]

詳細に解説頂きありがとうございます。
root.protocol("WM_DELETE_WINDOW", cload_callback_func)
を組み入れて右上の×ボタンを押すと、ループの動作が停止するようになりました。
頂いたコードを微修正して解決方法に再度コードを追記しました。
ただ、やはりGUIを立上げ→実行釦を押してループ中に×を押してGUIを閉じる→再度GUIを立ち上げる→実行釦を押すと、
Tcl_AsyncDelete: async handler deleted by the wrong thread
上記エラーが発生します。

＞スレッドで実行してる関数内で、tkinter にアクセスしてませんか？
この助言に当たる内容が恐らく本質なのだと思いますが、現状のコードにも存在しているのでしょうか。
startthread関数内の下記2行がtkinterにアクセスしているものかと思い、
self.button_run.config(state=tk.DISABLED)
self.button_stop.config(state=tk.NORMAL)
を除外してみましたが、結果は同じでした。

[teamikl]

＞ループ中に×を押してGUIを閉じる→再度GUIを立ち上げる→実行釦を押す

一点、把握漏れがありました。
確認:
- サブウィンドウではなく、メインウィンドウを閉じて一旦そのプロセスを終了した状態から
　再度立ち上げた場合でしょうか？
- Spyder ではなく、端末での実行で問題の動作は確認できますか？
　こちらで確認したのは端末での実行のみでした。

コードは見た感じ問題なさそうなので、実行環境の問題かもしれません。

[teamikl]

もう一点見逃してました、カーネルというのは Spyder のカーネルですよね。
関連のありそうな issue
https://github.com/spyder-ide/spyder/issues/14627

日本語の場合: ツール→設定→IPythonコンソール→グラフィクスtab→グラフィクスのバックエンド

を試してみてください。

----
>startthread関数内の下記2行がtkinterにアクセスしているものかと思い、
> ～を除外してみましたが、結果は同じでした。

startthread 関数はメインスレッドで呼ばれるので問題ありません。

mainstart 関数がPythonのサブスレッドで実行される関数ですが、
Tcl_AsyncDelete に関しては、Pythonのコードが実行されるスレッドではなく、
Tcl のコードのスレッドの問題なので、ここに関しては別問題でした。

[sobagome]

＞サブウィンドウではなく、メインウィンドウを閉じて一旦そのプロセスを終了した状態から再度立ち上げた場合でしょうか？
-メインウインドウを閉じてプロセスを終了して、再度立上げた状態です。

＞ Spyder ではなく、端末での実行で問題の動作は確認できますか？こちらで確認したのは端末での実行のみでした。
-コマンドプロンプトでの実行が上手くいかないので、jupyter notebookで実行を試しましたが、下記コメントが発生し停止しました。
The kernel appears to have died. It will restart automatically.

＞日本語の場合: ツール→設定→IPythonコンソール→グラフィクスtab→グラフィクスのバックエンドを試してみてください。
- 設定がインラインになっていたので、リンク先に従って「自動」、若しくは「Tkinter」の2パターン適用して試しましたが、結果は同じくTcl_AsyncDelete が発生しました。

-解決には至っていませんが、おっしゃるように実行環境の問題のような気がします。

[teamikl]

＞コマンドプロンプトでの実行が上手くいかないので

こちらを先に詰めるべきですね。
ちなみに、実際に実行しているコードと質問に掲載のコードは同じものですか？（確認点）

jupyter notebook で実行する場合、
もう少し、jupyter や tkinter の構成を把握する必要があって

ノートブック等の対話環境ではコード断片を
後から任意のタイミングで実行できるので、
稼働中のプロセスに対してコードを送るといった方式を取ってます。

通常の端末からの実行であれば、
プロセス終了時にソースの解放が行われ、
２度目の実行では新しい環境での実行になりますが、

対話実行の環境では、プロセスを維持し続ける必要がある為
「ウィンドウを閉じる」操作が、プロセスの終了に直結しません。
回答に書いた、デーモンスレッドも意図したタイミングに終了されないと思います。

繰り返し実行したい場合は、通常の実行であれば自動的に行われるような
リソースの解放等の後始末を自分で明示的に行う必要があることも有ります。

→再度立ち上げた場合に問題が起こる事から、ここの問題が濃厚です。
（リソース: 具体的には Tkinter 内部のスレッド)

----
https://bugs.python.org/issue39093

問題の再現自体が出来てないので、解決できるか確証はありませんが、

終了時に quit() を呼び出してみてください。
- A案: self.master.destroy() 後に self.master.quit()
- B案: app.mainloop() 後に root.quit()

後始末の案(リソースの解放) main()関数の最後に
root = app = None
import gc
gc.collect()

[sobagome]

＞コマンドプロンプトでの実行が上手くいかないので
＞こちらを先に詰めるべきですね。
＞ちなみに、実際に実行しているコードと質問に掲載のコードは同じものですか？（確認点）
-実際に実行しているコードも質問掲載コードと同一のものです。ちなみに、解決してコマンドプロンプトからも実行を試すことができました。その場合はTcl_AsyncDelete は出ませんでした。

＞後始末の案(リソースの解放) main()関数の最後に
＞root = app = None
＞import gc
＞gc.collect()
-こちらを追記することにより、Spyder及びjupyter notebook 環境でもTcl_AsyncDelete が出ないことを確認できました！ガベージコレクションによるリソースの解放を明示する必要があるということですね。

-以上より、私の質問に対して全て解決頂く事が出来ました。理由まで記載頂いたので、初学者の私にとっては非常に勉強になりました。何度も読み直して理解を深めたいと思います。ご丁寧にご回答頂きありがとうございました。

Answer 2

# -*- coding: utf-8 -*-

import tkinter as tk
import threading
import gc

class MainWin(tk.Frame):
    def __init__(self,master):
        super().__init__(master)
        self.thread = None
        self.grid()
        self.master.geometry("100x50")
        self.master.title("MainWindow")
        self.create_widgets()

    def create_widgets(self):
        # 実行ボタンの作成
        self.button_run = tk.Button(self, text="実行", command=self.startthread) 
        self.button_run.grid(row=0, column=0)
        # 停止ボタンの作成
        self.button_stop = tk.Button(self, text="停止", command=self._resetbutton) 
        self.button_stop.grid(row=0, column=1)

    def _resetbutton(self):
        self.running = False
        self.button_run.config(state=tk.NORMAL)

    def startthread(self):
        self.running = True
        newthread = threading.Thread(target=self.mainstart)
        newthread.start()
        self.thread = newthread
        self.button_run.config(state=tk.DISABLED)
        self.button_stop.config(state=tk.NORMAL)

    def mainstart(self):
        while self.running:
            print("start")
            print("stop")
            
    def cleanup(self):
        if self.thread:
            self.running = False
            self.thread.join()
            self.thread = None
        self.master.destroy() # self.master must be root object


def main():
    root = tk.Tk()
    app = MainWin(master=root)
    root.protocol("WM_DELETE_WINDOW", app.cleanup)
    app.mainloop()
    root = app = None
    gc.collect() 

if __name__ == "__main__":
    main()