Python / pandasのループ中にtkinterのラベルを書き換えたいが反映されない

Question

下記のようなコードでproglessのテキストを書き換えたいのですが、ループ中に書き換わらずにループ終了後に値が更新されます。
リアルタイムに反映させたいのですが何か良い方法はないでしょうか。

import tkinter as tk
import tkinter.filedialog as filedialog
import pandas as pd

def import_csvfile():
    global progless
    csvfile = csvfile_path.get()
    if not csvfile:
        message = 'csvが読み込めませんでした。'
        return

    df = pd.read_csv(csvfile)
    total = len(df)
    for index, row in df.iterrows():
        progless.set(f'進捗 {index+1} / {total}')

progless = tk.StringVar()
progress_area = tk.Label(main_frm, textvariable=progless)
progress_area.grid(column=1, row=4, sticky=tk.W, padx=10, pady=10 )

Answer 1

GUIを更新するにはメッセージループに処理を渡す必要があります。
タイマーなどを利用して進捗状態を確認してUIを変化させるようにしましょう。

Answer 2

t_obara さん提案の方法がお勧めの解決方法です。

ファイル読み込み部分を別スレッドにして、
UI更新はメインスレッドでタイマー等で行うのが定石。

---

問題の原因

ループ中に書き換わらずにループ終了後に値が更新されます。

これ自体は正常な挙動です。イベントハンドラとして登録した関数は、
以下のようなイベントループ内で呼び出されます。
（実際とは異なりますが、イベントループのイメージ）

def mainloop():
    while True:
        イベント処理 ユーザ操作に応じて import_csvfile() 等が呼び出される
        描画更新 <- イベント処理が終わった後に呼び出される

GUI のレスポンスをよくする為(即時に反映)には、
イベントで呼び出される関数自身は直ぐに終了する必要があります。
時間が掛かる処理を行いたい場合は、スレッドやタイマーを検討することになります。

同一スレッド内で順番に実行されているので、イベント内で
time.sleep や時間の掛かるループ等のブロッキング操作があると、
他のイベントの処理が滞り、GUIが応答しなくなる原因にもなります。

---

以下は、別の方法ですが
簡単に対応できる回避策について(妥協案です)

コードの全貌が解りませんが、ループ文内でprogress.set() の後に

• progress.update_idletasks() を呼び出す事で描画を即時更新できます。
• progress.update() を呼び出すとループ中のイベント処理にも対応できます。

(描画が更新されない以外に、他の操作も受け付けなくなってるはずです）

お勧めでない理由は、例えば、他に時間の掛かるイベントがあった場合、
ループ中の処理に割り込まれてしまい、おかしな挙動の原因になりやすい為。

Comments

[Anon_]

難しいですね。
tk.Tk().update()で対応できたように見えますが、本来はthreading.Timerを使う方法が良いという事でしょうか。

[Anon_]

updateで書換えの処理が走る間、ループ中の処理が停止するのでお勧めしないという理解であってますか？

[teamikl]

他の処理次第ではループ中の処理が停滞する（場合がある）
後、for内でループ毎に毎回GUIを更新すると、for文自体の実行も遅くなります。

少し複雑になってきますが、理想的には

- ファイルからの読込は別スレッドで行う
- プログレスバーの値の反映はタイマーで行う。
　視認できる間隔で良いので 60fps (15ms間隔程度で)

タイマーについては、GUI の更新はイベントループから行う必要がある為、
イベントループで処理されるGUIの提供するタイマーが良いです。
tkinter だとGUIのアニメーション用途には afterメソッドを使います。

threading.Timerは別スレッドで実行されます。
tkinterの場合は別スレッドから操作してもエラー無く動くことが多いですが、
完全にスレッドセーフという訳ではないので、
問題が起きた時に面倒になるので、避けた方が無難です。

[teamikl]

update()がお勧めでない理由、補足
update() 自体もイベントループと同じ処理する関数なので

def on_click(): # ボタンをクリックした時に呼び出されるとします
　for _ in range(10000):
　　...
　　root.update() # for-文 処理中にイベントがあるとここで 呼び出される

　割り込みのイベントが終わった後に元のfor文の続きが実行される

すぐ終わるイベントなら割り込まれても問題ありませんが、
時間の掛かるイベント・例えばon_clickが２回呼ばれた時等は
update() 内で更に新しい on_click のループが始まり、
それが終わった後に元のforループの続きが始まる、といった挙動になります。

この方法で行う場合は、ループ実行中は他のGUIの操作を
出来なくするのを徹底したが良いかもしれません。
# widget.config(state=tk.DISABLED) で操作禁止。 tk.NORMAL で戻る。

[teamikl]

update_idletasks() なら描画更新だけなので、
上述のイベントが割り込まれる問題はありません。

が、ループ中は他のイベントは処理されないので、例えば
もしループを中断するボタンを作ったとしても、クリックが反応しません。
ループ処理中はウィンドウの閉じるボタンも反応しない。

GUIを反映するだけなら、どちらもコード１行追加で出来る対応策ですが、
その辺りのデメリットがお勧めしない・妥協案とした理由です。

[Anon_]

なるほど。よく分かりました。ありがとうございます。