[FIX] fix default template, separate pdm package prod <-> dev, test build

Author: bnbong

.pre-commit-config.yaml

@@ -11,6 +11,27 @@ repos:
     -   id: check-yaml
     -   id: check-toml
     -   id: check-added-large-files
+
+-   repo: local
+    hooks:
+    -   id: format
+        name: format
+        entry: bash scripts/format.sh
+        language: system
+        pass_filenames: false
+        
+    -   id: lint
+        name: lint
+        entry: bash scripts/lint.sh
+        language: system
+        pass_filenames: false
+        
+    -   id: test
+        name: test
+        entry: bash scripts/fetch-and-test.sh
+        language: system
+        pass_filenames: false
+
 ci:
     autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
     autoupdate_commit_msg: ⬆ [pre-commit.ci] pre-commit autoupdate

fastapi-project-template/fastapi-default/src/crud/user.py-tpl

@@ -7,79 +7,38 @@ from typing import Type
 from uuid import UUID
 
 from ._base import load_json
-
-from sqlalchemy.exc import IntegrityError
-from sqlalchemy.ext.asyncio import AsyncSession
-from sqlmodel import select, delete
-
-from src.schemas.user import UserSchema
-from src.db.models.user import UserCreate, User, UserUpdate
 from src.helper.exceptions import InternalException, ErrorCode
+from src.schemas.user import UserSchema, UserCreate, UserUpdate
+from src.helper.global_data import mock_user_data
 
 
-def get_mock_user_data(id: UUID, response_model: Type[UserSchema]):
-    base_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "../.."))
-    file_path = os.path.join(base_path, "src", "mocks", "mock_users.json")
-    users = load_json(file_path)
-    user_data = next((user for user in users if user["id"] == str(id)), None)
+def get_mock_user_data(id: UUID) -> dict:
+    user_data = next((user for user in mock_user_data if user["id"] == str(id)), None)
     if user_data is None:
         raise InternalException(
-            message="ERROR : User not found.", error_code=ErrorCode.NOT_FOUND
+            message="User not found.", error_code=ErrorCode.NOT_FOUND
         )
-    return response_model(**user_data)
+    return user_data
 
 
-async def create_user(db: AsyncSession, user: UserCreate) -> User:
-    db_user = User(**user.dict())
-    try:
-        db.add(db_user)
-        await db.commit()
-        await db.refresh(db_user)
-        return db_user
-    except IntegrityError:
-        await db.rollback()
+def create_mock_user(user: UserCreate) -> dict:
+    new_user = user.model_dump()
+    if any(u["email"] == new_user["email"] for u in mock_user_data):
         raise InternalException(
             error_code=ErrorCode.CONFLICT,
-            message="ERROR : This user is already exist.",
+            message="This user is already exist.",
         )
+    mock_user_data.append(new_user)
+    return new_user
 
 
-async def get_user(db: AsyncSession, id: UUID) -> User:
-    query = select(User).where(User.id == id)
-    response = await db.execute(query)
-    return response.scalar_one_or_none()
-
-
-async def get_user_by_email(db: AsyncSession, email: str) -> User:
-    query = select(User).where(User.email == email)
-    response = await db.execute(query)
-    return response.scalar_one_or_none()
-
-
-async def update_user(db: AsyncSession, id: UUID, user: UserUpdate) -> User:
-    db_user = await get_user(db, id)
-    if not db_user:
-        raise InternalException(
-            error_code=ErrorCode.NOT_FOUND, message="ERROR : User not found."
-        )
-
-    for k, v in user.dict(exclude_unset=True).items():
-        setattr(db_user, k, v)
-
-    try:
-        await db.commit()
-        await db.refresh(db_user)
-        return db_user
-    except IntegrityError:
-        await db.rollback()
-        raise InternalException(
-            error_code=ErrorCode.CONFLICT,
-            message="ERROR : There is information that overlaps with other user information.",
-        )
+def update_mock_user(id: UUID, user: UserUpdate) -> dict:
+    user_data = get_mock_user_data(id)
+    update_data = user.model_dump(exclude_unset=True)
+    user_data.update(update_data)
+    return user_data
 
 
-async def delete_user(db: AsyncSession, id: UUID) -> int:
-    query = delete(User).where(User.id == id)
-    response = await db.execute(query)
-    await db.commit()
-    return response.rowcount
+def delete_mock_user(id: UUID) -> None:
+    user_data = get_mock_user_data(id)
+    mock_user_data.remove(user_data)

fastapi-project-template/fastapi-default/src/helper/global_data.py-tpl

@@ -18,7 +18,7 @@ def initialize_mock_data() -> None:
 
     # If the model has relations with other model,
     # you can map it their respective columns like below:
-    item_data = json.loads(json.dumps({'some': 'item', "user_id": "123e4567-e89b-12d3-a456-426614174000"}))
+    item_data = [{'some': 'item', "user_id": "123e4567-e89b-12d3-a456-426614174000"}]
     item_map = {}
     for item in item_data:
         user_id = item["user_id"]

fastapi-project-template/fastapi-default/src/router/user.py-tpl

@@ -3,7 +3,7 @@
 # --------------------------------------------------------------------------
 from . import *
 
-from src import mock_user_data
+from src.helper.global_data import mock_user_data
 from src.crud.user import get_mock_user_data
 from src.schemas import ResponseSchema
 from src.schemas.user import UserSchema, UserCreate, UserUpdate
@@ -28,23 +28,23 @@ def generate_new_user_id():
 )
 async def create_user_route(
     data: UserCreate,
+    request: Request,
 ):
-    new_user = {
-        "id": generate_new_user_id(),
-        "username": data.username,
-        "email": data.email,
-        "createdAt": datetime.utcnow().isoformat() + "Z",
-        "modifiedAt": datetime.utcnow().isoformat() + "Z",
-    }
-    mock_user_data.append(new_user)
-    response = ResponseSchema(
-        timestamp=datetime.utcnow().isoformat() + "Z",
-        status=201,
-        code="HTTP-201",
-        path=str(request.url),
-        message=UserSchema(**new_user),
-    )
-    return response
+    try:
+        new_user = create_mock_user(data)
+        response = ResponseSchema(
+            timestamp=datetime.utcnow().isoformat() + "Z",
+            status=201,
+            code="HTTP-201",
+            path=str(request.url),
+            message=UserSchema(**new_user),
+        )
+        return response
+    except InternalException as e:
+        return JSONResponse(
+            status_code=e.status,
+            content=e.to_response(path=str(request.url)).model_dump(),
+        )
 
 
 @router.get(

pyproject.toml

@@ -8,17 +8,21 @@ authors = [
 dependencies = [
     "click>=8.1.7",
     "rich>=13.9.2",
+    "fastapi-cli>=0.0.5",
+]
+requires-python = ">=3.12"
+readme = "README.md"
+license = {text = "MIT"}
+
+[project.optional-dependencies]
+dev = [
     "pytest>=8.3.3",
+    "pytest-cov>=5.0.0",
     "black>=24.10.0",
     "pre-commit>=4.0.1",
-    "pytest-cov>=5.0.0",
     "mypy>=1.12.0",
     "isort>=5.13.2",
-    "fastapi-cli>=0.0.5",
 ]
-requires-python = ">=3.12"
-readme = "README.md"
-license = {text = "MIT"}
 
 [project.scripts]
 fastkit = "fastapi_fastkit.cli:fastkit_cli"
@@ -27,11 +31,24 @@ fastkit = "fastapi_fastkit.cli:fastkit_cli"
 requires = ["pdm-backend"]
 build-backend = "pdm.backend"
 
-
 [tool.pdm]
 version = { source = "file", path = "src/fastapi_fastkit/__init__.py" }
 distribution = true
 
+[tool.pdm.dev-dependencies]
+test = [
+    "pytest>=8.3.3",
+    "pytest-cov>=5.0.0",
+]
+lint = [
+    "black>=24.10.0",
+    "mypy>=1.12.0",
+    "isort>=5.13.2",
+]
+dev = [
+    "pre-commit>=4.0.1",
+]
+
 [tool.pytest.ini_options]
 testpaths = ["test"]
 python_files = "test_*.py"