前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >如何掌握在Python中监控文件系统的技术

如何掌握在Python中监控文件系统的技术

作者头像
HuangWeiAI
发布2021-03-12 17:08:52
1.8K0
发布2021-03-12 17:08:52
举报
文章被收录于专栏:浊酒清味浊酒清味浊酒清味

通过阅读本文,您将了解如何检测对Python应用程序中现有文件所做的更改。我们将使用一个维护良好的模块,叫做看门狗(watchdog)。基于官方文档,watchdog是一个用于监视文件系统事件的Python API库和shell实用程序。

它同时支持Python 2.7和3.4+。但是,对于旧版本,建议您使用watchdog < 0.10.0。在本教程中,我将只介绍Python API库。让我们继续下一节,开始安装必要的模块。

设置

设置是相当简单和直接的pip安装。在继续之前,强烈建议设置一个虚拟环境。有两种方法

安装在PyPI

在终端中运行如下命令。

pip install watchdog

它将安装PyPI(在撰写本文时为0.10.2)的最新版本。

从代码库安装

此外,您可以在本地文件夹中克隆存储库并正常安装它。首先,让我们使用以下命令克隆它。

git clone --recursive git://github.com/gorakhargosh/watchdog.git

使用以下命令更改工作目录。确保它在工作目录中包含一个名为setup.py的文件。

cd watchdog

运行以下命令安装它。

pip install -e.

直接从存储库克隆它的一个主要优点是,您可以获得带有附加特性的最新版本。

您可以在终端中运行以下命令来验证安装是否成功。

pip show watchdog

让我们继续下一节并开始编写Python代码。

实现

watchdog的主要构建模块基于以下类:

  • 观察者
  • 事件处理程序

因此,实现就像这样简单:

  1. 创建一个watchdog.observers的实例。观察者线程类。
  2. 使用自己的实现定义事件处理程序的子类,并从中创建实例。
  3. 通过附加事件处理程序的观察者实例调用调度函数。它接受一些其他输入参数,比如要监视的目录的路径。
  4. 启动观察者线程并等待它生成事件,这些事件将触发事件处理程序中的代码。

事件处理程序

当前模块中有4种类型的事件处理程序可用:

  1. FileSystemEventHandler—可以覆盖其中方法的基本文件系统事件处理程序。
  2. PatternMatchingEventHandler——用与正在发生的事件相关的文件路径匹配给定的模式。
  3. RegexMatchingEventHandler -匹配给定的正则表达式和与发生事件相关的文件路径。
  4. LoggingEventHandler—记录捕获的所有事件。

其余的类继承自FileSystemEventHandler,它提供了以下函数供我们重写。

  • on_any_event -捕获所有事件处理程序。
  • on_created -创建文件或目录时调用。
  • on_deleted -当文件或目录被删除时调用。
  • on_modified -当文件或目录被修改时调用。
  • on_moved -当文件或目录被移动或重命名时调用。

导入

创建一个新的Python文件,并添加以下导入声明。我把它命名为test.py。

from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler

FileSystemEventHandler的子类

创建一个继承自FileSystemEventHandler的新类,并根据用例相应地覆盖这些函数。我将把它命名为MyHandler,但你可以随意命名它。

class MyHandler(FileSystemEventHandler):
    def on_any_event(self, event):
        print(event.event_type, event.src_path)

    def on_created(self, event):
        print("on_created", event.src_path)

    def on_deleted(self, event):
        print("on_deleted", event.src_path)

    def on_modified(self, event):
        print("on_modified", event.src_path)

    def on_moved(self, event):
        print("on_moved", event.src_path)

用实现的逻辑替换print语句。对于每个函数,它都有一个名为event的输入参数,该参数包含以下变量:

  • event_type—字符串形式的事件类型。默认为没有。
  • is_directory -如果为目录触发事件,则为True;否则错误。
  • src_path—触发此事件的文件系统对象的源路径。

最有用的参数是src_path,您可以在其中使用它来确定哪个文件被修改,然后再运行相应的逻辑。

if(event.src_path == "./path/file.txt"):
    print("Execute your logic here!")

观察者和事件

一旦你创建了子类,你就可以和观察者类一起安全地创建它的实例了。为监视过程分配您所选择的路径。我将检查一个新创建的名为json的文件夹。您可以根据自己的喜好修改它。

您也可以设置recursive递归参数,但强烈建议预先定义层次结构并将其设置为false,以防止权限不足或无法访问子文件夹的问题。

调用start将运行该线程,当您在相应的路径中进行修改时,将生成一个事件。

event_handler = MyHandler()
observer = Observer()
observer.schedule(event_handler, path='./json/', recursive=False)
observer.start()

测试

为了测试它,你必须实现一个正在运行的循环来防止它退出。退出一个KeyboardInterrupt异常时,调用stop函数来清理资源。

while True:
    try:
        pass
    except KeyboardInterrupt:
        observer.stop()

保存Python文件并在终端中运行它。根据您设置的名称修改名称。

python test.py

您可以通过创建一个新文档、修改其中的内容并从目录中删除它来轻松地测试它。下面是输出的示例:

·END·

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2021-02-28,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Python学会 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档