Injector - Python依赖注入框架技术文档

1. 安装指南

安装方式

您可以通过PyPI（Python软件包索引）使用pip来安装Injector。请运行以下命令：

pip install injector

确保您的Python环境版本为CPython 3.8+ 或 PyPy 3实现Python 3.8+。

2. 项目的使用说明

Injector 是一个Python依赖注入框架，旨在通过自动和传递性地提供依赖来简化大型应用程序的编码工作。它鼓励通过模块使用良好分隔的代码。

快速示例

以下是使用Injector的一个快速示例：

from injector import Injector, inject

class Inner:
    def __init__(self):
        self.forty_two = 42

class Outer:
    @inject
    def __init__(self, inner: Inner):
        self.inner = inner

injector = Injector()
outer = injector.get(Outer)
print(outer.inner.forty_two)  # 输出 42

完整示例

以下是一个完整的示例，展示Injector的使用方法：

from injector import Module, provider, Injector, inject, singleton
import sqlite3

class RequestHandler:
    @inject
    def __init__(self, db: sqlite3.Connection):
        self._db = db

    def get(self):
        cursor = self._db.cursor()
        cursor.execute('SELECT key, value FROM data ORDER by key')
        return cursor.fetchall()

class Configuration:
    def __init__(self, connection_string):
        self.connection_string = connection_string

def configure_for_testing(binder):
    configuration = Configuration(':memory:')
    binder.bind(Configuration, to=configuration, scope=singleton)

class DatabaseModule(Module):
    @singleton
    @provider
    def provide_sqlite_connection(self, configuration: Configuration) -> sqlite3.Connection:
        conn = sqlite3.connect(configuration.connection_string)
        cursor = conn.cursor()
        cursor.execute('CREATE TABLE IF NOT EXISTS data (key PRIMARY KEY, value)')
        cursor.execute('INSERT OR REPLACE INTO data VALUES ("hello", "world")')
        return conn

injector = Injector([configure_for_testing, DatabaseModule()])
handler = injector.get(RequestHandler)
print(tuple(map(str, handler.get()[0])))  # 输出 ('hello', 'world')

# 验证单例
print(injector.get(Configuration) is injector.get(Configuration))  # 输出 True
print(injector.get(sqlite3.Connection) is injector.get(sqlite3.Connection))  # 输出 True

3. 项目API使用文档

• @inject：用于标记类的构造函数，自动注入所需的依赖。
• Injector：用于创建和配置依赖注入环境。
• Injector.get：从Injector获取特定类型的实例。
• Injector.create_object：创建一个对象，自动注入其依赖。
• Module：定义一组绑定和提供者。
• provider：用于定义提供者函数，该函数负责生成依赖对象。
• singleton：用于指定绑定对象的生命周期为单例。

4. 项目安装方式

请参考上文“安装指南”中的步骤进行安装。

通过上述技术文档，您应该能够了解如何安装和使用Injector依赖注入框架。在大型项目中使用它可以帮助您更好地组织代码，提高代码的可维护性和扩展性。