Skip to content

Fix wiring marker typing #896

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.

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
merged 3 commits into from
May 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions src/dependency_injector/_cwiring.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
from typing import Any, Awaitable, Callable, Dict, Tuple, TypeVar

from .providers import Provider

T = TypeVar("T")

def _sync_inject(
fn: Callable[..., T],
args: Tuple[Any, ...],
kwargs: Dict[str, Any],
injections: Dict[str, Provider[Any]],
closings: Dict[str, Provider[Any]],
/,
) -> T: ...
async def _async_inject(
fn: Callable[..., Awaitable[T]],
args: Tuple[Any, ...],
kwargs: Dict[str, Any],
injections: Dict[str, Provider[Any]],
closings: Dict[str, Provider[Any]],
/,
) -> T: ...
def _isawaitable(instance: Any) -> bool: ...
2 changes: 1 addition & 1 deletion src/dependency_injector/containers.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class WiringConfiguration:
class Container:
provider_type: Type[Provider] = Provider
providers: Dict[str, Provider]
dependencies: Dict[str, Provider]
dependencies: Dict[str, Provider[Any]]
overridden: Tuple[Provider]
wiring_config: WiringConfiguration
auto_load_config: bool = True
Expand Down
89 changes: 59 additions & 30 deletions src/dependency_injector/wiring.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@
import sys
from types import ModuleType
from typing import (
TYPE_CHECKING,
Any,
Callable,
Dict,
Generic,
Iterable,
Iterator,
Optional,
Protocol,
Set,
Tuple,
Type,
Expand All @@ -23,6 +24,7 @@
cast,
)

from typing_extensions import Self

# Hotfix, see: https://github.com/ets-labs/python-dependency-injector/issues/362
if sys.version_info >= (3, 9):
Expand Down Expand Up @@ -66,7 +68,6 @@ def get_origin(tp):

from . import providers


__all__ = (
"wire",
"unwire",
Expand All @@ -89,7 +90,11 @@ def get_origin(tp):

T = TypeVar("T")
F = TypeVar("F", bound=Callable[..., Any])
Container = Any

if TYPE_CHECKING:
from .containers import Container
else:
Container = Any


class PatchedRegistry:
Expand Down Expand Up @@ -777,15 +782,15 @@ class RequiredModifier(Modifier):
def __init__(self) -> None:
self.type_modifier = None

def as_int(self) -> "RequiredModifier":
def as_int(self) -> Self:
self.type_modifier = TypeModifier(int)
return self

def as_float(self) -> "RequiredModifier":
def as_float(self) -> Self:
self.type_modifier = TypeModifier(float)
return self

def as_(self, type_: Type) -> "RequiredModifier":
def as_(self, type_: Type) -> Self:
self.type_modifier = TypeModifier(type_)
return self

Expand Down Expand Up @@ -833,15 +838,15 @@ class ProvidedInstance(Modifier):
def __init__(self) -> None:
self.segments = []

def __getattr__(self, item):
def __getattr__(self, item: str) -> Self:
self.segments.append((self.TYPE_ATTRIBUTE, item))
return self

def __getitem__(self, item):
def __getitem__(self, item) -> Self:
self.segments.append((self.TYPE_ITEM, item))
return self

def call(self):
def call(self) -> Self:
self.segments.append((self.TYPE_CALL, None))
return self

Expand All @@ -866,36 +871,56 @@ def provided() -> ProvidedInstance:
return ProvidedInstance()


class _Marker(Generic[T]):
MarkerItem = Union[
str,
providers.Provider[Any],
Tuple[str, TypeModifier],
Type[Container],
"_Marker",
]

__IS_MARKER__ = True

def __init__(
self,
provider: Union[providers.Provider, Container, str],
modifier: Optional[Modifier] = None,
) -> None:
if _is_declarative_container(provider):
provider = provider.__self__
self.provider = provider
self.modifier = modifier
if TYPE_CHECKING:

def __class_getitem__(cls, item) -> T:
if isinstance(item, tuple):
return cls(*item)
return cls(item)
class _Marker(Protocol):
__IS_MARKER__: bool

def __call__(self) -> T:
return self
def __call__(self) -> Self: ...
def __getattr__(self, item: str) -> Self: ...
def __getitem__(self, item: Any) -> Any: ...

Provide: _Marker
Provider: _Marker
Closing: _Marker
else:

class _Marker:

class Provide(_Marker): ...
__IS_MARKER__ = True

def __init__(
self,
provider: Union[providers.Provider, Container, str],
modifier: Optional[Modifier] = None,
) -> None:
if _is_declarative_container(provider):
provider = provider.__self__
self.provider = provider
self.modifier = modifier

class Provider(_Marker): ...
def __class_getitem__(cls, item: MarkerItem) -> Self:
if isinstance(item, tuple):
return cls(*item)
return cls(item)

def __call__(self) -> Self:
return self

class Closing(_Marker): ...
class Provide(_Marker): ...

class Provider(_Marker): ...

class Closing(_Marker): ...


class AutoLoader:
Expand Down Expand Up @@ -998,8 +1023,8 @@ def is_loader_installed() -> bool:
_loader = AutoLoader()

# Optimizations
from ._cwiring import _sync_inject # noqa
from ._cwiring import _async_inject # noqa
from ._cwiring import _sync_inject # noqa


# Wiring uses the following Python wrapper because there is
Expand Down Expand Up @@ -1028,13 +1053,17 @@ def _patched(*args, **kwargs):
patched.injections,
patched.closing,
)

return cast(F, _patched)


if sys.version_info >= (3, 10):

def _get_annotations(obj: Any) -> Dict[str, Any]:
return inspect.get_annotations(obj)

else:

def _get_annotations(obj: Any) -> Dict[str, Any]:
return getattr(obj, "__annotations__", {})

Expand Down
18 changes: 11 additions & 7 deletions tests/typing/aggregate.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
from dependency_injector import providers


class Animal:
...
class Animal: ...


class Cat(Animal):
...
class Cat(Animal): ...


# Test 1: to check Aggregate provider
Expand All @@ -20,13 +18,19 @@ class Cat(Animal):

provider1_set_non_string_keys: providers.Aggregate[str] = providers.Aggregate()
provider1_set_non_string_keys.set_providers({Cat: providers.Object("str")})
provider_set_non_string_1: providers.Provider[str] = provider1_set_non_string_keys.providers[Cat]
provider_set_non_string_1: providers.Provider[str] = (
provider1_set_non_string_keys.providers[Cat]
)

provider1_new_non_string_keys: providers.Aggregate[str] = providers.Aggregate(
{Cat: providers.Object("str")},
)
factory_new_non_string_1: providers.Provider[str] = provider1_new_non_string_keys.providers[Cat]
factory_new_non_string_1: providers.Provider[str] = (
provider1_new_non_string_keys.providers[Cat]
)

provider1_no_explicit_typing = providers.Aggregate(a=providers.Object("str"))
provider1_no_explicit_typing_factory: providers.Provider[str] = provider1_no_explicit_typing.providers["a"]
provider1_no_explicit_typing_factory: providers.Provider[str] = (
provider1_no_explicit_typing.providers["a"]
)
provider1_no_explicit_typing_object: str = provider1_no_explicit_typing("a")
10 changes: 6 additions & 4 deletions tests/typing/callable.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
from typing import Callable, Optional, Tuple, Any, Dict, Type
from typing import Any, Callable, Dict, Optional, Tuple, Type

from dependency_injector import providers


class Animal:
...
class Animal: ...


class Cat(Animal):
Expand Down Expand Up @@ -53,10 +52,13 @@ def create(cls) -> Animal:

# Test 9: to check the return type with await
provider9 = providers.Callable(Cat)


async def _async9() -> None:
animal1: Animal = await provider9(1, 2, 3, b="1", c=2, e=0.0) # type: ignore
animal2: Animal = await provider9.async_(1, 2, 3, b="1", c=2, e=0.0)


# Test 10: to check the .provides
provider10 = providers.Callable(Cat)
provides10: Optional[Callable[..., Cat]] = provider10.provides
Expand All @@ -68,5 +70,5 @@ async def _async9() -> None:
assert provides11 is Cat

# Test 12: to check string imports
provider12: providers.Callable[dict] = providers.Callable("builtins.dict")
provider12: providers.Callable[Dict[Any, Any]] = providers.Callable("builtins.dict")
provider12.set_provides("builtins.dict")
10 changes: 6 additions & 4 deletions tests/typing/configuration.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
from pathlib import Path
from typing import Any
from typing import Any, Dict

from dependency_injector import providers
from pydantic_settings import BaseSettings as PydanticSettings

from dependency_injector import providers

# Test 1: to check the getattr
config1: providers.Configuration = providers.Configuration()
provider1: providers.Provider[dict] = providers.Factory(dict, a=config1.a)
provider1: providers.Provider[Dict[str, Any]] = providers.Factory(dict, a=config1.a)

# Test 2: to check the from_*() method
config2 = providers.Configuration()
Expand Down Expand Up @@ -68,7 +68,9 @@
pydantic_settings=[PydanticSettings()],
)
config5_pydantic.set_pydantic_settings([PydanticSettings()])
config5_pydantic_settings: list[PydanticSettings] = config5_pydantic.get_pydantic_settings()
config5_pydantic_settings: list[PydanticSettings] = (
config5_pydantic.get_pydantic_settings()
)

# Test 6: to check init arguments
config6 = providers.Configuration(
Expand Down
7 changes: 4 additions & 3 deletions tests/typing/container.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
from typing import Any

from dependency_injector import providers


class Container:
...
class Container: ...


# Test 1: to check the return type
Expand All @@ -11,4 +12,4 @@ class Container:

# Test 2: to check the getattr
provider2 = providers.Container(Container)
attr: providers.Provider = provider2.attr
attr: providers.Provider[Any] = provider2.attr
8 changes: 4 additions & 4 deletions tests/typing/coroutine.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
from typing import Coroutine
from typing import Awaitable, Coroutine

from dependency_injector import providers


async def _coro() -> None:
...
async def _coro() -> None: ...


# Test 1: to check the return type
provider1 = providers.Coroutine(_coro)
var1: Coroutine = provider1()
var1: Awaitable[None] = provider1()

# Test 2: to check string imports
provider2: providers.Coroutine[None] = providers.Coroutine("_coro")
Expand Down
Loading