Watchdog，一双专为 Python 而生的守护者之眼

大家好！我是爱摸鱼的小鸿，关注我，收看每期的编程干货。

一个简单的库，也许能够开启我们的智慧之门，
一个普通的方法，也许能在危急时刻挽救我们于水深火热，
一个新颖的思维方式，也许能激发我们无尽的创造力，
一个独特的技巧，也许能成为我们的隐形盾牌……

神奇的 Python 库之旅，第 3 章

一、神秘的 Watchdog

在程序员的世界里，有一种神奇的力量，它能够守护着我们的代码，保障程序的正常运行。

这个力量就是 Python 第三方库 Watchdog。今天，让我们一起揭开这位守护者的神秘面纱，探索它的奥秘与魅力。

Watchdog 是 Python 中一个用于监视文件系统变化的库，它能够监控文件或目录的变化，并在变化发生时触发相应的事件，比如文件的创建、修改、删除等。

简单来说，就像是给你的文件系统装上了一双“守护者之眼”，时刻关注着文件的一举一动。
在这里插入图片描述

安装 Watchdog

pip install watchdog -i https://pypi.doubanio.com/simple

这里使用国内豆瓣镜像源安装会更快。

Github 项目地址

https://github.com/gorakhargosh/watchdog

二、Watchdog 应用场景

那么，我们如何与这位守护者相遇呢？别着急，接下来我将为大家介绍几个与 Watchdog 相遇的奇妙场景。

场景一：文件同步
小明是一名程序员，他经常需要在不同的机器之间同步文件。以前，他总是需要手动复制、粘贴文件，非常麻烦。但自从他遇到了 Watchdog，一切都变得不一样了。

他写了一个简单的 Python 脚本，使用 Watchdog 监控源文件夹的变化，一旦有文件被修改，就立即同步到目标文件夹。于是，小明再也不用担心文件同步的问题了，一切都变得轻松自如。

import time
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandlerclass MyHandler(FileSystemEventHandler):def on_modified(self, event):# 文件被修改时触发print(f'{event.src_path} has been modified')if __name__ == "__main__":path = '.'  # 监控当前目录event_handler = MyHandler()observer = Observer()observer.schedule(event_handler, path, recursive=True)observer.start()try:while True:time.sleep(1)except KeyboardInterrupt:observer.stop()observer.join()

场景二：自动化测试
小红是一名测试工程师，她经常需要运行自动化测试脚本来检查软件的稳定性。然而，有时测试过程中会遇到一些意外情况，比如文件被删除或修改了。

为了解决这个问题，小红引入了 Watchdog，让它监控测试用例所在的目录，一旦有文件变化，就立即重新运行测试脚本。这样一来，小红的测试工作变得更加稳定可靠了。

import time
import subprocess
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandlerclass MyHandler(FileSystemEventHandler):def on_modified(self, event):# 文件被修改时触发print(f'{event.src_path} has been modified')subprocess.run(['python', 'test_script.py'])  # 重新运行测试脚本if __name__ == "__main__":path = '.'  # 监控当前目录event_handler = MyHandler()observer = Observer()observer.schedule(event_handler, path, recursive=True)observer.start()try:while True:time.sleep(1)except KeyboardInterrupt:observer.stop()observer.join()

场景三：日志监控
小李是一名运维工程师，他负责维护公司的服务器，并时刻关注着服务器的运行情况。为了及时发现问题，他使用 Watchdog 监控服务器日志文件的变化，

一旦有异常日志产生，就立即发送邮件通知管理员。这样一来，小李能够第一时间发现并解决服务器的问题，保障系统的稳定运行。

import time
import smtplib
from email.mime.text import MIMEText
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandlerclass MyHandler(FileSystemEventHandler):def on_modified(self, event):# 文件被修改时触发print(f'{event.src_path} has been modified')send_email('Server Alert', 'An error log has been detected')def send_email(subject, message):# 发送邮件通知from_addr = 'your_email@example.com'to_addr = 'admin@example.com'msg = MIMEText(message)msg['Subject'] = subjectmsg['From'] = from_addrmsg['To'] = to_addrserver = smtplib.SMTP('smtp.example.com', 25)server.login(from_addr, 'your_password')server.sendmail(from_addr, [to_addr], msg.as_string())server.quit()if __name__ == "__main__":path = '/var/log'  # 监控日志文件夹event_handler = MyHandler()observer = Observer()observer.schedule(event_handler, path, recursive=True)observer.start()try:while True:time.sleep(1)except KeyboardInterrupt:observer.stop()observer.join()

更多功能、详细用法可参考官方文档：

https://pythonhosted.org/watchdog

三、总结

通过上面的三个场景，我们可以看到 Watchdog 在日常开发、测试和运维中的广泛应用。无论是文件同步、自动化测试还是日志监控，Watchdog 都可以为我们提供强大的支持，让我们的工作变得更加轻松和高效。

希望通过本文的介绍，大家对 Watchdog 有了更深入的了解，并能够在实际项目中加以应用。同时，也希望大家能够在编程的道路上不断探索，不断进步，成为更加优秀的程序员！