Merge pull request #1392 from dbluhm/fix/inject-return-type

fix: return type of inject
openwallet-foundation · Sep 3, 2021 · 136bed7 · 136bed7
2 parents 820971f + 504a3d0
commit 136bed7
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 8 deletions.
diff --git a/aries_cloudagent/admin/request_context.py b/aries_cloudagent/admin/request_context.py
@@ -61,7 +61,7 @@ def inject(
         self,
         base_cls: Type[InjectType],
         settings: Mapping[str, object] = None,
-    ) -> Optional[InjectType]:
+    ) -> InjectType:
         """
         Get the provided instance of a given class identifier.
 

diff --git a/aries_cloudagent/config/base.py b/aries_cloudagent/config/base.py
@@ -112,9 +112,7 @@ def inject(
         self,
         base_cls: Type[InjectType],
         settings: Mapping[str, object] = None,
-        *,
-        required: bool = True,
-    ) -> Optional[InjectType]:
+    ) -> InjectType:
         """
         Get the provided instance of a given class identifier.
 
@@ -127,6 +125,26 @@ def inject(
 
         """
 
+    @abstractmethod
+    def inject_or(
+        self,
+        base_cls: Type[InjectType],
+        settings: Mapping[str, object] = None,
+        default: Optional[InjectType] = None,
+    ) -> Optional[InjectType]:
+        """
+        Get the provided instance of a given class identifier or default if not found.
+
+        Args:
+            base_cls: The base class to retrieve an instance of
+            settings: An optional dict providing configuration to the provider
+            default: default return value if no instance is found
+
+        Returns:
+            An instance of the base class, or None
+
+        """
+
     @abstractmethod
     def copy(self) -> "BaseInjector":
         """Produce a copy of the injector instance."""

diff --git a/aries_cloudagent/config/injection_context.py b/aries_cloudagent/config/injection_context.py
@@ -109,7 +109,7 @@ def inject(
         self,
         base_cls: Type[InjectType],
         settings: Mapping[str, object] = None,
-    ) -> Optional[InjectType]:
+    ) -> InjectType:
         """
         Get the provided instance of a given class identifier.
 

diff --git a/aries_cloudagent/core/profile.py b/aries_cloudagent/core/profile.py
@@ -78,7 +78,7 @@ def inject(
         self,
         base_cls: Type[InjectType],
         settings: Mapping[str, object] = None,
-    ) -> Optional[InjectType]:
+    ) -> InjectType:
         """
         Get the provided instance of a given class identifier.
 
@@ -255,7 +255,7 @@ def inject(
         self,
         base_cls: Type[InjectType],
         settings: Mapping[str, object] = None,
-    ) -> Optional[InjectType]:
+    ) -> InjectType:
         """
         Get the provided instance of a given class identifier.
 

diff --git a/aries_cloudagent/messaging/request_context.py b/aries_cloudagent/messaging/request_context.py
@@ -192,7 +192,7 @@ def inject(
         self,
         base_cls: Type[InjectType],
         settings: Mapping[str, object] = None,
-    ) -> Optional[InjectType]:
+    ) -> InjectType:
         """
         Get the provided instance of a given class identifier.