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这个包确实可以节省不少事情。