Merge pull request #1517 from VWS-Python/rm-types-flask

Remove types-flask dependency

Author: adamtheturtle

pyproject.toml

@@ -305,7 +305,6 @@ dev = [
     "sphinxcontrib-spelling==8.0.0",
     "sphinx-toolbox==3.4.0",
     "sybil==4.0.1",
-    "types-Flask==1.1.6",
     "types-PyYAML==6.0.12.8",
     "types-Pillow==9.4.0.17",
     "types-requests==2.28.11.16",

src/mock_vws/_flask_server/target_manager.py

@@ -5,10 +5,11 @@
 import base64
 import dataclasses
 import datetime
+import json
 from http import HTTPStatus
 from zoneinfo import ZoneInfo
 
-from flask import Flask, jsonify, request
+from flask import Flask, Response, request
 from pydantic import BaseSettings
 
 from mock_vws.database import VuforiaDatabase
@@ -31,7 +32,7 @@ class TargetManagerSettings(BaseSettings):
     "/databases/<string:database_name>",
     methods=["DELETE"],
 )
-def delete_database(database_name: str) -> tuple[str, int]:
+def delete_database(database_name: str) -> Response:
     """
     Delete a database.
 
@@ -44,23 +45,26 @@ def delete_database(database_name: str) -> tuple[str, int]:
             if database_name == database.database_name
         }
     except ValueError:
-        return "", HTTPStatus.NOT_FOUND
+        return Response(response="", status=HTTPStatus.NOT_FOUND)
 
     TARGET_MANAGER.remove_database(database=matching_database)
-    return "", HTTPStatus.OK
+    return Response(response="", status=HTTPStatus.OK)
 
 
 @TARGET_MANAGER_FLASK_APP.route("/databases", methods=["GET"])
-def get_databases() -> tuple[str, int]:
+def get_databases() -> Response:
     """
     Return a list of all databases.
     """
     databases = [database.to_dict() for database in TARGET_MANAGER.databases]
-    return jsonify(databases), HTTPStatus.OK
+    return Response(
+        response=json.dumps(obj=databases),
+        status=HTTPStatus.OK,
+    )
 
 
 @TARGET_MANAGER_FLASK_APP.route("/databases", methods=["POST"])
-def create_database() -> tuple[str, int]:
+def create_database() -> Response:
     """
     Create a new database.
 
@@ -91,27 +95,28 @@ def create_database() -> tuple[str, int]:
     :status 201: The database has been successfully created.
     """
     random_database = VuforiaDatabase()
-    server_access_key = request.json.get(
+    request_json = json.loads(request.data)
+    server_access_key = request_json.get(
         "server_access_key",
         random_database.server_access_key,
     )
-    server_secret_key = request.json.get(
+    server_secret_key = request_json.get(
         "server_secret_key",
         random_database.server_secret_key,
     )
-    client_access_key = request.json.get(
+    client_access_key = request_json.get(
         "client_access_key",
         random_database.client_access_key,
     )
-    client_secret_key = request.json.get(
+    client_secret_key = request_json.get(
         "client_secret_key",
         random_database.client_secret_key,
     )
-    database_name = request.json.get(
+    database_name = request_json.get(
         "database_name",
         random_database.database_name,
     )
-    state_name = request.json.get(
+    state_name = request_json.get(
         "state_name",
         random_database.state.name,
     )
@@ -129,16 +134,22 @@ def create_database() -> tuple[str, int]:
     try:
         TARGET_MANAGER.add_database(database=database)
     except ValueError as exc:
-        return str(exc), HTTPStatus.CONFLICT
-
-    return jsonify(database.to_dict()), HTTPStatus.CREATED
+        return Response(
+            response=str(exc),
+            status=HTTPStatus.CONFLICT,
+        )
+
+    return Response(
+        response=json.dumps(database.to_dict()),
+        status=HTTPStatus.CREATED,
+    )
 
 
 @TARGET_MANAGER_FLASK_APP.route(
     "/databases/<string:database_name>/targets",
     methods=["POST"],
 )
-def create_target(database_name: str) -> tuple[str, int]:
+def create_target(database_name: str) -> Response:
     """
     Create a new target in a given database.
     """
@@ -147,27 +158,31 @@ def create_target(database_name: str) -> tuple[str, int]:
         for database in TARGET_MANAGER.databases
         if database.database_name == database_name
     ]
-    image_base64 = request.json["image_base64"]
+    request_json = json.loads(request.data)
+    image_base64 = request_json["image_base64"]
     image_bytes = base64.b64decode(s=image_base64)
     target = Target(
-        name=request.json["name"],
-        width=request.json["width"],
+        name=request_json["name"],
+        width=request_json["width"],
         image_value=image_bytes,
-        active_flag=request.json["active_flag"],
-        processing_time_seconds=request.json["processing_time_seconds"],
-        application_metadata=request.json["application_metadata"],
-        target_id=request.json["target_id"],
+        active_flag=request_json["active_flag"],
+        processing_time_seconds=request_json["processing_time_seconds"],
+        application_metadata=request_json["application_metadata"],
+        target_id=request_json["target_id"],
     )
     database.targets.add(target)
 
-    return jsonify(target.to_dict()), HTTPStatus.CREATED
+    return Response(
+        response=json.dumps(target.to_dict()),
+        status=HTTPStatus.CREATED,
+    )
 
 
 @TARGET_MANAGER_FLASK_APP.route(
     "/databases/<string:database_name>/targets/<string:target_id>",
     methods=["DELETE"],
 )
-def delete_target(database_name: str, target_id: str) -> tuple[str, int]:
+def delete_target(database_name: str, target_id: str) -> Response:
     """
     Delete a target.
     """
@@ -181,14 +196,17 @@ def delete_target(database_name: str, target_id: str) -> tuple[str, int]:
     new_target = dataclasses.replace(target, delete_date=now)
     database.targets.remove(target)
     database.targets.add(new_target)
-    return jsonify(new_target.to_dict()), HTTPStatus.OK
+    return Response(
+        response=json.dumps(new_target.to_dict()),
+        status=HTTPStatus.OK,
+    )
 
 
 @TARGET_MANAGER_FLASK_APP.route(
     "/databases/<string:database_name>/targets/<string:target_id>",
     methods=["PUT"],
 )
-def update_target(database_name: str, target_id: str) -> tuple[str, int]:
+def update_target(database_name: str, target_id: str) -> Response:
     """
     Update a target.
     """
@@ -199,17 +217,19 @@ def update_target(database_name: str, target_id: str) -> tuple[str, int]:
     ]
     target = database.get_target(target_id=target_id)
 
-    width = request.json.get("width", target.width)
-    name = request.json.get("name", target.name)
-    active_flag = request.json.get("active_flag", target.active_flag)
-    application_metadata = request.json.get(
+    request_json = json.loads(request.data)
+    width = request_json.get("width", target.width)
+    name = request_json.get("name", target.name)
+    active_flag = request_json.get("active_flag", target.active_flag)
+    application_metadata = request_json.get(
         "application_metadata",
         target.application_metadata,
     )
 
     image_value = target.image_value
-    if "image" in request.json:
-        image_value = base64.b64decode(s=request.json["image"])
+    request_json = json.loads(request.data)
+    if "image" in request_json:
+        image_value = base64.b64decode(s=request_json["image"])
 
     gmt = ZoneInfo("GMT")
     last_modified_date = datetime.datetime.now(tz=gmt)
@@ -227,7 +247,10 @@ def update_target(database_name: str, target_id: str) -> tuple[str, int]:
     database.targets.remove(target)
     database.targets.add(new_target)
 
-    return jsonify(new_target.to_dict()), HTTPStatus.OK
+    return Response(
+        response=json.dumps(new_target.to_dict()),
+        status=HTTPStatus.OK,
+    )
 
 
 if __name__ == "__main__":  # pragma: no cover

src/mock_vws/_flask_server/vwq.py

@@ -96,7 +96,9 @@ class ResponseNoContentTypeAdded(Response):
     Some of our responses need to not have a "Content-Type" header.
     """
 
-    default_mimetype = None
+    # The type in Flask is incorrect.
+    # See https://github.com/pallets/flask/pull/5034.
+    default_mimetype = None  # type: ignore[assignment]
 
 
 CLOUDRECO_FLASK_APP.response_class = ResponseNoContentTypeAdded

src/mock_vws/_flask_server/vws.py

@@ -67,7 +67,9 @@ class ResponseNoContentTypeAdded(Response):
     Some of our responses need to not have a "Content-Type" header.
     """
 
-    default_mimetype = None
+    # The type in Flask is incorrect.
+    # See https://github.com/pallets/flask/pull/5034.
+    default_mimetype = None  # type: ignore[assignment]
 
 
 VWS_FLASK_APP.response_class = ResponseNoContentTypeAdded