containers.pyi

from pathlib import Path
from typing import (
    Any,
    Awaitable,
    Callable as _Callable,
    ClassVar,
    Dict,
    Generic,
    Iterable,
    Iterator,
    List,
    Optional,
    Tuple,
    Type,
    TypeVar,
    Union,
    overload,
)

try:
    from typing import Self as _Self
except ImportError:
    from typing_extensions import Self as _Self

from .providers import Provider, BaseResource, Self, ProviderParent

C_Base = TypeVar("C_Base", bound="Container")
C = TypeVar("C", bound="DeclarativeContainer")
C_Overriding = TypeVar("C_Overriding", bound="DeclarativeContainer")
T = TypeVar("T")
TT = TypeVar("TT")

class WiringConfiguration:
    modules: List[Any]
    packages: List[Any]
    from_package: Optional[str]
    auto_wire: bool
    keep_cache: bool
    def __init__(
        self,
        modules: Optional[Iterable[Any]] = None,
        packages: Optional[Iterable[Any]] = None,
        from_package: Optional[str] = None,
        auto_wire: bool = True,
        keep_cache: bool = False,
        warn_unresolved: bool = False,
    ) -> None: ...

class Container:
    provider_type: Type[Provider[Any]] = Provider
    providers: Dict[str, Provider[Any]]
    dependencies: Dict[str, Provider[Any]]
    overridden: Tuple[Provider[Any], ...]
    wiring_config: WiringConfiguration
    auto_load_config: bool = True
    __self__: Self
    def __init__(self) -> None: ...
    def __deepcopy__(self, memo: Optional[Dict[str, Any]]) -> _Self: ...
    def __setattr__(self, name: str, value: Union[Provider[Any], Any]) -> None: ...
    def __delattr__(self, name: str) -> None: ...
    def set_providers(self, **providers: Provider[Any]) -> None: ...
    def set_provider(self, name: str, provider: Provider[Any]) -> None: ...
    def override(self, overriding: Union[Container, Type[Container]]) -> None: ...
    def override_providers(
        self, **overriding_providers: Union[Provider[Any], Any]
    ) -> ProvidersOverridingContext[C_Base]: ...
    def reset_last_overriding(self) -> None: ...
    def reset_override(self) -> None: ...
    def is_auto_wiring_enabled(self) -> bool: ...
    def wire(
        self,
        modules: Optional[Iterable[Any]] = None,
        packages: Optional[Iterable[Any]] = None,
        from_package: Optional[str] = None,
        keep_cache: Optional[bool] = None,
        warn_unresolved: bool = False,
    ) -> None: ...
    def unwire(self) -> None: ...
    def init_resources(
        self, resource_type: Type[BaseResource[Any]] = BaseResource
    ) -> Optional[Awaitable[None]]: ...
    def shutdown_resources(
        self, resource_type: Type[BaseResource[Any]] = BaseResource
    ) -> Optional[Awaitable[None]]: ...
    def load_config(self) -> None: ...
    def apply_container_providers_overridings(self) -> None: ...
    def reset_singletons(self) -> SingletonResetContext[C_Base]: ...
    def check_dependencies(self) -> None: ...
    def from_schema(self, schema: Dict[Any, Any]) -> None: ...
    def from_yaml_schema(
        self, filepath: Union[Path, str], loader: Optional[Any] = None
    ) -> None: ...
    def from_json_schema(self, filepath: Union[Path, str]) -> None: ...
    @overload
    def resolve_provider_name(self, provider: Provider[Any]) -> str: ...
    @classmethod
    @overload
    def resolve_provider_name(cls, provider: Provider[Any]) -> str: ...
    @property
    def parent(self) -> Optional[ProviderParent]: ...
    @property
    def parent_name(self) -> Optional[str]: ...
    def assign_parent(self, parent: ProviderParent) -> None: ...
    @overload
    def traverse(self, types: Optional[Iterable[Type[TT]]] = None) -> Iterator[TT]: ...
    @classmethod
    @overload
    def traverse(cls, types: Optional[Iterable[Type[TT]]] = None) -> Iterator[TT]: ...

class DynamicContainer(Container):
    def __getattr__(self, name: str) -> Provider[Any]: ...

class DeclarativeContainer(Container):
    cls_providers: ClassVar[Dict[str, Provider[Any]]]
    inherited_providers: ClassVar[Dict[str, Provider[Any]]]
    def __init__(self, **overriding_providers: Union[Provider[Any], Any]) -> None: ...
    @classmethod
    def override(cls, overriding: Union[Container, Type[Container]]) -> None: ...
    @classmethod
    def override_providers(
        cls, **overriding_providers: Union[Provider[Any], Any]
    ) -> ProvidersOverridingContext[C_Base]: ...
    @classmethod
    def reset_last_overriding(cls) -> None: ...
    @classmethod
    def reset_override(cls) -> None: ...

class ProvidersOverridingContext(Generic[T]):
    def __init__(
        self, container: T, overridden_providers: Iterable[Union[Provider[Any], Any]]
    ) -> None: ...
    def __enter__(self) -> T: ...
    def __exit__(self, *_: Any) -> None: ...

class SingletonResetContext(Generic[T]):
    def __init__(self, container: T): ...
    def __enter__(self) -> T: ...
    def __exit__(self, *_: Any) -> None: ...

def override(
    container: Type[C],
) -> _Callable[[Type[C_Overriding]], Type[C_Overriding]]: ...
def copy(container: Type[C]) -> _Callable[[Type[C_Overriding]], Type[C_Overriding]]: ...
def is_container(instance: Any) -> bool: ...