Improve liniting (#10)

* Init

* Remaining

Author: mslaursen

Makefile

@@ -9,7 +9,7 @@ version:
 
 lint:
 	uv run ruff format
-	uv run ruff check . --fix
+	uv run ruff check . --fix --unsafe-fixes
 
 test:
 	uv run pytest tests -s

fastapi_forge/__main__.py

@@ -1,7 +1,8 @@
+from pathlib import Path
+
 import click
+
 from fastapi_forge.frontend import init
-from pathlib import Path
-import os
 
 
 @click.group()
@@ -32,14 +33,14 @@ def main() -> None:
 def start(use_example: bool, no_ui: bool, from_yaml: str | None = None) -> None:
     """Start the FastAPI Forge server and generate a new project."""
     if use_example and from_yaml:
+        msg = "Cannot use '--use-example' and '--from-yaml' together."
         raise click.UsageError(
-            "Cannot use '--use-example' and '--from-yaml' together.",
+            msg,
         )
 
     yaml_path = None
     if from_yaml:
-        expanded_yaml_path = os.path.expanduser(from_yaml)
-        yaml_path = Path(expanded_yaml_path).resolve()
+        yaml_path = Path.expanduser(Path(from_yaml)).resolve()
 
         if not yaml_path.exists():
             raise click.FileError(f"YAML file not found: {yaml_path}")

fastapi_forge/dtos.py

@@ -1,23 +1,25 @@
+from typing import Annotated, Self
+
 from pydantic import (
     BaseModel,
-    computed_field,
+    ConfigDict,
     Field,
-    model_validator,
+    computed_field,
     field_validator,
-    ConfigDict,
+    model_validator,
 )
-from typing import Annotated
+
 from fastapi_forge.enums import FieldDataType
-from typing_extensions import Self
-from fastapi_forge.string_utils import snake_to_camel, camel_to_snake_hyphen
+from fastapi_forge.string_utils import camel_to_snake_hyphen, snake_to_camel
 
 BoundedStr = Annotated[str, Field(..., min_length=1, max_length=100)]
 SnakeCaseStr = Annotated[BoundedStr, Field(..., pattern=r"^[a-z][a-z0-9_]*$")]
 ModelName = SnakeCaseStr
 FieldName = SnakeCaseStr
 BackPopulates = Annotated[str, Field(..., pattern=r"^[a-z][a-z0-9_]*$")]
 ProjectName = Annotated[
-    BoundedStr, Field(..., pattern=r"^[a-zA-Z0-9](?:[a-zA-Z0-9._-]*[a-zA-Z0-9])?$")
+    BoundedStr,
+    Field(..., pattern=r"^[a-zA-Z0-9](?:[a-zA-Z0-9._-]*[a-zA-Z0-9])?$"),
 ]
 
 
@@ -55,19 +57,23 @@ def _validate(self) -> Self:
         """Validate field constraints."""
         if self.primary_key:
             if self.nullable:
-                raise ValueError("Primary key cannot be nullable.")
+                msg = "Primary key cannot be nullable."
+                raise ValueError(msg)
             if not self.unique:
                 self.unique = True
 
         metadata = self.metadata
-        if metadata.is_created_at_timestamp or metadata.is_updated_at_timestamp:
-            if self.type != FieldDataType.DATETIME:
-                raise ValueError(
-                    "Create/update timestamp fields must be of type DateTime."
-                )
+        if (
+            metadata.is_created_at_timestamp or metadata.is_updated_at_timestamp
+        ) and self.type != FieldDataType.DATETIME:
+            msg = "Create/update timestamp fields must be of type DateTime."
+            raise ValueError(
+                msg,
+            )
 
         if metadata.is_foreign_key and self.type != FieldDataType.UUID:
-            raise ValueError("Foreign Keys must be of type UUID.")
+            msg = "Foreign Keys must be of type UUID."
+            raise ValueError(msg)
         return self
 
     @computed_field
@@ -112,7 +118,8 @@ class ModelRelationship(_Base):
     def _validate_field_name(cls, value: str) -> str:
         """Ensure relationship field names end with '_id'."""
         if not value.endswith("_id"):
-            raise ValueError("Relationship field names must end with '_id'.")
+            msg = "Relationship field names must end with '_id'."
+            raise ValueError(msg)
         return value
 
     @computed_field
@@ -189,7 +196,7 @@ def _validate(self) -> Self:
         ]
         if len(unque_relationships) != len(set(unque_relationships)):
             raise ValueError(
-                f"Model '{self.name}' contains duplicate relationship field names."
+                f"Model '{self.name}' contains duplicate relationship field names.",
             )
 
         return self
@@ -232,7 +239,7 @@ def _validate_metadata(self) -> Self:
                 ]
                 if missing:
                     error_message = rule["error_message"].format(
-                        missing=", ".join(missing)
+                        missing=", ".join(missing),
                     )
                     raise ValueError(error_message)
 
@@ -251,7 +258,7 @@ def get_preview(self) -> "Model":
                     unique=relation.unique,
                     index=relation.index,
                     metadata=ModelFieldMetadata(is_foreign_key=True),
-                )
+                ),
             )
 
         return preview_model
@@ -273,20 +280,23 @@ def _validate_models(self) -> Self:
         model_names = [model.name for model in self.models]
         model_names_set = set(model_names)
         if len(model_names) != len(model_names_set):
-            raise ValueError("Model names must be unique.")
+            msg = "Model names must be unique."
+            raise ValueError(msg)
 
         if self.use_alembic and not self.use_postgres:
-            raise ValueError("Cannot use Alembic if PostgreSQL is not enabled.")
+            msg = "Cannot use Alembic if PostgreSQL is not enabled."
+            raise ValueError(msg)
 
         if self.use_builtin_auth and not self.use_postgres:
-            raise ValueError("Cannot use built-in auth if PostgreSQL is not enabled.")
+            msg = "Cannot use built-in auth if PostgreSQL is not enabled."
+            raise ValueError(msg)
 
         for model in self.models:
             for relationship in model.relationships:
                 if relationship.target_model not in model_names_set:
                     raise ValueError(
                         f"Model '{model.name}' has a relationship to "
-                        f"'{relationship.target_model}', which does not exist."
+                        f"'{relationship.target_model}', which does not exist.",
                     )
 
         return self
@@ -324,7 +334,7 @@ def has_cycle(node):
             if has_cycle(model_name):
                 raise ValueError(
                     f"Circular reference detected involving model '{model_name}'. "
-                    "Remove bidirectional relationships between models."
+                    "Remove bidirectional relationships between models.",
                 )
 
         return self

fastapi_forge/forge.py

@@ -1,25 +1,27 @@
-import os
-import shutil
 import asyncio
+import shutil
+from pathlib import Path
+from time import perf_counter
+
 from cookiecutter.main import cookiecutter
+
 from fastapi_forge.dtos import ProjectSpec
 from fastapi_forge.logger import logger
 from fastapi_forge.project_io import ProjectBuilder
-from time import perf_counter
 
 
-def _get_template_path() -> str:
+def _get_template_path() -> Path:
     """Return the absolute path to the project template directory."""
-    template_path = os.path.join(os.path.dirname(__file__), "template")
-    if not os.path.exists(template_path):
+    template_path = Path(__file__).parent / "template"
+    if not template_path.exists():
         raise RuntimeError(f"Template directory not found: {template_path}")
     return template_path
 
 
 async def _teardown_project(project_name: str) -> None:
     """Forcefully remove the project directory and all its contents."""
-    project_dir = os.path.join(os.getcwd(), project_name)
-    if os.path.exists(project_dir):
+    project_dir = Path.cwd() / project_name
+    if project_dir.exists():
         await asyncio.to_thread(shutil.rmtree, project_dir)
         logger.info(f"Removed project directory: {project_dir}")
 
@@ -33,10 +35,11 @@ async def build_project(spec: ProjectSpec) -> None:
         builder = ProjectBuilder(spec)
         await builder.build_artifacts()
 
-        template_path = _get_template_path()
+        template_path = str(_get_template_path())
+
         cookiecutter(
             template_path,
-            output_dir=os.getcwd(),
+            output_dir=str(Path.cwd()),
             no_input=True,
             overwrite_if_exists=True,
             extra_context={
@@ -50,7 +53,7 @@ async def build_project(spec: ProjectSpec) -> None:
 
         end = perf_counter()
         logger.info(f"Project built in {end - start:.2f} seconds.")
-    except Exception as e:
-        logger.error(f"Failed to create project: {e}")
+    except Exception as exc:
+        logger.error(f"Failed to create project: {exc}")
         await _teardown_project(spec.project_name)
         raise

fastapi_forge/frontend/components/header.py

@@ -13,14 +13,14 @@ def _build(self) -> None:
                 icon="eva-github",
                 color="white",
                 on_click=lambda: ui.navigate.to(
-                    "https://github.com/mslaursen/fastapi-forge"
+                    "https://github.com/mslaursen/fastapi-forge",
                 ),
             ).classes("self-center", remove="bg-white").tooltip(
-                "Drop a ⭐️ if you like FastAPI Forge!"
+                "Drop a ⭐️ if you like FastAPI Forge!",
             )
 
             ui.label(text="FastAPI Forge").classes(
-                "font-bold ml-auto self-center text-2xl"
+                "font-bold ml-auto self-center text-2xl",
             )
 
             ui.button(

fastapi_forge/frontend/components/model_create.py

@@ -1,4 +1,5 @@
 from nicegui import ui
+
 from fastapi_forge.frontend.state import state
 
 
@@ -13,7 +14,7 @@ def _build(self) -> None:
                 ui.input(placeholder="Model name")
                 .classes("self-center")
                 .tooltip(
-                    "Model names should be singular (e.g., 'user' instead of 'users')."
+                    "Model names should be singular (e.g., 'user' instead of 'users').",
                 )
             )
             self.add_button = (

fastapi_forge/frontend/components/model_row.py

@@ -1,4 +1,5 @@
 from nicegui import ui
+
 from fastapi_forge.dtos import Model
 from fastapi_forge.frontend.state import state
 
@@ -31,10 +32,12 @@ def _build(self) -> None:
 
             with ui.row().classes("gap-2"):
                 self.edit_button = ui.button(
-                    icon="edit", on_click=self._toggle_edit
+                    icon="edit",
+                    on_click=self._toggle_edit,
                 ).bind_visibility_from(self, "is_editing", lambda x: not x)
                 self.save_button = ui.button(
-                    icon="save", on_click=self._save_model
+                    icon="save",
+                    on_click=self._save_model,
                 ).bind_visibility_from(self, "is_editing")
                 ui.button(icon="delete", on_click=self._delete_model)
 

fastapi_forge/frontend/constants.py

@@ -1,6 +1,5 @@
 from typing import Any
 
-
 FIELD_COLUMNS: list[dict[str, Any]] = [
     {
         "name": "name",

fastapi_forge/frontend/main.py

@@ -1,15 +1,17 @@
-from fastapi_forge.forge import build_project
+import asyncio
+from pathlib import Path
+
+from nicegui import native, ui
+
 from fastapi_forge import project_io as p
+from fastapi_forge.forge import build_project
 from fastapi_forge.frontend import (
     Header,
-    ModelPanel,
     ModelEditorPanel,
+    ModelPanel,
     ProjectConfigPanel,
 )
-from pathlib import Path
-from nicegui import ui, native
 from fastapi_forge.frontend.state import state
-import asyncio
 
 
 async def _init_no_ui(project_path: Path) -> None:
@@ -21,7 +23,7 @@ async def _init_no_ui(project_path: Path) -> None:
 def setup_ui() -> None:
     """Setup basic UI configuration"""
     ui.add_head_html(
-        '<link href="https://unpkg.com/eva-icons@1.1.3/style/eva-icons.css" rel="stylesheet" />'
+        '<link href="https://unpkg.com/eva-icons@1.1.3/style/eva-icons.css" rel="stylesheet" />',
     )
     ui.button.default_props("round flat dense")
     ui.input.default_props("dense")

fastapi_forge/frontend/modals/field_modal.py

@@ -1,7 +1,9 @@
+from collections.abc import Callable
+
 from nicegui import ui
-from fastapi_forge.enums import FieldDataType
+
 from fastapi_forge.dtos import ModelField
-from typing import Callable
+from fastapi_forge.enums import FieldDataType
 from fastapi_forge.frontend.state import state
 
 
@@ -18,7 +20,8 @@ def _build(self) -> None:
             with ui.row().classes("w-full gap-2"):
                 self.field_name = ui.input(label="Field Name").classes("w-full")
                 self.field_type = ui.select(
-                    list(FieldDataType), label="Field Type"
+                    list(FieldDataType),
+                    label="Field Type",
                 ).classes("w-full")
                 self.primary_key = ui.checkbox("Primary Key").classes("w-full")
                 self.nullable = ui.checkbox("Nullable").classes("w-full")
@@ -64,15 +67,15 @@ def _build(self) -> None:
             ui.label("Update Field").classes("text-lg font-bold")
             with ui.row().classes("w-full gap-2"):
                 self.field_name = ui.input(label="Field Name", value="").classes(
-                    "w-full"
+                    "w-full",
                 )
                 self.field_type = ui.select(
                     list(FieldDataType),
                     label="Field Type",
                     value=None,
                 ).classes("w-full")
                 self.primary_key = ui.checkbox("Primary Key", value=False).classes(
-                    "w-full"
+                    "w-full",
                 )
                 self.nullable = ui.checkbox("Nullable", value=False).classes("w-full")
                 self.unique = ui.checkbox("Unique", value=False).classes("w-full")