Rename @wiring.injected -> inject

Author: scottzach1

README.md

@@ -31,7 +31,7 @@ With this approach you can automatically inject functions at load time using the
 from pif import wiring, providers
 
 
-@wiring.injected  # <- automatically injects providers.Provider default arguments!
+@wiring.inject  # <- automatically injects providers.Provider default arguments!
 def my_function(a: str = providers.ExistingSingleton("hello world")):
     return a
 
@@ -74,7 +74,7 @@ from pif import wiring, providers
 StringProvider = providers.ExistingSingleton("hello world")
 
 
-@wiring.injected
+@wiring.inject
 def my_function(a: str = StringProvider):
     return a
 
@@ -97,7 +97,7 @@ from pif import wiring, providers
 StringProvider = providers.ExistingSingleton("hello world")
 
 
-@wiring.injected
+@wiring.inject
 def my_function(a: str = StringProvider):
     return a
 

examples/simple_service/main.py

@@ -18,7 +18,7 @@ def do_stuff(self): ...
 ApiClientProvider = providers.Singleton[ApiClient](ApiClient, domain=ApiDomainProvider, token=ApiTokenProvider)
 
 
-@wiring.injected
+@wiring.inject
 def main(client: ApiClient = ApiClientProvider):
     """
     Your application logic.

pif/wiring.py

@@ -47,7 +47,7 @@ def patch_args(
     return args, kwargs
 
 
-def injected[T: Callable](func: T) -> T:
+def inject[T: Callable](func: T) -> T:
     """
     Get a decorated copy of `func` with patched arguments.
 
@@ -89,7 +89,7 @@ def patch_method[T: Callable | types.FunctionType](func: T) -> T:
     :return: a "patched" version of the method provided.
     """
     if any(1 for param in inspect.signature(func).parameters.values() if isinstance(param.default, providers.Provider)):
-        return injected(func)
+        return inject(func)
 
     return func
 

tests/test_wiring.py

@@ -48,7 +48,7 @@ def test_patch_lazy():
     mock = MagicMock()
     assert not mock.call_count
 
-    @wiring.injected
+    @wiring.inject
     def func(v=providers.Singleton[MagicMock](lambda: mock)):
         return v()
 
@@ -64,14 +64,14 @@ def test_patch_positional_only():
     Test patching for POSITIONAL_ONLY arguments.
     """
 
-    @wiring.injected
+    @wiring.inject
     def p1(a, b=provide("b"), c="c_default", /):
         return a, b, c
 
     assert p1(None) == (None, "b_injected", "c_default")
     assert p1(None, None) == (None, None, "c_default")
 
-    @wiring.injected
+    @wiring.inject
     def p2(a, b=None, c=provide("c"), /):
         return a, b, c
 
@@ -85,7 +85,7 @@ def test_patch_positional():
     Test patching for POSITIONAL_OR_KEYWORD arguments.
     """
 
-    @wiring.injected
+    @wiring.inject
     def p1(a, b=provide("b"), c="c_default"):
         return a, b, c
 
@@ -94,7 +94,7 @@ def p1(a, b=provide("b"), c="c_default"):
     assert p1(a=None) == (None, "b_injected", "c_default")
     assert p1(a=None, b=None) == (None, None, "c_default")
 
-    @wiring.injected
+    @wiring.inject
     def p2(a, b=None, c=provide("c")):
         return a, b, c
 
@@ -111,7 +111,7 @@ def test_patch_positional_or_keyword():
     Test patching for VAR_POSITIONAL argument.
     """
 
-    @wiring.injected
+    @wiring.inject
     def p1(a, b=provide("b"), *c, d="d_default", e=provide("e")):
         return a, b, *c, d, e