python?動態(tài)導入模塊實現(xiàn)模塊熱更新的方法

更新時間：2022年08月30日 09:40:04 作者：士多碧莉

這篇文章主要介紹了python?動態(tài)導入模塊，實現(xiàn)模塊熱更新,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

最近有個部署需求，需要讀取py文件格式的配置項，我的實現(xiàn)思路是把配置文件解析到內存中。主要使用兩種方法：

importlib.import_module
types.ModuleType

方法1、使用 import_module 動態(tài)導包

先來看看import module使用方法。

主要有兩個參數(shù)：
- package：包名
- name：模塊名
返回 module 對象

現(xiàn)在開始實現(xiàn)動態(tài)導包，成功讀取到配置項。

import importlib
settings = importlib.import_module("remote_settings")

這樣子就能初步實現(xiàn)動態(tài)倒入了，但是我有個需求，就是我的系統(tǒng)好些個模塊，用FOR循環(huán)導包，然后處理業(yè)務。然后問題來了，對同一個“包”導入多次，python并不會重新導入，而是返回內存緩存中該模塊的地址。

下面驗證一下，第一次寫入a = 123，第二次寫入a = "hello"。

輸出結果，兩次都是打印舊版本的變量，可見對同一個模塊進行多次import_module，并不能實現(xiàn)熱更新。

必須要reload，模塊才會更新。

輸出結果如下，動態(tài)reload后，成功獲得新版本a的值。

到此基本實現(xiàn)初步熱更新需求了，但是還有個問題：

問題一：重新加載的模塊不刪除舊版本在符號表中的登記項，比如舊版本中存在變量a，新版本中刪除了該變量，但是重載不會更新該變化。

def load_module(module_name):
    module = importlib.import_module(module_name)
    return importlib.reload(module)
 
def rewrite_file(file_name, content):
    with open(file_name, "w+") as f:
        f.write(content)
 
def main():
 
    rewrite_file(file_name, "a=123\nb=456")
    c1 = load_module(module_name)
    print(hasattr(c1, "a"))
    
    rewrite_file(file_name, "c=100\nd=200")
    c1 = load_module(module_name)
    print(hasattr(c1, "a"))

我們期望輸出 True、False，但是兩次都是輸出True，也就是說重新加載的模塊不會刪除最初舊版本模塊在符號表中的登記項。

方法2、使用types.ModuleType 創(chuàng)建模塊對象

手動創(chuàng)建module對象，而不是使用內存中的module對象。這種方法不需要判斷是否需要重載，而且是真正的更新，會刪除舊版本模塊的登記項。

import types
 
def import_from_pyfile(filename):
    d = types.ModuleType("config")  # 創(chuàng)建一個模塊對象
    d.__file__ = filename
 
    try:
        with open(filename, "r") as  config_file:
            exec(compile(config_file.read(), filename, "exec"), d.__dict__)
    except ImportError as e:
        print("failt to read config file: {}".format(filename))
        raise e
 
    return d

下面驗證一下

我們期望的輸出依次是True、False，符合需求

因此，這種方法能讓我們的模塊實現(xiàn)真正的重載。

一些注意事項

無論是方法1還是方法2，都是返回一個module對象，module對象存在一些共性問題。

問題一：重新加載類不影響類的任何已存實例，已存實例將繼續(xù)使用原來的定義，只有重新加載后創(chuàng)建的新實例使用新定義。

# 原先的 Dog 定義
# class Dog():
#     def __init__(self):
#         self.name = None
c1 = load_module(module_name)
old_dog = c1.Dog()
 
 
# 中間去修改了 Dog 定義
# class Dog():
#     def __init__(self):
#         self.name = "旺財"
c1 = load_module(module_name)
new_dog = c1.Dog()
 
print(old_dog.name, new_dog.name)
 
 
>>> ouput:
None 旺財

問題二：模塊內的引用，不會被reload。比如模塊configA中引用了其他模塊（configB），當configB發(fā)生變化，重新加載configA，并不會對configB進行重載。

預期應該依次輸出 configB version1、configBversion2，但是輸出了兩次configB version1，這說明了模塊內的引用，不會被reload，需要手動更新它。

我這實現(xiàn)了一個遞歸更新方法，不僅對當前模塊熱更新，還更新里面所有的引用。

def load_module(module):
    if isinstance(module, str):  # 首次import
        module = importlib.import_module(module)
    return importlib.reload(module)
 
 
def reload_module(module):
    load_module(module)
 
    for key, child_module in vars(module).items():
        if isinstance(child_module, types.ModuleType):
            reload_module(child_module)

效果如下：

def test_reload_module():
    configA = "config"
    configB = "./configB.py"
    configC = "./configC.py"
    rewrite_file(configB, "import configC\nname ='configB version1'")
    rewrite_file(configC, "name ='configC version1'")
 
    confA = load_module(configA)
    print("原始configB.name:", confA.configB.name)
    print("原始configC.name:", confA.configB.configC.name)
 
    a = 123
    rewrite_file(configB, "import configC\nname ='configB version2'")
    rewrite_file(configC, "name ='configC version2'")
 
    confA = load_module(configA)
    print("非遞歸重載configA, configB.name:", confA.configB.name)
    print("非遞歸重載configA, configC.name:", confA.configB.configC.name)
 
 
    reload_module(confA)
    print("遞歸重載configA, configB.name:", confA.configB.name)
    print("遞歸重載configA, configC.name:", confA.configB.configC.name)

日志如下：