GUIアプリの処理中にプログレスバーを表示したい。

Question

前提・実現したいこと

PythonのTkinterを使ってGUIでファイル等を選択し、処理を行うことが出来るアプリを作っています。この処理中にユーザーに処理中であることを知らせる為、プログレスバーを利用しようとしています。しかし、下記のコードにある通りプログレスバーを扱おうとすると進捗状況が反映出来なかったり、アプリが停止してしまいます。原因や解決策が分かる方に教えていただきたいです。

該当のソースコード

from tkinter import *
from tkinter import ttk
import time
import tkinter as tk

def button_click():
    pbval.set(pbval.get() + 1)
    root.update()

win = tk.Tk()
win.title("TEST")
win.geometry("300x700")
time.sleep(1)
win.destroy()

#プログレスバー作成
root = tk.Tk()
ttk.Style().theme_use('classic')
root.title('Progress')

root.columnconfigure(0, weight=1)
root.rowconfigure(0, weight=1)

# Frame
frame1 = ttk.Frame(root, padding=10)
frame1.grid(sticky=(N, W, S, E))
frame1.columnconfigure(0, weight=1)
frame1.rowconfigure(0, weight=1)

pbval = IntVar(value=0)
pb = ttk.Progressbar(
    frame1,
    orient=HORIZONTAL,
    variable=pbval,
    maximum=5,
    length=200,
    mode='determinate')
pb.grid(row=0, column=0, sticky=(N, E, S, W))


def ok_click():
    def button_click():
        pbval.set(pbval.get() + 1)
        root.update()    
    
    button_click()
    time.sleep(1)

    button_click()
    time.sleep(1)

    button_click()
    time.sleep(1)

    button_click()
    time.sleep(1)

    button_click()
    time.sleep(1)



ok_click()

root.mainloop()
win.mainloop()

試したこと

・.destroyを使って入力窓を消してから処理中にプログレスバーを表示させる　→　入力窓が最初から消えてしまい失敗。

Comments

[hide5stm]

回答できなくて申し訳ないですが、
1. 想定している動きがわからないです、300x700のwindowを表示して、そこの上のボタンが押されたらprogressバーが表示されるみたいな感じでしょうか。
2. GUIプログラミングの場合、mainloop()でイベント待ちに入るのが正しいフレームワークの使い方なので、time.sleep()を使ってしまうと、mainloop()に戻れなくなるので、time.sleep()使ってはまずいはずです。
3. あと、mainloop()が2つある状況はまずいはずです。tkとttkのmainloop()を統合するのか、片方しか使わないようにするか。など1つのmainloop()でイベントを待つようにする必要があると思います。

[beginerdesu]

ご質問ありがとうございます。
１.おっしゃる通りです。もう少し詳しく説明すると300*700のwindow上で処理に用いるエクセルファイルを選択しokボタンを押すとok_clickが実行されprogressバーが表示されるようにしたいと考えております。また、実際はok_click中にエクセルファイルを開く挙動や書き込み、保存のような挙動を追加する予定で、その際の進行度合いを確認できるようにprogressバーを作成しようとした次第です。
２.time.sleep()は上記のようにエクセルファイルを開く挙動などを再現するために便宜的に用いたものですので削除いたします。
3.一度統合という線(tk.toplevel)を用いて作成してみます。

言葉足らずで混乱を招き申し訳ございませんでした。その他アドバイスなどございましたらご指摘ください。

Answer 1

問題点:
イベントループ内で time.sleep や root.update を使ってはいけません。

厳密には、質問のコードではok_click()は mainloop() 前に呼ばれているので
「イベントループ外」ですが、一般的なケースを想定して。

time.sleep() は、イベント処理を止めてしまいます。

root.update() は、イベントループと同じ処理を行うので、
状況次第ではイベントループが入れ子になってしまい、
イベントが意図した順に処理されないようなことが起こり得ます。

質問のコードでは問題にはなりませんが、
update() 後に何か行う場合は、潜在的な問題になるので、非推奨です。

描画の更新が目的の場合は、root.update_idletasks() を使います。
大抵の場合はGUIの提供するタイマー(tkinterではafter関数)を使った方が良いです。

解決策:

• バックグラウンドで行いたい処理は、Thread もしくは Process を使う。
• プログレスバーの更新は、タイマー(after関数) を使う。
• 進捗の通知には、Queue を用います(タイマーで読み出して IntVar を更新する)
• 開始時に ok_click を呼び出したい場合は、イベントループから呼ばれるように
  root.mainloop() 前に root.after_idle(ok_click) とします。

---

追記: 内容的に、コードの一部を修正して動くような問題ではなく、設計から見直しが必要です。
概要だけでの把握は難しいと思うので、関連の有りそうなサンプルコードを載せます。

• repl.it ProgressBar
  queue を使う際の注意点。(メッセージの頻度について)
• repl.it TkThreadProcess
  queue を使い、サブスレッドからメインスレッドにメッセージを送るサンプル
• repl.it TestTkThreadQueue
  queue を使い、メインスレッドからサブスレッドにメッセージを送るサンプル

※ 過去の質問で作成したコードもあるため、余分な情報も含まれてますが、
関係なさそうな部分は読み飛ばしてください。

関連の有りそうな用語

• GUI については、イベント駆動型、イベントループ
• マルチスレッド、排他制御、スレッド間通信 (いくつか方法はありますが、同期Queueを使う方法)

---

他の問題点

• win.mainloop() の win は、事前に破棄 (win.destroy) されてます。

tk.Tk() や mainloop() を複数回呼び出すのは、
問題を起こしやすいので、プログラム中では一度のみにして、
２つ目のウィンドウが必要な場合は、tk.Toplevel を使ってください。