def test_named_list(self):
class Class1:
@named_arg("my_param", "type_1")
@named_arg("my_other_param", "type_2")
def __init__(self, my_param: List[str], my_other_param: List[str],
my_default_param: List[str]):
self.my_param = my_param
self.my_other_param = my_other_param
self.my_default_param = my_default_param
injector = Injector(bindings=[
SelfBinding(Class1),
MultiBinding(str, [
ItemBinding(bound_instance="my_type_1"),
],
named="type_1"),
MultiBinding(str, [
ItemBinding(bound_instance="my_type_2"),
],
named="type_2"),
MultiBinding(
str,
[
ItemBinding(bound_instance="my_default"),
],
),
])
instance = injector.inject(Class1)
self.assertIsInstance(instance, Class1)
self.assertEqual(["my_type_1"], instance.my_param)
self.assertEqual(["my_type_2"], instance.my_other_param)
self.assertEqual(["my_default"], instance.my_default_param)
def test_list_injection_item_singletons(self):
injector = Injector(bindings=[
MultiBinding(MyClass, [ItemBinding(bound_class=MyClass)])
])
list_instance = injector.inject(List[MyClass])
tuple_instance = injector.inject(Tuple[MyClass])
self.assertIs(list_instance[0], tuple_instance[0])
def test_generic_type_parameter_injection(self):
MyTypeVar = TypeVar("MyTypeVar")
class MyGeneric(Generic[MyTypeVar]):
pass
class MyClass1:
def __init__(self, my_param: MyGeneric):
self.my_param = my_param
class MyClass2:
def __init__(self, my_param: MyGeneric[str]):
self.my_param = my_param
class MyClass3:
def __init__(self, my_param: MyGeneric[MyTypeVar]):
self.my_param = my_param
with self.assertRaises(NonInjectableTypeError):
Injector(bindings=[
SelfBinding(MyGeneric),
SelfBinding(MyClass2),
])
with self.assertRaises(NonInjectableTypeError):
Injector(bindings=[
SelfBinding(MyGeneric),
SelfBinding(MyClass3),
])
injector = self.get_injector(MyGeneric, MyClass1)
my_generic = injector.inject(MyGeneric)
self.assertIsInstance(my_generic, MyGeneric)
my_instance_1 = injector.inject(MyClass1)
self.assertIsInstance(my_instance_1, MyClass1)
def test_private_module_multi_bind(self):
class DependencyClass:
pass
class MySubClass1(MyClass):
def __init__(self, arg: DependencyClass):
MyClass.__init__(self)
self.arg = arg
class MySubClass2(MyClass):
def __init__(self, arg: DependencyClass):
MyClass.__init__(self)
self.arg = arg
class MyModule1(PrivateModule):
def configure(self) -> None:
self.expose(
self.multi_bind(MyClass,
[self.bind_item(to_class=MySubClass1)]))
self.bind(DependencyClass)
class MyModule2(PrivateModule):
def configure(self) -> None:
self.expose(
self.multi_bind(MyClass,
[self.bind_item(to_class=MySubClass2)],
override_bindings=False))
self.bind(DependencyClass)
injector = Injector([MyModule1(), MyModule2()])
instances = injector.inject(List[MyClass])
self.assertEqual(2, len(instances))
self.assertIsInstance(instances[0], MySubClass1)
self.assertIsInstance(instances[1], MySubClass2)
self.assertIsNot(instances[0].arg, instances[1].arg)
def test_set_direct_injection(self):
class_set = Injector(bindings=[
MultiBinding(MyClass, [ItemBinding(bound_class=MyClass)])
]).inject(Set[MyClass])
self.assertIsInstance(class_set, set)
self.assertEqual(1, len(list(class_set)))
self.assertIsInstance(class_set.pop(), MyClass)
def test_named_arg(self):
class Class1:
@named_arg("my_param_1", "new_param_1")
@named_arg("my_param_2", "new_param_2")
def __init__(self, my_param_1: str, my_param_2: str,
my_param_3: str, my_param_4: str):
self.my_param_1 = my_param_1
self.my_param_2 = my_param_2
self.my_param_3 = my_param_3
self.my_param_4 = my_param_4
injector = Injector(bindings=[
InstanceBinding(str, "param_1", named="new_param_1"),
InstanceBinding(str, "unused_param_1", named="param_1"),
InstanceBinding(str, "param_2", named="new_param_2"),
InstanceBinding(str, "param_3", named="my_param_3"),
InstanceBinding(str, "param_4"),
SelfBinding(Class1),
])
instance = injector.inject(Class1)
self.assertIsInstance(instance, Class1)
self.assertEqual("param_1", instance.my_param_1)
self.assertEqual("param_2", instance.my_param_2)
self.assertEqual("param_3", instance.my_param_3)
self.assertEqual("param_4", instance.my_param_4)
def test_inject_from_multiple_providers_takes_last(self):
my_instance = MyType()
my_instance_2 = MyType()
injector = Injector(bindings=[
InstanceBinding(MyType, my_instance),
InstanceBinding(MyType, my_instance_2),
])
self.assertIs(my_instance_2, injector.inject(MyType))
def test_auto_injection_with_default(self):
class ParentClass:
def __init__(self, my_arg: MyClass = None):
self.my_arg = my_arg
injector = Injector(options=InjectorOptions(auto_bindings=True))
my_instance = injector.inject(ParentClass)
self.assertIsInstance(my_instance, ParentClass)
self.assertIsNone(my_instance.my_arg)
def test_inject_from_module(self):
my_instance = MyType()
class MyModule(Module):
def configure(self) -> None:
self.bind(MyType, to_instance=my_instance)
injector = Injector([MyModule()])
self.assertEqual(my_instance, injector.inject(MyType))
def test_private_module_uses_exposed_bindings(self):
instance_1 = MyClass()
class MyPrivateModule(PrivateModule):
def configure(self) -> None:
self.expose(self.bind(MyClass, to_instance=instance_1))
injector = Injector([MyPrivateModule()])
instance = injector.inject(MyClass)
self.assertIs(instance_1, instance)
def test_private_module_does_not_expose_bindings(self):
instance_1 = MyClass()
class MyPrivateModule(PrivateModule):
def configure(self) -> None:
self.bind(MyClass, to_instance=instance_1)
injector = Injector([MyPrivateModule()])
with self.assertRaises(NonInjectableTypeError):
injector.inject(MyClass)
def test_auto_injection_with_named_binding(self):
class ParentClass:
@named_arg("my_arg", "my_name")
def __init__(self, my_arg: MyClass):
self.my_arg = my_arg
injector = Injector(options=InjectorOptions(auto_bindings=True))
my_instance = injector.inject(ParentClass)
self.assertIsInstance(my_instance, ParentClass)
self.assertIsInstance(my_instance.my_arg, MyClass)
def test_private_module_does_not_expose_self_bindings(self):
class MySubClass(MyClass):
pass
class MyPrivateModule(PrivateModule):
def configure(self) -> None:
self.expose(self.bind(MyClass, to_class=MySubClass))
injector = Injector([MyPrivateModule()])
with self.assertRaises(NonInjectableTypeError):
injector.inject(MySubClass)
def test_list_union_injection(self):
class MyParentClass:
def __init__(self, params: List[Union[str, int]]):
self.params = params
injector = Injector(bindings=[
SelfBinding(MyParentClass),
InstanceBinding(str, "hello"),
InstanceBinding(int, 1),
])
parent = injector.inject(MyParentClass)
self.assertIsInstance(parent, MyParentClass)
self.assertEqual(["hello", 1], parent.params)
def test_auto_injection_with_binding_override(self):
class ParentClass:
def __init__(self, my_arg: MyClass):
self.my_arg = my_arg
class MySubClass(MyClass):
pass
injector = Injector(bindings=[ClassBinding(MyClass, MySubClass)],
options=InjectorOptions(auto_bindings=True))
my_instance = injector.inject(ParentClass)
self.assertIsInstance(my_instance, ParentClass)
self.assertIsInstance(my_instance.my_arg, MySubClass)
def test_singleton_scope_multiple_bindings(self):
class MySubType(MyClass):
pass
injector = Injector(bindings=[
SelfBinding(MySubType),
ClassBinding(MyClass, MySubType),
])
sub_instance_from_sub_type = injector.inject(MySubType)
sub_instance_from_mother_type = injector.inject(MyClass)
self.assertIs(sub_instance_from_mother_type,
sub_instance_from_sub_type)
def test_args_injection_with_multi_binding(self):
class MyParentClass:
def __init__(self, *my_param: MyClass):
self.my_param = my_param
injector = Injector(bindings=[
SelfBinding(MyParentClass),
MultiBinding(MyClass, [ItemBinding(bound_instance=MyClass())])
])
parent = injector.inject(MyParentClass)
self.assertIsInstance(parent, MyParentClass)
self.assertIsInstance(parent.my_param, tuple)
self.assertIsInstance(parent.my_param[0], MyClass)
def test_private_module_use_private_binding_through_exposed_binding(self):
class MyParentClass:
def __init__(self, arg: MyClass):
self.arg = arg
class MyPrivateModule(PrivateModule):
def configure(self) -> None:
self.expose(self.bind(MyParentClass))
self.bind(MyClass)
injector = Injector([MyPrivateModule()])
instance = injector.inject(MyParentClass)
self.assertIsInstance(instance, MyParentClass)
self.assertIsInstance(instance.arg, MyClass)
def test_private_module_uses_public_binding_through_private_binding(self):
class MyParentClass:
def __init__(self, arg: MyClass):
self.arg = arg
class MyPrivateModule(PrivateModule):
def configure(self) -> None:
self.expose(self.bind(MyParentClass))
injector = Injector([MyPrivateModule()], [SelfBinding(MyClass)])
parent = injector.inject(MyParentClass)
child = injector.inject(MyClass)
self.assertIsInstance(parent, MyParentClass)
self.assertIsInstance(parent.arg, MyClass)
self.assertIs(parent.arg, child)
def test_cyclic_dependencies_raise_exception(self):
class MyOtherClass:
def __init__(self, arg: MyClass):
self.arg = arg
class MyImpl(MyClass):
def __init__(self, arg: MyOtherClass):
MyClass.__init__(self)
self.arg = arg
with self.assertRaises(CyclicDependencyError):
Injector(bindings=[
ClassBinding(MyClass, MyImpl),
SelfBinding(MyOtherClass)
])
Injector(bindings=[ClassBinding(MyClass, MyImpl)])
def test_list_direct_injection(self):
class_list = Injector(bindings=[
MultiBinding(MyClass, [ItemBinding(bound_class=MyClass)])
]).inject(List[MyClass])
self.assertIsInstance(class_list, list)
self.assertEqual(1, len(class_list))
self.assertIsInstance(class_list[0], MyClass)
def test_shared_singleton(self):
class MyParentA:
def __init__(self, my_arg: MyClass):
self.my_arg = my_arg
class MyParentB:
def __init__(self, my_arg: MyClass):
self.my_arg = my_arg
injector = Injector(bindings=[
SelfBinding(MyClass),
SelfBinding(MyParentA),
SelfBinding(MyParentB),
])
my_parent_a = injector.inject(MyParentA)
my_parent_b = injector.inject(MyParentB)
self.assertIs(my_parent_a.my_arg, my_parent_b.my_arg)
def test_subtype_argument_injection(self):
class MySubClass(MyClass):
pass
class MyOtherClass:
def __init__(self, my_param: MyClass):
self.my_param = my_param
injector = Injector(bindings=[
ClassBinding(MyClass, MySubClass, scope=PerLookupScope),
SelfBinding(MyOtherClass),
])
other_instance = injector.inject(MyOtherClass)
self.assertIsInstance(other_instance.my_param, MyClass)
self.assertIsInstance(other_instance.my_param, MySubClass)
my_instance = injector.inject(MyClass)
self.assertIsInstance(my_instance, MyClass)
self.assertIsInstance(my_instance, MySubClass)
def test_private_module_reuses_state(self):
class MyParentClass:
def __init__(self, arg: MyClass):
self.arg = arg
class MyPrivateModule(PrivateModule):
def configure(self) -> None:
self.expose(
self.bind(MyParentClass),
self.bind(MyClass),
)
injector = Injector([MyPrivateModule()])
parent = injector.inject(MyParentClass)
child = injector.inject(MyClass)
self.assertIsInstance(parent, MyParentClass)
self.assertIsInstance(child, MyClass)
self.assertIs(parent.arg, child)
def test_list_multiple_injection(self):
class MySubClass(MyClass):
pass
class MyParentClass:
def __init__(self, param: List[MyClass]):
self.param = param
my_instance = MyClass()
my_instance_2 = MyClass()
my_instance_3 = MyClass()
class MyProvider(Provider[MyClass]):
def get(self) -> MyClass:
return my_instance_2
class MyProvider2(Provider[MyClass]):
def get(self) -> MyClass:
return my_instance_3
class NewModule(Module):
def configure(self) -> None:
self.multi_bind(
MyClass,
[
self.bind_item(to_class=MyClass),
self.bind_item(to_class=MySubClass),
self.bind_item(to_instance=my_instance),
self.bind_item(to_provider=MyProvider),
self.bind_item(to_provider=MyProvider2()),
],
)
self.bind(MyParentClass)
injector = Injector([NewModule()])
parent = injector.inject(MyParentClass)
self.assertIsInstance(parent.param, list)
self.assertEqual(5, len(parent.param))
self.assertIsInstance(parent.param[0], MyClass)
self.assertIsInstance(parent.param[1], MySubClass)
self.assertIs(parent.param[2], my_instance)
self.assertIs(parent.param[3], my_instance_2)
self.assertIs(parent.param[4], my_instance_3)
def test_provider_injection_from_provider_binding(self):
class MyParentClass:
def __init__(self, my_param: Provider[MyClass]):
self.my_param = my_param
class MyProvider(Provider[MyClass]):
def get(self) -> MyClass:
return MyClass()
provider = MyProvider()
injector = Injector(bindings=[
ProviderBinding(MyClass, provider),
SelfBinding(MyParentClass)
])
parent = injector.inject(MyParentClass)
self.assertIsInstance(parent, MyParentClass)
self.assertIs(parent.my_param, provider)
instance = parent.my_param.get()
self.assertIsInstance(instance, MyClass)
def test_provider_instance_injection(self):
class MyParent:
def __init__(self, my_arg: MyClass, my_str: str):
self.my_arg = my_arg
self.my_str = my_str
class MyParentProvider(Provider[MyParent]):
def __init__(self, my_arg: MyClass):
self.my_arg = my_arg
def get(self) -> MyParent:
return MyParent(self.my_arg, "hello")
injector = Injector(bindings=[
ProviderBinding(MyParent, MyParentProvider(MyClass())),
])
my_parent = injector.inject(MyParent)
self.assertIsInstance(my_parent.my_arg, MyClass)
self.assertEqual("hello", my_parent.my_str)
def test_cyclic_dependencies_with_private_module_are_handled(self):
class MyOtherClass:
def __init__(self, arg: MyClass):
self.arg = arg
class MyImpl(MyClass):
def __init__(self, arg: MyOtherClass):
MyClass.__init__(self)
self.arg = arg
class MyPrivateModule(PrivateModule):
def configure(self) -> None:
self.expose(self.bind(MyOtherClass))
self.bind(MyClass)
injector = Injector([MyPrivateModule()],
[ClassBinding(MyClass, MyImpl)])
my_impl = injector.inject(MyClass)
self.assertIsInstance(my_impl, MyImpl)
self.assertIsInstance(my_impl.arg, MyOtherClass)
self.assertIsInstance(my_impl.arg.arg, MyClass)
def test_immediate_injection(self):
called = []
class MyOtherClass:
def __init__(self):
called.append("ok")
Injector(bindings=[
SelfBinding(MyOtherClass, scope=ImmediateScope),
])
self.assertEqual(["ok"], called)
def test_named_singleton(self):
class MyParentA:
@named_arg("my_arg", "name_1")
def __init__(self, my_arg: MyClass):
self.my_arg = my_arg
class MyParentB:
@named_arg("my_arg", "name_2")
def __init__(self, my_arg: MyClass):
self.my_arg = my_arg
injector = Injector(bindings=[
SelfBinding(MyClass, named="name_1"),
SelfBinding(MyClass, named="name_2"),
SelfBinding(MyParentA),
SelfBinding(MyParentB),
])
my_parent_a = injector.inject(MyParentA)
my_parent_b = injector.inject(MyParentB)
self.assertIsNot(my_parent_a.my_arg, my_parent_b.my_arg)
