Python（TkInter） 関数側でカーソルの変更を行っても即座に反映しない

Question

# モーダルウィンドウ
self.dialog['cursor'] = 'hand2'
self.this = self.dialog



# WebAPIアクセス
    def webAPI(self):
       self.this['cursor'] = 'watch'                 # ★関数起動後にすぐさまカーソルが変わることを期待したが...
       # 割愛
       # 割愛 WebAPI/DataBase　データ取得で時間を要す
       # 割愛 
       self.this['cursor'] = 'hand2'

モーダルウィンドウ上のボタン押下（CallBack）から上記関数を実行しており、関数の起動直後にカーソルを変更している認識です。
当方Windows10ですが、クルクル廻るカーソルが現れません。
時間のかかる関数の本質の部分の前後で、カーソルを変更させる配慮をしたつもりですが変化がありません。

何が悪いのでしょう？？　こういうものとして　諦めるべきでしょうか？

Answer 1

webAPI関数はどのように呼び出してますか？self.this は何でしょう？
対象のウィジェットによっては期待通りの動作をすることも有るようですが

問題の原因は、
cursor の設定自体は設定値の変更に過ぎず、
実際に描写が変更されるのは、イベント処理で呼び出される関数の実行が終わり
処理がメインループに移った時になります。

tkinterのmainloop() のイベントループが、
マウスやボタンクリック時のイベント呼び出しや
描画の更新等を担っています。

これは単一のスレッドで順番に実行されている為、
イベント内で時間のかかる処理をすると、
一時的に他のイベントが処理されなくなり
ウィンドウが操作を受け付けなくなったり、固まった状態に陥ったりします。

一時的な回避策としては、明示的に描画の更新処理を呼び出す事です。

def webAPI(self):
    self.this['cursor'] = 'watch'
    self.update() # <-- これで明示的に描画更新できますが

    # 時間のかかる処理 ... この間描画は更新されない。
    # ウィンドウも操作を受け付けない状態になります

    self.this['cursor'] = 'hand2'

時間のかかる処理は別スレッド等で行うようにすると、
ウィンドウの操作が固まる状態も解決できます。この場合であれば、

• 解決案1) webAPI()関数自体をスレッドで呼ぶように変更
• 解決案2) cursor変更の間の処理の身をスレッドで実行する
  この場合、終了時のカーソル変更は別の場所で行うことになります。

他に、非同期IOを使うといった方法もありますが、
tkinter での事例が少ないのでお勧めはし辛いです。

---

一時的な回避策

import time
import tkinter as tk
from tkinter import ttk

root = tk.Tk()
def onClick():
    button['state'] = 'disable'
    root['cursor'] = 'watch'
    time.sleep(0.01) # <--- 少し待ってから。(これがないと複数回試したときに描画更新されないことあり)
    root.update()  # <--- 描画更新

    time.sleep(5)  # <--- 時間のかかる処理
    
    button['state'] = 'normal'
    root['cursor'] = 'hand1'
button = ttk.Button(root, text="OK", command=onClick)
button.pack()
root.mainloop()

時間のかかる処理をスレッドで実行

import time
import tkinter as tk
from tkinter import ttk
from threading import Thread
from contextlib import contextmanager

DEFAULT_BUTTON_TEXT = "OK"

@contextmanager
def on_busy_task(root, button):
    # 前準備と後始末
    try:
        button['state'] = 'disable'
        button["text"] = "Running..."
        root['cursor'] = 'watch'
        yield
    finally:
        button['state'] = 'normal'
        button["text"] = DEFAULT_BUTTON_TEXT
        root['cursor'] = 'hand1'

def heavyTask(root, button):
    with on_busy_task(root, button):
        time.sleep(5)  # <-- 時間のかかる処理

def onClick():
    thread = Thread(target=heavyTask, args=(root, button), daemon=True)
    thread.start()

root = tk.Tk()
button = ttk.Button(root, text=DEFAULT_BUTTON_TEXT, command=onClick)
button.pack()
root.mainloop()

Comments

[saya24]

いつもご支援をありがとうございます。

>webAPI関数はどのように呼び出してますか？self.this は何でしょう？
requestを予めインポートしておき、関数の中ではrequests.postでURLへアクセスすることを行っています。
self.thisは　モーダルウィンドウを定義づける部分で　self.this=selef.dialog のコードから格納してます。

超親切にご説明を頂いたのですが、self.update() 　でもう大満足の結果を得られましたよ。
今後の開発に役立てられるよう　後続部分も解読しておきます....

ありがとうございました。

[teamikl]

知りたかった部分は、webAPI関数が既にスレッドで呼ばれていたのか
メインループは動いてるがカーソルが変更されないとなると別問題なので、
念の為に確認した次第でした。後続部分は余談程度に・・・

数秒程度の待ち時間ならメインループが止まっても気になりませんが、
問題は数分規模の待ち時間が発生し、処理の中断を行いたいとなった場合、
中断の操作をしようにも、メインループが止まっているとGUIが入力を受け付けない状態なので、
マルチスレッド/プロセスや非同期といった手法が必要になってきます。