change types of backend methods, refactor use of mypy

Author: Phil Varner

.github/workflows/pr.yml

@@ -24,5 +24,6 @@ jobs:
         run: |
           python -m pip install pre-commit
           pre-commit run --all-files
+          mypy src 
       - name: Run tests
         run: poetry run nox

.pre-commit-config.yaml

@@ -19,6 +19,11 @@ repos:
     rev: v1.13.0
     hooks:
       - id: mypy
-        files: ".*\\.py$"
+        args: []  # override default of [--strict, --ignore-missing-imports]
+        files: src/
         additional_dependencies:
           - types-pyRFC3339~=1.1.1
+          - pydantic~=2.9.2
+          - returns~=0.23.0
+          - fastapi~=0.115.0
+          - geojson_pydantic~=1.1.1

bin/server.py

@@ -2,12 +2,11 @@
 from uuid import uuid4
 
 from fastapi import FastAPI, Request
-from returns.maybe import Maybe, Nothing
+from returns.maybe import Maybe
 from returns.result import Failure, Result, Success
 
 from stapi_fastapi.backends.product_backend import ProductBackend
 from stapi_fastapi.backends.root_backend import RootBackend
-from stapi_fastapi.exceptions import failure_with
 from stapi_fastapi.models.conformance import CORE
 from stapi_fastapi.models.opportunity import (
     Opportunity,
@@ -39,24 +38,20 @@ class MockRootBackend(RootBackend):
     def __init__(self, orders: MockOrderDB) -> None:
         self._orders: MockOrderDB = orders
 
-    async def get_orders(
-        self, request: Request
-    ) -> Result[OrderCollection, Maybe[Exception]]:
+    async def get_orders(self, request: Request) -> Result[OrderCollection, Exception]:
         """
         Show all orders.
         """
         return Success(OrderCollection(features=list(self._orders.values())))
 
     async def get_order(
         self, order_id: str, request: Request
-    ) -> Result[Order, Maybe[Exception]]:
+    ) -> Result[Maybe[Order], Exception]:
         """
         Show details for order with `order_id`.
         """
-        if order := self._orders.get(order_id):
-            return Success(order)
 
-        return Failure(Nothing)
+        return Success(Maybe.from_optional(self._orders.get(order_id)))
 
 
 class MockProductBackend(ProductBackend):
@@ -70,17 +65,17 @@ async def search_opportunities(
         product_router: ProductRouter,
         search: OpportunityRequest,
         request: Request,
-    ) -> Result[list[Opportunity], Maybe[Exception]]:
+    ) -> Result[list[Opportunity], Exception]:
         try:
             return Success(
                 [o.model_copy(update=search.model_dump()) for o in self._opportunities]
             )
         except Exception as e:
-            return failure_with(e)
+            return Failure(e)
 
     async def create_order(
         self, product_router: ProductRouter, payload: OrderRequest, request: Request
-    ) -> Result[Order, Maybe[Exception]]:
+    ) -> Result[Order, Exception]:
         """
         Create a new order.
         """
@@ -112,7 +107,7 @@ async def create_order(
             self._orders[order.id] = order
             return Success(order)
         except Exception as e:
-            return failure_with(e)
+            return Failure(e)
 
 
 class MyOpportunityProperties(OpportunityProperties):

pyproject.toml

@@ -29,6 +29,7 @@ pytest-coverage = "^0.0"
 pyrfc3339 = "^1.1"
 pre-commit = "^3.7.0"
 nox = "^2024.4.15"
+mypy = "^1.13.0"
 
 [tool.poetry.scripts]
 dev = "stapi_fastapi.__dev__:cli"
@@ -78,3 +79,10 @@ build-backend = "poetry_dynamic_versioning.backend"
 
 [tool.poetry-dynamic-versioning]
 enable = true
+
+[[tool.mypy.overrides]]
+module = "pygeofilter.parsers.*"
+ignore_missing_imports = true
+
+# [tool.mypy]
+#plugins = ['pydantic.mypy']

src/stapi_fastapi/backends/product_backend.py

@@ -3,7 +3,6 @@
 from typing import Protocol
 
 from fastapi import Request
-from returns.maybe import Maybe
 from returns.result import Result
 
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
@@ -17,7 +16,7 @@ async def search_opportunities(
         product_router: ProductRouter,
         search: OpportunityRequest,
         request: Request,
-    ) -> Result[list[Opportunity], Maybe[Exception]]:
+    ) -> Result[list[Opportunity], Exception]:
         """
         Search for ordering opportunities for the  given search parameters.
 
@@ -30,7 +29,7 @@ async def create_order(
         product_router: ProductRouter,
         search: OrderRequest,
         request: Request,
-    ) -> Result[Order, Maybe[Exception]]:
+    ) -> Result[Order, Exception]:
         """
         Create a new order.
 

src/stapi_fastapi/backends/root_backend.py

@@ -8,17 +8,15 @@
 
 
 class RootBackend(Protocol):  # pragma: nocover
-    async def get_orders(
-        self, request: Request
-    ) -> Result[OrderCollection, Maybe[Exception]]:
+    async def get_orders(self, request: Request) -> Result[OrderCollection, Exception]:
         """
         Return a list of existing orders.
         """
         ...
 
     async def get_order(
         self, order_id: str, request: Request
-    ) -> Result[Order, Maybe[Exception]]:
+    ) -> Result[Maybe[Order], Exception]:
         """
         Get details for order with `order_id`.
 

src/stapi_fastapi/exceptions.py

@@ -1,12 +1,6 @@
 from typing import Any, Optional
 
 from fastapi import HTTPException, status
-from returns.maybe import Some
-from returns.result import Failure
-
-
-def failure_with(e: Exception) -> Failure[Some[Exception]]:
-    return Failure(Some(e))
 
 
 class StapiException(HTTPException):

src/stapi_fastapi/models/product.py

@@ -84,6 +84,8 @@ def with_links(self: Self, links: list[Link] | None = None) -> Self:
 
 
 class ProductsCollection(BaseModel):
-    type_: Literal["ProductCollection"] = Field("ProductCollection", alias="type")
+    type_: Literal["ProductCollection"] = Field(
+        default="ProductCollection", alias="type"
+    )
     links: list[Link] = Field(default_factory=list)
     products: list[Product]

src/stapi_fastapi/types/filter.py

@@ -1,10 +1,10 @@
-from typing import Annotated
+from typing import Annotated, Any
 
 from pydantic import BeforeValidator
 from pygeofilter.parsers import cql2_json
 
 
-def validate(v: dict):
+def validate(v: dict[str, Any]) -> dict[str, Any]:
     if v:
         try:
             cql2_json.parse({"filter": v})

src/stapi_fastapi/types/json_schema_model.py

@@ -8,7 +8,7 @@
 )
 
 
-def validate(v: Any):
+def validate(v: Any) -> Any:
     if not issubclass(v, BaseModel):
         raise RuntimeError("BaseModel class required")
     return v