Pythonで実行しているループをipywidgetsのボタンで停止させたい

Question

長大なループをボタン操作などで停止させたい

• Google ColabなどのJupyter notebook上でボタン押下でループ処理を実行
• ループは一定時間(数)処理した後に自動終了する
  • ただし状況で長時間(回数)になるケースがある
• ユーザー操作により途中で停止させたい

前提(環境)

Google Colab上で実装したい為、tkInterではなくipywidgetsを使って実装。
開始と停止ボタンをipywidgets.Button()で作成し、それぞれループ開始と停止の関数をバインド。
VSCode上のJupyter notebookでも確認したが同じ結果。

状況

開始ボタン押下でループを開始し、停止ボタンで終了用のフラグを立てるようにしています。
ループ中でフラグを監視し、フラグが立った所でループを終了させるようにしましたが停止しません。
ループが優先され、ボタン押下イベントが通知されていないと考えてループを別スレッドで実行するように変更してみました。
しかし、結果は同じでループは終了しません。「停止」ボタンでフラグを立てていますが、そもそもボタン押下時のイベントがループ中は保留されてしまうように見えます。

Threadの使い方が悪いのか、iwidgetsの使い方なのか判然としなく、手掛かりを頂けたらと思い投稿しました。

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

停止ボタンを押下しても即反映されず、ループ終了後にイベントを受けて処理している様子です。
ループ中にイベントを受けていないので、ループが停止せずに最後まで到達してしまいます。

実行結果

Start
Loop:0
Loop:1
Loop:2
Loop:3
Loop:4
Loop:5
Loop:6
Loop:7
Loop:8
Loop:9
not alive
Stop
Stop
Stop
Stop
Stop

該当のソースコード

import time
import ipywidgets as widgets

from IPython.display import display
import threading

flag = False

def loop_start(e):
    print('Start')
    thread = threading.Thread(target=count_loop)
    thread.start()

    try:
        while True:
            thread.join(timeout=0.1)
            if not thread.is_alive():
                print('not alive')
                return
            if flag:
                return
    except KeyboardInterrupt:
        print('Interrupt')

def count_loop():
    for i in range(10):
        if flag:
            return
        time.sleep(1)
        current.value = str(i)
    pass

def loop_stop(e):
    print('Stop')
    flag = True

output = widgets.Output()
start = widgets.Button(description='開始')
stop = widgets.Button(description='停止')
buttons = widgets.Box([start, stop])

start.on_click(loop_start)
stop.on_click(loop_stop)

display(buttons, output)

試したこと

処理間隔などの問題でボタン押下イベントを受け付けていない可能性を考えて、ループ中にsleep()を挟んでみましたが変わりませんでした。
また、キーボードイベントでインターラプトできるとの事だったので仕込んでみましたが、Ctl+Cも効いているように見えません。
Google Colab環境、VSCode環境どちらでも同じ結果となりました。

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

Google Colaboratory(通常版)
VSCode 上のJupyter notebook(v2023.2.1000481019)
Python 3.10.7

Answer 1

下記の変更だけではだめで、ちゃんとやるなら非同期処理を書いてやる必要があるみたいですね。
https://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Asynchronous.html

こちらのQAが、参考になると思います。
https://stackoverflow.com/questions/64282319/stop-button-for-breaking-while-loop-within-ipywidgets-ecosystem

import time
import ipywidgets as widgets

from IPython.display import display
import threading

current = '-1'
flag = False

def loop_start(e):
    with output:
        print('Start')
    thread.start()

def count_loop():
    global current
    for i in range(10):
        with output:
            print(current)
        if flag:
            return
        time.sleep(1)
        current = str(i)

def loop_stop(e):
    global flag
    flag = True
    thread.join()
    with output:
        print('Stop')

output = widgets.Output()
start = widgets.Button(description='開始')
stop = widgets.Button(description='停止')
buttons = widgets.Box([start, stop])

start.on_click(loop_start)
stop.on_click(loop_stop)

display(buttons, output)

thread = threading.Thread(target=count_loop)

最初の回答

loop_stopの中の flag はglobalにしないといけないです。
じゃないと、flag というローカル変数を True でセットするだけになります。

def loop_stop(e):
    global flag
    print('Stop')
    flag = True

Comments

[San]

確かに！失礼しました。

ただ、この部分を変えても結果としては変わりませんでした。
loop_stop関数自体がループ中に呼び出されないのは変化ありませんでした。

[San]

> You may want to pause your Python code to wait for some user interaction with a widget from the frontend. Typically this would be hard to do since running Python code blocks any widget messages from the frontend until the Python code is done.
まさにこの部分で言及されていますね。
非同期かジェネレーター、どちらかで実装できるとの事なので、Google Colab環境でできそうな手法を試してみようと思います。

有難うございました！