Start using typeguard

Author: WillGibson

_starter_kit/src/thing.py

@@ -1,3 +1,7 @@
+from typeguard import typechecked
+
+
+@typechecked
 class Thing:
     _can_act: bool
     _has_acted: bool = False
@@ -15,5 +19,6 @@ def has_acted(self) -> bool:
         return self._has_acted
 
 
+@typechecked
 class ThingCantActException(Exception):
     pass

_starter_kit/tests/test_thing.py

@@ -1,4 +1,5 @@
 import pytest
+
 from _starter_kit.src.thing import Thing, ThingCantActException
 
 

fox_goose_corn/src/crossing_manager.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typeguard import typechecked
 
 from fox_goose_corn.src.model.boat import Boat
 from fox_goose_corn.src.model.cargo_item import (
@@ -10,6 +10,7 @@
 )
 
 
+@typechecked
 class CrossingManager:
     def __init__(self, boat: Boat, fox: Fox, goose: Goose, corn: Corn):
         self._corn = corn

fox_goose_corn/src/model/boat.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from fox_goose_corn.src.model.cargo_item import AbstractCargoItem, Fox
+from fox_goose_corn.src.model.cargo_item import AbstractCargoItem
 from fox_goose_corn.src.model.river import RiverSide
 
 

fox_goose_corn/src/model/cargo_item.py

@@ -1,13 +1,15 @@
-from abc import abstractmethod, ABC
-from typing import Type
+from abc import ABC
+
+from typeguard import typechecked
 
 from fox_goose_corn.src.model.river import RiverSide
 
 
+@typechecked
 class AbstractCargoItem(ABC):
     _current_side: RiverSide = RiverSide.FARM_SIDE
 
-    def is_at(self, expected_side: RiverSide) -> None:
+    def is_at(self, expected_side: RiverSide) -> bool:
         return self._current_side is expected_side
 
     def unload_cargo_item_at(self, side: RiverSide) -> None:
@@ -17,17 +19,21 @@ def is_on_same_side_as(self, other_cargo_item: "AbstractCargoItem") -> bool:
         return self._current_side == other_cargo_item._current_side
 
 
+@typechecked
 class Fox(AbstractCargoItem):
     pass
 
 
+@typechecked
 class Goose(AbstractCargoItem):
     pass
 
 
+@typechecked
 class Corn(AbstractCargoItem):
     pass
 
 
+@typechecked
 class CargoEatingCargoException(Exception):
     pass

fox_goose_corn/src/model/river.py

@@ -1,6 +1,9 @@
 from enum import Enum
 
+from typeguard import typechecked
 
+
+@typechecked
 class RiverSide(Enum):
     FARM_SIDE: str = "farm-side"
     MARKET_SIDE: str = "market-side"

list_things/src/continuous_subset.py

@@ -1,7 +1,10 @@
 from itertools import accumulate
 from typing import Optional
 
+from typeguard import typechecked
 
+
+@typechecked
 def continuous_subset_adding_up_to(full_set: list[int], target_sum: int) -> Optional[list[int]]:
     full_set.sort()  # Might improve performance on more random lists if the values are in ascending order
 

list_things/src/scattered_subset.py

@@ -1,7 +1,10 @@
 from itertools import combinations
 from typing import Optional
 
+from typeguard import typechecked
 
+
+@typechecked
 def scattered_subset_adding_up_to(
     full_set: list[int],
     target_sum: int,

thing_rental/src/model/person.py

@@ -1,2 +1,6 @@
+from typeguard import typechecked
+
+
+@typechecked
 class Person:
     pass

thing_rental/src/model/rental.py

@@ -1,7 +1,10 @@
+from typeguard import typechecked
+
 from thing_rental.src.model.person import Person
 from thing_rental.src.model.thing import Thing
 
 
+@typechecked
 class Rental:
     person: Person
     thing: Thing