asyncioでtkinterのダイアログを開けない

Question

Python3.6を使用してasyncioとtkinterを用いたコードを書きたいと思います。
しかし残念ながらこの二つは相性が悪く併用が難しいです。

dialog.py

from tkinter import filedialog, Tk, Frame
import platform
from pathlib import Path


class Dialogs(Frame):
    def __init__(self):
        self.root = Tk()
        super().__init__(self.root)
        self.root.geometry("0x0")
        self.root.overrideredirect(1)
        self.root.withdraw()
        self.system = platform.system()
        self.pack()

    def open_dialog(self, dialog_open_method=filedialog.askopenfilename, options=None):
        if self.system == "Windows":
            self.root.deiconify()
        self.root.update()
        self.root.lift()
        self.root.focus_force()
        path_str = dialog_open_method(**(options or {}))
        self.root.update()
        if self.system == "Windows":
            self.root.withdraw()
        return Path(path_str)

ダイアログを開きファイルを選択します。

main.py

from dialog import Dialogs
import asyncio

loop = asyncio.get_event_loop()
dialog = Dialogs()


async def looper():
    while True:
        await asyncio.sleep(1)
        print("loop!")


async def main():
    asyncio.ensure_future(looper())
    path = dialogs.open_dialog()
    print(path)


if __name__ == "__main__":
    loop.run_until_complete(main())

上記のコードはEventLoopをブロックしてしまいます。
通常はrun_in_executorを用いるところですがRuntimeError: main thread is not in main loopとエラーを出されます。
どのようなコードを用いればEventLoopをブロックされずに済むのでしょうか？
回答の方を宜しくお願いします。

Answer 1

適切な回答かどうか自信がない(asyncioの仕様経験が乏しい)のですが、自分は次のように考えました。

• Tkinterはメインスレッドで動かす。

run_in_executorを使ってしまうとメインスレッド以外でTkinterが実行されることになるためか、ご質問にあるとおりうまくいかないようです。メインスレッド以外でTkinterのイベントループが動くものかどうかよく調べてはいないですが・・・。よってTkinterに関する処理をasyncioのタスクとして動かすのはあきらめざるを得ないように思います。async関数の中でTkinterを呼び出しても動くことは動くでしょうが、そこで非同期I/O処理は全て止まってしまうため並行して動かしたいならasyncioを動かすスレッドとは別のスレッドで(asyncioの枠組みとは別の世界で)動かす必要があるように思います。

• 非同期I/Oはメインスレッド以外でも動くのでこちらをサブスレッドで動かすようにする。

• asyncioの処理はコルーチンをディスパッチしないと進まない

mainにてタスクの実行を(awaitなどで)待ってないので、コルーチンは生成されるものの、その実行が先に進まないままmainが終わってしまいます。

• Tkinterの処理をasyncio側で待つ

asyncio.Futureを作り、メインスレッド側でそのFutureにset_resultで結果を設定してやるとasyncio処理側でそのFutureを待つことで同期および結果が利用できると考えました。他にもっとよい（自然）な方法があるかも知れません・・・

main.py

from dialog import Dialogs
import asyncio
import threading


# 元のコードそのままにしたが、別スレッドで非同期I/Oを行うなら
# サブスレッドで asyncio.new_event_loop() とした方が自然か?
loop = asyncio.get_event_loop()
dialog = Dialogs()


async def looper():
    tname = threading.current_thread().name
    print(f"{tname}: looper start")
    for i in range(10):
        await asyncio.sleep(1)
        print(f"{tname}:{i}: awaken")


class AsyncioThread(threading.Thread):
    def __init__(self, loop, dialog_future, *args, **kwargs):
        self.loop = loop
        self.dialog_future = dialog_future
        super().__init__(*args, **kwargs)

    def run(self):
        future = main(self.dialog_future)
        print(f"{self.name}: thread start")
        print(f"{self.name}: loop = {self.loop}")
        print(f"{self.name}: future = {future}")

        self.loop.run_until_complete(future)
        print(f"{self.name}: completed")


async def main(dialog_future):
    await asyncio.gather(asyncio.ensure_future(looper()), dialog_future)
    print(f"main: path={dialog_future.result()}")


def main1():
    # loop = asyncio.new_event_loop()
    dialog_future = asyncio.Future()
    thread = AsyncioThread(loop=loop, dialog_future=dialog_future, daemon=False)

    thread.start()

    path = dialog.open_dialog()
    print(path)
    dialog_future.set_result(path)

    thread.join()


if __name__ == '__main__':
    main1()

Comments

[namuyan]

回答して頂きありがとうございます。EventLoopはMainThreadでないと動きませんよ、のはずだったのですが動きますね。KILLSIGが理由でWindowsでは動かなかった記憶がありMainThreadである必要があると考えていました。いったい何と間違えていたのであろう？

[KSwordOfHaste]

EventLoopはメインスレッド以外でも動くと思います。実際run_in_executorはサブスレッドで動作するわけですからEventLoopがメインスレッド以外でも動いてくれないと困ると思います。

ひょっとしたらEventLoopがmainスレッドでは最初から用意されているのに対してmainスレッド以外では用意されていない点(get_event_loop()はデフォルト状態ではmainスレッドに対してしか通用しないため、loopの省略を許す多くのasyncio関数がデフォルトでmainスレッド以外では動かない)と混同しておられたりしないでしょうか？