refactoring: ♻️ Rename constant to set_constant

Author: remimd

documentation/basic-usage.md

@@ -24,12 +24,13 @@ class Injectable:
     """ class implementation """
 ```
 
-If you have a constant (such as a global variable) and wish to register it as an injectable, use `constant` function.
+If you have a constant (such as a global variable) and wish to register it as an injectable, use `set_constant`
+function.
 
 ```python
-from injection import constant
+from injection import set_constant
 
-app = constant(Application())
+app = set_constant(Application())
 ```
 
 ## Inject an instance

injection/_pkg.py

@@ -3,21 +3,22 @@
 __all__ = (
     "Module",
     "ModulePriorities",
-    "constant",
     "default_module",
     "get_instance",
     "get_lazy_instance",
     "inject",
     "injectable",
+    "set_constant",
     "singleton",
 )
 
 default_module = Module(f"{__name__}:default_module")
 
-constant = default_module.constant
 get_instance = default_module.get_instance
 get_lazy_instance = default_module.get_lazy_instance
 
 inject = default_module.inject
 injectable = default_module.injectable
 singleton = default_module.singleton
+
+set_constant = default_module.set_constant

injection/_pkg.pyi

@@ -10,14 +10,15 @@ _T = TypeVar("_T")
 
 default_module: Final[Module] = ...
 
-constant = default_module.constant
 get_instance = default_module.get_instance
 get_lazy_instance = default_module.get_lazy_instance
 
 inject = default_module.inject
 injectable = default_module.injectable
 singleton = default_module.singleton
 
+set_constant = default_module.set_constant
+
 @final
 class Module:
     """
@@ -60,7 +61,7 @@ class Module:
         singleton will be constructed. At injection time, the injected instance will
         always be the same.
         """
-    def constant(
+    def set_constant(
         self,
         instance: _T,
         on: type | Iterable[type] | UnionType = ...,

injection/core/module.py

@@ -309,7 +309,7 @@ def __brokers(self) -> Iterator[Container | Module]:
         yield from tuple(self.__modules)
         yield self.__container
 
-    def constant(self, instance: _T, on: type | Types = None) -> _T:
+    def set_constant(self, instance: _T, on: type | Types = None) -> _T:
         cls = type(instance)
 
         @self.injectable(on=(cls, on))

tests/core/test_module.py

@@ -114,21 +114,32 @@ def test_get_lazy_instance_with_no_injectable_return_lazy_none(self, module):
         assert lazy_instance.is_set
 
     """
-    constant
+    set_constant
     """
 
-    def test_constant_with_success_return_instance(self, module):
+    def test_set_constant_with_success_return_instance(self, module):
         instance = SomeClass()
-        return_value = module.constant(instance)
+        return_value = module.set_constant(instance)
         assert instance is return_value is module.get_instance(SomeClass)
 
-    def test_constant_with_on_return_instance(self, module):
-        class Class(SomeClass):
+    def test_set_constant_with_on_return_instance(self, module):
+        class A:
+            ...
+
+        class B(A):
+            ...
+
+        class C(B):
             ...
 
-        instance = Class()
-        module.constant(instance, on=SomeClass)
-        assert instance is module.get_instance(Class) is module.get_instance(SomeClass)
+        instance = C()
+        module.set_constant(instance, on=(A, B))
+        assert (
+            instance
+            is module.get_instance(A)
+            is module.get_instance(B)
+            is module.get_instance(C)
+        )
 
     """
     use