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分支发起拉取请求