Pythonでファイルの変更を監視する方法！watchdogライブラリの使い方を徹底解説

どのプログラミング言語においても、ファイルの変更を監視する処理は、OSごとの仕様の違い（クロスプラットフォーム問題）があるため、自前で実装するのは容易ではありません。

Pythonには、この課題を解決するために広く利用されている「watchdog」というクロスプラットフォーム対応のライブラリがあります。watchdogを使えば、Windows・macOS・Linuxなど環境を問わず、ファイルシステムの変更イベントを簡単に検知できます。

watchdogのインストール

watchdogはpipコマンドで簡単にインストールできます。

$ pip install watchdog

サンプルコード：ファイルの変更を検知する

ここでは、「my_file.txt」といったカレントディレクトリ内のファイルの変更を監視するシンプルなプログラムを紹介します。

import time
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler

class MyHandler(FileSystemEventHandler):
    def on_modified(self, event):
        print("Got it!")

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

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

observer.join()

コードの解説

このプログラムを実行し、監視対象ディレクトリ内のファイルに何らかの変更を加えると、MyHandlerクラスのon_modifiedメソッドがイベント情報とともに自動的に呼び出されます。

主なポイント

• イベントハンドラのカスタマイズ： MyHandlerクラス内に独自の処理を記述することで、変更検知時の動作を自由に定義できます。また、on_created（ファイル作成）やon_deleted（ファイル削除）、on_moved（移動・リネーム）などのメソッドもオーバーライド可能です。
• 監視対象の指定： observer.schedule()のpath引数で、監視したいファイルやディレクトリを指定します。上記の例ではカレントディレクトリ「.」を監視しています。
• 再帰的な監視： recursive=Trueに設定すると、サブディレクトリ以下も含めて監視できます。

プログラムを停止する場合は、キーボードのCtrl + Cを押してください。KeyboardInterruptを受け取って、Observerが安全に終了します。