introduce mypy

Author: pgorecki

pyproject.toml

@@ -54,3 +54,7 @@ compose_up = "docker-compose -f docker-compose.dev.yml up"
 
 [tool.black]
 exclude = 'tmp'
+
+[tool.mypy]
+mypy_path = "src"
+

src/api/models/bidding.py

@@ -1,23 +1,24 @@
 from datetime import datetime
-from uuid import UUID
 
 from pydantic import BaseModel
 
+from seedwork.domain.value_objects import GenericUUID
+
 
 class BidReadModel(BaseModel):
     amount: float
     currency: str
-    bidder_id: UUID
+    bidder_id: GenericUUID
     bidder_username: str
 
 
 class BiddingResponse(BaseModel):
-    listing_id: UUID
+    listing_id: GenericUUID
     auction_status: str = "active"  # active, ended
     auction_end_date: datetime
     bids: list[BidReadModel]
 
 
 class PlaceBidRequest(BaseModel):
-    bidder_id: UUID
+    bidder_id: GenericUUID
     amount: float

src/api/routers/catalog.py

@@ -1,6 +1,4 @@
-import uuid
 from typing import Annotated
-from uuid import UUID
 
 from fastapi import APIRouter, Depends
 
@@ -14,7 +12,7 @@
 )
 from modules.catalog.application.query.get_all_listings import GetAllListings
 from modules.catalog.application.query.get_listing_details import GetListingDetails
-from seedwork.domain.value_objects import Money
+from seedwork.domain.value_objects import GenericUUID, Money
 
 """
 Inspired by https://developer.ebay.com/api-docs/sell/inventory/resources/offer/methods/createOffer
@@ -60,7 +58,7 @@ async def create_listing(
     Creates a new listing
     """
     command = CreateListingDraftCommand(
-        listing_id=uuid.uuid4(),
+        listing_id=GenericUUID.next_id(),
         title=request_body.title,
         description=request_body.description,
         ask_price=Money(request_body.ask_price_amount, request_body.ask_price_currency),
@@ -100,7 +98,7 @@ async def delete_listing(
 )
 @inject
 async def publish_listing(
-    listing_id: UUID,
+    listing_id: GenericUUID,
     app: Annotated[Application, Depends(get_application)],
     current_user: Annotated[User, Depends(get_authenticated_user)],
 ):

src/api/tests/test_bidding.py

@@ -4,7 +4,7 @@
     CreateListingDraftCommand,
     PublishListingDraftCommand,
 )
-from seedwork.domain.value_objects import UUID, Money
+from seedwork.domain.value_objects import GenericUUID, Money
 from seedwork.infrastructure.logging import logger
 
 
@@ -44,9 +44,9 @@ def setup_app_for_bidding_tests(app, listing_id, seller_id, bidder_id):
 
 @pytest.mark.integration
 def test_place_bid(app, api_client):
-    listing_id = UUID(int=1)
-    seller_id = UUID(int=2)
-    bidder_id = UUID(int=3)
+    listing_id = GenericUUID(int=1)
+    seller_id = GenericUUID(int=2)
+    bidder_id = GenericUUID(int=3)
     setup_app_for_bidding_tests(app, listing_id, seller_id, bidder_id)
 
     url = f"/bidding/{listing_id}/place_bid"

src/api/tests/test_catalog.py

@@ -4,7 +4,7 @@
     CreateListingDraftCommand,
     PublishListingDraftCommand,
 )
-from seedwork.domain.value_objects import UUID, Money
+from seedwork.domain.value_objects import GenericUUID, Money
 
 
 @pytest.mark.integration
@@ -17,13 +17,13 @@ def test_empty_catalog_list(api_client):
 @pytest.mark.integration
 def test_catalog_list_with_one_item(app, api_client):
     # arrange
-    command_result = app.execute_command(
+    app.execute_command(
         CreateListingDraftCommand(
-            listing_id=UUID(int=1),
+            listing_id=GenericUUID(int=1),
             title="Foo",
             description="Bar",
             ask_price=Money(10),
-            seller_id=UUID("00000000000000000000000000000002"),
+            seller_id=GenericUUID(int=2),
         )
     )
 
@@ -37,7 +37,7 @@ def test_catalog_list_with_one_item(app, api_client):
     assert response.json() == {
         "data": [
             {
-                "id": str(UUID(int=1)),
+                "id": str(GenericUUID(int=1)),
                 "title": "Foo",
                 "description": "Bar",
                 "ask_price_amount": 10.0,
@@ -52,20 +52,20 @@ def test_catalog_list_with_two_items(app, api_client):
     # arrange
     app.execute_command(
         CreateListingDraftCommand(
-            listing_id=UUID(int=1),
+            listing_id=GenericUUID(int=1),
             title="Foo #1",
             description="Bar",
             ask_price=Money(10),
-            seller_id=UUID("00000000000000000000000000000002"),
+            seller_id=GenericUUID(int=2),
         )
     )
     app.execute_command(
         CreateListingDraftCommand(
-            listing_id=UUID(int=2),
+            listing_id=GenericUUID(int=2),
             title="Foo #2",
             description="Bar",
             ask_price=Money(10),
-            seller_id=UUID("00000000000000000000000000000002"),
+            seller_id=GenericUUID(int=2),
         )
     )
 
@@ -90,22 +90,22 @@ def test_catalog_delete_draft(app, authenticated_api_client):
     current_user = authenticated_api_client.current_user
     app.execute_command(
         CreateListingDraftCommand(
-            listing_id=UUID(int=1),
+            listing_id=GenericUUID(int=1),
             title="Listing to be deleted",
             description="...",
             ask_price=Money(10),
             seller_id=current_user.id,
         )
     )
 
-    response = authenticated_api_client.delete(f"/catalog/{str(UUID(int=1))}")
+    response = authenticated_api_client.delete(f"/catalog/{str(GenericUUID(int=1))}")
 
     assert response.status_code == 204
 
 
 @pytest.mark.integration
 def test_catalog_delete_non_existing_draft_returns_404(authenticated_api_client):
-    listing_id = UUID("00000000000000000000000000000001")
+    listing_id = GenericUUID(int=1)
     response = authenticated_api_client.delete(f"/catalog/{listing_id}")
     assert response.status_code == 404
 
@@ -114,7 +114,7 @@ def test_catalog_delete_non_existing_draft_returns_404(authenticated_api_client)
 def test_catalog_publish_listing_draft(app, authenticated_api_client):
     # arrange
     current_user = authenticated_api_client.current_user
-    listing_id = UUID(int=1)
+    listing_id = GenericUUID(int=1)
     app.execute_command(
         CreateListingDraftCommand(
             listing_id=listing_id,
@@ -134,7 +134,7 @@ def test_catalog_publish_listing_draft(app, authenticated_api_client):
 
 def test_published_listing_appears_in_biddings(app, authenticated_api_client):
     # arrange
-    listing_id = UUID(int=1)
+    listing_id = GenericUUID(int=1)
     current_user = authenticated_api_client.current_user
     app.execute_command(
         CreateListingDraftCommand(

src/api/tests/test_login.py

@@ -1,7 +1,7 @@
 import pytest
 
 from modules.iam.application.services import IamService
-from seedwork.domain.value_objects import UUID
+from seedwork.domain.value_objects import GenericUUID
 
 
 @pytest.mark.integration
@@ -10,7 +10,7 @@ def test_login_with_api_token(app, api_client):
     with app.transaction_context() as ctx:
         iam_service = ctx.get_service(IamService)
         iam_service.create_user(
-            user_id=UUID(int=1),
+            user_id=GenericUUID(int=1),
             email="[email protected]",
             password="admin",
             access_token="token",
@@ -33,7 +33,7 @@ def test_login_with_invalid_username_returns_400(app, api_client):
     with app.transaction_context() as ctx:
         iam_service = ctx.get_service(IamService)
         iam_service.create_user(
-            user_id=UUID(int=1),
+            user_id=GenericUUID(int=1),
             email="[email protected]",
             password="admin",
             access_token="token",
@@ -55,7 +55,7 @@ def test_login_with_invalid_password_returns_400(app, api_client):
     with app.transaction_context() as ctx:
         iam_service = ctx.get_service(IamService)
         iam_service.create_user(
-            user_id=UUID(int=1),
+            user_id=GenericUUID(int=1),
             email="[email protected]",
             password="admin",
             access_token="token",

src/config/__init__.py

@@ -1 +1 @@
-
+foo = "bar"

src/modules/__init__.py

@@ -1,19 +1,18 @@
 from dataclasses import dataclass
-from decimal import Decimal
 
 from modules.bidding.application import bidding_module
-from modules.bidding.domain.entities import Listing
 from modules.bidding.domain.repositories import ListingRepository
 from modules.bidding.domain.value_objects import Bid, Bidder, Money
 from seedwork.application.command_handlers import CommandResult
 from seedwork.application.commands import Command
+from seedwork.domain.value_objects import GenericUUID
 
 
 @dataclass
 class PlaceBidCommand(Command):
-    listing_id: str
-    bidder_id: str
-    amount: Decimal
+    listing_id: GenericUUID
+    bidder_id: GenericUUID
+    amount: int  # todo: Decimal
     currency: str = "USD"
 
 
@@ -24,7 +23,7 @@ def place_bid(
     bidder = Bidder(id=command.bidder_id)
     bid = Bid(bidder=bidder, max_price=Money(command.amount))
 
-    listing: Listing = listing_repository.get_by_id(command.listing_id)
+    listing = listing_repository.get_by_id(command.listing_id)
     listing.place_bid(bid)
 
     return CommandResult.success()