python dependency injector

什麼是Dependency Injector ？

Dependency Injector是 Python 的依賴注入框架。

它有助於實現依賴注入原則。

Dependency Injector的主要特點：

• 提供者。提供Factory 、 Singleton 、 Callable 、 Coroutine 、 Object 、 List 、 Dict 、 Configuration 、 Resource 、 Dependency和Selector提供者來協助組裝物件。請參閱提供者。
• 壓倒一切。可以動態地由另一個提供者覆蓋任何提供者。這有助於測試和配置開發/階段環境，以用存根等取代 API 用戶端。
• 配置。從yaml 、 ini和json檔案、 pydantic設定、環境變數和字典中讀取配置。請參閱配置提供者。
• 資源。幫助初始化和配置日誌記錄、事件循環、執行緒或進程池等。請參閱資源提供者。
• 容器。提供聲明性和動態容器。請參閱容器。
• 接線。將依賴項注入函數和方法中。協助與其他框架整合：Django、Flask、Aiohttp、Sanic、FastAPI 等。
• 異步。支援異步注入。請參閱非同步注入。
• 打字。提供型別存根， mypy友善。請參閱鍵入和 mypy。
• 表現。快速地。用Cython寫。
• 成熟度。成熟且可投入生產。經過充分測試、記錄和支援。

 from dependency_injector import containers , providers
from dependency_injector . wiring import Provide , inject


class Container ( containers . DeclarativeContainer ):

    config = providers . Configuration ()

    api_client = providers . Singleton (
        ApiClient ,
        api_key = config . api_key ,
        timeout = config . timeout ,
    )

    service = providers . Factory (
        Service ,
        api_client = api_client ,
    )


@ inject
def main ( service : Service = Provide [ Container . service ]) -> None :
    ...


if __name__ == "__main__" :
    container = Container ()
    container . config . api_key . from_env ( "API_KEY" , required = True )
    container . config . timeout . from_env ( "TIMEOUT" , as_ = int , default = 5 )
    container . wire ( modules = [ __name__ ])

    main ()  # <-- dependency is injected automatically

    with container . api_client . override ( mock . Mock ()):
        main ()  # <-- overridden dependency is injected automatically

當您呼叫main()函數時， Service相依性會自動組裝和注入。

當您進行測試時，您可以呼叫container.api_client.override()方法來用模擬取代真實的API客戶端。當您呼叫main()時，模擬會被注入。

您可以用另一個提供者覆蓋任何提供者。

它還可以幫助您針對不同環境重新配置專案：用開發或階段上的存根取代 API 用戶端。

使用Dependency Injector ，物件組裝被整合到一個容器中。依賴注入是明確定義的。這使得理解和改變應用程式的工作方式變得更容易。

請造訪文件以了解有關 Python 中的依賴注入和控制反轉的更多資訊。

安裝

該軟體包在 PyPi 上可用：

 pip install 依賴注入器

文件

該文件可在此處取得。

範例

選擇以下選項之一：

• 應用範例（單一容器）
• 應用範例（多個容器）
• 解耦套件範例（多個容器）
• Boto3 範例
• 姜戈範例
• 燒瓶範例
• Aiohttp 範例
• 薩尼克範例
• FastAPI範例
• FastAPI + Redis 範例
• FastAPI + SQLAlchemy 範例

教學

選擇以下選項之一：

• Flask Web 應用程式教學
• Aiohttp REST API 教學課程
• Asyncio 監控守護程式教學
• CLI應用教學

概念

此框架遵循 PEP20（Python 之禪）原則：

Explicit is better than implicit

您需要明確指定如何組裝以及在何處注入依賴項。

該框架的強大之處在於其簡單性。 Dependency Injector是一個功能強大的概念的簡單工具。

常見問題

什麼是依賴注入？

• 依賴注入是減少耦合、增加內聚的原則

為什麼要進行依賴注入？

• 您的程式碼變得更加靈活、可測試且清晰？

如何開始應用依賴注入？

• 您開始遵循依賴注入原則編寫程式碼
• 您在容器中註冊所有應用程式元件及其相依性
• 當你需要一個元件時，你可以指定在哪裡注入它或從容器中取得它

我付出什麼代價，得到什麼？

• 您需要明確指定依賴項
• 一開始這將是額外的工作
• 隨著專案的發展，它會得到回報

有問題嗎？

• 打開 Github 問題

發現錯誤？

• 打開 Github 問題

想幫忙嗎？

• ️ 在 Github 上為Dependency Injector加註星標
• ？使用Dependency Injector啟動一個新項目
• 向您的朋友介紹Dependency Injector

想做出貢獻嗎？

• ？分叉項目
• ⬅️ 向develop分支發起拉取請求