apply ruff linting/format & make mypy happy

Author: toro-berlin

stapi-fastapi/src/stapi_fastapi/backends/product_backend.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
-from collections.abc import Coroutine
-from typing import Any, Callable
+from collections.abc import Callable, Coroutine
+from typing import Any
 
 from fastapi import Request
 from returns.maybe import Maybe
@@ -18,7 +18,7 @@
 
 SearchOpportunities = Callable[
     [ProductRouter, OpportunityPayload, str | None, int, Request],
-    Coroutine[Any, Any, ResultE[tuple[list[Opportunity], Maybe[str]]]],
+    Coroutine[Any, Any, ResultE[tuple[list[Opportunity], Maybe[str]]]],  # type: ignore
 ]
 """
 Type alias for an async function that searches for ordering opportunities for the given
@@ -34,8 +34,10 @@
 Returns:
     A tuple containing a list of opportunities and a pagination token.
 
-    - Should return returns.result.Success[tuple[list[Opportunity], returns.maybe.Some[str]]] if including a pagination token
-    - Should return returns.result.Success[tuple[list[Opportunity], returns.maybe.Nothing]] if not including a pagination token
+    - Should return returns.result.Success[tuple[list[Opportunity], returns.maybe.Some[str]]]
+      if including a pagination token
+    - Should return returns.result.Success[tuple[list[Opportunity], returns.maybe.Nothing]]
+      if not including a pagination token
     - Returning returns.result.Failure[Exception] will result in a 500.
 
 Note:
@@ -66,7 +68,7 @@
 
 GetOpportunityCollection = Callable[
     [ProductRouter, str, Request],
-    Coroutine[Any, Any, ResultE[Maybe[OpportunityCollection]]],
+    Coroutine[Any, Any, ResultE[Maybe[OpportunityCollection]]],  # type: ignore
 ]
 """
 Type alias for an async function that retrieves the opportunity collection with
@@ -80,14 +82,14 @@
     request (Request): FastAPI's Request object.
 
 Returns:
-    - Should return returns.result.Success[returns.maybe.Some[OpportunityCollection]] if the opportunity collection is found.
-    - Should return returns.result.Success[returns.maybe.Nothing] if the opportunity collection is not found or if access is denied.
+    - Should return returns.result.Success[returns.maybe.Some[OpportunityCollection]]
+      if the opportunity collection is found.
+    - Should return returns.result.Success[returns.maybe.Nothing] if the opportunity collection is not found or
+      if access is denied.
     - Returning returns.result.Failure[Exception] will result in a 500.
 """
 
-CreateOrder = Callable[
-    [ProductRouter, OrderPayload, Request], Coroutine[Any, Any, ResultE[Order]]
-]
+CreateOrder = Callable[[ProductRouter, OrderPayload, Request], Coroutine[Any, Any, ResultE[Order]]]  # type: ignore
 """
 Type alias for an async function that creates a new order.
 

stapi-fastapi/src/stapi_fastapi/backends/root_backend.py

@@ -1,5 +1,5 @@
-from collections.abc import Coroutine
-from typing import Any, Callable, TypeVar
+from collections.abc import Callable, Coroutine
+from typing import Any, TypeVar
 
 from fastapi import Request
 from returns.maybe import Maybe
@@ -26,8 +26,10 @@
 Returns:
     A tuple containing a list of orders and a pagination token.
 
-    - Should return returns.result.Success[tuple[list[Order], returns.maybe.Some[str]]] if including a pagination token
-    - Should return returns.result.Success[tuple[list[Order], returns.maybe.Nothing]] if not including a pagination token
+    - Should return returns.result.Success[tuple[list[Order], returns.maybe.Some[str]]]
+      if including a pagination token
+    - Should return returns.result.Success[tuple[list[Order], returns.maybe.Nothing]]
+      if not including a pagination token
     - Returning returns.result.Failure[Exception] will result in a 500.
 """
 
@@ -65,8 +67,10 @@
 Returns:
     A tuple containing a list of order statuses and a pagination token.
 
-    - Should return returns.result.Success[returns.maybe.Some[tuple[list[OrderStatus], returns.maybe.Some[str]]] if order is found and including a pagination token.
-    - Should return returns.result.Success[returns.maybe.Some[tuple[list[OrderStatus], returns.maybe.Nothing]]] if order is found and not including a pagination token.
+    - Should return returns.result.Success[returns.maybe.Some[tuple[list[OrderStatus], returns.maybe.Some[str]]]
+      if order is found and including a pagination token.
+    - Should return returns.result.Success[returns.maybe.Some[tuple[list[OrderStatus], returns.maybe.Nothing]]]
+      if order is found and not including a pagination token.
     - Should return returns.result.Success[returns.maybe.Nothing] if the order is not found or if access is denied.
     - Returning returns.result.Failure[Exception] will result in a 500.
 """
@@ -84,14 +88,14 @@
     limit (int): The maximum number of search records to return in a page.
 
 Returns:
-    - Should return returns.result.Success[tuple[list[OpportunitySearchRecord], returns.maybe.Some[str]]] if including a pagination token
-    - Should return returns.result.Success[tuple[list[OpportunitySearchRecord], returns.maybe.Nothing]] if not including a pagination token
+    - Should return returns.result.Success[tuple[list[OpportunitySearchRecord], returns.maybe.Some[str]]]
+      if including a pagination token
+    - Should return returns.result.Success[tuple[list[OpportunitySearchRecord], returns.maybe.Nothing]]
+      if not including a pagination token
     - Returning returns.result.Failure[Exception] will result in a 500.
 """
 
-GetOpportunitySearchRecord = Callable[
-    [str, Request], Coroutine[Any, Any, ResultE[Maybe[OpportunitySearchRecord]]]
-]
+GetOpportunitySearchRecord = Callable[[str, Request], Coroutine[Any, Any, ResultE[Maybe[OpportunitySearchRecord]]]]
 """
 Type alias for an async function that gets the OpportunitySearchRecord with
 `search_record_id`.
@@ -102,6 +106,7 @@
 
 Returns:
     - Should return returns.result.Success[returns.maybe.Some[OpportunitySearchRecord]] if the search record is found.
-    - Should return returns.result.Success[returns.maybe.Nothing] if the search record is not found or if access is denied.
+    - Should return returns.result.Success[returns.maybe.Nothing] if the search record is not found or
+      if access is denied.
     - Returning returns.result.Failure[Exception] will result in a 500.
 """

stapi-fastapi/src/stapi_fastapi/exceptions.py

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

stapi-fastapi/src/stapi_fastapi/models/conformance.py

@@ -6,6 +6,4 @@
 
 
 class Conformance(BaseModel):
-    conforms_to: list[str] = Field(
-        default_factory=list, serialization_alias="conformsTo"
-    )
+    conforms_to: list[str] = Field(default_factory=list, serialization_alias="conformsTo")

stapi-fastapi/src/stapi_fastapi/models/order.py

@@ -1,6 +1,6 @@
 from collections.abc import Iterator
 from enum import StrEnum
-from typing import Any, Generic, Literal, Optional, TypeVar, Union
+from typing import Any, Generic, Literal, TypeVar
 
 from geojson_pydantic.base import _GeoJsonBase
 from geojson_pydantic.geometries import Geometry
@@ -18,7 +18,7 @@
 from stapi_fastapi.types.datetime_interval import DatetimeInterval
 from stapi_fastapi.types.filter import CQL2Filter
 
-Props = TypeVar("Props", bound=Union[dict[str, Any], BaseModel])
+Props = TypeVar("Props", bound=dict[str, Any] | BaseModel)
 Geom = TypeVar("Geom", bound=Geometry)
 
 
@@ -47,8 +47,8 @@ class OrderStatusCode(StrEnum):
 class OrderStatus(BaseModel):
     timestamp: AwareDatetime
     status_code: OrderStatusCode
-    reason_code: Optional[str] = None
-    reason_text: Optional[str] = None
+    reason_code: str | None = None
+    reason_text: str | None = None
     links: list[Link] = Field(default_factory=list)
 
     model_config = ConfigDict(extra="allow")
@@ -86,7 +86,7 @@ class Order(_GeoJsonBase):
     type: Literal["Feature"] = "Feature"
 
     geometry: Geometry = Field(...)
-    properties: OrderProperties = Field(...)
+    properties: OrderProperties[OrderStatus] = Field(...)
 
     links: list[Link] = Field(default_factory=list)
 

stapi-fastapi/src/stapi_fastapi/models/product.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from enum import StrEnum
-from typing import TYPE_CHECKING, Literal, Optional, Self
+from typing import TYPE_CHECKING, Any, Literal, Self
 
 from pydantic import AnyHttpUrl, BaseModel, Field
 
@@ -30,13 +30,13 @@ class ProviderRole(StrEnum):
 
 class Provider(BaseModel):
     name: str
-    description: Optional[str] = None
+    description: str | None = None
     roles: list[ProviderRole]
     url: AnyHttpUrl
 
     # redefining init is a hack to get str type to validate for `url`,
     # as str is ultimately coerced into an AnyHttpUrl automatically anyway
-    def __init__(self, url: AnyHttpUrl | str, **kwargs) -> None:
+    def __init__(self, url: AnyHttpUrl | str, **kwargs: Any) -> None:
         super().__init__(url=url, **kwargs)
 
 
@@ -62,15 +62,15 @@ class Product(BaseModel):
 
     def __init__(
         self,
-        *args,
+        *args: Any,
         constraints: type[Constraints],
         opportunity_properties: type[OpportunityProperties],
         order_parameters: type[OrderParameters],
         create_order: CreateOrder,
         search_opportunities: SearchOpportunities | None = None,
         search_opportunities_async: SearchOpportunitiesAsync | None = None,
         get_opportunity_collection: GetOpportunityCollection | None = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         super().__init__(*args, **kwargs)
 
@@ -101,17 +101,13 @@ def search_opportunities(self) -> SearchOpportunities:
     @property
     def search_opportunities_async(self) -> SearchOpportunitiesAsync:
         if not self._search_opportunities_async:
-            raise AttributeError(
-                "This product does not support async opportunity search"
-            )
+            raise AttributeError("This product does not support async opportunity search")
         return self._search_opportunities_async
 
     @property
     def get_opportunity_collection(self) -> GetOpportunityCollection:
         if not self._get_opportunity_collection:
-            raise AttributeError(
-                "This product does not support async opportunity search"
-            )
+            raise AttributeError("This product does not support async opportunity search")
         return self._get_opportunity_collection
 
     @property
@@ -132,10 +128,7 @@ def supports_opportunity_search(self) -> bool:
 
     @property
     def supports_async_opportunity_search(self) -> bool:
-        return (
-            self._search_opportunities_async is not None
-            and self._get_opportunity_collection is not None
-        )
+        return self._search_opportunities_async is not None and self._get_opportunity_collection is not None
 
     def with_links(self, links: list[Link] | None = None) -> Self:
         if not links:
@@ -147,8 +140,6 @@ def with_links(self, links: list[Link] | None = None) -> Self:
 
 
 class ProductsCollection(BaseModel):
-    type_: Literal["ProductCollection"] = Field(
-        default="ProductCollection", alias="type"
-    )
+    type_: Literal["ProductCollection"] = Field(default="ProductCollection", alias="type")
     links: list[Link] = Field(default_factory=list)
     products: list[Product]

stapi-fastapi/src/stapi_fastapi/models/shared.py

@@ -22,7 +22,7 @@ class Link(BaseModel):
 
     # redefining init is a hack to get str type to validate for `href`,
     # as str is ultimately coerced into an AnyUrl automatically anyway
-    def __init__(self, href: AnyUrl | str, **kwargs):
+    def __init__(self, href: AnyUrl | str, **kwargs: Any) -> None:
         super().__init__(href=href, **kwargs)
 
     # overriding the default serialization to filter None field values from