enable mypy, and fix code warnings produced by it

Author: Phil Varner

.pre-commit-config.yaml

@@ -15,3 +15,10 @@ repos:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        files: ".*\\.py$"
+        additional_dependencies:
+          - types-pyRFC3339~=1.1.1

bin/server.py

@@ -3,13 +3,14 @@
 from fastapi import FastAPI, Request
 
 from stapi_fastapi.backends.product_backend import ProductBackend
+from stapi_fastapi.backends.root_backend import RootBackend
 from stapi_fastapi.exceptions import ConstraintsException, NotFoundException
 from stapi_fastapi.models.opportunity import (
     Opportunity,
     OpportunityPropertiesBase,
     OpportunityRequest,
 )
-from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.order import Order, OrderCollection
 from stapi_fastapi.models.product import (
     Product,
     Provider,
@@ -22,15 +23,15 @@ class MockOrderDB(dict[int | str, Order]):
     pass
 
 
-class MockRootBackend:
+class MockRootBackend(RootBackend):
     def __init__(self, orders: MockOrderDB) -> None:
         self._orders: MockOrderDB = orders
 
-    async def get_orders(self, request: Request) -> list[Order]:
+    async def get_orders(self, request: Request) -> OrderCollection:
         """
         Show all orders.
         """
-        return list(self._orders.values())
+        return OrderCollection(features=list(self._orders.values()))
 
     async def get_order(self, order_id: str, request: Request) -> Order:
         """

src/stapi_fastapi/exceptions.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, Optional
 
 from fastapi import HTTPException, status
 
@@ -13,5 +13,5 @@ def __init__(self, detail: Any) -> None:
 
 
 class NotFoundException(StapiException):
-    def __init__(self, detail: Any) -> None:
+    def __init__(self, detail: Optional[Any] = None) -> None:
         super().__init__(status.HTTP_404_NOT_FOUND, detail)

src/stapi_fastapi/models/order.py

@@ -16,7 +16,7 @@ class OrderProperties(BaseModel):
 class Order(Feature[Geometry, OrderProperties]):
     # We need to enforce that orders have an id defined, as that is required to
     # retrieve them via the API
-    id: StrictInt | StrictStr  # type: ignore
+    id: StrictInt | StrictStr
     type: Literal["Feature"] = "Feature"
     links: list[Link] = Field(default_factory=list)
 

src/stapi_fastapi/routers/product_router.py

@@ -47,7 +47,8 @@ def __init__(
             name=f"{self.root_router.name}:{self.product.id}:search-opportunities",
             methods=["POST"],
             response_class=GeoJSONResponse,
-            response_model=OpportunityCollection[Geometry, self.product.constraints],
+            # unknown why mypy can't see the constraints property on Product, ignoring
+            response_model=OpportunityCollection[Geometry, self.product.constraints],  # type: ignore
             summary="Search Opportunities for the product",
         )
 

tests/backends.py

@@ -3,6 +3,7 @@
 from fastapi import Request
 
 from stapi_fastapi.backends.product_backend import ProductBackend
+from stapi_fastapi.backends.root_backend import RootBackend
 from stapi_fastapi.exceptions import ConstraintsException, NotFoundException
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
 from stapi_fastapi.models.order import Order, OrderCollection
@@ -13,15 +14,15 @@ class MockOrderDB(dict[int | str, Order]):
     pass
 
 
-class MockRootBackend:
+class MockRootBackend(RootBackend):
     def __init__(self, orders: MockOrderDB) -> None:
         self._orders = orders
 
     async def get_orders(self, request: Request) -> OrderCollection:
         """
         Show all orders.
         """
-        return list(self._orders.values())
+        return OrderCollection(features=list(self._orders.values()))
 
     async def get_order(self, order_id: str, request: Request) -> Order:
         """

tests/datetime_interval_test.py

@@ -16,7 +16,7 @@ class Model(BaseModel):
 
 
 def rfc3339_strftime(dt: datetime, format: str) -> str:
-    tds = timedelta_seconds(dt.tzinfo.utcoffset(dt))
+    tds = timedelta_seconds(dt.tzinfo.utcoffset(dt))  # type: ignore
     long = timezone(tds)
     short = "Z"