Tkinterでファイルダイアログを再度開くとエラーになる

Question

##解決したいこと
ほかのプログラムを動かしているときに、Tkinterのファイルダイアログ（filedialog）を実行し、ファイルを選択するプログラム。一度目は成功するが、二度目は下記のようなエラーが発生する。それを防ぎたい。

##コード

import pyxel as px
import tkinter as tk
import tkinter.filedialog
import os
import threading

class App:
	def __init__(self):
		self.sp = None #選択されたファイルのファイルパス
		px.init(250,125,caption="")
		px.run(self.update, self.draw)

	def update(self):
		if px.btnp(px.KEY_Q):
			px.quit()

		if px.btnp(px.KEY_F):
			threading.Thread(target = self.open_file).start()#pyxelとtkinterを同時実行

	def draw(self):
		px.cls(0)
		px.text(0,0,str(self.sp),7) #指定されたファイルパスを表示

	def open_file(self):
		fTyp = [("","")]
		iDir = os.path.abspath(os.path.dirname(__file__))
		selected_file_path = tkinter.filedialog.askopenfilename(filetypes = fTyp,initialdir=iDir)　#ファイルパスの入力
		self.sp = selected_file_path

App()

##エラー

Exception in thread Thread-2:
Traceback (most recent call last):
  File "C:\Users\Sakuramochi\AppData\Local\Programs\Python\Python39\lib\threading.py", line 950, in _bootstrap_inner
    self.run()
  File "C:\Users\Sakuramochi\AppData\Local\Programs\Python\Python39\lib\threading.py", line 888, in run
    self._target(*self._args, **self._kwargs)
  File "c:\Users\Sakuramochi\kpp\Pyxel\pyxel coder\pyxel_coder.py", line 27, in open_file
    selected_file_path = tkinter.filedialog.askopenfilename(filetypes = fTyp,initialdir=iDir)
  File "C:\Users\Sakuramochi\AppData\Local\Programs\Python\Python39\lib\tkinter\filedialog.py", line 382, in askopenfilename
    return Open(**options).show()
  File "C:\Users\Sakuramochi\AppData\Local\Programs\Python\Python39\lib\tkinter\commondialog.py", line 42, in show
    w = Frame(self.master)
  File "C:\Users\Sakuramochi\AppData\Local\Programs\Python\Python39\lib\tkinter\__init__.py", line 3121, in __init__
    Widget.__init__(self, master, 'frame', cnf, {}, extra)
  File "C:\Users\Sakuramochi\AppData\Local\Programs\Python\Python39\lib\tkinter\__init__.py", line 2569, in __init__
    self.tk.call(
RuntimeError: main thread is not in main loop

##バージョン
Python-最新
tkinter-8.6.9
pyxel-1.4.3

Answer 1

エラーについては解決済みなので、掘り下げる必要はないかもしれませんが、
動作確認のために書いたコード張っておきます。

---

#!/usr/bin/env python3.8

import tkinter as tk
from tkinter.filedialog import askopenfilename
from threading import Thread


def open_dialog():
    filename = askopenfilename()
    print("Filename: {}".format(filename))


def main():
    root = tk.Tk()

    thread1 = Thread(target=open_dialog, daemon=True)
    thread2 = Thread(target=open_dialog, daemon=True)

    # イベントループ開始後にスレッド開始
    root.after_idle(thread1.start)
    root.after_idle(thread2.start)

    root.mainloop() # 課題: ここが px.run とは共存できない


if __name__ == '__main__':
    main()

普通の tkinter の作法で mainloop を使う解決策。この場合のtkのイベントループは
root オブジェクトが作られたスレッドと同じスレッドで稼働してる為、
スレッド側で新たに作らなくとも、デフォルトのrootオブジェクトの利用で問題ありません。

別の課題があって、pyxel のイベントループどのように一緒に使うかが難しい点。
→ 解決案は後述

---

tkinter のみでのエラーの再現。

スレッド内で複数回 root オブジェクトを作るのは、
同時起動の際に問題になる事があります。

以下のコードは２つ目のダイアログを「同時に」開こうとする際にエラー。
この場合、parent=root とすることで回避可能。

#!/usr/bin/env python3.8

from threading import Thread
import tkinter as tk
from tkinter.filedialog import askopenfilename


def open_dialog():
    root = tk.Tk()
    root.withdraw()

    filename = askopenfilename() # XXX:  (parent=root)
    print("Filename: {}".format(filename))

    root.destroy()


def main():
    thread1 = Thread(target=open_dialog)
    thread1.start()

    # NOTE: 複数の root を作っている為、２つのダイアログを同時に開ける
    thread2 = Thread(target=open_dialog)
    thread2.start()

    # ダイアログが閉じられるのを待つ
    thread1.join()
    thread2.join()


if __name__ == '__main__':
    main()

---

原因は、イベントループとtk.Tk()の作成されたスレッドが異なる事なので、
別スレッドで非表示の tkinter mainloop を起動しておく解決案。

#!/usr/bin/env python3.8

from threading import Thread, Event
import tkinter as tk
from tkinter.filedialog import askopenfilename

def tk_dummy_loop(event):
    root = tk.Tk()
    root.withdraw()
    root.after_idle(event.set) # mainloop内から呼び出される。イベント待機へ通知
    root.mainloop()


def open_dialog():
    filename = askopenfilename()
    print("Filename: {}".format(filename))


def main():
    event = Event()
    thread1 = Thread(target=tk_dummy_loop, args=(event,), daemon=True)
    thread1.start()
    event.wait() # mainloop起動を待つ

    thread1 = Thread(target=open_dialog)
    thread1.start()

    # NOTE: tkinter のイベントループはひとつなので、スレッドは起動中だが
    # ２つ目のダイアログは１つ目のダイアログが閉じられる迄開かない
    thread2 = Thread(target=open_dialog)
    thread2.start()

    # この方法の場合は、メインスレッドで px.run が使える

    # スレッドの終了待ち
    thread1.join()
    thread2.join()


if __name__ == '__main__':
    main()

tkinter mainloop のスレッドには daemon=True を指定し、強制終了。

Comments

[sakuramochi_py]

いろいろとありがとうございます。
参考にさせて戴きます

Answer 2

ベストアンサーさんの回答を参考にしました。

def open_file(self):
	root = tk.Tk()
	root.withdraw()
	fTyp = [("","")]
	iDir = os.path.abspath(os.path.dirname(__file__))
	selected_file_path = tkinter.filedialog.askopenfilename(filetypes = fTyp,initialdir=iDir)
	self.sp = selected_file_path
	root.deiconify()
	root.destroy()

これで不必要なTkinterウィンドウも非表示でエラー無く実行できます。

Comments

[nto]

deiconifyを使用しなくても、withdrawのままrootのdestroyは可能ですよ。
またファイルを選択せずキャンセルをした場合等の処理も分岐させた方が良いでしょう。

[sakuramochi_py]

deiconify 必要ないんですね！
Tkinter について詳しくないのでとてもありがたいです。
分岐等は後から付け足します

[teamikl]

通常の利用では問題ないので不要かもしれませんが、
一度目のダイアログを「閉じずに」もう一度ダイアログを開こうとした場合、
同様のエラーがでると思います。

スレッドセーフにするには、上記のコードからは
askopenfilename の引数に parent=root を明示することで回避できます。

[sakuramochi_py]

その件については大丈夫です、
ファイルダイアログが開いている間は開けないようにしました

Answer 3

エラーメッセージの通りで、main loopが無いのです。
tkinterのお作法に則って、main loopを作成しましょう。

また、pyxelとtkinterを同時実行と記載されていますが、これはかなり難しいでしょう。
初心者ならば、使う部分を分けて使うように考えた方が良いかと思います。

例えば、ゲームのシナリオをファイルから読むとかであれば、ゲームの開始前にロード（tkinter）を使い、その後pyxelを使うようにするとか。

Comments

[sakuramochi_py]

やはりmain loopは必要不可欠なんですね…
Pyxelでテキストエディタを作っていて、ファイル選択にTkinterを選びました。いつでも自由にファイル選択をしたいので同時実行で頑張ってみることにします。
回答ありがとうございました。

[teamikl]

tkinter の 訂正: (mainloop 自体はダイアログ内で使われていて)
※ 今回のコード場合はダイアログのみの利用の為使われていない
エラーはスレッドに関するものなので、１～２行目の原因の説明が違います。

tkinter モジュールは、tcl/tkライブラリと通信する為のrootオブジェクトを
初期化時に作成するのですが、初回作成時に
これをモジュール内のグローバル変数に保持し、
２回目以降で再利用されるようになってます。

１回目は同一スレッドで作成される為、問題なし。
２回目は前のスレッドで作成されたオブジェクトの為エラーとなってます。
別回答にあるように、毎回rootオブジェクトを破棄する(destroy) のも解決策の一つです。

----
pyxel もイベントループを持っているようなので、
tkinterと同時に使うのが難しい点は、同意です。

[sakuramochi_py]

なるほど
イベントループ同士の同時実行は具体的にどの部分が難しいのですか？

[teamikl]

事例が少ないのが難しい点でしょうか。
ケース次第なので、具体例を出すのもたくさんあり難しいのですが。

単一スレッドの場合: 例) よくあるのが、GUIが応答なしになる問題
片方のイベントループを実行中はもう片方のイベントが停滞するので、
双方のイベント処理を交互に実行する仕組を実装する事になります。
「イベント駆動型プログラミング」や「イベントループ」の理解がヒント。

マルチスレッドの場合: 今回の件も事例の一つ
「排他制御」や「スレッド間通信」の理解が必要な領域で、
一見正しく動いてるようでも、環境やタイミング次第で問題になる事が有りえます。

質問のコードでは、self.sp に別スレッドから代入してる部分は、
排他制御なしに代入してるので、スレッド安全な操作ではありません。
(これ自体がすぐにエラーになるわけではありませんが、注意が必要な箇所）

ダイアログのみの利用なら、現状の利用方法でも差し支えなさそうですが、
スレッド内でTkウィジェットの利用を完結しなければならないという
制限があります。
他のウィジェットも作りたい場合は、この制限内で利用する工夫が必要です。
対策 → スレッドは維持し、
スレッド間で安全な操作ができる同期Queue を使って
データのやり取り（スレッド間通信）をする。

[sakuramochi_py]

なるほど！
同時に変数に代入してしまった場合に問題が発生するんですね。
Queue を使って
import queue
q = queue.LifoQueue()
q.put(selected_file_path)

while not q.empty():
self.sp = q.get()

このように書けば解決しますか？

[teamikl]

同時アクセスの問題についてはそれで解決出来ますが、
「イベントループの中で処理をブロッキングする」のは別問題で、
キューが入るまで処理が止まる → イベントループが停滞 → 応答なしになってしまいます

イベントループ内でキューの読み出しをする場合は、
ノンブロッキング版の get_nowait を使ったり別スレッドで読み出すようにします。

出来れば複数のスレッドからの代入は、一つのスレッドからのみに制限した方が良いですが、
必ずしも問題が出るわけではないので、現状の使い方(片方から代入)であれば許容範囲かな。

[sakuramochi_py]

ありがとうございます！
そしてt_obataさん通知行ってしまっていたら申し訳ありません。