python中文件變化監控-watchdog

起步

在python中文件監控主要有兩個庫，一個是pyinotify，一個是watchdog。pyinotify依賴於Linux平台的inotify，后者則對不同平台的的事件都進行了封裝。因為我主要用於Windows平台，所以下面着重介紹watchdog（推薦大家閱讀一下watchdog實現源碼，有利於深刻的理解其中的原理）。
watchdog在不同的平台使用不同的方法進行文件檢測。在init.py中發現了如下注釋：

|Inotify|                             Linux 2.6.13+                    ``inotify(7)`` based observer
|FSEvents|                            Mac OS X                         FSEvents based observer
|Kqueue|                              Mac OS X and BSD with kqueue(2)  ``kqueue(2)`` based observer
|WinApi|(ReadDirectoryChangesW)       MS Windows                       Windows API-based observer
|Polling|                             Any                              fallback implementation

給出示例代碼如下：

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# Created by victor

# 本模塊的功能:<檢測文件夾變化>

# 導入watchdog對應模塊
from watchdog.observers import Observer
from watchdog.events import *
# 導入時間模塊
import time

class FileEventHandler(FileSystemEventHandler):
    # 初始化魔術方法
    def __init__(self):
        FileSystemEventHandler.__init__(self)

    # 文件或文件夾移動
    def on_moved(self, event):
        if event.is_directory:
            print("directory moved from {0} to {1}".format(event.src_path,event.dest_path))
        else:
            print("file moved from {0} to {1}".format(event.src_path,event.dest_path))

    # 創建文件或文件夾
    def on_created(self, event):
        if event.is_directory:
            print("directory created:{0}".format(event.src_path))
        else:
            print("file created:{0}".format(event.src_path))

    # 刪除文件或文件夾
    def on_deleted(self, event):
        if event.is_directory:
            print("directory deleted:{0}".format(event.src_path))
        else:
            print("file deleted:{0}".format(event.src_path))

    # 移動文件或文件夾
    def on_modified(self, event):
        if event.is_directory:
            print("directory modified:{0}".format(event.src_path))
        else:
            print("file modified:{0}".format(event.src_path))

if __name__ == "__main__":
    # 實例化Observer對象
    observer = Observer()
    event_handler = FileEventHandler()
    # 設置監聽目錄
    dis_dir = "e:/"
    observer.schedule(event_handler,dis_dir,True)
    observer.start()
    try:
        while True:
            # 設置監聽頻率(間隔周期時間)
            time.sleep(1)
    except KeyboardInterrupt:
        observer.stop()
    observer.join()

小結

watchdog主要采用觀察者模型（廢話，從變量命名就可以看出來）。主要有三個角色：observer，event_handler，被監控的文件夾。三者原本是獨立的，主要通過observer.schedule函數將三者串起來，意思為observer不斷檢測調用平台依賴代碼對監控文件夾進行變動檢測，當發現改變時，通知event_handler處理。最后特別推薦讀者有時間可以閱讀一下watchdog的源碼，寫的易懂而且架構很好用