watchdog: 全自動化監控目錄文件

楔子

有些時候我們需要對一個目錄進行監控，檢測其內部是否有文件的新增、刪除、以及每個文件的內容是否發生變化，這個時候如果是你的話，你會選擇怎么做呢？

顯然也是一個比較麻煩的工作，倒不是說難，主要是比較繁雜。但萬幸的是，已經有一個第三方包watchdog幫我們完美地實現了這一點，所以這就是Python啊，想做什么都有現成的。

那么下面就來看一下它的用法，當然要先安裝。直接：pip install watchdog即可。

使用方法

在我的桌面上有一個空目錄test，一會兒我們對這個目錄做的操作都會體現出來，另外這個包是可以適配所有主流操作系統的。

# 導入Observer和FileSystemEventHandler
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler


# 定義一個類, 繼承自FileSystemEventHandler
class CodeEventHandler(FileSystemEventHandler):

    def on_moved(self, event):
        """當一個文件或者目錄被重命名時"""
        print(f"{event.src_path} 被重命名為 {event.dst_path}")

    def on_created(self, event):
        """當一個文件或者目錄被創建時"""
        print(f"{event.src_path}被創建了")

    def on_deleted(self, event):
        """當一個文件或者目錄被刪除時"""
        print(f"{event.src_path}被刪除了")

    def on_modified(self, event):
        """當一個文件或者目錄被修改時"""
        print(f"{event.src_path}被修改了")


def main():
    # 創建一個觀察者
    observer = Observer()
    # 開啟調度, 接收三個參數: handler、監控的目錄、是否遞歸所有子目錄
    observer.schedule(CodeEventHandler(), r"C:\Users\satori\Desktop\test", True)
    # 啟動監聽, 注意: 這里是開啟了一個新的守護線程, 所以程序如果結束, 該線程也會停止
    # 這也符合我們的需求
    observer.start()


main()
while True:
    pass

下面就來演示一下：

• 創建一個文件

C:\Users\satori\Desktop\test\新建文本文檔.txt被創建了

• 創建一個目錄

C:\Users\satori\Desktop\test\新建文件夾 被創建了

• 重命名

C:\Users\satori\Desktop\test\新建文本文檔.txt 被重命名為 C:\Users\satori\Desktop\test\1.txt
C:\Users\satori\Desktop\test\新建文件夾 被重命名為 C:\Users\satori\Desktop\test\test_child

• 將文件1.txt移動到子目錄test_child, 所以此時會伴隨一個創建、一個刪除以及一個修改

C:\Users\satori\Desktop\test\1.txt 被刪除了   //因為該文件移動之后相當於不存在了, 所以被刪除了
C:\Users\satori\Desktop\test\test_child\1.txt 被創建了  //顯然此時文件相當於被創建
C:\Users\satori\Desktop\test\test_child 被修改了  
//因為test目錄里面的文件變了, 因此相當於被修改了
//如果是文本, 那么會監控內容是否變化, 目錄則監控內部文件的數量和位置是否有變化

• 修改文件1.txt

C:\Users\satori\Desktop\test\1.txt 被修改了

小結

使用方法非常簡單，內部都幫你封裝好了，所以watchdog這個包確實可以節省不少事情。