Type hints (#866)

* Tighten bounds on Settings

* Replace use of lru_cache with cache

CHANGELOG.md

@@ -16,6 +16,7 @@ Write the date in place of the "Unreleased" in the case a new version is release
 - Use schemas for describing server configuration on the client side too.
 - Refactored Authentication providers to make use of inheritance, adjusted
   mode in the `AboutAuthenticationProvider` schema to be `internal`|`external`.
+- Improved type hinting and efficiency of caching singleton values
 
 ## v0.1.0-b16 (2024-01-23)
 

tiled/config.py

@@ -8,7 +8,7 @@
 import warnings
 from collections import defaultdict
 from datetime import timedelta
-from functools import lru_cache
+from functools import cache
 from pathlib import Path
 
 import jsonschema
@@ -25,7 +25,7 @@
 from .validation_registration import validation_registry as default_validation_registry
 
 
-@lru_cache(maxsize=1)
+@cache
 def schema():
     "Load the schema for service-side configuration."
     import yaml

tiled/profiles.py

@@ -13,7 +13,7 @@
 import shutil
 import sys
 import warnings
-from functools import lru_cache
+from functools import cache
 from pathlib import Path
 
 import jsonschema
@@ -35,7 +35,7 @@
 ]
 
 
-@lru_cache(maxsize=1)
+@cache
 def schema():
     "Load the schema for profiles."
     import yaml
@@ -204,7 +204,7 @@ def resolve_precedence(levels):
     return combined
 
 
-@lru_cache(maxsize=1)
+@cache
 def load_profiles():
     """
     Return a mapping of profile_name to (source_path, content).

tiled/server/app.py

@@ -8,7 +8,7 @@
 import urllib.parse
 import warnings
 from contextlib import asynccontextmanager
-from functools import lru_cache, partial
+from functools import cache, partial
 from pathlib import Path
 from typing import List
 
@@ -437,15 +437,15 @@ async def unhandled_exception_handler(
         response_model=schemas.GetDistinctResponse,
     )(patch_route_signature(distinct, query_registry))
 
-    @lru_cache(1)
+    @cache
     def override_get_authenticators():
         return authenticators
 
-    @lru_cache(1)
+    @cache
     def override_get_root_tree():
         return tree
 
-    @lru_cache(1)
+    @cache
     def override_get_settings():
         settings = get_settings()
         for item in [
@@ -771,14 +771,14 @@ async def set_cookies(request: Request, call_next):
     app.dependency_overrides[get_settings] = override_get_settings
     if query_registry is not None:
 
-        @lru_cache(1)
+        @cache
         def override_get_query_registry():
             return query_registry
 
         app.dependency_overrides[get_query_registry] = override_get_query_registry
     if serialization_registry is not None:
 
-        @lru_cache(1)
+        @cache
         def override_get_serialization_registry():
             return serialization_registry
 
@@ -788,7 +788,7 @@ def override_get_serialization_registry():
 
     if validation_registry is not None:
 
-        @lru_cache(1)
+        @cache
         def override_get_validation_registry():
             return validation_registry
 

tiled/server/authentication.py

@@ -26,7 +26,6 @@
 from fastapi.security.api_key import APIKeyBase, APIKeyCookie, APIKeyQuery
 from fastapi.security.utils import get_authorization_scheme_param
 from fastapi.templating import Jinja2Templates
-from pydantic_settings import BaseSettings
 from sqlalchemy.future import select
 from sqlalchemy.orm import selectinload
 from sqlalchemy.sql import func
@@ -62,7 +61,7 @@
 from . import schemas
 from .core import DEFAULT_PAGE_SIZE, MAX_PAGE_SIZE, json_or_msgpack
 from .protocols import InternalAuthenticator, UserSessionState
-from .settings import get_settings
+from .settings import Settings, get_settings
 from .utils import API_KEY_COOKIE_NAME, get_authenticators, get_base_url
 
 ALGORITHM = "HS256"
@@ -214,7 +213,7 @@ async def get_decoded_access_token(
     request: Request,
     security_scopes: SecurityScopes,
     access_token: str = Depends(oauth2_scheme),
-    settings: BaseSettings = Depends(get_settings),
+    settings: Settings = Depends(get_settings),
 ):
     if not access_token:
         return None
@@ -239,7 +238,7 @@ async def get_current_principal(
     security_scopes: SecurityScopes,
     decoded_access_token: str = Depends(get_decoded_access_token),
     api_key: str = Depends(get_api_key),
-    settings: BaseSettings = Depends(get_settings),
+    settings: Settings = Depends(get_settings),
     authenticators=Depends(get_authenticators),
     db=Depends(get_database_session),
 ):
@@ -509,7 +508,7 @@ def build_auth_code_route(authenticator, provider):
 
     async def route(
         request: Request,
-        settings: BaseSettings = Depends(get_settings),
+        settings: Settings = Depends(get_settings),
         db=Depends(get_database_session),
     ):
         request.state.endpoint = "auth"
@@ -607,7 +606,7 @@ async def route(
         code: str = Form(),
         user_code: str = Form(),
         state: Optional[str] = None,
-        settings: BaseSettings = Depends(get_settings),
+        settings: Settings = Depends(get_settings),
         db=Depends(get_database_session),
     ):
         request.state.endpoint = "auth"
@@ -670,7 +669,7 @@ def build_device_code_token_route(authenticator, provider):
     async def route(
         request: Request,
         body: schemas.DeviceCode,
-        settings: BaseSettings = Depends(get_settings),
+        settings: Settings = Depends(get_settings),
         db=Depends(get_database_session),
     ):
         request.state.endpoint = "auth"
@@ -710,7 +709,7 @@ def build_handle_credentials_route(authenticator: InternalAuthenticator, provide
     async def route(
         request: Request,
         form_data: OAuth2PasswordRequestForm = Depends(),
-        settings: BaseSettings = Depends(get_settings),
+        settings: Settings = Depends(get_settings),
         db=Depends(get_database_session),
     ):
         request.state.endpoint = "auth"
@@ -962,7 +961,7 @@ async def apikey_for_principal(
 async def refresh_session(
     request: Request,
     refresh_token: schemas.RefreshToken,
-    settings: BaseSettings = Depends(get_settings),
+    settings: Settings = Depends(get_settings),
     db=Depends(get_database_session),
 ):
     "Obtain a new access token and refresh token."
@@ -975,7 +974,7 @@ async def refresh_session(
 async def revoke_session(
     request: Request,
     refresh_token: schemas.RefreshToken,
-    settings: BaseSettings = Depends(get_settings),
+    settings: Settings = Depends(get_settings),
     db=Depends(get_database_session),
 ):
     "Mark a Session as revoked so it cannot be refreshed again."

tiled/server/dependencies.py

@@ -1,4 +1,4 @@
-from functools import lru_cache
+from functools import cache
 from typing import Optional, Tuple, Union
 
 import pydantic_settings
@@ -24,25 +24,25 @@
 SLICE_REGEX = rf"^{DIM_REGEX}(?:,{DIM_REGEX})*$"
 
 
-@lru_cache(1)
+@cache
 def get_query_registry():
     "This may be overridden via dependency_overrides."
     return default_query_registry
 
 
-@lru_cache(1)
+@cache
 def get_deserialization_registry():
     "This may be overridden via dependency_overrides."
     return default_deserialization_registry
 
 
-@lru_cache(1)
+@cache
 def get_serialization_registry():
     "This may be overridden via dependency_overrides."
     return default_serialization_registry
 
 
-@lru_cache(1)
+@cache
 def get_validation_registry():
     "This may be overridden via dependency_overrides."
     return default_validation_registry

tiled/server/metrics.py

@@ -5,7 +5,7 @@
 """
 
 import os
-from functools import lru_cache
+from functools import cache
 
 from fastapi import APIRouter, Request, Response, Security
 from prometheus_client import CONTENT_TYPE_LATEST, Histogram, generate_latest
@@ -135,7 +135,7 @@ def capture_request_metrics(request, response):
             ).observe(metrics["compress"]["ratio"])
 
 
-@lru_cache()
+@cache
 def prometheus_registry():
     """
     Configure prometheus_client.