p34709852
/
monkey
forked from p15670423/monkey
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Common: Document exceptions for DIContainer

This commit is contained in:
Mike Salvatore 2022-08-05 11:43:15 -04:00
parent d8b37553e3
commit 345633b1e3
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
monkey/common/di_container.py
View File

@ -31,6 +31,7 @@ class DIContainer:
:param interface: An interface or abstract base class that other classes depend upon :param interface: An interface or abstract base class that other classes depend upon
:param concrete_type: A `type` (class) that implements `interface` :param concrete_type: A `type` (class) that implements `interface`
:raises TypeError: If `concrete_type` is not a class, or not a subclass of `interface`
""" """
if not inspect.isclass(concrete_type): if not inspect.isclass(concrete_type):
raise TypeError( raise TypeError(
@ -54,6 +55,7 @@ class DIContainer:
:param interface: An interface or abstract base class that other classes depend upon :param interface: An interface or abstract base class that other classes depend upon
:param instance: An instance (object) of a `type` that implements `interface` :param instance: An instance (object) of a `type` that implements `interface`
:raises TypeError: If `instance` is not an instance of `interface`
""" """
if not isinstance(instance, interface): if not isinstance(instance, interface):
raise TypeError( raise TypeError(
@ -106,6 +108,7 @@ class DIContainer:
:param **type_**: A `type` (class) to construct :param **type_**: A `type` (class) to construct
:return: An instance of **type_** :return: An instance of **type_**
:raises UnresolvableDependencyError: If any dependencies could not be successfully resolved
""" """
try: try:
return self._resolve_type(type_) return self._resolve_type(type_)
@ -125,6 +128,7 @@ class DIContainer:
:param **type_**: A type (class) to resolve dependencies for :param **type_**: A type (class) to resolve dependencies for
:return: An Sequence of dependencies to be injected into `type_`'s constructor :return: An Sequence of dependencies to be injected into `type_`'s constructor
:raises UnresolvableDependencyError: If any dependencies could not be successfully resolved
""" """
args = [] args = []