Merge pull request #105 from lsst-sqre/u/jsickcodes/flask2

Update to Flask 2

CHANGELOG.rst

@@ -5,7 +5,8 @@ Change log
 2.0.0 (Unreleased)
 ==================
 
-- Add support the testing mysql and postgres databases locally and in GitHub Actions.
+- Add support for testing mysql and postgres databases locally and in GitHub Actions.
+- Update to Flask 2.
 
 1.20.3 (2020-11-17)
 ===================

Makefile

@@ -19,16 +19,15 @@ help:
 .PHONY: update-deps
 update-deps:
 	pip install --upgrade pip-tools pip setuptools
-	pip-compile --upgrade --build-isolation --generate-hashes --output-file requirements/main.txt requirements/main.in
-	pip-compile --upgrade --build-isolation --generate-hashes --output-file requirements/dev.txt requirements/dev.in
+	pip-compile --upgrade --build-isolation --output-file requirements/main.txt requirements/main.in
+	pip-compile --upgrade --build-isolation --output-file requirements/dev.txt requirements/dev.in
 
 .PHONY: init
 init:
-	pip install --editable .
 	pip install --upgrade -r requirements/main.txt -r requirements/dev.txt
+	pip install --editable .
 	rm -rf .tox
-	pip install --upgrade pre-commit tox
-	pip install --pre --upgrade tox-docker
+	pip install --upgrade pre-commit tox tox-docker
 	pre-commit install
 
 .PHONY: update

keeper/api/dashboards.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Dict, Tuple
+from typing import Dict, Tuple
 
 from flask_accept import accept_fallback
 
@@ -14,15 +14,12 @@
 
 from ._models import QueuedResponse
 
-if TYPE_CHECKING:
-    from flask import Response
-
 
 @api.route("/dashboards", methods=["POST"])
 @accept_fallback
 @token_auth.login_required
 @permission_required(Permission.ADMIN_PRODUCT)
-def rebuild_all_dashboards() -> Tuple[Response, int, Dict[str, str]]:
+def rebuild_all_dashboards() -> Tuple[str, int, Dict[str, str]]:
     """Rebuild the LTD Dasher dashboards for all products.
 
     Note that dashboards are built asynchronously.

keeper/api/editions.py

@@ -26,8 +26,6 @@
 from ._urls import build_from_url, url_for_edition
 
 if TYPE_CHECKING:
-    from flask import Response
-
     from keeper.models import Build
 
 
@@ -207,7 +205,7 @@ def deprecate_edition(id: int) -> Tuple[str, int]:
 @api.route("/products/<slug>/editions/", methods=["GET"])
 @accept_fallback
 @log_route()
-def get_product_editions(slug: str) -> Response:
+def get_product_editions(slug: str) -> str:
     """List all editions published for a Product.
 
     **Example request**

keeper/api/queue.py

@@ -2,7 +2,7 @@
 
 from typing import Dict, Tuple
 
-from flask import abort, jsonify, url_for
+from flask import Response, abort, jsonify, url_for
 from flask_accept import accept_fallback
 
 from keeper.api import api
@@ -13,7 +13,7 @@
 @api.route("/queue/<id>", methods=["GET"])
 @accept_fallback
 @log_route()
-def get_task_status(id: int) -> Tuple[str, int, Dict[str, str]]:
+def get_task_status(id: int) -> Tuple[Response, int, Dict[str, str]]:
     try:
         if celery_app is not None:
             task = celery_app.AsyncResult(id)

keeper/appfactory.py

@@ -32,8 +32,9 @@ def create_flask_app(profile: Optional[str] = None) -> Flask:
     config[_profile].init_app(app)  # type: ignore  # doesn't recog classmethod
 
     # Add the middleware to respect headers forwarded from the proxy server
+    # Assigning to the wsgi_app method is recommended by the Flask docs
     if app.config["PROXY_FIX"]:
-        app.wsgi_app = ProxyFix(
+        app.wsgi_app = ProxyFix(  # type: ignore [assignment]
             app.wsgi_app,
             x_for=app.config["TRUST_X_FOR"],
             x_proto=app.config["TRUST_X_PROTO"],

keeper/v2api/tasks.py

@@ -4,7 +4,7 @@
 
 from typing import Dict, Tuple
 
-from flask import abort, jsonify
+from flask import Response, abort, jsonify
 from flask_accept import accept_fallback
 
 from keeper.auth import token_auth
@@ -19,7 +19,7 @@
 @accept_fallback
 @log_route()
 @token_auth.login_required
-def get_task(id: int) -> Tuple[str, int, Dict[str, str]]:
+def get_task(id: int) -> Tuple[Response, int, Dict[str, str]]:
     try:
         if celery_app is not None:
             task = celery_app.AsyncResult(id)

requirements/dev.in

@@ -14,7 +14,7 @@ sqlalchemy-stubs
 mock
 coverage[toml]
 mypy
-Sphinx<4
+Sphinx
 sphinx-rtd-theme
 numpydoc
 sphinxcontrib-httpdomain

requirements/main.in

@@ -5,7 +5,8 @@
 # After editing, update requirements/main.txt by running:
 #     make update-deps
 
-Flask<2
+Flask
+itsdangerous<2.1
 uWSGI
 Flask-SQLAlchemy
 SQLAlchemy