快捷導(dǎo)航

Python實(shí)現(xiàn)模塊熱加載的示例代碼

更新時間：2023年12月19日 09:25:31 作者：Python成長路

這篇文章主要為大家詳細(xì)介紹了Python實(shí)現(xiàn)模塊熱加載的相關(guān)知識,文中的示例代碼講解詳細(xì),具有一定的借鑒價值,有需要的小伙伴可以參考一下

為什么需要熱加載

在某些情況，你可能不希望關(guān)閉Python進(jìn)程并重新打開，或者你無法重新啟動Python，這時候就需要實(shí)現(xiàn)實(shí)時修改代碼實(shí)時生效，而不用重新啟動Python

在我的需求下，這個功能非常重要，我將Python注入到了其他進(jìn)程，并作為一個線程運(yùn)行。如果我想關(guān)閉Python，要么殺死Python相關(guān)的線程，要么重新啟動進(jìn)程，這都比較麻煩。所以當(dāng)我修改完代碼后，熱加載代碼是最方便的方法

Python中的導(dǎo)入機(jī)制

我們重復(fù)導(dǎo)入一個庫時，第二次導(dǎo)入時并沒有運(yùn)行庫里面的代碼，比如先寫一個a.py,在里面寫一行代碼print("a模塊加載")，然后在寫一個b.py, 里面寫兩行import a。即使你在多線程中再導(dǎo)入一遍a模塊，也不會打印。例如下面的代碼：

import a
import threading
print(id(a))

def test():
    import a
    print(id(a))

threading.Thread(target=test).start()

可以看到a的id是一樣的，也就是同一個對象。

為什么會這樣呢？這和Python的模塊導(dǎo)入機(jī)制有關(guān)，Python會在sys.modules這個字典里存儲著所有的全局模塊，當(dāng)你導(dǎo)入一個新模塊時，他會先查找sys.modules里有沒有這個模塊，如果沒有再導(dǎo)入，如果有就在當(dāng)前代碼增加個引用。舉個最簡單的例子:

a.py

print("a模塊加載")

def aa():
    print("a模塊中的aa方法被加載")

b.py

import sys
a = sys.modules["a"]
a.aa()

c.py

import a
import b

先導(dǎo)入a模塊，這樣sys.modules已經(jīng)有了a模塊，你就可以使用sys.modules["a"]來使用a模塊，它和import a基本是一樣的。如果你先import b就會發(fā)現(xiàn)sys.modules不存在a

重新導(dǎo)入模塊1

既然知道它是先查找sys.modules，那我在導(dǎo)入之前，先刪除掉里面的a再導(dǎo)入就可以了

import a
import sys
del sys.modules["a"]
import a

這樣就能重新加載模塊

重新導(dǎo)入模塊2

Python基礎(chǔ)庫也提供了一個方法重新加載模塊:

import a
import importlib

importlib.reload(a)

看一下內(nèi)部代碼是怎么實(shí)現(xiàn)的：

邏輯也比較簡單，先看sys.modules里有沒有這個模塊，如果有就使用_bootstrap._exec導(dǎo)入模塊。我們是不是也可以通過_bootstrap._exec來重新導(dǎo)入模塊，可以但不建議，因?yàn)橄聞澗€開頭的模塊或者函數(shù)都是不建議外部使用的，這些接口可能在版本更新后變動比較頻繁

無法熱加載的情況

__main__模塊無法熱加載。當(dāng)你執(zhí)行python a.py，這個a.py文件是無法熱加載的，它并沒有作為模塊導(dǎo)入，在sys.modules的名稱就是__main__

如果你在__main__使用from a import A導(dǎo)入的類，即使a模塊重新加載，__main__里面的A也不會改變

熱加載無法影響已經(jīng)實(shí)例化的對象，比如你修改了模塊里面的類代碼，但是已經(jīng)在__main__里實(shí)例化了這個類對象，并且一直使用未釋放，它的邏輯在熱加載之后不會受影響。

函數(shù)級熱加載

要想實(shí)現(xiàn)函數(shù)、方法乃至對象級別的熱加載，得修改內(nèi)存中的Python對象。有一個項(xiàng)目實(shí)現(xiàn)了這種，有興趣的可以看：https://github.com/breuleux/jurigged

我的需求沒有這么細(xì)，就不測試了

監(jiān)聽文件變化

我選擇的是watchdog，另一個pyinotify不支持Windows。

watchdog在Windows上有點(diǎn)小bug，修改文件會觸發(fā)兩次事件。搜到一個解決方案：不使用默認(rèn)的事件觸發(fā)，而是利用文件快照，每隔一段時間做一次比對。原文鏈接：Python神器watchdog(監(jiān)控文件變化)，我測試了一下效果很好。

源碼

完整的源碼就不放了，具體可以看：https://github.com/kanadeblisst00/module_hot_loading

國內(nèi)倉庫：http://www.pygrower.cn:21180/kanadeblisst/module_hot_loading

安裝

pip install module-hot-loading

使用

from threading import Event
from module_hot_loading import monitor_dir


if __name__ == "__main__":
    event = Event()
    event.set()
    path = "."
    monitor_dir(path, event, __file__, interval=2, only_import_exist=False)

monitor_dir的參數(shù):