Merge branch 'route-response-type' into switch-to-responses

Author: adamtheturtle

src/mock_vws/_requests_mock_server/mock_web_query_api.py

@@ -22,11 +22,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.
 
@@ -39,7 +41,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.
 
@@ -93,7 +97,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

@@ -38,11 +38,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.
 
@@ -55,7 +57,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.
 
@@ -128,9 +132,7 @@ def __init__(
         path_pattern="/targets",
         http_methods={HTTPMethod.POST},
     )
-    def add_target(
-        self, request: PreparedRequest
-    ) -> tuple[int, dict[str, str], str]:
+    def add_target(self, request: PreparedRequest) -> _ResponseType:
         """
         Add a target.
 
@@ -206,9 +208,7 @@ def add_target(
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.DELETE},
     )
-    def delete_target(
-        self, request: PreparedRequest
-    ) -> tuple[int, dict[str, str], str]:
+    def delete_target(self, request: PreparedRequest) -> _ResponseType:
         """
         Delete a target.
 
@@ -273,10 +273,7 @@ def delete_target(
         return HTTPStatus.OK, headers, body_json
 
     @route(path_pattern="/summary", http_methods={HTTPMethod.GET})
-    def database_summary(
-        self,
-        request: PreparedRequest,
-    ) -> tuple[int, dict[str, str], str]:
+    def database_summary(self, request: PreparedRequest) -> _ResponseType:
         """
         Get a database summary report.
 
@@ -341,9 +338,7 @@ def database_summary(
         return HTTPStatus.OK, headers, body_json
 
     @route(path_pattern="/targets", http_methods={HTTPMethod.GET})
-    def target_list(
-        self, request: PreparedRequest
-    ) -> tuple[int, dict[str, str], str]:
+    def target_list(self, request: PreparedRequest) -> _ResponseType:
         """
         Get a list of all targets.
 
@@ -401,9 +396,7 @@ def target_list(
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def get_target(
-        self, request: PreparedRequest
-    ) -> tuple[int, dict[str, str], str]:
+    def get_target(self, request: PreparedRequest) -> _ResponseType:
         """
         Get details of a target.
 
@@ -469,9 +462,7 @@ def get_target(
         path_pattern=f"/duplicates/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def get_duplicates(
-        self, request: PreparedRequest
-    ) -> tuple[int, dict[str, str], str]:
+    def get_duplicates(self, request: PreparedRequest) -> _ResponseType:
         """
         Get targets which may be considered duplicates of a given target.
 
@@ -543,9 +534,7 @@ def get_duplicates(
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.PUT},
     )
-    def update_target(
-        self, request: PreparedRequest
-    ) -> tuple[int, dict[str, str], str]:
+    def update_target(self, request: PreparedRequest) -> _ResponseType:
         """
         Update a target.
 
@@ -653,9 +642,7 @@ def update_target(
         path_pattern=f"/summary/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def target_summary(
-        self, request: PreparedRequest
-    ) -> tuple[int, dict[str, str], str]:
+    def target_summary(self, request: PreparedRequest) -> _ResponseType:
         """
         Get a summary report for a target.