python settings 中通過字符串導入模塊

1. 項目文件結構

set_test
├─ main.py  # 入口函數
│
├─notify  # 自定義的模塊
│  ├─ email.py  # 自定義模塊
│  ├─ msg.py    # 自定義模塊
│  ├─ wechat.py # 自定義模塊
│  └─ __init__.py # 模塊導入初始化函數
│
└─set_test  # 總配置文件
    └─ settings.py

# 這個項目的架構是很多開源項目的架構標准

2. 接下來看看 文件中的內容

2.1. __init__.py 文件的內容

from set_test import settings  # 導入配置文件
import importlib
#   指定路徑, 找到指定文件, 並導入
#   作用與 import 模塊名 相同


def send_init(context):
    for path in settings.NOTTFY_LIST:
        # 1. 將路徑與類分開, 如
        #   'notify.email.Email' 分成了  ['notify.email', 'Email']
        #   module_path : 模塊路徑名
        #   class_name  : 模塊中的類名
        module_path, class_name = path.rsplit('.', 1)

        # 2. 利用 importlib 導致指定路徑的模塊文件
        modle = importlib.import_module(module_path)  # 導入 module_path 路徑的文件
        cls = getattr(modle, class_name)  # 從 modle 模塊中 找到 class_name 指定的類
        # 所以此時 cls 就是 settings 中要執行的類了
        
        # 3. 執行獲取到的類
        # a = cls()
        # a.send(context)  #  調用統一接口 send 
        # print(a)
        

if __name__ == '__main__':
    send_init("send 調用")

2.2. notify 模塊下的文件

2). wechat.py

#!/usr/bin/env python3


class WeChat(object):
    def __init__(self):
        pass

    def send(self, content):
        """
        固定格式, 每個添加的模塊都寫名字相同的方法, 方便統一調用, send 就是類的統一接口
        :param content:
        :return:
        """
        print("WeChat")

3). email.py

#!/usr/bin/env python3

class Email(object):
    def __init__(self):
        pass

    def send(self, content):
        """
        固定格式, 每個添加的模塊都寫名字相同的方法, 方便統一調用, send 就是類的統一接口
        :param content:
        :return:
        """
        print("Email")

msg.py 文件 與 email.py 只有文件名與類型不同，其他相同

3. 總結

3.1. 步驟

1). 將代碼寫在 __init__.py 中, 如果寫在其他路徑下的話, 一定要保證路徑正確, 否則找不到模塊
2). 導入 settings 中指定指定函數的列表, from set_test.settings import NOTTFY_LIST
3). 循環列表, 獲取每一個元素對其進行操作
4). 將元素 切分成 路徑、類名兩部分， 
5). 使用 modle = importlib.import_module(路徑) 函數, 導入指定的文件
6). 使用 getattr(modle, 類名) 找到 文件中的指定類, 返回值就是所需要的類了

3.2. 介紹 及 使用途徑

1. 這樣寫是為了 開放封閉原則，使用避免取消或者添加功能時，需要改代碼的問題
2. 使用途徑是在用戶要執行多個模塊功能時使用，寫進 settings 文件的 NOTTFY_LIST 列表中的類會在調用模塊時直接執行