Python3のtkinterで並行処理？を行いたい

Question

tkinterで、スタートボタンとストップボタンを生成し、スタートボタンが押されれば数字をカウントし始め、ストップボタンが押されればカウントをストップ　といったプログラムを作ろうと思っています。

ースタートボタンを押したらスタートメソッドを呼び出してメソッド内のwhile文でカウントが始まり、ストップフラグが立っていないかif文で確認し、フラグが立っていればwhile文をbreakで抜ける。
ーストップボタンを押したらストップフラグが立つ。

というように作ろうとしたのですが、while文が一度反応すればwhile文による無限ループから離脱できなくなり、ボタンも固まりプログラムがフリーズしてしまいます。

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

・無限ループから抜け出せずプログラムがフリーズする

該当のソースコード

python3

import tkinter as tk
import threading

def start():
    global frame
    global stop
       
    while True:
        if stop==False:
            break
        else:
            print(frame)
            frame=frame+1

def stop():
    global stop
    stop=False      

######ここからはメソッド外

frame=1
stop=True
root=tk.Tk()
Button001=tk.Button(root,text="Start",command=start)
Button001.pack()
Button002=tk.Button(root,text="End",command=stop)
Button002.pack()
root.mainloop()

試したこと

ネットで調べたら、threadingを使えば並行処理ができると聞いたので、試した結果プログラムはフリーズしなくなり、ボタンも押せるようになったのですがどういったわけかストップボタンを押してストップフラグを立たせてもループが止まりません・・・

threadingを使った場合のコード(『ここからはメソッド外』以降から

frame=1
stop=True
thread_1 = threading.Thread(target=start)
thread_2 = threading.Thread(target=stop)

root=tk.Tk()
Button001=tk.Button(root,text="Start",command=thread_1.start())
Button001.pack()
Button002=tk.Button(root,text="End",command=thread_2.start())
Button002.pack()
root.mainloop()

もしかしたら簡単すぎるミスがどこかにあるかもしれないのですが、自分でいろいろ試してもわかりませんでした・・・
どなたかご回答お願いします。m(_ _)m
あとわかりにくかったらすいません

Answer 1

まずは動作しない原因を２点ほど

１.
tk.Button() の command引数に渡すのは関数オブジェクトとなりますので、

Button001=tk.Button(root,text="Start",command=thread_1.start())
Button001.pack()
Button002=tk.Button(root,text="End",command=thread_2.start())
Button002.pack()

の部分は

Button001=tk.Button(root,text="Start",command=thread_1.start)
Button001.pack()
Button002=tk.Button(root,text="End",command=thread_2.start)
Button002.pack()

の間違いかと思います。

上の間違った記述だと、thread_*.start() を実行 して、その結果を command に渡すという意味になってしまいます。

２.
stop という名前が 関数名 def stop() とフラグ stop=True の２つの使用している為、stop() が動作しておりませんので、どちらかの名前を変更してください。

とりあえず、フラグ名を stop_flag に変更するなどで良いかと思います。

上記の変更を行うことで、**『とりあえず』**は動作するかと思います。

---

ただし・・。上記の処理では
・threadを停止した後に threading.join()による リソースの回収処理部がない
・threadの開始処理(start())は１度だけしかできないので、２度目の開始ができない
・アプリケーションが終了したときのthread停止処理が入ってない

等などの問題があります。

個人的には
・現状のstart()・stop()処理をそのままスレッドで実行する

のではなく、

・スレッド処理部は start()やstop()の関数以外で行う
・start() にてスレッドの生成やstart()処理を行う
・stop() にてスレッドの停止やjoin()処理を行う

といった処理にするほうが良いかと思います。

以下は軽くサンプルです。

import tkinter as tk
import threading
import time

def time_count():
    global frame
    global stop_flag

    while not stop_flag:
        print(frame)
        frame=frame+1
        time.sleep(1)

def start():
    global stop_flag
    global thread

    # スレッドが無いなら生成してstart()する
    if not thread:
        thread = threading.Thread(target=time_count)
        stop_flag=False
        thread.start()

def stop():
    global stop_flag
    global thread

    # スレッドがある場合停止してjoin()する
    if thread:
        stop_flag=True
        thread.join()
        thread=None

frame=1
stop_flag=False
thread=None
root=tk.Tk()
Button001=tk.Button(root,text="Start",command=start)
Button001.pack()
Button002=tk.Button(root,text="Stop",command=stop)
Button002.pack()
root.mainloop()
# 終了時にスレッドを停止する処理
stop_flag=True
thread.join()

Comments

[tomo1998]

commandのところは完全にうっかりミスでした・・・ｗ
つい関数宣言と同じ感覚で・・・ｗ
()ついたままだと、結果をcommandに渡す、ということになるんですね
同じ名前を使っちゃいけないことも知りませんでした(;'∀')
自分が無知すぎたorz
ちなみに、リソースの回収、threading.join()とは何ですか？
よくわからないので教えていただけると幸いです。

[magichan]

thread.join() は要はthreadの停止（threadに割り振った関数が終了したこと）を待つ関数です。
上記のコードではstopフラグをセットにすることによりループを抜けさせて停止処理を行っているのですが、もっと複雑なコードになってくるとループ内で待ち状態になっていたり、重い処理を行っている等で直ぐにループを抜けるとは限らない訳す。(私のサンプルでもループ内sleep()がありますので、ループを抜けるまで１秒以上かかる可能性があるわけです)
にも関わらず再度"start"が呼ばれて新しいthreadを生成してstopフラグをクリアする処理をしてしまうと、前のthreadも裏で同時に動き続けるという事態になってしまい、不具合の原因となりかねない上に、CPU資源やメモリー資源を無駄に消費してしまいます。
そのため、threadの停止処理を行う場合は thread.join() を呼びthreadが確実に終了（つまりCPU資源やメモリー資源の解放）してから次の処理を行うという実装にするほうが良いかと思います。

Answer 2

主な問題点は

• 関数stopとフラグ変数stopの名前が同じ

言語によっては関数的なものと変数的なものを同じ名前で定義できます。例えばJavaは同じ名前のフィールド(変数的なもの)とメソッド(関数的なもの)を同一クラスに定義できます。しかしPythonでは同じスコープ（本質問ではグローバル空間）に同じ名前の関数と変数を同時には定義できません。def stop(): ...で関数を定義しても、そのあとでstop = Trueなどとしてしまうと「stopという名前に格納されていた関数値がFalseで上書きされる」ため、stopはもはや関数ではなくなるのです。またこのような病的なコードを実行してもpythonインタープリタはエラーを報告しません。「他の値で上書きすることを前提として関数定義をする」という手法はまず使わないでしょうから本来は「defにより関数定義したら同じスコープでその関数名を他の目的(変数)では使わない」とすべきでしょう。
スレッドを使うコードに修正した際にEndボタンを押してもwhileループが完了しない原因はthreading.Thread(target=stop)を呼び出したときのstopの値が「関数ではなくTrueという値になってしまっている」からです。

• Buttonのcommand引数

この引数に渡すべきは「ボタンが押された時点で実行すべき関数」です。質問者さんのコードでは
Button001=tk.Button(root,text="Start",command=thread_1.start())
となってますが、これではstartが起動されるのはボタンが押されたときではなく、ボタンを生成したときになってしまいます。
ボタンが押されたときにstartしたい場合は
Button001 = tk.Button(root, text="Start", command=thread_1.start)
などと書くべきです。スレッドを用いるようにしたコードではStartボタンを押さなくてもwhileループが始まっていますよね？

• Endボタンの処理は別スレッドで行う必要なし

別スレッドで行うと動かなくなるわけではありませんが、そうすることに意味はありません。
Buttonのコンストラクターのcommand引数に指定するのはあくまで関数であり、それはボタンが押されたときに呼び出されます。またその関数が終了するまではtkinterのイベント処理は動かなくなります。それゆえEndStartボタンのcommandで直接whileループするような関数を指定するとご質問にあるような問題が起きます。これをスレッドを用いて回避すると
(A) ボタンを押したら別のスレッドを開始し即座に呼び出し元へ戻るようにする
(B) whileループは別のスレッドで実行する。
となるわけで「tkinterのイベント処理はメインスレッドで継続しつつ、whileループは別のスレッドで並行して動かす＝＞tkinterのイベント処理がwhileループにより阻害されないようにする」という考え方になります。一方Endボタンの処理は「単にフラグを変更する」だけなので、それを行うのにわざわざスレッドを動かす必要はありません。

• startボタンは一度しか動作しません

同一のスレッドインスタンス(thread_1に代入されている値)を開始できるのは一度きりです。よってStart/Endボタンを複数回動かすならStartボタンを押すたびにスレッドインスタンスを新たに生成しなければならない点に注意してください。（一度だけでよいなら元のままでも構いません）

以上の点に着目し次のように修正してみました。

import tkinter as tk
import threading


def run():  # startという名前のままでもよいがわかりやすさのためrunにした
    global frame, stop

    stop = False  # フラグの名前がstopなのですから停止させるまではFalseにするのが自然です
                  # 動いている間Trueであるようなフラグにするならrunningなどとすべきでしょう
                  # こういう「名前のおかしさ」は第三者のコードの理解を阻害します
    while not stop:  # 論理が冗長なので若干修正
        print(frame)
        frame += 1

def on_start():
    threading.Thread(target=run).start()

def on_stop():
    global stop
    stop = True

# ここからは関数外(on_stopなどはグローバルな関数であって普通メソッドとは呼びません)

frame = 1
root = tk.Tk()
Button001 = tk.Button(root, text="Start", command=on_start)
Button001.pack()
Button002 = tk.Button(root, text="End", command=on_stop)
Button002.pack()
root.mainloop()

Comments

[KSwordOfHaste]

のんびりコメントしてたらmagichanさんとかぶった回答をしてしまいました。また自分の回答ではmagichanさん指摘のスレッドの後始末に言及できてませんでした～

[tomo1998]

なんと！
Python3では同じ名前を使うと上書きされてしまうんですね・・・知りませんでした(;'∀')
次回からは分かりやすいように名前を変えてみます～
Button Widgetのcommand引数はうっかりミスでした(-_-;)
つい関数宣言と同じ感じで記入してしまい・・ｗ　申し訳ない！
確かにEndボタンは別スレッドを使う必要なさそう

試してみたところスレッドインスタンスは確かに一度しか作動できないみたいですね・・・2度実行させようとしたらエラーが発生していました

おかげさまでとてもよく理解＆解決できました！
ご丁寧な回答ありがとうございました！

Answer 3

参考URL
簡易ストップウォッチを作ってみた　＠Python3

tkinter使用するのは初めてなので質問のコードをコピペして少しづつ削りながら動作確認してると
ほとんどが無くなりました。
最低限Endボタンが機能するようになったのでご参考までに。

動くか動かないかの違いはここだけの気がします。
if __name__ == '__main__':

# coding=UTF-8
import tkinter as tk
import threading

def start():
    print('start!')
def stop():
    print('end!')

# main
if __name__ == '__main__':
    root=tk.Tk()
    Button001=tk.Button(root,text="Start",command=start)
    Button001.pack()
    Button002=tk.Button(root,text="End",command=stop)
    Button002.pack()
    root.mainloop()

Comments

[tomo1998]

ご回答ありがとうございます・・・っ！
確かにボタンは作動するのですが、ちょっと希望していたのと違う感じに～(;'∀')
説明が下手で申し訳ないです・・・
「if __name__ == '__main__':」は、その実行されたプログラムがモジュールとして作動していなければ実行するコードなので、ちょっと関連性がない気がします・・・すいません＞＜

[opyon]

この回答した後自分でも作ってみてハマったので似たような質問してます。
よかったら参考までに御覧ください。

[tomo1998]

なんと！早速見てみます！ｗ