[[384020]]

本文轉(zhuǎn)載自微信公眾號(hào)「Python學(xué)會(huì)」，作者Huangwei AI。轉(zhuǎn)載本文請(qǐng)聯(lián)系Python學(xué)會(huì)公眾號(hào)。   

看門狗watch dog

通過(guò)閱讀本文，您將了解如何檢測(cè)對(duì)Python應(yīng)用程序中現(xiàn)有文件所做的更改。我們將使用一個(gè)維護(hù)良好的模塊，叫做看門狗(watchdog)?；诠俜轿臋n，watchdog是一個(gè)用于監(jiān)視文件系統(tǒng)事件的Python API庫(kù)和shell實(shí)用程序。

它同時(shí)支持Python 2.7和3.4+。但是，對(duì)于舊版本，建議您使用watchdog < 0.10.0。在本教程中，我將只介紹Python API庫(kù)。讓我們繼續(xù)下一節(jié)，開始安裝必要的模塊。

設(shè)置

設(shè)置是相當(dāng)簡(jiǎn)單和直接的pip安裝。在繼續(xù)之前，強(qiáng)烈建議設(shè)置一個(gè)虛擬環(huán)境。有兩種方法

安裝在PyPI

在終端中運(yùn)行如下命令。

pip install watchdog 

它將安裝PyPI(在撰寫本文時(shí)為0.10.2)的最新版本。

從代碼庫(kù)安裝

此外，您可以在本地文件夾中克隆存儲(chǔ)庫(kù)并正常安裝它。首先，讓我們使用以下命令克隆它。

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

使用以下命令更改工作目錄。確保它在工作目錄中包含一個(gè)名為setup.py的文件。

cd watchdog 

運(yùn)行以下命令安裝它。

pip install -e. 

直接從存儲(chǔ)庫(kù)克隆它的一個(gè)主要優(yōu)點(diǎn)是，您可以獲得帶有附加特性的最新版本。

您可以在終端中運(yùn)行以下命令來(lái)驗(yàn)證安裝是否成功。

pip show watchdog 

讓我們繼續(xù)下一節(jié)并開始編寫Python代碼。

實(shí)現(xiàn)

watchdog的主要構(gòu)建模塊基于以下類:

• 觀察者
• 事件處理程序

因此，實(shí)現(xiàn)就像這樣簡(jiǎn)單:

1. 創(chuàng)建一個(gè)watchdog.observers的實(shí)例。觀察者線程類。
2. 使用自己的實(shí)現(xiàn)定義事件處理程序的子類，并從中創(chuàng)建實(shí)例。
3. 通過(guò)附加事件處理程序的觀察者實(shí)例調(diào)用調(diào)度函數(shù)。它接受一些其他輸入?yún)?shù)，比如要監(jiān)視的目錄的路徑。
4. 啟動(dòng)觀察者線程并等待它生成事件，這些事件將觸發(fā)事件處理程序中的代碼。

事件處理程序

當(dāng)前模塊中有4種類型的事件處理程序可用:

1. FileSystemEventHandler—可以覆蓋其中方法的基本文件系統(tǒng)事件處理程序。
2. PatternMatchingEventHandler——用與正在發(fā)生的事件相關(guān)的文件路徑匹配給定的模式。
3. RegexMatchingEventHandler -匹配給定的正則表達(dá)式和與發(fā)生事件相關(guān)的文件路徑。
4. LoggingEventHandler—記錄捕獲的所有事件。

其余的類繼承自FileSystemEventHandler，它提供了以下函數(shù)供我們重寫。

• on_any_event -捕獲所有事件處理程序。
• on_created -創(chuàng)建文件或目錄時(shí)調(diào)用。
• on_deleted -當(dāng)文件或目錄被刪除時(shí)調(diào)用。
• on_modified -當(dāng)文件或目錄被修改時(shí)調(diào)用。
• on_moved -當(dāng)文件或目錄被移動(dòng)或重命名時(shí)調(diào)用。

導(dǎo)入

創(chuàng)建一個(gè)新的Python文件，并添加以下導(dǎo)入聲明。我把它命名為test.py。

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

FileSystemEventHandler的子類

創(chuàng)建一個(gè)繼承自FileSystemEventHandler的新類，并根據(jù)用例相應(yīng)地覆蓋這些函數(shù)。我將把它命名為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) 

用實(shí)現(xiàn)的邏輯替換print語(yǔ)句。對(duì)于每個(gè)函數(shù)，它都有一個(gè)名為event的輸入?yún)?shù)，該參數(shù)包含以下變量:

• event_type—字符串形式的事件類型。默認(rèn)為沒(méi)有。
• is_directory -如果為目錄觸發(fā)事件，則為True;否則錯(cuò)誤。
• src_path—觸發(fā)此事件的文件系統(tǒng)對(duì)象的源路徑。

最有用的參數(shù)是src_path，您可以在其中使用它來(lái)確定哪個(gè)文件被修改，然后再運(yùn)行相應(yīng)的邏輯。

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

觀察者和事件

一旦你創(chuàng)建了子類，你就可以和觀察者類一起安全地創(chuàng)建它的實(shí)例了。為監(jiān)視過(guò)程分配您所選擇的路徑。我將檢查一個(gè)新創(chuàng)建的名為json的文件夾。您可以根據(jù)自己的喜好修改它。

您也可以設(shè)置recursive遞歸參數(shù)，但強(qiáng)烈建議預(yù)先定義層次結(jié)構(gòu)并將其設(shè)置為false，以防止權(quán)限不足或無(wú)法訪問(wèn)子文件夾的問(wèn)題。

調(diào)用start將運(yùn)行該線程，當(dāng)您在相應(yīng)的路徑中進(jìn)行修改時(shí)，將生成一個(gè)事件。

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

測(cè)試

為了測(cè)試它，你必須實(shí)現(xiàn)一個(gè)正在運(yùn)行的循環(huán)來(lái)防止它退出。退出一個(gè)KeyboardInterrupt異常時(shí)，調(diào)用stop函數(shù)來(lái)清理資源。

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

保存Python文件并在終端中運(yùn)行它。根據(jù)您設(shè)置的名稱修改名稱。

python test.py 

您可以通過(guò)創(chuàng)建一個(gè)新文檔、修改其中的內(nèi)容并從目錄中刪除它來(lái)輕松地測(cè)試它。下面是輸出的示例: