Merge pull request #177 from illuin-tech/pr/175

 Fix multi bindings being duplicated

Author: Aegdesil

CHANGELOG.md

@@ -3,6 +3,11 @@
 Opyoid follows [semver guidelines](https://semver.org) for versioning.
 
 ## Unreleased
+## 3.0.2
+### Fixes
+- Fixed an issue with multi binding unexpectedly injecting multiple instances of the same class
+- Fixed an edge case when modules were configured multiple times when imported inside different modules
+
 ## 3.0.1
 ### Fixes
 - Fix NoBindingFound error being raised when using multi bindings and injecting pep585 style list arguments

opyoid/bindings/abstract_module.py

@@ -17,7 +17,7 @@
 
 
 class AbstractModule:
-    """Base class for Modules, should not be used outside of the library."""
+    """Base class for Modules, should not be used outside the library."""
 
     conditions: Tuple[Condition, ...] = ()
 
@@ -28,7 +28,7 @@ def __init__(
     ):
         self._is_configured = False
         self._binding_registry = BindingRegistry(log_bindings)
-        self._module_instances = shared_modules or {}
+        self._module_instances = shared_modules if shared_modules is not None else {}
 
     @property
     def binding_registry(self) -> BindingRegistry:
@@ -64,9 +64,11 @@ def install(self, module: Union["AbstractModule", Type["AbstractModule"]]) -> No
                 if isinstance(binding, RegisteredMultiBinding):
                     binding = RegisteredMultiBinding(
                         binding.raw_binding,
+                        module_instance,
                         item_bindings=[
                             RegisteredBinding(
                                 registered_item_binding.raw_binding,
+                                module_instance,
                                 (module_instance,) + binding.source_path,
                             )
                             for registered_item_binding in binding.item_bindings
@@ -75,6 +77,7 @@ def install(self, module: Union["AbstractModule", Type["AbstractModule"]]) -> No
                 else:
                     binding = RegisteredBinding(
                         binding.raw_binding,
+                        module_instance,
                         (module_instance,) + binding.source_path,
                     )
             self._binding_registry.register(binding, add_self_binding=False)
@@ -181,12 +184,12 @@ def _register(self, binding: Binding[Any]) -> RegisteredBinding[Any]:
         if isinstance(binding, MultiBinding):
             registered_binding: RegisteredBinding[Any] = self._register_multi_binding(binding)
         else:
-            registered_binding = RegisteredBinding(binding)
+            registered_binding = RegisteredBinding(binding, binding_source=self)
             self._binding_registry.register(registered_binding)
         return registered_binding
 
     def _register_multi_binding(self, binding: MultiBinding[InjectedT]) -> RegisteredMultiBinding[InjectedT]:
-        registered_binding = RegisteredMultiBinding(binding)
+        registered_binding = RegisteredMultiBinding(binding, binding_source=self)
         for source_item_binding in binding.item_bindings:
             scope = cast(
                 Type[Scope], source_item_binding.scope if source_item_binding.scope is not EMPTY else binding.scope
@@ -219,6 +222,6 @@ def _register_multi_binding(self, binding: MultiBinding[InjectedT]) -> Registere
             else:
                 raise BindingError(f"ItemBinding in {binding!r} has no instance, class or provider, one should be set")
 
-            registered_binding.item_bindings.append(RegisteredBinding(item_binding))
+            registered_binding.item_bindings.append(RegisteredBinding(item_binding, binding_source=self))
         self._binding_registry.register(registered_binding)
         return registered_binding

opyoid/bindings/binding_registry.py

@@ -66,8 +66,9 @@ def _append_to_multi_binding(
         new_raw_binding = cast(MultiBinding[InjectedItemT], registered_binding.raw_binding)
         previous_raw_binding = cast(MultiBinding[InjectedItemT], previous_binding.raw_binding)
         for item_binding, raw_item_binding in zip(registered_binding.item_bindings, new_raw_binding.item_bindings):
-            previous_binding.item_bindings.append(item_binding)
-            previous_raw_binding.item_bindings.append(raw_item_binding)
+            if item_binding not in previous_binding.item_bindings:
+                previous_binding.item_bindings.append(item_binding)
+                previous_raw_binding.item_bindings.append(raw_item_binding)
 
     def _create_or_override_binding(
         self, registered_binding: RegisteredBinding[InjectedT], previous_binding: Optional[RegisteredBinding[InjectedT]]
@@ -102,7 +103,9 @@ def _register_self_binding(self, registered_binding: RegisteredBinding[Any]) ->
             self_binding = binding
 
         if self_binding is not None and self_binding.target not in self:
-            self.register(RegisteredBinding(self_binding, registered_binding.source_path))
+            self.register(
+                RegisteredBinding(self_binding, registered_binding.binding_source, registered_binding.source_path)
+            )
 
     def get_bindings_by_target(self) -> Dict[FrozenTarget[Any], RegisteredBinding[Any]]:
         return self._bindings_by_target

opyoid/bindings/registered_binding.py

@@ -1,4 +1,4 @@
-from typing import Generic, Tuple, TYPE_CHECKING
+from typing import Generic, Optional, Tuple, TYPE_CHECKING
 
 import attr
 
@@ -7,11 +7,13 @@
 from .binding import Binding
 
 if TYPE_CHECKING:
+    from .abstract_module import AbstractModule
     from .private_module import PrivateModule
 
 
 @attr.s(auto_attribs=True, frozen=True)
 class RegisteredBinding(Generic[InjectedT]):
     raw_binding: Binding[InjectedT]
+    binding_source: Optional["AbstractModule"]
     source_path: Tuple["PrivateModule", ...] = attr.Factory(tuple)
     target: FrozenTarget[InjectedT] = attr.Factory(lambda self: self.raw_binding.target, takes_self=True)

opyoid/providers/providers_factories/jit_provider_factory.py

@@ -18,6 +18,6 @@ def create(self, context: InjectionContext[InjectedT]) -> Provider[InjectedT]:
             and isinstance(context.target.type, type)
         ):
             return self._provider_factory.create(
-                RegisteredBinding(SelfBinding(context.target.type, named=context.target.named)), context
+                RegisteredBinding(SelfBinding(context.target.type, named=context.target.named), None), context
             )
         raise IncompatibleProviderFactory

tests/test_bindings/test_abstract_module.py

@@ -50,8 +50,8 @@ def configure(self) -> None:
         self.module.install(module)
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType)),
-                FrozenTarget(OtherType, "my_name"): RegisteredBinding(SelfBinding(OtherType, named="my_name")),
+                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType), module),
+                FrozenTarget(OtherType, "my_name"): RegisteredBinding(SelfBinding(OtherType, named="my_name"), module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -65,7 +65,7 @@ def configure(self) -> None:
         self.module.install(OtherModule)
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType), source_path=(ANY,)),
+                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType), ANY, source_path=(ANY,)),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -75,7 +75,7 @@ def test_bind_class_to_itself(self):
 
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType)),
+                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType), self.module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -85,8 +85,8 @@ def test_bind_class_to_another_class(self):
 
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(ClassBinding(MyType, OtherType)),
-                FrozenTarget(OtherType): RegisteredBinding(SelfBinding(OtherType)),
+                FrozenTarget(MyType): RegisteredBinding(ClassBinding(MyType, OtherType), self.module),
+                FrozenTarget(OtherType): RegisteredBinding(SelfBinding(OtherType), self.module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -97,7 +97,7 @@ def test_bind_instance(self):
 
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(InstanceBinding(MyType, my_instance)),
+                FrozenTarget(MyType): RegisteredBinding(InstanceBinding(MyType, my_instance), self.module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -108,8 +108,8 @@ def test_bind_multiple_overrides_binding(self):
 
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(ClassBinding(MyType, OtherType)),
-                FrozenTarget(OtherType): RegisteredBinding(SelfBinding(OtherType)),
+                FrozenTarget(MyType): RegisteredBinding(ClassBinding(MyType, OtherType), self.module),
+                FrozenTarget(OtherType): RegisteredBinding(SelfBinding(OtherType), self.module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -118,7 +118,7 @@ def test_bind_with_scope(self):
         self.module.bind(MyType, scope=PerLookupScope)
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType, scope=PerLookupScope)),
+                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType, scope=PerLookupScope), self.module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -132,10 +132,11 @@ def test_bind_with_name(self):
 
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(InstanceBinding(MyType, my_instance)),
-                FrozenTarget(MyType, "my_name"): RegisteredBinding(SelfBinding(MyType, named="my_name")),
+                FrozenTarget(MyType): RegisteredBinding(InstanceBinding(MyType, my_instance), self.module),
+                FrozenTarget(MyType, "my_name"): RegisteredBinding(SelfBinding(MyType, named="my_name"), self.module),
                 FrozenTarget(OtherType, "my_other_name"): RegisteredBinding(
-                    InstanceBinding(OtherType, my_other_instance, named="my_other_name")
+                    InstanceBinding(OtherType, my_other_instance, named="my_other_name"),
+                    self.module,
                 ),
             },
             self.module.binding_registry.get_bindings_by_target(),
@@ -146,10 +147,12 @@ def test_bind_provider_class(self):
         self.assertEqual(
             {
                 FrozenTarget(MyType, "my_name"): RegisteredBinding(
-                    ProviderBinding(MyType, MyProvider, scope=PerLookupScope, named="my_name")
+                    ProviderBinding(MyType, MyProvider, scope=PerLookupScope, named="my_name"),
+                    self.module,
                 ),
                 FrozenTarget(MyProvider, "my_name"): RegisteredBinding(
-                    SelfBinding(MyProvider, scope=PerLookupScope, named="my_name")
+                    SelfBinding(MyProvider, scope=PerLookupScope, named="my_name"),
+                    self.module,
                 ),
             },
             self.module.binding_registry.get_bindings_by_target(),
@@ -159,8 +162,8 @@ def test_bind_provider_instance(self):
         self.module.bind(MyType, to_provider=self.my_provider)
         self.assertEqual(
             {
-                FrozenTarget(MyType): RegisteredBinding(ProviderBinding(MyType, self.my_provider)),
-                FrozenTarget(MyProvider): RegisteredBinding(InstanceBinding(MyProvider, self.my_provider)),
+                FrozenTarget(MyType): RegisteredBinding(ProviderBinding(MyType, self.my_provider), self.module),
+                FrozenTarget(MyProvider): RegisteredBinding(InstanceBinding(MyProvider, self.my_provider), self.module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )
@@ -202,23 +205,27 @@ def test_multi_binding(self):
                         named="my_name",
                         override_bindings=False,
                     ),
+                    self.module,
                     item_bindings=[
                         RegisteredBinding(
-                            SelfBinding(MyType, scope=PerLookupScope, named="my_name"),
+                            SelfBinding(MyType, scope=PerLookupScope, named="my_name"), binding_source=self.module
                         ),
                         RegisteredBinding(
-                            InstanceBinding(MyType, instance, named="my_name"),
+                            InstanceBinding(MyType, instance, named="my_name"), binding_source=self.module
                         ),
                         RegisteredBinding(
                             ProviderBinding(MyType, provider, scope=PerLookupScope, named="my_name"),
+                            binding_source=self.module,
                         ),
                     ],
                 ),
                 FrozenTarget(MyProvider, "my_name"): RegisteredBinding(
-                    SelfBinding(MyProvider, scope=PerLookupScope, named="my_name")
+                    SelfBinding(MyProvider, scope=PerLookupScope, named="my_name"),
+                    self.module,
                 ),
                 FrozenTarget(MyType, "my_name"): RegisteredBinding(
-                    SelfBinding(MyType, scope=PerLookupScope, named="my_name")
+                    SelfBinding(MyType, scope=PerLookupScope, named="my_name"),
+                    self.module,
                 ),
             },
             self.module.binding_registry.get_bindings_by_target(),
@@ -244,13 +251,10 @@ def test_multi_binding_default_parameters(self):
                         named=None,
                         override_bindings=False,
                     ),
-                    item_bindings=[
-                        RegisteredBinding(
-                            SelfBinding(MyType),
-                        )
-                    ],
+                    self.module,
+                    item_bindings=[RegisteredBinding(SelfBinding(MyType), binding_source=self.module)],
                 ),
-                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType)),
+                FrozenTarget(MyType): RegisteredBinding(SelfBinding(MyType), self.module),
             },
             self.module.binding_registry.get_bindings_by_target(),
         )