feat(Type Check): Added mypy (#78)

Author: mslaursen

.github/workflows/check.yaml

@@ -17,5 +17,7 @@ jobs:
         run: uv sync --all-extras --dev
       - name: Lint with Ruff
         run: uv run ruff check .
+      - name: Static type check with mypy
+        run: uv run mypy fastapi_forge
       - name: Run tests
         run: uv run pytest tests -s -v

Makefile

@@ -20,6 +20,7 @@ version: # Show the version of FastAPI Forge.
 lint: # Run linters on the codebase.
 	uv run ruff format
 	uv run ruff check . --fix --unsafe-fixes
+	uv run mypy fastapi_forge
 
 .PHONY: test
 test: # Run all tests in the codebase.

fastapi_forge/core/build.py

@@ -5,7 +5,7 @@
 import click
 
 from fastapi_forge.logger import logger
-from fastapi_forge.project_io import ArtifactBuilder, create_fastapi_project_builder
+from fastapi_forge.project_io import ArtifactBuilder, create_fastapi_artifact_builder
 from fastapi_forge.schemas import ProjectSpec
 
 from .cookiecutter_adapter import (
@@ -23,7 +23,7 @@ def __init__(
         builder: ArtifactBuilder,
         template_processor: TemplateProcessor,
         template_generator: CookiecutterAdapter,
-        template_resolver: Callable,
+        template_resolver: Callable[[], Path],
         project_validator: ProjectValidator | None = None,
     ):
         self.builder = builder
@@ -68,7 +68,7 @@ async def build_fastapi_project(
 
     try:
         director = ProjectBuildDirector(
-            builder=create_fastapi_project_builder(spec, dry_run=dry_run),
+            builder=create_fastapi_artifact_builder(spec, dry_run=dry_run),
             project_validator=ProjectNameValidator(),
             template_processor=DefaultTemplateProcessor(),
             template_generator=template_generator,

fastapi_forge/example-projects/__init__.py

@@ -10,7 +10,7 @@
     "ProjectLoader",
     "YamlProjectExporter",
     "YamlProjectLoader",
-    "create_fastapi_project_builder",
+    "create_fastapi_artifact_builder",
     "create_postgres_project_loader",
     "create_yaml_project_exporter",
     "load_from_database",
@@ -36,7 +36,7 @@ def load_from_database(conn_str: str, schema: str = "public") -> ProjectSpec:
     return DatabaseProjectLoader(inspector, schema).load()
 
 
-def create_fastapi_project_builder(
+def create_fastapi_artifact_builder(
     spec: ProjectSpec, dry_run: bool = False
 ) -> FastAPIArtifactBuilder:
     return FastAPIArtifactBuilder(

fastapi_forge/project_io/__init__.py

@@ -1,3 +1,4 @@
+from typing import Any
 from urllib.parse import urlparse
 
 import psycopg2
@@ -38,7 +39,7 @@ def fetch_enums(self, schema: str) -> dict[str, list[str]]:
         )
         return dict(self.cursor.fetchall())
 
-    def fetch_enum_columns(self, schema: str) -> list[tuple]:
+    def fetch_enum_columns(self, schema: str) -> list[tuple[Any, ...]]:
         self.cursor.execute(
             """
             SELECT
@@ -65,7 +66,7 @@ def fetch_enum_columns(self, schema: str) -> list[tuple]:
         )
         return self.cursor.fetchall()
 
-    def fetch_schema_tables(self, schema: str) -> list[tuple]:
+    def fetch_schema_tables(self, schema: str) -> list[tuple[Any, ...]]:
         self.cursor.execute(
             """
             SELECT
@@ -146,7 +147,7 @@ def get_connection_string(self) -> str:
     def get_db_name(self) -> str:
         return self.db_name
 
-    def __del__(self):
+    def __del__(self) -> None:
         if hasattr(self, "cursor"):
             self.cursor.close()
         if hasattr(self, "conn"):

fastapi_forge/project_io/database/postgres_inspector.py

@@ -1,5 +1,5 @@
 from abc import abstractmethod
-from typing import Protocol
+from typing import Any, Protocol
 
 
 class DatabaseInspector(Protocol):
@@ -12,11 +12,11 @@ def fetch_enums(self, schema: str) -> dict[str, list[str]]:
         raise NotImplementedError
 
     @abstractmethod
-    def fetch_enum_columns(self, schema: str) -> list[tuple]:
+    def fetch_enum_columns(self, schema: str) -> list[tuple[Any, ...]]:
         raise NotImplementedError
 
     @abstractmethod
-    def fetch_schema_tables(self, schema: str) -> list[tuple]:
+    def fetch_schema_tables(self, schema: str) -> list[tuple[Any, ...]]:
         raise NotImplementedError
 
     @abstractmethod

fastapi_forge/project_io/database/protocols.py

@@ -44,7 +44,9 @@ def inspect_schema(self, schema: str = "public") -> SchemaInspectionResult:
             raise ValueError(f"Database error: {e}") from e
 
     @staticmethod
-    def _build_enum_usage(enum_columns: list[tuple]) -> dict[str, list[dict[str, Any]]]:
+    def _build_enum_usage(
+        enum_columns: list[tuple[Any, ...]],
+    ) -> dict[str, list[dict[str, Any]]]:
         usage: dict[str, list[dict[str, Any]]] = {}
         for schema, table, column, data_type, enum_type in enum_columns:
             if enum_type not in usage:

fastapi_forge/project_io/database/schema.py

@@ -62,8 +62,8 @@ def _create_model_from_table(
         self,
         table_name: str,
         table_name_full: str,
-        columns_data: list[dict],
-        enum_column_lookup: dict,
+        columns_data: list[dict[str, Any]],
+        enum_column_lookup: dict[str, str],
     ) -> Model:
         fields = []
         relationships = []
@@ -101,7 +101,9 @@ def _create_model_from_table(
         return Model(name=table_name, fields=fields, relationships=relationships)
 
     @staticmethod
-    def _process_column_defaults(column: dict[str, Any], data_type: Any) -> tuple:
+    def _process_column_defaults(
+        column: dict[str, Any], data_type: Any
+    ) -> tuple[str | None, dict[str, Any] | None]:
         default = None
         extra_kwargs = None
 

fastapi_forge/project_io/loader/database_loader.py

@@ -9,7 +9,7 @@
 
 
 class Jinja2Engine(TemplateEngine):
-    def __init__(self):
+    def __init__(self) -> None:
         self.env = Environment()
         self._register_core_filters()