Pysimpleguiのデバックウインドウやプログレスメーターのボタンで処理を中断できるようにしたい

Question

前提・実現したいこと

こんにちは。Python学習2か月目のプログラミング初心者です。
質問に答えていただけると幸いです。

現在、CSVファイルを読み込み、1ファイル毎にある処理を行っているプログラムを作成しています。
ファイル処理中にPysimpleguiのDebug WindowかProgress Meterを用いて処理状況を
画面に表示させているのですが、ウインドウの何らかのボタンが押された場合、
処理を中断するような仕様にしたいです。

該当のソースコード

#files_pathに各CSVファイルのパスがリストで入っている

# プログレスメーターの場合
i = 1
for file_path in files_path:　　　　# ファイル毎に処理
    # プログレスメーター
    sg.one_line_progress_meter('ファイル処理中', i+1, ful = len(files_path), key = 'pbar', orientation="v",)

　　（ファイル処理部）

    i = i + 1


# デバッグウインドウの場合
for file_path in files_path:　　　　# ファイル毎に処理
    sg.Print(ファイル名 + "処理中")　　　 # デバッグウインドウ

　　（ファイル処理部）

    sg.Print(ファイル名 + "処理完了")

試したこと

event , values = window.read()
を使うとボタンが押されるとそれに応じた何らかの値が返ってきますが、
その場合ボタンを押さないと次の処理に進まないため、
（ウインドウに進捗状況を表示）＋（ファイルの処理）
ができません。
目指したいのは、
（ウインドウに進捗状況を表示）＋（ファイルの処理）＋（何らかのボタンで中断処理）
です。
解決手段わかる方、ご教示お願いします！

補足情報（FW/ツールのバージョンなど）

ここにより詳細な情報を記載してください。

Answer 1

余談ですが、sg.Print() での中断やってみました。こんな感じになります。
(注意点: あまり深くデバッグしてないので、他で不都合が出ることがあるかも知れません。)

def hook_cancelable_debug_close():
    from functools import wraps
    import PySimpleGUI as sg
    import PySimpleGUI.PySimpleGUI as _sg

    _sg_print = sg.Print
    _sg_debug_close = _sg._DebugWin.Close

    class ClosedException(Exception):
        pass

    @wraps(_sg_debug_close)
    def _close(self):
        _sg_debug_close(self)
        raise ClosedException

    @wraps(_sg_print)
    def _print(self, *args, **kw):
        try:
            _sg_print(self, *args, **kw)
        except ClosedException:
            return False
        return True

    sg.Print = _print
    _sg._DebugWin.Close = _close



import PySimpleGUI as sg

# sg.Print 関数の差し替え。
hook_cancelable_debug_close()

import time
for num in range(1000):
    if not sg.Print(num): # <-- Quit ボタンを押した時中断
        break
    time.sleep(0.1)

Comments

[sugar_p]

ありがとうございます！
試してみたいと思います。

Answer 2

簡単な方法: 対象を一つづつ処理するのであれば、
sg.one_line_progress_meterを使うと楽できます。

with open(filepath) as infile:
    for line in infile:
        if not sg.one_line_progress_meter(...):
            break # 中断
        # ファイル処理

---

ここから、ステップアップとして

• 進捗ダイアログ以外のUI操作も可能にする -> timeout イベントを使う
• 複数のファイルを同時に処理する -> スレッドを使う

等が考えられます。

以下は timeout で処理するデモ(スレッドは使ってません)
工夫が必要な点:

• ファイルの処理を「ジェネレータ」として実装
  timeout イベント内で next() で読み出すことで、

　1ステップづつ実行が実現できます

• window.read の timeout パラメータは、必要なときのみ設定

from contextlib import closing
import PySimpleGUI as sg

layout = [
    [sg.Text("File:"), sg.Input(__file__, key="-INPUT-FILE-")],
    [sg.Text("Status:"),
     sg.ProgressBar(key="-PROCESSING-", size=(30, 20), max_value=100)],
    [sg.Button("Start", key="-START-"), sg.Button("Stop", key="-STOP-")],
]



def gen_bytes_count(filepath):
    import os
    # Total Bytes
    filesize = os.stat(filepath).st_size
    count = 0

    # NOTE: バイト数カウントのためバイナリで開いてます
    # テキストで開いた場合、文字数 != バイト数(ファイルサイズ) と一致しません
    with open(filepath, "rb") as infile:
        for line in infile:
            count += len(line)
            yield (int(100*count/filesize), count)

task = None
options = {}
timeout_options = {"timeout":100, "timeout_key":"-timeout-"}

def task_cancel():
    global task
    task = None
    options.clear()

def task_start(filepath):
    global task
    task = gen_bytes_count(filepath)
    options.update(timeout_options)


with closing(sg.Window('Bytes Count', layout)) as window:

    while True:
        event, values = window.read(**options)
        # print(event)
        if not event:
            break
        elif event == "-STOP-":
            task_cancel()
        elif event == "-START-":
            task_start(values["-INPUT-FILE-"])
        elif event == "-timeout-":
            if not task: # 処理するファイルが無い時
                continue

            info = next(task, None)
            if not info: # ファイル処理が終わった時
                task_cancel()
                continue

            status, count = info
            window["-PROCESSING-"].update_bar(status)
            sg.Print(status, count)
            ret = sg.OneLineProgressMeter(
                'Byte count', status, 100, "", '{}'.format(count))
            if not ret: # 進捗ダイアログの Cancel が押された時
                task_cancel()
                continue

Comments

[sugar_p]

ご回答ありがとうございます！
if not sg.one_line_progress_meter(...):
break # 中断
をfor文中に追記することで中断処理を行うことができました。
（任意のタイミングで中断はできてないのかもしれませんが）

発展バージョンとしてサンプルコード書いてくれた部分は、
難しく全ては理解できないですが、少しずつトライしてみようと思います。

欲を言って申し訳ありませんが、もう一つ質問させて頂いてもよろしいでしょうか？
デバッグウインドウsg.Print()の閉じ方をご存じでしょうか？
公式サイトではPrintClose()かeasy_print_close()で閉じることができると
書いてありましたが、どちらもNameErrorが出ます。

[teamikl]

sg.one_line_progress_meter を追記する場所はどこにしてますか。

ファイル単位のforループであれば、ファイル単位での処理の中断
ファイル内部の処理(CSVなら行毎)であれば行の処理中に中断可能です。

＞デバッグウインドウsg.Print()の閉じ方

モジュールはどの様にインポートしてますか？

import PySimpleGUI as sg

としていれば、sg.PrintClose() で閉じられます。
"sg." を忘れてないか確認してみて下さい。

もしくは参考にしたコードが
from PySimpleGUI import * となっていたのかもしれません。

[sugar_p]

すみません、もう一つ質問させてください。
プログレスメーターと同じように

for file_path in files_path:　　　　# ファイル毎に処理
sg.Print(ファイル名 + "処理中")　　　 # デバッグウインドウ

　　（ファイル処理部）

sg.Print(ファイル名 + "処理完了")

if not sg.Print():
break

を書いてみると、1周目の処理でプログラムが終了してしまいます。
これはどうしてでしょうか？

[teamikl]

>if not sg.Print(): <-- Print が原因かな。
ここでNone が返るので必ず break します --> ループを抜ける

sg.one_line_progress_meter と同じようには使えません。

[sugar_p]

コメントありがとうございます！
プログレスメータの処理中断と、sg.PrintClose()の件
理解できました。

[sugar_p]

>>if not sg.Print(): <-- Print が原因かな。
>ここでNone が返るので必ず break します --> ループを抜ける
>sg.one_line_progress_meter と同じようには使えません。
分かりました。ありがとうございます。
sg.Print()の場合はもう少し複雑な処理になるということでしょうか

[teamikl]

＞sg.Print()の場合はもう少し複雑な処理

もし「デバッグウインドウを閉じた時に中断したい」という事であれば、
簡単にはできなさそうです。
「Quit」が押されたのを、ライブラリ外から検知できない為。