pythonのwxで監視アプリをつくり、タスクバーの右クリックメニューを出して処理を実行させたい

Question

python 3.8　で開発
windows 8.1　で起動させたいアプリです。

ttray_test_before.py

import wx			#wxPython のモジュール
import wx.adv
# ファイル変更イベント検出のため、watchdogをインポート
from watchdog.events import PatternMatchingEventHandler
from watchdog.observers import Observer

# ファイルアクセス
import os
# 時間処理
import datetime

# 監視対象ディレクトリ
target_dir = r'C:\My Documents\watch'

#-------------------------------------------------------------------------------
#   質問用のダミー処理
#-------------------------------------------------------------------------------
def dummy_fnc():
    # 現在時刻
    nowtime = datetime.datetime.now().strftime("%Y%m%d%H%M%S")
    filepath = os.path.join(target_dir , nowtime + '.txt')
    with open(filepath, 'a', encoding='utf-8') as file:
        file.write(nowtime + '\n')

#-------------------------------------------------------------------------------
#   タスクトレイのクラス　(TaskBarIconを継承)
#-------------------------------------------------------------------------------
class SysTray(wx.adv.TaskBarIcon):

    def __init__(self):

        # 初期起動
        wx.adv.TaskBarIcon.__init__(self)   # 継承元の初期化を呼び出す

        # カレントディレクトリの変更
        os.chdir(os.getcwd())

        # アイコン設定
        icon = wx.Icon('icon.png', wx.BITMAP_TYPE_ANY )
        self.SetIcon(icon, "filewatcher")

        # 左クリック時の関数登録
        self.Bind(wx.adv.EVT_TASKBAR_LEFT_UP, self.LeftClick)

    #---------------------------------------------------------------------------------------------------
    #   タスクトレイでアイコンをクリックしたときにメニューを表示させ、メニュー内をクリックしたら処理を行う
    #---------------------------------------------------------------------------------------------------
    def CreatePopupMenu(self):
        # タスクトレイメニューの作成
        menu = wx.Menu()
        menu.Append(1, "手動処理")
        menu.Append(2, "終了")
        self.Bind(wx.EVT_MENU, self.click_item)
        return menu
    #-------------------------------------------------------------------------------
    #   左マウスボタンクリック
    #-------------------------------------------------------------------------------
    def LeftClick(self, even):
        # クローズイベントでフレーム重複作成を防止
        # ・・・出来てないが、質問内容とは関係ない不具合
        wx.Frame(None).Show()

    #-------------------------------------------------------------------------------
    #   メニュー項目をクリック
    #-------------------------------------------------------------------------------
    def click_item(self, event):
        event_id = event.GetId()    # IDを取得する

        if event_id == 1:
            # 本当はメイン処理が別途あるが質問対象外の内容の為非公開とし、ダミー処理とする
            dummy_fnc()

        elif event_id == 2:
            self.exitTray( event )

    #-------------------------------------------------------------------------------
    #   終了処理
    #-------------------------------------------------------------------------------
    def exitTray(self, event):
        self.Destroy()
        wx.Exit()

#-------------------------------------------------------------------------------
#　メイン
#-------------------------------------------------------------------------------
if __name__ == "__main__":
   app = wx.App()
   # タスクトレイクラスの呼出
   taskttr = SysTray()
   # 右クリックでメニュー呼び出し
   SysTray.CreatePopupMenu(taskttr)

   app.MainLoop()

上記にてタスクトレイにアプリを常駐させ、
アイコンを右クリックすると
「手動処理」
「終了」
が表示されます。

「手動処理」を押すとメイン処理(本処理は公開不可の為、ダミー処理です)
「終了」でアプリを終了させます。

上記は正常に動作しております。
(※最終的にはpy2exeでexe化しタスクスケジューラ起動させるようにする)

今度、特定のディレクトリ内にファイルが作成された時、
「手動処理」と同じ関数を実行させたいです。

ttray_test_main.py

import wx			#wxPython のモジュール
import wx.adv
# ファイル変更イベント検出のため、watchdogをインポート
from watchdog.events import PatternMatchingEventHandler
from watchdog.observers import Observer

# osをインポート
import os

import datetime
# 時間処理
# 監視対象ディレクトリ
target_dir = r'C:\My Documents\watch'

#-------------------------------------------------------------------------------
#   質問用のダミー処理
#-------------------------------------------------------------------------------
def dummy_fnc():
    # 現在時刻
    nowtime = datetime.datetime.now().strftime("%Y%m%d%H%M%S")
    filepath = os.path.join(target_dir , nowtime + '.txt')
    with open(filepath, 'a', encoding='utf-8') as file:
        file.write(nowtime + '\n')

#-------------------------------------------------------------------------------
#   ファイル監視のクラス　(　PatternMatchingEventHandlerを継承)
#-------------------------------------------------------------------------------
class FileChangeHandler(PatternMatchingEventHandler):
     # クラス初期化
     def __init__(self, patterns):
         super(FileChangeHandler, self).__init__(patterns=patterns)


     # ファイル作成時のイベント
     def on_created(self, event):
         # 本当はメイン処理が別途あるが質問対象外の内容の為非公開とし、ダミー処理とする
         dummy_fnc()

#-------------------------------------------------------------------------------
#　監視処理
#-------------------------------------------------------------------------------
def watchfile():

     # ファイル監視の開始
     event_handler = FileChangeHandler(['*.*'])
     observer = Observer()
     # ↓ recursive = True ← サブディレクトリも対象
     observer.schedule(event_handler, target_dir, recursive=True)
     observer.start()

     # 処理が終了しないようスリープを挟んで無限ループ
     try:
         while True:
           pass

     # Ctri + C で止める
     except KeyboardInterrupt:
         observer.stop()
     observer.join()

#-------------------------------------------------------------------------------
#   タスクトレイのクラス　(TaskBarIconを継承)
#-------------------------------------------------------------------------------
class SysTray(wx.adv.TaskBarIcon):

    def __init__(self):

        # 初期起動
        wx.adv.TaskBarIcon.__init__(self)   # 継承元の初期化を呼び出す

        # カレントディレクトリの変更
        os.chdir(os.getcwd())

        # アイコン設定
        icon = wx.Icon('icon.png', wx.BITMAP_TYPE_ANY )
        self.SetIcon(icon, "filewatcher")

        # 左クリック時の関数登録
        self.Bind(wx.adv.EVT_TASKBAR_LEFT_UP, self.LeftClick)
    #---------------------------------------------------------------------------------------------------
    #   タスクトレイでアイコンをクリックしたときにメニューを表示させ、メニュー内をクリックしたら処理を行う
    #---------------------------------------------------------------------------------------------------
    def CreatePopupMenu(self):
        # タスクトレイメニューの作成
        menu = wx.Menu()
        menu.Append(1, "手動処理")
        menu.Append(2, "終了")
        self.Bind(wx.EVT_MENU, self.click_item)
        return menu
    #-------------------------------------------------------------------------------
    #   左マウスボタンクリック
    #-------------------------------------------------------------------------------
    def LeftClick(self, even):
        # クローズイベントでフレーム重複作成を防止
        # ・・・出来てないが、質問内容とは関係ない不具合
        wx.Frame(None).Show()

    #-------------------------------------------------------------------------------
    #   メニュー項目をクリック
    #-------------------------------------------------------------------------------
    def click_item(self, event):
        event_id = event.GetId()    # IDを取得する

        if event_id == 1:
            # 本当はメイン処理が別途あるが質問対象外の内容の為非公開とし、ダミー処理とする
            dummy_fnc()

        elif event_id == 2:
            self.exitTray( event )

    #-------------------------------------------------------------------------------
    #   終了処理
    #-------------------------------------------------------------------------------
    def exitTray(self, event):
        self.Destroy()
        wx.Exit()

#-------------------------------------------------------------------------------
#　メイン
#-------------------------------------------------------------------------------
if __name__ == "__main__":
   app = wx.App()
   # タスクトレイクラスの呼出
   taskttr = SysTray()
   # 右クリックでメニュー呼び出し
   SysTray.CreatePopupMenu(taskttr)

   # ファイル監視の開始
   watchfile()

   app.MainLoop()

とコーディングしました。

出来ている事
ファイル追加時にdummy_fncは正常に処理をする
出来ていなくて出来るようにしたいこと
タスクトレイを右クリックした時に、ttray_test_before.pyの時と同様
メニュー表示し、
「手動処理」を押すとメイン処理の実行、「終了」でアプリを終了させたい。

どのように変更すれば良いか教えてください。

Answer 1

問題点: ファイルの監視が終わるまで GUI が開始しない

   # ファイル監視の開始
   watchfile()

   app.MainLoop()

となっていますが、watchfile 関数が無限ループを持つブロッキング処理になってます

     # 処理が終了しないようスリープを挟んで無限ループ
     try:
         while True:
           pass

     # Ctri + C で止める
     except KeyboardInterrupt:
         observer.stop()
     observer.join()

これではwatchfile が終わらないと app.MainLoop() が呼ばれないので、GUIが稼働しません。

observer はスレッドで実行されるので、observer.start() の後は関数を抜けても大丈夫です。
observer.stop() をアプリケーション終了時に呼び出す為に、
observerのインスタンス自体は何処かに保持してください。

解決策: MainLoop を呼び出す為に、無限ループでブロックしない

observer.start()

app.MainLoop()

observer.stop() # 終了をリクエスト
observer.join() # 処理中のタスクが完了するまで待機

Comments

[toccipc]

teamikl　様
無限ループが問題だったんですね。
joinはそもそも実装してたのでそこで待てば良かったのに、ってとこなんですね。

記載のコードにて修正したところ、稼働の確認が取れました。

```python

def watchfile():

# ファイル監視の開始
event_handler = FileChangeHandler(['*.*'])
observer = Observer()
# ↓ recursive = True ← サブディレクトリも対象
observer.schedule(event_handler, target_dir, recursive=True)
observer.start()

# 監視開始
app.MainLoop()

observer.stop()
observer.join()

```

※他、修正無し

ご回答いただきありがとうございました。

[teamikl]

>joinはそもそも実装してたのでそこで待てば良かったのに、ってとこなんですね

細かい点なのですが、若干ニュアンスが違って、
認識としては join ではなく 「MainLoopで待てば良かった」 とした方が適切です。
（コメントに記載のコード自体は問題ありません）

join でも待機できるのですが、observer.start ではバックグラウンドのスレッドでの実行なので
app.MainLoop が稼働してる間は、そもそも observer に待機を指示する必要がありません。

app.MainLoop と observer.join が「ブロッキング処理」なので、どちらも
無限ループに期待されるような待機ポイントとして用いることができます。

GUIと併用する場合に join で待つ場合は注意が必要になり
GUI のイベントハンドラ内で Thread.join (observer.join) や無限ループのような
ブロッキング処理をすると、GUIが応答なしになってしまいます。

上記のコードでは、MainLoop を抜けて GUI が終了してから
observer を stop し join でその完了迄待つという構成にしてます。

# 監視開始 <-- 監視の開始はこちら
observer.start()

# アプリケーションの終了を待つ
app.MainLoop()

# 監視停止
observer.stop()
observer.join()

[toccipc]

修正したところ（上記とは別で）の記載失念

#-------------------------------------------------------------------------------
#　メイン
#-------------------------------------------------------------------------------
if __name__ == "__main__":
app = wx.App()
# タスクトレイクラスの呼出
taskttr = SysTray()
# 右クリックでメニュー呼び出し
SysTray.CreatePopupMenu(taskttr)

app.MainLoop()

の最後の
app.MainLoop()
を消しました。

[toccipc]

これ、よくよく見ると 終了してもpythonのプロセスは消えて無いですね。
終了を押して、タスクトレイから消えますが・・・タスクマネージャからpythonは消えていない・・・