Add type hints to src/palace/manager/api/admin/ code.

Author: dbernstein

pyproject.toml

@@ -75,11 +75,6 @@ disallow_incomplete_defs = false
 disallow_untyped_decorators = false
 disallow_untyped_defs = false
 module = [
-    "palace.manager.api.admin.admin_authentication_provider",
-    "palace.manager.api.admin.model.custom_lists",
-    "palace.manager.api.admin.password_admin_authentication_provider",
-    "palace.manager.api.admin.routes",
-    "palace.manager.api.admin.validator",
     "palace.manager.api.annotations",
     "palace.manager.api.app",
     "palace.manager.api.authentication.base",

src/palace/manager/api/admin/admin_authentication_provider.py

@@ -1,9 +1,17 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from palace.manager.sqlalchemy.model.admin import Admin
+
+
 class AdminAuthenticationProvider:
-    def sign_in_template(self, redirect_url):
+    def sign_in_template(self, redirect_url: str | None) -> str:
         # Returns HTML to be rendered on the sign in page for
         # this authentication provider.
         raise NotImplementedError()
 
-    def active_credentials(self, admin):
+    def active_credentials(self, admin: Admin) -> bool:
         # Returns True if the admin's credentials are not expired.
         raise NotImplementedError()

src/palace/manager/api/admin/controller/collection_settings.py

@@ -13,6 +13,7 @@
 from palace.manager.api.admin.problem_details import (
     CANNOT_DELETE_COLLECTION_WITH_CHILDREN,
     MISSING_COLLECTION,
+    MISSING_IDENTIFIER,
     MISSING_PARENT,
     MISSING_SERVICE,
     PROTOCOL_DOES_NOT_SUPPORT_PARENTS,
@@ -171,13 +172,17 @@ def process_deleted_libraries(
             reap_unassociated_loans.delay()
             reap_unassociated_holds.delay()
 
-    def process_delete(self, service_id: int) -> Response | ProblemDetail:
+    def process_delete(self, service_id: int | str) -> Response | ProblemDetail:
         self.require_system_admin()
+        try:
+            sid = int(service_id) if isinstance(service_id, str) else service_id
+        except ValueError:
+            return MISSING_SERVICE
 
         integration = get_one(
             self._db,
             IntegrationConfiguration,
-            id=service_id,
+            id=sid,
             goal=self.registry.goal,
         )
         if not integration:
@@ -196,8 +201,13 @@ def process_delete(self, service_id: int) -> Response | ProblemDetail:
         return Response("Deleted", 200)
 
     def process_collection_self_tests(
-        self, identifier: int | None
+        self, identifier: int | str | None
     ) -> Response | ProblemDetail:
+        if identifier is not None and isinstance(identifier, str):
+            try:
+                identifier = int(identifier)
+            except ValueError:
+                return MISSING_IDENTIFIER
         return self.process_self_tests(identifier)
 
     def run_self_tests(

src/palace/manager/api/admin/controller/dashboard.py

@@ -14,6 +14,7 @@
 from palace.manager.api.local_analytics_exporter import LocalAnalyticsExporter
 from palace.manager.api.util.flask import get_request_library
 from palace.manager.sqlalchemy.model.admin import Admin
+from palace.manager.util.problem_detail import ProblemDetail
 
 
 class DashboardController(CirculationManagerController):
@@ -25,7 +26,7 @@ def stats(
 
     def bulk_circulation_events(
         self, analytics_exporter: LocalAnalyticsExporter | None = None
-    ) -> tuple[str, str, str, str | None]:
+    ) -> tuple[str | ProblemDetail, str, str, str | None]:
         date_format = "%Y-%m-%d"
 
         def get_date(field: str) -> date:

src/palace/manager/api/admin/model/custom_lists.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from pydantic import NonNegativeInt
 
 from palace.manager.util.flask_util import CustomBaseModel
@@ -11,10 +13,10 @@ class CustomListSharePostResponse(CustomBaseModel):
 class CustomListPostRequest(CustomBaseModel):
     name: str
     id: NonNegativeInt | None = None
-    entries: list[dict] = []
+    entries: list[dict[str, Any]] = []
     collections: list[int] = []
-    deletedEntries: list[dict] = []
+    deletedEntries: list[dict[str, Any]] = []
     # For auto updating lists
     auto_update: bool = False
-    auto_update_query: dict | None = None
-    auto_update_facets: dict | None = None
+    auto_update_query: dict[str, Any] | None = None
+    auto_update_facets: dict[str, Any] | None = None

src/palace/manager/api/admin/password_admin_authentication_provider.py

@@ -1,5 +1,7 @@
-from flask import render_template, url_for
+from flask import Response, render_template, url_for
 from sqlalchemy.orm.session import Session
+from werkzeug.datastructures import ImmutableMultiDict
+from werkzeug.wrappers.response import Response as WerkzeugResponse
 
 from palace.manager.api.admin.admin_authentication_provider import (
     AdminAuthenticationProvider,
@@ -28,7 +30,7 @@ def __init__(self, send_email: SendEmailCallable):
     def get_secret_key(db: Session) -> str:
         return Key.get_key(db, KeyType.ADMIN_SECRET_KEY, raise_exception=True).value
 
-    def sign_in_template(self, redirect):
+    def sign_in_template(self, redirect: str | None) -> str:
         password_sign_in_url = url_for("password_auth")
         forgot_password_url = url_for("admin_forgot_password")
         return render_template(
@@ -44,7 +46,9 @@ def sign_in_template(self, redirect):
         )
 
     @staticmethod
-    def forgot_password_template(redirect):
+    def forgot_password_template(
+        redirect: str | None | Response | WerkzeugResponse,
+    ) -> str:
         forgot_password_url = url_for("admin_forgot_password")
         return render_template(
             "admin/auth/forgot-password.html.jinja2",
@@ -56,7 +60,11 @@ def forgot_password_template(redirect):
         )
 
     @staticmethod
-    def reset_password_template(reset_password_token, admin_id, redirect):
+    def reset_password_template(
+        reset_password_token: str,
+        admin_id: int,
+        redirect: str | None | Response | WerkzeugResponse,
+    ) -> str:
         reset_password_url = url_for(
             "admin_reset_password",
             reset_password_token=reset_password_token,
@@ -71,7 +79,13 @@ def reset_password_template(reset_password_token, admin_id, redirect):
             button_style=button_style,
         )
 
-    def sign_in(self, _db, request={}):
+    def sign_in(
+        self,
+        _db: Session,
+        request: ImmutableMultiDict[str, str] | dict[str, str | None] | None = None,
+    ) -> tuple[dict[str, str], str | None] | tuple[ProblemDetail, None]:
+        if request is None:
+            request = {}
         email = request.get("email")
         password = request.get("password")
         redirect_url = request.get("redirect")
@@ -91,7 +105,7 @@ def sign_in(self, _db, request={}):
 
         return INVALID_ADMIN_CREDENTIALS, None
 
-    def active_credentials(self, admin):
+    def active_credentials(self, admin: Admin) -> bool:
         # Admins who have a password are always active.
         return True