python asyncioを使用した際GUIが動かなくなる

Question

発生している問題・エラーメッセージ

tkinterを使用してGUIを作成し、Websocket接続ボタンを押すことで、websocket通信を開始させたいのですが、
ボタンを押すと通信は開始されるが、その後、GUIが一切の入力を受け付けなくなってしまいます。
(画面がホワイトアウトし、くるくるが回っている状態)

下記のコードに問題がある点、対処方法を教えて頂きたいです。

よろしくお願いいたします。

class A:
   def __init__(self,master):
　　　～～省略

　　async def connect_ws(self):
       uri = 'ws://localhost:18080/xxxxxxx/websocket'
       async with websockets.connect(uri, ping_timeout=None) as ws:
           while not ws.closed:
                response = await ws.recv()

　


class Win2(tk.Frame):
　　def __init__(self,master):
　　　self.A = A()
　　　～～省略

　　def create_widgets(self):
　　  　self.makeorder_button_connectws = ttk.Button(self.labelFrame, text='Websocket接続',command = self.connect_ws)
       self.makeorder_button_connectws.pack()
    　　～～省略

　　def connect_ws(self):
 　　　  loop = asyncio.get_event_loop()
        loop.create_task(self.A.connect_ws())
        try:
            loop.run_forever()
        except KeyboardInterrupt:
            exit()

使用しているバージョン

python 3.10

tkinter 8.6
asyncio-3.4.3

Comments

[Demerara]

tkinter についてはよく知りませんが、async / await を関数の中で使うのであれば、その関数そのものも async で定義する必要があります。

async def connect_ws(self): としてみてください。

[TheBullchannel]

ありがとうございます。
tkinterのボタンを押すことで、class Win2 のconnect_wsを呼び出し、
async で定義したclass A のconnect_wsを呼び出し。webscoketの接続を試みましたが、
やはり、GUI（Ｗin2）フリーズしてしまいます。
フリーズしてしまうのは、win２のconnect_wsメソッドが動き続けているからでしょうか.

[Demerara]

少し tkinter について調べてみましたが、async の使われ方が、python や tkinter のバージョン、使用しているモジュール等によってかなり違いがあるようです。差し支えなければ、import している tkinter 及び 非同期に関連するモジュールと python 等のバージョンも補足として質問本文に追記すると回答が得られやすくなるかもしれません。

[TheBullchannel]

使用しているモジュールのバージョンを追記させていただきました.
よろしくお願いいたします。

[Demerara]

def connect_ws(self):
try:
asyncio.run(self.A.connect_ws())
ecept KeyboardInterrupt:
exit()

だと、どうですか？ websockets のドキュメントを参考にしました。
https://websockets.readthedocs.io/en/stable/index.html

[TheBullchannel]

試してみましたが、やはりwebsocket通信自体は開始されるものの、GUIが操作不能になってしまいます。
tkinterのmainloopの中ではasyncioのloopを動かせないのでしょうか。tkinterとは別のスレッドで動かす等はできるのでしょうか？

[Demerara]

役に立ちそうな過去の質問を探してみました。参考にしてみてください。どうやら、tkinter の mainloop の中では asyncio を動かすのは無理っぽいので、thread とかを使うみたいです。

Python3 Tkinter Tkinterとソケット通信のサーバの立ち上げ
https://teratail.com/questions/317832

Python3 非同期処理について
https://teratail.com/questions/331789

asyncioでtkinterのダイアログを開けない
https://teratail.com/questions/199068

Tkinter内でのループ処理
https://teratail.com/questions/299389

[TheBullchannel]

Demerara様、ありがとうございました。
threadを用いて、別のスレッドにてasyncioのループを作成することにより、GUIが停止することなくwebsocket接続を行うことができました。

[Demerara]

役に立てたようでよかったです。そのコメントの内容を回答欄に書いて自己解決として、この質問を閉じておいてください。

Answer 1

解決済みのようですが、シングルスレッドで tkinter と asyncio を動かす方法について

tkinter と asyncio は、どちらもイベント駆動なので、
片方のイベントループが実行されている間は、他方のイベントループは待機中になります。

root.mainloop() や、loop.run_forever() は、
ブロッキング処理なのでコードの実行がウィンドウを閉じるまで止まってしまいます。
イベントループを実行するコードなので、他方のイベントループ内では使ってはいけません。

別スレッドにする事は、複数のイベントループを同時に実行する解決策の一つですが、
マルチスレッドでは、スレッド間での安全なデータの受け渡し方法が必要となってきます。
(マルチスレッドの場合は、同期キューを用いたスレッド間通信を調べてみてください)

---

シングルスレッドでの解消法は、
どちらかのイベントループ内で他方のイベント処理を定期的に更新する方法です。

プログラム全体は asyncio のイベントループで動かし、
tkinter のイベントループは、mainloop() は呼び出さずに、
asyncio内で代替のイベントループを組みます。

async def tk_event_loop(root, interval=1/120):
    while True:
        root.update()
        await asyncio.sleep(interval)

Answer 2

class A:
def init(self,master):
～～省略
async def connect_ws(self):
async with websockets.connect('ws://localhost:18080/XXXXXXXXX/websocket', ping_timeout=None) as ws:
while not ws.closed:
response = await ws.recv()
board = json.loads(response)

def createloop(self,loop):
loop.create_task(self.connect_ws())
loop.run_forever()

class Win2(tk.Frame):
def init(self,master):
self.A = A()
～～省略

　　def create_widgets(self):
self.makeorder_button_connectws = ttk.Button(self.labelFrame, text='Websocket接続',command = self.connect_ws)
self.makeorder_button_connectws.pack()
～～省略

　　def connect_ws(self):
loop = asyncio.new_event_loop()
thread1 = threading.Thread(target=A.createloop, args=(loop))
thread1.start()

上記のように、あらかじめWin2クラス（メインのクラス）にてasyncioのループを作成しておきます。
次に、asyncioを動かしたいクラス内でloopにタスクを設定し、threading.threadに、loopとともに渡すことにより、
GUIのloopを妨げることなく、別スレッドにてasyncioを動作させることが可能です。