使用 Python 注入器模块复制指南 @Named

Question

我正在使用 injector 模块，它体现了用于 DI 框架的大部分 Guice API。

我试图通过 @Named 绑定注释完成 Guice 所做的事情。也就是说，使用injector.Module覆盖configure方法，使用Binder绑定多个相同类型但名称不同的实例：

import pathlib
import injector

ConfigFile = pathlib.WindowsPath
UserFile = pathlib.WindowsPath

cfg_file = pathlib.Path.home() / 'settings.cfg'
usr_file = pathlib.Path.home() / 'user.inf'

class AppModule(injector.Module):

    def configure(self, binder):
        binder.bind(ConfigFile, to=cfg_file) # Guice uses annotatedWith here
        binder.bind(UserFile, to=usr_file) # Guice uses annotatedWith here

class App:

    @injector.inject
    def __init__(self, cfg: ConfigFile, usr: UserFile):
        self.config = cfg
        self.user = usr

app = injector.Injector(AppModule).get(App)
print(app.config, app.user) # prints the contents of `usr_file` for both

我认为Binder.multibind 我有一些生存能力，但我的尝试没有成功。我可以设计的唯一解决方案是必须将pathlib.Path 子类化，并且这些子类显式绑定到它们的实例（可以在injector.Module 中使用@provider 与@singleton 一起管理）。

是否有另一种无法解决子类的方法来完成此任务？

Answer 1

可以使用来自 typing_extensions 的 Annotated（已经是注入器的依赖项或来自 Python 3.9 的类型）。在上面的示例中，只需替换

ConfigFile = pathlib.WindowsPath
UserFile = pathlib.WindowsPath

与

ConfigFile = Annotated[pathlib.WindowsPath, 'config']
UserFile = Annotated[pathlib.WindowsPath, 'user']

它应该可以工作。

使用 typing.NewType 都是可行的，但它可能无法很好地与静态类型检查器配合使用。

这是在 python 3.6 上测试的完整工作示例：

from injector import Injector, inject, Module, singleton, provider
from typing_extensions import Annotated

from typing import NewType, Callable

# You can use Greeting instead of Annotated[str, 'greeting'] as it's the same type
Greeting = Annotated[str, 'greeting']


class Greeter:
    @inject
    def __init__(self, greeting: Annotated[str, 'greeting']):
        self.greeting = greeting

    def greet(self):
        print(self.greeting)


class MyModule(Module):

    def configure(self, binder):
        binder.bind(Greeting, to='Howdy', scope=singleton)
        binder.bind(str, to='Hello', scope=singleton)


def main():
    injector = Injector([MyModule()])
    greeter = injector.get(Greeter)
    greeter.greet()


if __name__ == '__main__':
    main()

有一点问题，如果你不提供Annotated[str, 'greeting'] 的绑定，注入器将使用一个默认构造函数，它会产生一些东西，但可能不是你所期望的。另一方面，它对 str 的处理方式相同——愉快地构造了一个空字符串。

在安装了以下软件包的 conda 环境中进行测试（使用 pip 安装注入器）：

# Name                    Version
injector                  0.18.4 
libffi                    3.0.9  
pip                       18.1   
python                    3.6.8  
setuptools                40.8.0 
sqlite                    3.26.0 
typing-extensions         3.7.4.3
wheel                     0.33.1 
xz                        5.2.3