Python-inject 技术文档

1. 安装指南

要安装 python-inject，请使用 pip 包管理器。在命令行中执行以下命令：

pip install inject

确保你的 Python 环境已经安装了 pip。如果你的系统中没有 pip，你可能需要先安装它。

2. 项目的使用说明

python-inject 是一个依赖注入库，它以简单、快速、线程安全的方式为 Python 项目提供依赖注入功能。以下是几个使用 python-inject 的步骤示例：

自动参数注入示例

在 Python 3.5 及以上版本中，可以使用 @inject.autoparams 装饰器自动注入带有类型注解的函数参数。

@inject.autoparams()
def refresh_cache(cache: RedisCache, db: DbInterface):
    pass

逐步骤示例

import inject

# 从注入器请求依赖。
def foo(bar):
    cache = inject.instance(Cache)
    cache.save('bar', bar)

# 使用 @inject.params 装饰器注入依赖。
@inject.params(cache=Cache, user=CurrentUser)
def baz(foo, cache=None, user=None):
    cache.save('foo', foo, user)

# 以不同方式调用函数：
# 使用注入的参数
baz('foo')

# 使用位置参数
baz('foo', my_cache)

# 使用关键字参数
baz('foo', my_cache, user=current_user)

类属性注入示例

class User(object):
    cache = inject.attr(Cache)
            
    def __init__(self, id):
        self.id = id

    def save(self):
        self.cache.save('users', self)
    
    @classmethod
    def load(cls, id):
        return cls.cache.load('users', id)

配置示例

def my_config(binder):
    binder.bind(Cache, RedisCache('localhost:1234'))

# 配置共享注入器。
inject.configure(my_config)

3. 项目API使用文档

以下是 python-inject 提供的主要 API：

• inject.instance(cls): 从注入器中请求 cls 的实例。
• @inject.params(...): 装饰器，用于注入函数或方法的参数。
• @inject.autoparams(): 装饰器，自动注入带有类型注解的函数或方法参数。
• inject.attr(cls): 创建一个属性，用于请求 cls 的实例。
• inject.bind(key, value): 绑定一个实例到注入器。
• inject.bind_to_constructor(cls, constructor): 绑定一个构造函数到注入器。
• inject.bind_to_provider(cls, provider): 绑定一个提供者函数到注入器。
• inject.configure(config): 配置注入器。

更多 API 详细信息，请参考官方文档。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中介绍。简要概述如下：

使用 pip 包管理器执行以下命令：

pip install inject

这将安装 python-inject 的最新版本到你的 Python 环境中。