Python で，ファイル更新を監視

【概要】

本記事では，watchdog（ファイルシステムの変更を検知する Python ライブラリ）を用いて，指定したディレクトリ内の特定ファイルの更新を監視し，追記された内容を表示するプログラムを扱う。

引数でディレクトリを指定して実行する。引数がないときは，プログラムが置かれているディレクトリを使う。そのディレクトリ内の log.txt（ファイル名は FILENAME で設定）の更新を監視する。変更の検出には MD5 ハッシュ（ファイル内容から計算する固定長の値で，内容が変わると値も変わる）を使い，ファイルへの「追記」だけを前提として，追記された内容を表示する。デバウンス（短い時間に連続して起きるイベントをまとめて1回分として扱う仕組み）により，同じ変更に対する重複イベントを抑える。プログラムを止めるには Ctrl + C を使う。

【目次】

【関連する外部ページ】

watchdog の公式ページ: https://pypi.org/project/watchdog/

【サイト内の関連情報】

機械学習や深層学習の開発環境（NVIDIA CUDA，Visual Studio，Cursor など）の準備: https://www.kkaneko.jp/cc/dev/aiassist.html

1. 前準備

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

以下のいずれかの方法でPython 3.12をインストールする。Pythonがインストール済みの場合、この手順は不要である。

方法 1：winget によるインストール

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして、コマンド全体をコマンドプロンプトにコピー＆ペーストする。

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動するとPATHが反映される。

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

方法 2：インストーラーによるインストール

  1. Python公式サイト（https://www.python.org/downloads/）にアクセスし、「Download Python 3.x.x」ボタンからWindows用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」にチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号（例：Python 3.12.x）が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

Python の開発環境 Visual Studio Code のインストールと Python 用の設定

Python の開発環境Visual Studio Code（プログラムを編集するソフトウェア。以下、VS Code）を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより，既存の VS Code を削除し，全ユーザー共有の設定で再インストールしたうえで，拡張機能（VS Code に機能を追加するソフトウェア）をまとめて導入する．

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして，コマンド全体をコマンドプロンプトにコピー＆ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM （%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す）
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合，VS Code で使用する Python 本体（インタプリタ：Python プログラムを解釈・実行するソフトウェア）を選択する必要がある．

  1. コマンドパレット（コマンド名で機能を呼び出す VS Code の入力欄）を開く（Ctrl+Shift+P）
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から，使用する Python（例：C:\Program Files\Python312\python.exe）を選択する．

Python プログラム実行手順

[Windows での Python プログラム実行手順を見るには、ここをクリック]

Windows での Python 実行手順（Visual Studio Codeを使用）

プログラムファイルの作成と保存

  1. 左サイドバーの「エクスプローラー」アイコン（Ctrl+Shift+E）をクリックする
  2. 「NO FOLDER OPENED」（作業対象フォルダが未選択の状態）と表示される場合は，「Open Folder」をクリックし，プログラムを保存するフォルダを選択する

    続いて「フォルダを信用するか」を確認する画面（フォルダ内のコードを実行してよいか確認する VS Code の仕組み）が表示されるので，チェックして Yes を選択する

  3. フォルダ名の右側に表示される「新しいファイル」アイコンをクリックする
  4. ファイル名（例：aitask.py．ファイル名は何でも良い）を入力し Enter を押す．拡張子は .py（Python ファイルを示す拡張子）とする
  5. 実行したいコードを選択し，Ctrl+C でコピーする．VS Code のエディタ領域に Ctrl+V で貼り付ける
  6. Ctrl+S で保存する

プログラムの実行

  1. エディタ右上の三角形「▷」アイコン（Run Python File：現在開いている Python ファイルを実行するボタン）をクリックする．または，エディタ上で右クリックし「ターミナルで Python ファイルを実行」を選択する
  2. VS Code 下部のターミナル（コマンドの入出力を表示する画面）に，実行結果（print 関数の出力等）が表示される
  3. tkinter（Python 標準の GUI ライブラリ）のファイル選択ダイアログを使うプログラムを実行した場合は，ダイアログが開くので対象画像を選択する
  4. VS Code 下部のターミナルで実行結果を確認する．OpenCV ウィンドウ（OpenCV が画像を表示するために開く専用ウィンドウ）が開いた場合はそちらも確認する．OpenCV ウィンドウは，マウスクリックでウィンドウをアクティブ（操作対象の状態）にしてからキーを押すと終了する

2. watchdog のインストール

管理者権限でコマンドプロンプトを起動する （手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。

起動したコマンドプロンプトで，次を実行する。

python -m pip install -U --no-user watchdog

3. 実行手順

演習のコードをテキストエディタ（Visual Studio Code やメモ帳など）に貼り付け，文字コードを UTF-8 にして保存する。監視対象の log.txt を，保存したプログラムと同じディレクトリに作成しておく。

引数でディレクトリを指定することもできる。指定したディレクトリ内の log.txt が監視対象になる。

python a.py C:\path\to\directory

動作確認チェックリスト

確認項目期待される結果
引数なしで起動プログラムが置かれているディレクトリの log.txt を監視し，待機状態になる
引数でディレクトリを指定して起動指定したディレクトリの log.txt を監視し，待機状態になる
log.txt にテキストを追記して保存追記した内容が表示される
Ctrl + C を押下プログラムが停止する

4. 概要・使い方・実行上の注意

本プログラムは，watchdog の Observer（変更を監視するクラス）と FileSystemEventHandler（イベント発生時の処理を書くクラス）を用いて，ファイルシステムの変更イベントを監視する。

引数でディレクトリを指定する。引数がないときは，プログラムが置かれているディレクトリ（os.path.abspath(os.path.dirname(__file__)) で取得）を使う。プログラムは，その指定したディレクトリへ os.chdir で移動したうえで，そのディレクトリ内の log.txt（ファイル名は FILENAME で設定）の更新を監視する。

on_modified（監視対象が変更されたときに呼ばれる処理）の発生時に，ファイルの MD5 ハッシュ値を前回の値と比べ，変更があったときだけ処理を実行する。ファイルへの「追記」だけを前提とし，前回読み取った位置（self.pos）から末尾までの内容を読み取って表示する。

OS のファイルシステム通知では，1回の保存操作に対して複数の on_modified イベントが発生することがある。本プログラムでは，前回のイベントから 0.5 秒以内のイベントを無視するデバウンス（self.last_event_time）により，重複した出力を防ぐ。

プログラムを止めるには Ctrl + C を使う。

5. 演習1：ファイル更新の監視プログラムを実行する

テーマ名：watchdog によるファイル更新の監視と，追記内容の表示

手順

  1. 次のコードを実行（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）する。あらかじめ，プログラムと同じディレクトリに監視対象の log.txt を作成しておく。
  2. プログラムを起動し，待機状態になることを確認する。
  3. log.txt をテキストエディタで開き，行を追記して保存する。追記した内容が表示されることを確認する。
  4. 引数でディレクトリを指定して起動し，そのディレクトリ内の log.txt が監視されることを確認する。
  5. Ctrl + C を押し，プログラムが停止することを確認する。

ヒント

考察ポイント

# -*- coding: utf-8 -*-
# 事前準備
#   pip install -U --no-user watchdog
# 使い方
#   引数でディレクトリを指定する．引数がないときは，
#   このプログラムが置かれているディレクトリを使用する．
#   そのディレクトリ内のファイル log.txt（ファイル名は FILENAME で設定）の更新を監視する．
#   プログラムを止めるには Ctrl + C（同時押し）
# 参考 Web ページ
#   https://pypi.org/project/watchdog/

import sys
import time
import os
import hashlib
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler

FILENAME = 'log.txt'

class ChangeHandler(FileSystemEventHandler):
    def __init__(self):
        with open(FILENAME, 'rb') as f:
            self.oldmd5 = hashlib.md5(f.read()).hexdigest()
        with open(FILENAME, 'r') as f:
            f.read()
            self.pos = f.tell()
        self.last_event_time = 0

    def on_modified(self, event):
        if event.is_directory or os.path.basename(event.src_path) != FILENAME:
            return
        now = time.time()
        if now - self.last_event_time < 0.5:
            return
        self.last_event_time = now
        with open(FILENAME, 'rb') as f:
            mymd5 = hashlib.md5(f.read()).hexdigest()
        if self.oldmd5 == mymd5:
            return
        self.oldmd5 = mymd5
        with open(FILENAME, 'r') as f:
            f.seek(self.pos)
            dat = f.read()
            self.pos = f.tell()
        if dat:
            print(dat, end='')

path = sys.argv[1] if len(sys.argv) > 1 else os.path.abspath(os.path.dirname(__file__))
os.chdir(path)
observer = Observer()
observer.schedule(ChangeHandler(), path, recursive=False)
observer.start()
try:
    while True:
        time.sleep(5)
finally:
    observer.stop()
    observer.join()

6. まとめ