some improvements and clean

Author: giladfuchs

docker/docker-compose.yaml

@@ -1,10 +1,10 @@
 version: "3.7"
+name: fullstack-template
 
 services:
   db:
     image: postgres:17
-    container_name: postgresql1
-    restart: always
+    container_name: fullstack-template-db
     environment:
       POSTGRES_USER: admin
       POSTGRES_PASSWORD: admin
@@ -14,14 +14,13 @@ services:
     ports:
       - "5434:5434"
     volumes:
-      - postgres_data:/var/lib/postgresql/data
+      - postgres_data_fullstack_template:/var/lib/postgresql/data
 
   backend:
     container_name: fastapi-backend
     build:
       context: ../fastapi-postgres
       dockerfile: ../docker/DockerfileFastapi
-    restart: always
     depends_on:
       - db
     environment:
@@ -36,7 +35,6 @@ services:
       args:
         APP_DIR: "vue3"
         VITE_API_URL: "http://localhost:5001"
-    restart: always
     ports:
       - "3355:80"
 
@@ -48,11 +46,10 @@ services:
       args:
         APP_DIR: "react"
         VITE_API_URL: "http://localhost:5001"
-    restart: always
     ports:
       - "3366:80"
 
 
 
 volumes:
-  postgres_data:
+  postgres_data_fullstack_template:

fastapi-postgres/app/__init__.py

@@ -26,21 +26,23 @@ def create_app(docs=False) -> FastAPI:
     )
 
     @app.exception_handler(HTTPException)
-    async def validation_exception_handler(request, exc: HTTPException):
+    async def http_exception_handler(request, exc: HTTPException):
         return JSONResponse(
-            content=dict(message=f"error in response value {exc.detail}"),
+            content={"message": f"error in response value {exc.detail}"},
             status_code=exc.status_code,
         )
 
     @app.exception_handler(ValidationError)
-    async def validation_exception_handler(request, exc: ValidationError):
+    async def pydantic_validation_exception_handler(request, exc: ValidationError):
         return JSONResponse(
-            content=dict(message=f"error in response value {exc}"),
+            content={"message": f"error in response value {exc}"},
             status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
         )
 
     @app.exception_handler(RequestValidationError)
-    async def validation_exception_handler(request, exc: RequestValidationError):
+    async def request_validation_exception_handler(
+        request, exc: RequestValidationError
+    ):
         errors = []
         for err in exc.errors():
             loc = err["loc"]

fastapi-postgres/app/routers/crud.py

@@ -1,4 +1,4 @@
-from typing import List, Type
+from typing import Type
 
 from fastapi import APIRouter, Body, Depends, HTTPException
 
@@ -11,7 +11,7 @@ def generate_crud_routes(
     model: Type[DBModel],
     prefix: str,
     require_token: bool = True,
-    allowed_methods: List[str] = ["read", "add", "edit", "delete"],
+    allowed_methods: list[str] = ["read", "add", "edit", "delete"],
 ):
     router = APIRouter(prefix=f"/{prefix}", tags=[prefix])
 
@@ -31,7 +31,7 @@ def _plain_filter(
 
     if "read" in allowed_methods:
 
-        @router.post("", response_model=List[response_payload] | response_payload)
+        @router.post("", response_model=list[response_payload] | response_payload)
         async def fetch_rows(
             pagination: Pagination = Depends(),
             filter_query: FilterQuery = filter_dep,
@@ -54,7 +54,7 @@ async def delete_rows(
 
     if "add" in allowed_methods or "edit" in allowed_methods:
 
-        @router.post("/{add_or_id}", response_model=model.table)
+        @router.post("/{add_or_id}", response_model=model.payload)
         async def add_or_update(
             add_or_id: str,
             body: model.payload,

fastapi-postgres/common/db_model/__init__.py

@@ -118,7 +118,7 @@ async def add_or_find_update_single(
         add_or_id: str | int,
         body: BaseModel | dict[str, Any],
         **kwargs: Any,
-    ) -> "cls.table":
+    ) -> BaseTable:
         user_auth = kwargs.get("user_auth")
 
         if add_or_id != "add":
@@ -203,7 +203,7 @@ async def fetch_rows(
                         _.model_dump(include_relations=filter_query.relation_model)
                         for _ in results
                     ]
-                    if as_dict or filter_query.relation_model
+                    if as_dict
                     else list(results)
                 )
         except Exception as ex:

fastapi-postgres/common/enums/__init__.py

@@ -40,7 +40,7 @@ class Grade(EnumBase):
     F = "F"
     G = "G"
     H = "H"
-    I = "I"
+    I_ = "I"
     J = "J"
     K = "K"
     L = "L"

fastapi-postgres/common/serializers/__init__.py

@@ -1,4 +1,4 @@
-from typing import Any, List, Optional, Set, TypeAlias
+from typing import Any, TypeAlias
 
 from pydantic import BaseModel
 from pydantic import Field as PydanticField
@@ -15,7 +15,7 @@ def model_dump(
         *,
         include_relations: bool = False,
         max_depth: int = 1,
-        _visited: Set[int] | None = None,
+        _visited: set[int] | None = None,
         **kwargs: Any,
     ) -> dict[str, Any]:
         base = super().model_dump(**kwargs)
@@ -72,7 +72,7 @@ def model_dump(
 
 
 class IdBaseTable(BaseTable):
-    id: Optional[int] = Field(default=None, primary_key=True)
+    id: int | None = Field(default=None, primary_key=True)
 
     def __hash__(self):
         return hash(self.id)
@@ -93,9 +93,9 @@ class DBQuery(BaseModel):
 
 
 class FilterQuery(BaseModel):
-    query: List[DBQuery] = []
+    query: list[DBQuery] = Field(default_factory=list)
     relation_model: bool = False
-    sort: Optional[str] = None
+    sort: str | None = None
 
 
 class Pagination(BaseModel):

fastapi-postgres/common/serializers/payload.py

@@ -1,5 +1,3 @@
-from typing import List
-
 from pydantic import BaseModel, Field
 
 from common.enums import Grade
@@ -19,7 +17,7 @@ class StudentPayload(BaseModel):
 
 
 class FullStudentPayload(StudentPayload):
-    assignments: List[AssignmentPayload] = []
+    assignments: list[AssignmentPayload] = []
     id: int
 
 

fastapi-postgres/common/serializers/table_model.py

@@ -1,5 +1,3 @@
-from typing import List, Optional
-
 from sqlmodel import Field, Relationship, String, UniqueConstraint
 
 from common.enums import Grade
@@ -8,27 +6,34 @@
 
 class Teacher(IdBaseTable, table=True):
     __table_args__ = (UniqueConstraint("phone", "id", name="phone_id"),)
+
     phone: float
-    students: Optional[List["Student"]] = Relationship(
-        sa_relationship_kwargs={"cascade": "all, delete"}, back_populates="teacher"
+
+    students: list["Student"] | None = Relationship(
+        sa_relationship_kwargs={"cascade": "all, delete"},
+        back_populates="teacher",
     )
 
-    assignments: Optional[List["Assignment"]] = Relationship(
-        sa_relationship_kwargs={"cascade": "all, delete"}, back_populates="teacher"
+    assignments: list["Assignment"] | None = Relationship(
+        sa_relationship_kwargs={"cascade": "all, delete"},
+        back_populates="teacher",
     )
 
 
 class Student(IdBaseTable, table=True):
     __table_args__ = (UniqueConstraint("name", "phone", name="name_phone"),)
+
     teacher_id: int = Field(foreign_key="teacher.id")
     teacher: Teacher = Relationship(back_populates="students")
 
     name: str
     grade: Grade = Field(sa_type=String, nullable=False)
 
     phone: float
-    assignments: Optional[List["Assignment"]] = Relationship(
-        sa_relationship_kwargs={"cascade": "all, delete"}, back_populates="student"
+
+    assignments: list["Assignment"] | None = Relationship(
+        sa_relationship_kwargs={"cascade": "all, delete"},
+        back_populates="student",
     )
 
 

fastapi-postgres/common/utils/parse_obj.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Dict, List, Union, get_type_hints
+from typing import Union, get_type_hints
 
 from pydantic import BaseModel
 
@@ -11,8 +11,8 @@ class ParseObj:
     def set_elements_by_dict(
         cls,
         db_obj: BaseTable,
-        new_obj: Union[BaseModel, BaseTable, Dict],
-        exclude_items: List[str] = [],
+        new_obj: Union[BaseModel, BaseTable, dict],
+        exclude_items: list[str] = [],
     ):
         def extract_items(obj):
             if hasattr(obj, "model_dump"):
@@ -30,15 +30,15 @@ def update_nested(target, updates):
                     if k not in exclude_items:
                         setattr(target, k, v)
 
-        def coerce_datetime_if_needed(field_name, value):
+        def coerce_datetime_if_needed(field_name, _value):
             expected_types = get_type_hints(db_obj.__class__)
             if field_name in expected_types and expected_types[field_name] == datetime:
-                if isinstance(value, str):
+                if isinstance(_value, str):
                     try:
-                        return datetime.fromisoformat(value)
+                        return datetime.fromisoformat(_value)
                     except Exception:
-                        return value
-            return value
+                        return _value
+            return _value
 
         items = extract_items(new_obj)
 

fastapi-postgres/format.sh

@@ -1,8 +1,14 @@
 #!/bin/bash
-#it's not in the requirement file maybe you need to install it
+
+# Development tools (not in requirements.txt):
+# pip install ruff isort black
+
 # Format Python code with black and sort imports with isort
 echo "Running isort..."
 isort .
 
 echo "Running black..."
 black .
+
+echo "Running ruff (lint)..."
+ruff check .   --fix