Skip to content

feat: ✨ Improve decorator type hints #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
remimd merged 1 commit into from
Jun 14, 2025
Merged

feat: ✨ Improve decorator type hints #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 148 additions & 13 deletions injection/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ from ._core.common.type import InputType as _InputType
from ._core.common.type import TypeInfo as _TypeInfo
from ._core.module import InjectableFactory as _InjectableFactory
from ._core.module import ModeStr, PriorityStr
from ._core.module import Recipe as _Recipe
from ._core.scope import ScopeKindStr

type _Decorator[T] = Callable[[T], T]

__MODULE: Final[Module] = ...

afind_instance = __MODULE.afind_instance
Expand Down Expand Up @@ -120,88 +121,222 @@ class Module:
def __contains__(self, cls: _InputType[Any], /) -> bool: ...
@property
def is_locked(self) -> bool: ...
@overload
def inject[**P, T](
self,
wrapped: Callable[P, T] = ...,
wrapped: Callable[P, T],
/,
*,
threadsafe: bool | None = ...,
) -> Any:
) -> Callable[P, T]:
"""
Decorator applicable to a class or function. Inject function dependencies using
parameter type annotations. If applied to a class, the dependencies resolved
will be those of the `__init__` method.

With `threadsafe=True`, the injection logic is wrapped in a `threading.RLock`.
"""

@overload
def inject[T](
self,
wrapped: type[T],
/,
*,
threadsafe: bool | None = ...,
) -> type[T]: ...
@overload
def inject[**P, T](
self,
wrapped: None = ...,
/,
*,
threadsafe: bool | None = ...,
) -> _Decorator[Callable[P, T]] | _Decorator[type[T]]: ...
@overload
def injectable[**P, T](
self,
wrapped: _Recipe[P, T] = ...,
wrapped: Callable[P, T],
/,
*,
cls: _InjectableFactory[T] = ...,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> Any:
) -> Callable[P, T]:
"""
Decorator applicable to a class or function. It is used to indicate how the
injectable will be constructed. At injection time, a new instance will be
injected each time.
"""

@overload
def injectable[**P, T]( # type: ignore[overload-overlap]
self,
wrapped: Callable[P, Awaitable[T]],
/,
*,
cls: _InjectableFactory[T] = ...,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> Callable[P, Awaitable[T]]: ...
@overload
Comment thread
remimd marked this conversation as resolved.
def injectable[T](
self,
wrapped: type[T],
/,
*,
cls: _InjectableFactory[T] = ...,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> type[T]: ...
@overload
def injectable[**P, T](
self,
wrapped: None = ...,
/,
*,
cls: _InjectableFactory[T] = ...,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> (
_Decorator[Callable[P, T]]
| _Decorator[Callable[P, Awaitable[T]]]
| _Decorator[type[T]]
): ...
@overload
def singleton[**P, T](
self,
wrapped: _Recipe[P, T] = ...,
wrapped: Callable[P, T],
/,
*,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> Any:
) -> Callable[P, T]:
"""
Decorator applicable to a class or function. It is used to indicate how the
singleton will be constructed. At injection time, the injected instance will
always be the same.
"""

def scoped[T](
@overload
def singleton[**P, T]( # type: ignore[overload-overlap]
self,
wrapped: Callable[P, Awaitable[T]],
/,
*,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> Callable[P, Awaitable[T]]: ...
@overload
def singleton[T](
self,
wrapped: type[T],
/,
*,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> type[T]: ...
@overload
Comment thread
remimd marked this conversation as resolved.
def singleton[**P, T](
self,
wrapped: None = ...,
/,
*,
inject: bool = ...,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> (
_Decorator[Callable[P, T]]
| _Decorator[Callable[P, Awaitable[T]]]
| _Decorator[type[T]]
): ...
def scoped[**P, T](
self,
scope_name: str,
/,
*,
inject: bool = ...,
on: _TypeInfo[T] = (),
mode: Mode | ModeStr = ...,
) -> Any:
) -> (
_Decorator[Callable[P, T]]
| _Decorator[Callable[P, Awaitable[T]]]
| _Decorator[Callable[P, AsyncIterator[T]]]
| _Decorator[Callable[P, Iterator[T]]]
| _Decorator[type[T]]
):
"""
Decorator applicable to a class or function or generator function. It is used
to indicate how the scoped instance will be constructed. At injection time, the
injected instance is retrieved from the scope.
"""

def should_be_injectable[T](self, wrapped: type[T] = ..., /) -> Any:
@overload
def should_be_injectable[T](self, wrapped: type[T], /) -> type[T]:
"""
Decorator applicable to a class. It is used to specify whether an injectable
should be registered. Raise an exception at injection time if the class isn't
registered.
"""

@overload
def should_be_injectable[T](
self,
wrapped: None = ...,
/,
) -> _Decorator[type[T]]: ...
@overload
def constant[**P, T](
self,
wrapped: _Recipe[P, T] = ...,
wrapped: Callable[P, T],
/,
*,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> Any:
) -> Callable[P, T]:
"""
Decorator applicable to a class or function. It is used to indicate how the
constant is constructed. At injection time, the injected instance will always
be the same. Unlike `@singleton`, dependencies will not be resolved.
"""

@overload
def constant[**P, T]( # type: ignore[overload-overlap]
self,
wrapped: Callable[P, Awaitable[T]],
/,
*,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> Callable[P, Awaitable[T]]: ...
@overload
def constant[T](
self,
wrapped: type[T],
/,
*,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> type[T]: ...
@overload
def constant[**P, T](
self,
wrapped: None = ...,
/,
*,
on: _TypeInfo[T] = ...,
mode: Mode | ModeStr = ...,
) -> (
_Decorator[Callable[P, T]]
| _Decorator[Callable[P, Awaitable[T]]]
| _Decorator[type[T]]
): ...
def set_constant[T](
self,
instance: T,
Expand Down
3 changes: 2 additions & 1 deletion injection/_core/common/type.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
Generator,
Iterable,
Iterator,
Sequence,
)
from inspect import isfunction
from types import GenericAlias, UnionType
Expand All @@ -26,7 +27,7 @@
InputType[T]
| Callable[..., T]
| Callable[..., Awaitable[T]]
| Iterable[TypeInfo[T]]
| Sequence[TypeInfo[T]]
)


Expand Down
17 changes: 14 additions & 3 deletions injection/entrypoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,20 @@
]


def autocall[**P, T](wrapped: Callable[P, T] | None = None, /) -> Any:
def decorator(wp: Callable[P, T]) -> Callable[P, T]:
wp() # type: ignore[call-arg]
@overload
def autocall[T: Callable[..., Any]](wrapped: T, /) -> T: ...


@overload
def autocall[T: Callable[..., Any]](wrapped: None = ..., /) -> Callable[[T], T]: ...


def autocall[T: Callable[..., Any]](
wrapped: T | None = None,
/,
) -> T | Callable[[T], T]:
def decorator(wp: T) -> T:
wp()
return wp

return decorator(wrapped) if wrapped else decorator
Expand Down
Loading