python使用watchdog实现文件资源监控

 更新时间:2025年01月10日 09:13:16   作者:觅远  
watchdog 支持跨平台文件资源监控,可以检测指定文件夹下文件及文件夹变动,下面我们来看看Python如何使用watchdog实现文件资源监控吧

Python文件监控库watchdogs简介

随着Python在各种应用领域中的广泛使用,其生态环境也在持续繁荣,特别是各种第三方库的诞生,极大地丰富了开发者的工具箱。在众多库中, watchdog 作为一个高效的文件系统监控库,对于实时响应文件系统的各种事件(如文件创建、修改、删除等)提供了极大便利。无论是在需要监控项目文件变化以触发自动化构建的开发场景,还是在需要日志记录、文件备份等运维任务中, watchdog 都能发挥重要的作用。

文件资源监控

安装:pip install watchdog

watchdog 支持跨平台文件资源监控,可以检测指定文件夹下文件及文件夹变动,当出现不同变动(新增、删除、修改)后,可进行相应处理。

from time import sleep, strftime
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler
 
 
class FileMonitoring(FileSystemEventHandler):
    # event.is_directory 判断是否是目录操作
    def on_modified(self, event):  # 文件或文件夹被修改时触发(新增、删除及修改文件或文件夹都会被监测为文件夹的修改)
        tm = strftime("%Y-%m-%d %H:%M:%S")
        print(f'{tm} 修改文件夹{event.src_path}')
 
    def on_created(self, event):  # 文件或目录被创建时触发
        tm = strftime("%Y-%m-%d %H:%M:%S")
        if event.is_directory:
            print(f'{tm} 创建文件夹{event.src_path}')
        else:
            print(f'{tm} 创建文件{event.src_path}')
 
    def on_deleted(self, event):  # 文件或目录被删除时触发
        tm = strftime("%Y-%m-%d %H:%M:%S")
        if event.is_directory:
            print(f'{tm} 删除文件夹{event.src_path}')
        else:
            print(f'{tm} 删除文件{event.src_path}')
 
    def on_moved(self, event):  # 目录的创建和删除操作,被Watchdog视为移动操作,因此通过on_moved方法进行捕捉,重命名也可用此捕获。
        tm = strftime("%Y-%m-%d %H:%M:%S")
        if event.is_directory:
            print(f'{tm} 重命名文件夹:文件夹{event.src_path} 重命名为 {event.dest_path}')
        else:
            print(f'{tm} 重命名文件:文件{event.src_path} 重命名为  {event.dest_path}')
 
 
class MyFileMonitor():
    def __init__(self):
        self.event_handler = FileMonitoring()  # 初始化事件处理器实例
 
    def sever(self, watched_dir, recursive: bool = True):
        '''
        :param watched_dir: .schedule 方法设置要监控的目录路径和事件处理器
        :param recursive: recursive=True 参数以递归地监控目录内的所有子目录
        :return:
        '''
        self.observer = Observer()  # 初始化观察器
        self.observer.schedule(self.event_handler, watched_dir, recursive=recursive)  # 将事件处理器关联到观察器
        return self.observer
 
    def run(self, watched_dir, recursive: bool = True):
        '''
        启动观察器并进入无限循环,直到用户按下 Ctrl+C 中断程序,
        observer.stop() 和 observer.join() 来正确停止和清理观察器资源。
        '''
 
        observer = self.sever(watched_dir, recursive)
        observer.start()
        try:
            while True:
                sleep(.1)
        except KeyboardInterrupt:
            observer.stop()
 
        observer.join()

监测文件夹新增、删除、修改文件夹

在Python中,watchdog 库确实提供了方便的方式来监控文件夹及其内部文件的新增、删除、修改以及重命名等事件。下面是一个简单的示例,展示如何使用 watchdog 来监听一个文件夹中的这些事件

import time
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler
 
# 定义事件处理器类
class MyHandler(FileSystemEventHandler):
    def on_modified(self, event):
        print(f'File modified: {event.src_path}')
 
    def on_created(self, event):
        print(f'File created: {event.src_path}')
 
    def on_deleted(self, event):
        print(f'File deleted: {event.src_path}')
 
    # 对于文件夹的创建、删除操作,请注意:
    # 目录级别的事件可通过on_moved方法捕获,因为创建和删除目录也表现为移动事件
    def on_moved(self, event):
        if event.is_directory:
            what = "Directory"
        else:
            what = "File"
        print(f'{what} moved: {event.src_path} to {event.dest_path}')
 
# 初始化事件处理器实例
event_handler = MyHandler()
 
# 指定要监控的文件夹路径
watched_dir = '/path/to/watch'
 
# 初始化观察器
observer = Observer()
 
# 将事件处理器关联到观察器
observer.schedule(event_handler, watched_dir, recursive=True)
 
# 启动观察器
observer.start()
 
print(f'Starting to watch {watched_dir} for file system events...')
try:
    while True:
        time.sleep(1)
except KeyboardInterrupt:
    observer.stop()
 
observer.join()

在这个例子中,MyHandler 类继承了 FileSystemEventHandler 并实现了几个方法来处理不同的文件系统事件。on_modified 方法会在文件被修改时触发,on_created 在文件或目录被创建时触发,而 on_deleted 在文件或目录被删除时触发。对于目录的创建和删除操作,由于Watchdog将它们视为移动操作,因此通过 on_moved 方法进行捕捉,并检查 event.is_directory 属性以区分是文件还是目录。

通过 observer.schedule 方法设置要监控的目录路径和事件处理器,并设置 recursive=True 参数以递归地监控目录内的所有子目录。

最后启动观察器并进入无限循环,直到用户按下 Ctrl+C 中断程序,此时会调用 observer.stop() 和 observer.join() 来正确停止和清理观察器资源。

到此这篇关于python使用watchdog实现文件资源监控的文章就介绍到这了,更多相关python watchdog文件资源监控内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用Python将数组的元素导出到变量中(unpacking)

    使用Python将数组的元素导出到变量中(unpacking)

    最近工作中遇到一个问题,需要利用Python将数组(list)或元组(tuple)中的元素导出到N个变量中,现在将我实现的方法分享给大家,有需要的朋友们可以参考借鉴,下面来一起看看吧。
    2016-10-10
  • 基于Python实现超级玛丽游戏的示例代码

    基于Python实现超级玛丽游戏的示例代码

    这篇文章主要介绍了利用python实现超级玛丽游戏的示例代码,帮助大家更好的理解和使用python开发游戏,感兴趣的朋友可以跟随小编一起学习一下
    2022-05-05
  • QT5 Designer 打不开的问题及解决方法

    QT5 Designer 打不开的问题及解决方法

    这篇文章主要介绍了QT5 Designer 打不开的问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08
  • 介绍Python的Django框架中的静态资源管理器django-pipeline

    介绍Python的Django框架中的静态资源管理器django-pipeline

    这篇文章主要介绍了介绍Python的Django框架中的静态资源管理器django-pipeline,django-pipeline是一个开源项目,被用来处理css等静态文件,需要的朋友可以参考下
    2015-04-04
  • Python解析微信dat文件的方法

    Python解析微信dat文件的方法

    这篇文章主要介绍了Python解析微信dat文件的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • Python2和3字符编码的区别知识点整理

    Python2和3字符编码的区别知识点整理

    在本篇文章中小编给各位分享的是关于Python2和3字符编码的区别知识点,有需要的朋友们可以学习下。
    2019-08-08
  • python随机获取列表中某一元素的方法

    python随机获取列表中某一元素的方法

    本文主要介绍了python随机获取列表中某一元素的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-02-02
  • Python 中单例模式的实现方法

    Python 中单例模式的实现方法

    这篇文章主要介绍了Python 中单例模式的实现方法,文章围绕主题展开详细的内容介绍,具有一定的参考价值,感兴趣的小伙伴可以学习一下下面文章详细内容
    2022-08-08
  • Python的socket模块源码中的一些实现要点分析

    Python的socket模块源码中的一些实现要点分析

    我们平时引入Python的socket模块利用其中的方法可以轻松地写出搭建socket通信的程序,今天我们就来看一下Python的socket模块源码中的一些实现要点分析,领略Python简洁代码的一些背后功劳.
    2016-06-06
  • python 3.6.7实现端口扫描器

    python 3.6.7实现端口扫描器

    这篇文章主要为大家详细介绍了python 3.6.7实现端口扫描器,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-09-09

最新评论