文章目录
- 1 概述
- 2 安装watchdog
- 3 使用示例
| 更多精彩内容 |
|---|
| 👉内容导航 👈 |
| 👉Qt开发 👈 |
| 👉python开发 👈 |
1 概述
python实现实时监控文件的创建、修改、删除操作
跟踪文件夹内容的增删改变化
可用于文件发生变化时自动触发相应处理逻辑
实现热重载机制，如配置文件更新后自动重新加载
事件去抖动（防抖）：同一个文件1秒内多次事件只处理一次。
基于
watchdog实现；
- watchdog 是一个用于监控文件系统事件的 Python 库，它能够监听文件或目录的变化，如创建、修改、删除和移动等操作。这个库在需要实时响应文件系统变化的场景中非常有用，比如自动构建系统、日志监控、文件同步工具等。
- 主要组件
- Observer：观察者对象，负责监控指定路径的文件系统事件。它会持续运行一个后台线程来监听事件。
- FileSystemEventHandler：事件处理器基类，用户需要继承这个类并重写相应的事件处理方法来定义对特定事件的响应。
- Event：事件对象，代表一个具体的文件系统事件，包含了事件类型和相关文件路径等信息。
典型应用场景
- 开发工具
- 代码编辑器监听源文件变化实现自动刷新
- 构建工具监听源码变更触发重新编译
- 文件同步服务
- 监控本地文件夹变化同步到云端
- 实现文件实时备份功能
- 系统管理
- 监控配置文件变化并动态调整程序行为
- 跟踪重要目录的安全变更记录
2 安装watchdog
- 使用命令行
pip install watchdog进行安装；
3 使用示例
importtimeimportosfrompathlibimportPathfromwatchdog.observersimportObserverfromwatchdog.eventsimportFileSystemEventHandlerclassWatchdogHandler(FileSystemEventHandler):def__init__(self):self._file_path=Noneself.last_modified={}# 上次修改时间defset_target_file(self,target_file):""" 设置监控的目标文件 :param target_file: :return: """ifPath(target_file).is_file()andos.path.exists(target_file):self._file_path=target_fileelse:raiseFileNotFoundError(f"{target_file}不存在")defdispatch(self,event):""" 对事件进行分发处理，过滤掉非目标文件的事件 :param event: :return: """# 忽略临时文件ifevent.src_path.endswith('~'):return# 如果没有设置目标文件，则处理所有事件ifself._file_pathisNone:super().dispatch(event)else:# 判断是否是目标文件，如果是则处理该事件ifos.path.abspath(event.src_path)==os.path.abspath(self._file_path):super().dispatch(event)defon_modified(self,event):""" 文件修改事件处理 """now=time.time()# 每个文件1秒内只响应一次ifnow-self.last_modified.get(event.src_path,0)>1:self.last_modified[event.src_path]=nowprint(f"文件被修改:{event.src_path}")defon_created(self,event):""" 文件创建事件处理 """print(f"文件被创建:{event.src_path}")defon_deleted(self,event):""" 文件删除事件处理 """print(f"文件被删除:{event.src_path}")classWatchdogPath:def__init__(self):self.observer=Observer()defstop(self):self.observer.stop()defwatchdog_path(self,target_path):""" 监控指定路径的文件或目录变化 :param target_path: 目标路径，可以是文件或目录 """ifnotos.path.exists(target_path):print(f"{target_path}不存在")returntarget_path=os.path.abspath(target_path)# 获取绝对路径event_handler=WatchdogHandler()# 如果是文件，则设置目标文件ifPath(target_path).is_file():event_handler.set_target_file(target_path)target_path=os.path.dirname(target_path)or"."# 获取文件所在目录self.observer.schedule(event_handler,target_path,recursive=False)self.observer.start()# 启动监控，在后台线程运行# 使用示例if__name__=="__main__":# target_path = "E:/Code/PythonProject2/test.pyproject"# target_path = "./test.pyproject"target_path="./"w=WatchdogPath()w.watchdog_path(target_path)w.observer.join()# 等待线程结束
