Merge pull request #2263 from VWS-Python/route-response-type

Use ResponseType variable so we are tied in fewer places to requests_mock

Author: adamtheturtle

src/mock_vws/_requests_mock_server/mock_web_query_api.py

@@ -28,11 +28,13 @@
 
 _ROUTES: set[Route] = set()
 
+_ResponseType = str
+
 
 def route(
     path_pattern: str,
     http_methods: set[str],
-) -> Callable[[Callable[..., str]], Callable[..., str]]:
+) -> Callable[[Callable[..., _ResponseType]], Callable[..., _ResponseType]]:
     """
     Register a decorated method so that it can be recognized as a route.
 
@@ -45,7 +47,9 @@ def route(
         A decorator which takes methods and makes them recognizable as routes.
     """
 
-    def decorator(method: Callable[..., str]) -> Callable[..., str]:
+    def decorator(
+        method: Callable[..., _ResponseType],
+    ) -> Callable[..., _ResponseType]:
         """
         Register a decorated method so that it can be recognized as a route.
 
@@ -99,7 +103,7 @@ def __init__(
         self._query_match_checker = query_match_checker
 
     @route(path_pattern="/v1/query", http_methods={HTTPMethod.POST})
-    def query(self, request: "Request", context: "Context") -> str:
+    def query(self, request: "Request", context: "Context") -> _ResponseType:
         """
         Perform an image recognition query.
         """

src/mock_vws/_requests_mock_server/mock_web_services_api.py

@@ -40,11 +40,13 @@
 
 _ROUTES: set[Route] = set()
 
+_ResponseType = str
+
 
 def route(
     path_pattern: str,
     http_methods: set[HTTPMethod],
-) -> Callable[[Callable[..., str]], Callable[..., str]]:
+) -> Callable[[Callable[..., str]], Callable[..., _ResponseType]]:
     """
     Register a decorated method so that it can be recognized as a route.
 
@@ -57,7 +59,9 @@ def route(
         A decorator which takes methods and makes them recognizable as routes.
     """
 
-    def decorator(method: Callable[..., str]) -> Callable[..., str]:
+    def decorator(
+        method: Callable[..., _ResponseType],
+    ) -> Callable[..., _ResponseType]:
         """
         Register a decorated method so that it can be recognized as a route.
 
@@ -130,7 +134,9 @@ def __init__(
         path_pattern="/targets",
         http_methods={HTTPMethod.POST},
     )
-    def add_target(self, request: "Request", context: "Context") -> str:
+    def add_target(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Add a target.
 
@@ -207,7 +213,9 @@ def add_target(self, request: "Request", context: "Context") -> str:
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.DELETE},
     )
-    def delete_target(self, request: "Request", context: "Context") -> str:
+    def delete_target(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Delete a target.
 
@@ -274,7 +282,9 @@ def delete_target(self, request: "Request", context: "Context") -> str:
         return body_json
 
     @route(path_pattern="/summary", http_methods={HTTPMethod.GET})
-    def database_summary(self, request: "Request", context: "Context") -> str:
+    def database_summary(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Get a database summary report.
 
@@ -340,7 +350,9 @@ def database_summary(self, request: "Request", context: "Context") -> str:
         return body_json
 
     @route(path_pattern="/targets", http_methods={HTTPMethod.GET})
-    def target_list(self, request: "Request", context: "Context") -> str:
+    def target_list(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Get a list of all targets.
 
@@ -400,7 +412,9 @@ def target_list(self, request: "Request", context: "Context") -> str:
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def get_target(self, request: "Request", context: "Context") -> str:
+    def get_target(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Get details of a target.
 
@@ -468,7 +482,9 @@ def get_target(self, request: "Request", context: "Context") -> str:
         path_pattern=f"/duplicates/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def get_duplicates(self, request: "Request", context: "Context") -> str:
+    def get_duplicates(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Get targets which may be considered duplicates of a given target.
 
@@ -542,7 +558,9 @@ def get_duplicates(self, request: "Request", context: "Context") -> str:
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.PUT},
     )
-    def update_target(self, request: "Request", context: "Context") -> str:
+    def update_target(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Update a target.
 
@@ -651,7 +669,9 @@ def update_target(self, request: "Request", context: "Context") -> str:
         path_pattern=f"/summary/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def target_summary(self, request: "Request", context: "Context") -> str:
+    def target_summary(
+        self, request: "Request", context: "Context"
+    ) -> _ResponseType:
         """
         Get a summary report for a target.