API server code health pass - reduce use of request global (#1069)

Author: rzats

src/server/_pandas.py

@@ -1,6 +1,7 @@
 from typing import Dict, Any, Optional
 import pandas as pd
 
+from flask import request
 from sqlalchemy import text
 from sqlalchemy.engine.base import Engine
 
@@ -20,7 +21,7 @@ def as_pandas(query: str, params: Dict[str, Any], db_engine: Engine = engine, pa
 
 
 def print_pandas(df: pd.DataFrame):
-    p = create_printer()
+    p = create_printer(request.values.get("format"))
 
     def gen():
         for row in df.to_dict(orient="records"):

src/server/_params.py

@@ -446,7 +446,7 @@ def parse_source_signal_sets() -> List[SourceSignalSet]:
     ds = request.values.get("data_source")
     if ds:
         # old version
-        require_any("signal", "signals", empty=True)
+        require_any(request, "signal", "signals", empty=True)
         signals = extract_strings(("signals", "signal"))
         if len(signals) == 1 and signals[0] == "*":
             return [SourceSignalSet(ds, True)]
@@ -462,7 +462,7 @@ def parse_geo_sets() -> List[GeoSet]:
     geo_type = request.values.get("geo_type")
     if geo_type:
         # old version
-        require_any("geo_value", "geo_values", empty=True)
+        require_any(request, "geo_value", "geo_values", empty=True)
         geo_values = extract_strings(("geo_values", "geo_value"))
         if len(geo_values) == 1 and geo_values[0] == "*":
             return [GeoSet(geo_type, True)]
@@ -478,7 +478,7 @@ def parse_time_set() -> TimeSet:
     time_type = request.values.get("time_type")
     if time_type:
         # old version
-        require_all("time_type", "time_values")
+        require_all(request, "time_type", "time_values")
         time_values = extract_dates("time_values")
         if time_values == ["*"]:
             return TimeSet(time_type, True)

src/server/_printer.py

@@ -2,7 +2,7 @@
 from io import StringIO
 from typing import Any, Dict, Iterable, List, Optional, Union
 
-from flask import Response, jsonify, request, stream_with_context
+from flask import Response, jsonify, stream_with_context
 from flask.json import dumps
 import orjson
 
@@ -11,12 +11,10 @@
 from .utils.logger import get_structured_logger
 
 
-def print_non_standard(data):
+def print_non_standard(format: str, data):
     """
     prints a non standard JSON message
     """
-
-    format = request.values.get("format", "classic")
     if format == "json":
         return jsonify(data)
 
@@ -250,8 +248,9 @@ def _end(self):
         return b""
 
 
-def create_printer() -> APrinter:
-    format: str = request.values.get("format", "classic")
+def create_printer(format: str) -> APrinter:
+    if format is None:
+        return ClassicPrinter()
     if format == "tree":
         return ClassicTreePrinter("signal")
     if format.startswith("tree-"):

src/server/_query.py

@@ -12,6 +12,7 @@
     cast
 )
 
+from flask import request
 from sqlalchemy import text
 from sqlalchemy.engine import Row
 
@@ -259,7 +260,7 @@ def execute_queries(
     execute the given queries and return the response to send them
     """
 
-    p = create_printer()
+    p = create_printer(request.values.get("format"))
 
     fields_to_send = set(extract_strings("fields") or [])
     if fields_to_send:

src/server/_validate.py

@@ -1,12 +1,11 @@
-from typing import List, Optional, Sequence, Tuple, Union
+from typing import Optional
 
-from flask import request
+from flask import Request
 
 from ._exceptions import UnAuthenticatedException, ValidationFailedException
-from .utils import IntRange, TimeValues
 
 
-def resolve_auth_token() -> Optional[str]:
+def resolve_auth_token(request: Request) -> Optional[str]:
     # auth request param
     if "auth" in request.values:
         return request.values["auth"]
@@ -20,8 +19,8 @@ def resolve_auth_token() -> Optional[str]:
     return None
 
 
-def check_auth_token(token: str, optional=False) -> bool:
-    value = resolve_auth_token()
+def check_auth_token(request: Request, token: str, optional=False) -> bool:
+    value = resolve_auth_token(request)
 
     if value is None:
         if optional:
@@ -35,7 +34,7 @@ def check_auth_token(token: str, optional=False) -> bool:
     return valid_token
 
 
-def require_all(*values: str) -> bool:
+def require_all(request: Request, *values: str) -> bool:
     """
     returns true if all fields are present in the request otherwise raises an exception
     :returns bool
@@ -46,7 +45,7 @@ def require_all(*values: str) -> bool:
     return True
 
 
-def require_any(*values: str, empty=False) -> bool:
+def require_any(request: Request, *values: str, empty=False) -> bool:
     """
     returns true if any fields are present in the request otherwise raises an exception
     :returns bool

src/server/endpoints/afhsb.py

@@ -1,6 +1,6 @@
 from typing import Dict, List
 
-from flask import Blueprint
+from flask import Blueprint, request
 
 from .._config import AUTH
 from .._params import extract_integers, extract_strings
@@ -54,8 +54,8 @@ def _split_flu_types(flu_types: List[str]):
 
 @bp.route("/", methods=("GET", "POST"))
 def handle():
-    check_auth_token(AUTH["afhsb"])
-    require_all("locations", "epiweeks", "flu_types")
+    check_auth_token(request, AUTH["afhsb"])
+    require_all(request, "locations", "epiweeks", "flu_types")
 
     locations = extract_strings("locations")
     epiweeks = extract_integers("epiweeks")

src/server/endpoints/cdc.py

@@ -1,4 +1,4 @@
-from flask import Blueprint
+from flask import Blueprint, request
 
 from .._config import AUTH, NATION_REGION, REGION_TO_STATE
 from .._params import extract_strings, extract_integers
@@ -12,8 +12,8 @@
 
 @bp.route("/", methods=("GET", "POST"))
 def handle():
-    check_auth_token(AUTH["cdc"])
-    require_all("locations", "epiweeks")
+    check_auth_token(request, AUTH["cdc"])
+    require_all(request, "locations", "epiweeks")
 
     # parse the request
     locations = extract_strings("locations")

src/server/endpoints/covid_hosp_facility.py

@@ -1,4 +1,4 @@
-from flask import Blueprint
+from flask import Blueprint, request
 
 from .._params import extract_integers, extract_strings
 from .._query import execute_query, QueryBuilder
@@ -10,7 +10,7 @@
 
 @bp.route("/", methods=("GET", "POST"))
 def handle():
-    require_all("hospital_pks", "collection_weeks")
+    require_all(request, "hospital_pks", "collection_weeks")
     hospital_pks = extract_strings("hospital_pks")
     collection_weeks = extract_integers("collection_weeks")
     publication_dates = extract_integers("publication_dates")

src/server/endpoints/covid_hosp_facility_lookup.py

@@ -1,4 +1,4 @@
-from flask import Blueprint
+from flask import Blueprint, request
 
 from .._params import extract_strings
 from .._query import execute_query, QueryBuilder
@@ -10,7 +10,7 @@
 
 @bp.route("/", methods=("GET", "POST"))
 def handle():
-    require_any("state", "ccn", "city", "zip", "fips_code")
+    require_any(request, "state", "ccn", "city", "zip", "fips_code")
     state = extract_strings("state")
     ccn = extract_strings("ccn")
     city = extract_strings("city")

src/server/endpoints/covid_hosp_state_timeseries.py

@@ -1,4 +1,4 @@
-from flask import Blueprint
+from flask import Blueprint, request
 
 from .._params import extract_integers, extract_strings, extract_date
 from .._query import execute_query, QueryBuilder
@@ -11,7 +11,7 @@
 
 @bp.route("/", methods=("GET", "POST"))
 def handle():
-    require_all("states", "dates")
+    require_all(request, "states", "dates")
     states = extract_strings("states")
     dates = extract_integers("dates")
     issues = extract_integers("issues")