メインコンテンツへスキップ
見出し画像

フォルダの見張り番 Watchdog ~ファイルの変化を見逃さないPython~

    1.ファイルを見張る


    あなたが「この共有フォルダに新しいファイルが置かれたら知らせてね。」なんて言われたらどうしますか。
    ひたすら監視し続けますか?
    人間には、ちょっときついですよね。

    これをPythonが代わりにやってくれるんです。

    Pythonでファイルの見張り役を作れば、
    24時間見落としもなく淡々とファイルを見張ってくれます。

    2.Watchdogは、イベントの監視役

    Watchdog が見ているのは イベント です。

    • ファイルが作られた

    • ファイルが変更された

    • ファイルが消された

    • 名前が変わった

    これらをPythonが見にいくというよりはWindowsから
    通知を受け取っています。

    サンプルコード

    このサンプルコードは、監視中のフォルダに
    ファイルやフォルダが新しく作成された、またはコピーされたときに
    知らせるコードです。

    from watchdog.observers import Observer
    from watchdog.events import FileSystemEventHandler
    import time
    
    WATCH_FOLDER=r"C:\Users\<ユーザー名>\your_watch_folder"
    
    class MyHandler(FileSystemEventHandler):
        def on_created(self, event):
            if not event.is_directory:
                print(f"👀 新しいファイルを発見: {event.src_path}")
            else:
                print(f"👀 新しいフォルダを発見: {event.src_path}")
    
    observer = Observer()
    observer.schedule(MyHandler(), path=WATCH_FOLDER, recursive=False)
    observer.start()
    
    try:
        while True:
            time.sleep(1)
    except KeyboardInterrupt:
        observer.stop()
    
    observer.join()

    3.コード解説

    ここからは、上のコードを要点ごとに区切って解説します。

    class MyHandler(FileSystemEventHandler):
        def on_created(self, event): # on_created()をオーバーライド
            if not event.is_directory: # フォルダでない場合
                print(f"👀 新しいファイルを発見: {event.src_path}")
            else: # フォルダの場合
                print(f"👀 新しいフォルダを発見: {event.src_path}")

    FileSystemEventHandler クラスの on_created メソッド を上書き(オーバーライド)することで、
    ファイルやフォルダが作成されたときの処理を実行できます。

    他にも

    • on_modified:更新検知

    • on_deleted:削除検知

    • on_moved:移動・リネームされた

    • on_any_event:すべてのイベント

    などのメソッドが用意されており、
    同様に上書き(オーバーライド)することで、それぞれのイベント発生時に処理を行えます。

    これらのメソッドは、該当するイベントが発生したときに Watchdog 側から自動的に呼び出されます。

    observer = Observer()
    observer.schedule(MyHandler(), path=WATCH_FOLDER, recursive=False)
    observer.start()

    Observer()は、監視用のインスタンスを作成します。
    observer.schedule()で 監視内容のハンドラー、監視するフォルダパス などを設定します。

    recursive=False は、監視するフォルダ内のフォルダを監視しません。
    True にすると監視するフォルダの中のフォルダを全て監視対象にします。

    observer.start() で observer による監視がメインのスレッドとは別のスレッドで開始されます。

    スレッドとは、プログラムの中で同時に処理を進めるための実行の流れのことです。

    通常、Pythonプログラムは上から順に1つの流れ(メインスレッド)で処理が実行されます。
    しかし、時間がかかる処理や常に動き続ける処理をそのまま書いてしまうと、他の処理が止まってしまいます。

    Watchdog の監視処理は、

    • 常にフォルダの変化を待ち続ける

    • プログラムが終了するまで動き続ける

    という性質があるため、メインの処理とは別のスレッドで動かされています。

    これにより、

    • メインスレッドは待機や終了処理を担当

    • 監視処理は裏側で常に動き続ける

    という役割分担が行われています。

    try:
        while True:
            time.sleep(1)
    except KeyboardInterrupt:
        observer.stop()

    ですので while True: で無限ループを作りメインスレッドが終了しないようにします。
    time.sleep(1) は、負荷を軽くするための待ち時間になります。

    ターミナルで Ctrl + C を押すと、KeyboardInterrupt が発生します。
    このときに observer.stop() を呼ぶことで

    • 監視スレッドを安全に停止

    • 中途半端な状態で終わらせない

    ようにしています。

    observer.join()

    これは、observer が完全に停止するまで待つという意味です。

    別スレッドで実行されている observer の終了を待ってメインのスレッドを
    終了します。

    4.応用 ~何に使えるか~

    通知する

    監視フォルダに何らかの変化があった場合に通知をします。
    例えば、共有フォルダにファイルが保存されたらなどです。

    自動処理する

    ファイルが置かれたら自動的に処理をします。
    例えばファイル名を見て請求書のファイルであれば
    会社別に別のフォルダに格納します。
    と同時にファイルのデータをCSVやExcelファイルへ
    追記します。

    アップロードする

    フォルダにファイルが置かれたら
    WebサービスやFTPを使ってアップロードします。

    ログ・証跡を残す用途

    例えばユーザーフォルダを丸ごと
    Watchdog で監視してログをとり
    1日の作業記録を撮ります。
    ただし、この場合は除外フォルダや
    除外する動作を指定する必要があります。


    等など、他に色々応用出ます。

    5.まとめ

    Watchdog を使うことで、
    「人が見張っていた作業」を Python に任せることができます。

    フォルダの変化を定期的に確認しにいくのではなく、
    Windows からの通知を受け取って処理を行うため、無駄がなく確実です。

    今回紹介したコードでは、フォルダ内でファイルやフォルダが作成・コピーされたことを検知し、Python 側で処理を実行しました。

    この仕組みを応用すれば、

    • 通知

    • 自動処理

    • アップロード

    • ログ取得

    など、さまざまな業務を「置くだけ」「起きたら自動」で動かせます。

    ※ ファイルのコピーや保存方法によっては、1つの操作で複数のイベントが発生する場合があります。
    実務で使う場合は、処理の二重実行を防ぐ工夫が必要になることもあります。


     
     
    元情シスが便利な業務効率化テクを発信中。 自作できるようにプロトタイプ的なソースを公開。 分かりやすく解説しているつもり。 HP、Xもあわせてご覧ください。 HP:https://goro-bizaid.com X:https://x.com/Goro_bizaid

    あなたへのおすすめ