execを外部から止める手段の有無 + multiprocessing.Processでtk.Button['status']を変更した際に発生するエラー

Question

現在、以下のようなものを作成しています。
Pythonのコードを実行するPythonのアプリと思っていただいて大丈夫です。

• GUIはtkinterで構築する
• 画面上にはテキストボックス x 1とボタン x 2がある
• ボタン①を押した際に、テキストボックス内の文字列をexecで実行する(名前空間を渡す都合上、execを使用しています)

実装自体は大まかに以下のように完成はしています。

from threading import Thread

class Application:
  def _build_gui (self: Self) -> None:
    # GUIはここで構築する
    # イベントハンドラとかもここで設定

  def _exec (self: Self) -> None:
    def callback () -> None:
      self._disable_ui() # UIを操作不能にする('status'を弄るだけです)
      try:
        exec(PY_CODE_STR, MY_NAMESPACE)
      except:
        # エラー出力などの処理
      finally:
        self._enable_ui() # UIを操作可能にする
    self._thread = Thread(target=callback, daemon=True)
    self._thread.start()

ただ、実行を中断する機能を追加する必要が出てきました(ボタン②を押した際に実行)。
threading.Threadは外から中断させるようなものではない(意訳)といった記事も多く、無理やり中断させるのを避けるためにmultiprocessing.Processの使用を検討しています。
一旦は単純な置き換えとして以下のような形としています。

from multiprocessing import Process

class Application:
  def _exec (self: Self) -> None:
    self._process = Process(target=callback)
    self._process.start()

  def _stop (self: Self) -> None:
    self._process.terminate() # プロセスキル
    self._process = None
    self._enable_ui()

ですが、どうやらprocess_func内のself._disable_ui()を実行した際に以下のようなエラーが発生しているようです。
※self._disable_ui()の削除で動作することを確認しています。

Unknown sequence number while processing queue
You called XInitThreads, this is not your fault

質問したい内容としては以下のものとなります。

• execにより実行されている処理を止める手段は何かありませんか？
• multiprocessing.Processで実行した処理内でUIの操作を行った際に上記のエラーとなる要因は何か分かりませんか？

Answer 1

multiprocessing.Queueの存在を見落としていました…
__init__内でmp.Queueのインスタンスを抱えさせて、
同時にself._check_queueをループさせてキューの監視をします。
_exec_proc内でmp.Processのインスタンスを作成するとき、
引数にargs=(self._queue,)を渡しておきます。
callback側でqueue.putを呼んでデータを突っ込んで、
キューの監視結果に基づいてGUIの更新をすれば良さそう？です。

tkinterはシングルスレッドであるが故に、
マルチスレッド側からは弄られないみたいな情報がありました。

Comments

[teamikl]

Queue を用いる解決策で大丈夫ですが、一つだけ実装方法に関して懸念点があります。

> 同時にself._check_queueをループさせてキューの監視をします。

この監視ループは tkinter のタイマー(after)ですか？それともThread内でのループ？

もしThread内のループで監視してる場合は、タイマーでの監視を検討するか、
以下の点に注意してThreadを用いるのを推奨します。既にタイマーの場合は、問題ありません。

大抵のGUIライブラリはイベント駆動という性質上、
イベントループ(tkinter では mainloop)はシングルスレッドで稼働します。

> マルチスレッド側からは弄られない

正確には、別スレッドから弄ってはいけない、です。これは tkinterに拘わらず、

UI の更新は必ずイベントループが稼働してるスレッドで行う必要があります。
大抵の場合メインスレッド。
(tkinter では mainloop を呼び出したスレッド ⇒ つまり、イベントハンドラ内から UIの更新しないといけない）

但し、tkinter はイベントハンドラ外・別スレッドからのGUI操作が出来てしまいます。
問題なく動いてるように見えても、複雑化すると意図しない挙動となることもあるので注意が必要です。
※ 現状の挙動で問題なくても、拡張していくうちに顕在化する可能性がある。
　⇒ 再現性が稀だとデバッグが困難に。
※ 代替・妥協案で 別スレッドから after_idle を使い、イベントループ側から実行させる方法がありますが、
　完全なスレッドセーフではありません。特に終了時に処理を行いたい場合に、工夫が必要になります。
　

[Refrain]

`_check_queue`はtkinterの`after`で呼んであります。
また、最終的にはUIの操作についても`_check_queue`で行うようにしました(抜粋は下記)。
ボタン操作時に`mp.Queue.put`を通してデータ格納、ループ内で`mp.Queue.get_nowait`でデータを取得してプロセスキルやUI操作を行わせてあります。
解決後にも関わらずのご注意、ありがとうございました！

```python
class Application:
def __init__ (self):
self._process = None
self._queue = Queue()
root.after(100, self._check_queue)
root.mainloop()
def _start_process (self):
self._process = Process(target=self._callback, args=(self._queue,))
self._process.start()
self._queue.put(...)
def _stop_process (self):
self._queue.put(None)
def _check_queue (self):
# プロセス有無チェック
# キュー取得
# プロセスキルやUI操作
@staticmethod
def _callback (queue):
# プロセス有無チェック
# キュー取得
# コード実行
self._queue.put(None)
```