Python Scheduleの実行中、UIから停止を受け付けることはできますか

Question

こちらの記事を参考に、予め定義しておく処理を定刻実行しようとしています。
TkInterのデスクトップアプリから、一連の定刻処理の起動をユーザに操作させる作りを考えています。

PythonのShceduleというと、起動ばかりがネットに紹介されている気がしますが
【ユーザの指示をもって　これを停めるようなことはできないでしょうか？】

【ひょっとして....下記コードでループに入ると、TkInterのUIを一切受け付けなくなる・固まってしまう事象になるでしょうか？？？】

while True:
    schedule.run_pending()
    time.sleep(1)

あまりにも事例を見つけられないので、ひょっとして　非常識なことを尋ねているのでは？？と若干不安です。
よろしくお願いします。

Answer 1

1つのアプリケーション(プロセス)で「ジョブ」と「ジョブを制御する処理」がある場合、通常マルチスレッド化します。

Tkinter Window作成----------ジョブのStart/Stopを制御するスレッド------------>
                    |
                    -------ジョブを処理するスレッド ----------------------->

2つのスレッドで情報のやり取りを行う仕組みが必要になりますので、例えば共通の変数としてqueue.Queue()のインスタンスを用意し、制御するスレッドからqueue.put("STOP")で停止メッセージを送信し、ジョブを処理スレッド内でqueue.get()をメッセージを受け取り"STOP"を受け取ったら停止する、ということを行います。

複数のプロセス間でこれを行う場合、排他処理として空のファイルを作ることをやります。停止させたい場合にあるディレクトリに空ファイルを置くとプログラムが停止する、というような方式です。

サンプルソース

1秒毎に時刻を表示します。GUIでSTART/STOPが可能です。GUIの作成とスレッド作成を同じJobManagerクラス内に閉じ込めることで、メンバ変数を使ってstart/stopを制御しています。

[追記] teamiklさんの指摘事項(afterでループするとメインスレッドから呼ばれてしまうバグ)を修正しました。

import datetime
import schedule
import threading
import tkinter as tk
import time

MONITOR_PERIOD = 1


def now():
    return datetime.datetime.now().strftime("%Y年%m月%d日 %H:%M:%S")


class JobManager:
    def __init__(self, root):
        self.root = root
        self.running = True
        self.job_enable = True
        self.time = tk.StringVar()

        # GUIの準備
        frame = tk.Frame(root)
        frame.pack()
        button_start = tk.Button(frame, text="Start", command=self.start)
        button_start.pack(side=tk.LEFT)
        button_stop = tk.Button(frame, text="Stop", command=self.stop)
        button_stop.pack(side=tk.LEFT)
        button = tk.Button(frame, text="Quit", fg="red", command=self.quit)
        button.pack(side=tk.LEFT)
        label_time = tk.Label(root, textvariable=self.time)
        label_time.pack()

        # ジョブのスケジューリング
        schedule.every(MONITOR_PERIOD).seconds.do(self.job)

        # スレッドの開始
        self.thread = threading.Thread(target=self.run_monitor)
        self.thread.start()

    def run_monitor(self):
        while self.running:
            schedule.run_pending()
            time.sleep(0.2)
        self.root.quit()

    def job(self):
        if self.job_enable:
            self.time.set(now())

    def start(self):
        self.job_enable = True

    def stop(self):
        self.job_enable = False
        self.time.set("Job is disabled")

    def quit(self):
        self.running = False


def main():
    root = tk.Tk()
    JobManager(root)
    root.mainloop()


if __name__ == "__main__":
    main()

Comments

[saya24]

yymmtさん、ご見解をありがとうございます。
なんか見慣れない言葉がでてきて少々気がめいっていますが、まずはqueueをキーワードにネットで検索するところから始めたいと思います。
制御する側は　TkInter側ですね。本当うまくいくと良いのですが

[yymmt]

queueはあくまでも一例です。Tkinterとscheduleを使ったサンプルソースを追記しておきました。

[saya24]

マルチスレッド化にすることで、スケジュールを停止させるための指示を　UIもしくくは他の制御からを受け付けるようにする手立ては　こちらの記事を参考に大方理解致しました。（https://teratail.com/questions/147319）
SCHEDULEに登録した定刻タスクを取り除く、という措置は　単純に　ループを終わらせてschedule.run_pending()の機会をとっぱらう、ということなのですね？？

勝手に.remove　とか　.killとか　あるようなイメージを思い描いていて....なんか皆さんと違う感覚でおおりました

横やりを入れて、スレッド内のループを終わらせる、ということなのかなぁ....

[saya24]

おっと、行き違い

[yymmt]

いえ、ブロッキングが入る処理だとスレッドごと強制終了する必要があるため、常にこの方法が取れる訳ではないです。

[saya24]

せっかく理解できた、と思ったら違いましたか。残念...ブロッキングが入る処理？？？ですか。
ますます難しくなってきまたしよ（汗）

いづれにしも　ご丁寧に例を示して頂きありがとうございます。只今理解に努めています。

（手元の環境でご提示のコードを試す上で　日時の部分は全角文字を除去した上で実行させて頂きました。なんか文字コードに起因するようなエラーになったので）

[saya24]

マルチスレッドという言葉も分からなかった私に　ご丁寧に事例を交えて説明頂き、なんとか初心者である私が目的を達成することができました。ありがとうございました。

[teamikl]

サンプルの # スレッドの開始 ですけど、Tkinterのタイマー(after)の場合、
以降の run_monitor は mainloopからメインスレッドで呼び出されるので、これだと２回目以降の呼び出しがマルチスレッドになってません。
(→時間の掛かるジョブがあった場合、GUIのメインループは止まります)

確認方法: スリープ等のジョブを入れるとGUIがフリーズする。
run_monitor内で、print(threading.current_thread()) すると
実行中のスレッドが確認できます。

理由: Tkinterではイベントループがメインのひとつのみ、だからです。
例えば、Qt のタイマーだとスレッド毎にイベントループを持てるので、
別スレッド内でタイマー処理等も可能と、ライブラリ毎に事情が異なる部分です。

(本題の、質問に対しての回答として)中断のアプローチとしては問題ありません。
が、スレッドに関しては恐らく意図してない動作になってるので、確認して見て下さい。
スレッドを使わずに self.run_monitor() とした場合とほぼ(初回以外)変わらない挙動になってます。

[saya24]

いつもお世話になっております。だんだんと話についていけなくなってきました....
秒間隔のschedule.run.pendingの最中　UIが遮断されるから　されないようにするため、threadingの導入を決定しました。よくスレッドの概念ができていないまま、24時にリスケしたいという次の課題に取り組んでしまい、また色々なリスクもご提案頂き　話が複雑化してきた印象をもっています。
ひとえに私の勉強不足です

まず、スケジュールのクリアを、定刻処理の一つとして登録するよう対処してみます。
親スレッド子スレッドも　まだよくわかっていないので、今回ご提示頂きました
print(threading.current_thread())　は　試して実態をみたいところです。

まずは　引き続いてのご支援にお礼まで

[yymmt]

> 例えば、Qt のタイマーだとスレッド毎にイベントループを持てるので、
> 別スレッド内でタイマー処理等も可能と、ライブラリ毎に事情が異なる部分です
う、かなり昔に作ったQtのタイマーから適当に作ったソースというのがバレてしまいましたね。

[yymmt]

threading.current_thread()を叩いて見たら1回目(子スレッド)と2回目以降(親スレッド)のスレッドが違っていてビックリしました。指摘事項をそのままにするのは気持ちが悪いのでソースコードを修正しました。

[teamikl]

Qtでは自分は逆のパターンではまったことがありました。
Tkinter ではこれを利用して after() を 子スレッド → メインスレッド への
通信手段として使えるのですが、Qt(QThread) では同スレッド内で実行と。

タイマーを使う時は、
イベントループ (Tkinterでは mainloop) の存在を意識しないといけないなという教訓になりました。

----
＞だんだんと話についていけなくなってきました....

オフトピ＆別の質問にあるコードでは修正済と同じ形なので大丈夫ですよ。

スレッドの確認方法についてはデバッグ時にも役に立つので、
マルチスレッドでプログラムを作るなら、覚えておいて損はないと思います。

print()で表示するのは暫定的な方法でしたが、
マルチスレッドでは複数のスレッドから同時書き込みがあった場合
というのを気にしなくてはいけなくなってくるので、実際にはprint代わりに
スレッドでも安全に使える logging モジュールを使います。

使い方は長くなるので、モジュール名前の紹介のみになってしまいますが、
設定でスレッド名を表示といったカスタマイズも出来ます。