Merge pull request #109 from igorbenav/fast-crud

Fast crud

Author: igorbenav

README.md

@@ -55,8 +55,8 @@
 - 🏬 Easy redis caching
 - 👜 Easy client-side caching
 - 🚦 ARQ integration for task queue
-- ⚙️ Efficient querying (only queries what's needed) with support for joins
-- ⎘ Out of the box pagination support
+- ⚙️ Efficient and robust queries with <a href="https://github.com/igorbenav/fastcrud">fastcrud</a>
+- ⎘ Out of the box offset and cursor pagination support with <a href="https://github.com/igorbenav/fastcrud">fastcrud</a>
 - 🛑 Rate Limiter dependency
 - 👮 FastAPI docs behind authentication and hidden based on the environment
 - 🦾 Easily extendable
@@ -749,14 +749,15 @@ poetry run alembic upgrade head
 
 ### 5.6 CRUD
 
-Inside `app/crud`, create a new `crud_entities.py` inheriting from `CRUDBase` for each new entity:
+Inside `app/crud`, create a new `crud_entities.py` inheriting from `FastCRUD` for each new entity:
 
 ```python
-from app.crud.crud_base import CRUDBase
+from fastcrud import FastCRUD
+
 from app.models.entity import Entity
 from app.schemas.entity import EntityCreateInternal, EntityUpdate, EntityUpdateInternal, EntityDelete
 
-CRUDEntity = CRUDBase[Entity, EntityCreateInternal, EntityUpdate, EntityUpdateInternal, EntityDelete]
+CRUDEntity = FastCRUD[Entity, EntityCreateInternal, EntityUpdate, EntityUpdateInternal, EntityDelete]
 crud_entity = CRUDEntity(Entity)
 ```
 
@@ -767,7 +768,7 @@ So, for users:
 from app.model.user import User
 from app.schemas.user import UserCreateInternal, UserUpdate, UserUpdateInternal, UserDelete
 
-CRUDUser = CRUDBase[User, UserCreateInternal, UserUpdate, UserUpdateInternal, UserDelete]
+CRUDUser = FastCRUD[User, UserCreateInternal, UserUpdate, UserUpdateInternal, UserDelete]
 crud_users = CRUDUser(User)
 ```
 

pyproject.toml

@@ -30,6 +30,7 @@ redis = "^5.0.1"
 arq = "^0.25.0"
 gunicorn = "^21.2.0"
 bcrypt = "^4.1.1"
+fastcrud = "^0.1.5"
 
 
 [build-system]

src/app/api/v1/posts.py

@@ -36,7 +36,8 @@ async def write_post(
     post_internal_dict["created_by_user_id"] = db_user["id"]
 
     post_internal = PostCreateInternal(**post_internal_dict)
-    return await crud_posts.create(db=db, object=post_internal)
+    created_post: PostRead = await crud_posts.create(db=db, object=post_internal)
+    return created_post
 
 
 @router.get("/{username}/posts", response_model=PaginatedListResponse[PostRead])
@@ -77,7 +78,7 @@ async def read_post(
     if db_user is None:
         raise NotFoundException("User not found")
 
-    db_post = await crud_posts.get(
+    db_post: PostRead | None = await crud_posts.get(
         db=db, schema_to_select=PostRead, id=id, created_by_user_id=db_user["id"], is_deleted=False
     )
     if db_post is None:

src/app/api/v1/rate_limits.py

@@ -31,7 +31,8 @@ async def write_rate_limit(
         raise DuplicateValueException("Rate Limit Name not available")
 
     rate_limit_internal = RateLimitCreateInternal(**rate_limit_internal_dict)
-    return await crud_rate_limits.create(db=db, object=rate_limit_internal)
+    created_rate_limit: RateLimitRead = await crud_rate_limits.create(db=db, object=rate_limit_internal)
+    return created_rate_limit
 
 
 @router.get("/tier/{tier_name}/rate_limits", response_model=PaginatedListResponse[RateLimitRead])
@@ -65,7 +66,9 @@ async def read_rate_limit(
     if not db_tier:
         raise NotFoundException("Tier not found")
 
-    db_rate_limit = await crud_rate_limits.get(db=db, schema_to_select=RateLimitRead, tier_id=db_tier["id"], id=id)
+    db_rate_limit: dict | None = await crud_rate_limits.get(
+        db=db, schema_to_select=RateLimitRead, tier_id=db_tier["id"], id=id
+    )
     if db_rate_limit is None:
         raise NotFoundException("Rate Limit not found")
 

src/app/api/v1/tiers.py

@@ -24,7 +24,8 @@ async def write_tier(
         raise DuplicateValueException("Tier Name not available")
 
     tier_internal = TierCreateInternal(**tier_internal_dict)
-    return await crud_tiers.create(db=db, object=tier_internal)
+    created_tier: TierRead = await crud_tiers.create(db=db, object=tier_internal)
+    return created_tier
 
 
 @router.get("/tiers", response_model=PaginatedListResponse[TierRead])
@@ -40,7 +41,7 @@ async def read_tiers(
 
 @router.get("/tier/{name}", response_model=TierRead)
 async def read_tier(request: Request, name: str, db: Annotated[AsyncSession, Depends(async_get_db)]) -> dict:
-    db_tier = await crud_tiers.get(db=db, schema_to_select=TierRead, name=name)
+    db_tier: TierRead | None = await crud_tiers.get(db=db, schema_to_select=TierRead, name=name)
     if db_tier is None:
         raise NotFoundException("Tier not found")
 

src/app/api/v1/users.py

@@ -36,7 +36,8 @@ async def write_user(
     del user_internal_dict["password"]
 
     user_internal = UserCreateInternal(**user_internal_dict)
-    return await crud_users.create(db=db, object=user_internal)
+    created_user: UserRead = await crud_users.create(db=db, object=user_internal)
+    return created_user
 
 
 @router.get("/users", response_model=PaginatedListResponse[UserRead])
@@ -61,7 +62,9 @@ async def read_users_me(request: Request, current_user: Annotated[UserRead, Depe
 
 @router.get("/user/{username}", response_model=UserRead)
 async def read_user(request: Request, username: str, db: Annotated[AsyncSession, Depends(async_get_db)]) -> dict:
-    db_user = await crud_users.get(db=db, schema_to_select=UserRead, username=username, is_deleted=False)
+    db_user: UserRead | None = await crud_users.get(
+        db=db, schema_to_select=UserRead, username=username, is_deleted=False
+    )
     if db_user is None:
         raise NotFoundException("User not found")
 
@@ -168,7 +171,7 @@ async def read_user_tier(
     if not db_tier:
         raise NotFoundException("Tier not found")
 
-    joined = await crud_users.get_joined(
+    joined: dict = await crud_users.get_joined(
         db=db,
         join_model=Tier,
         join_prefix="tier_",

src/app/core/db/crud_token_blacklist.py

@@ -1,6 +1,7 @@
-from ...crud.crud_base import CRUDBase
+from fastcrud import FastCRUD
+
 from ..db.token_blacklist import TokenBlacklist
 from ..schemas import TokenBlacklistCreate, TokenBlacklistUpdate
 
-CRUDTokenBlacklist = CRUDBase[TokenBlacklist, TokenBlacklistCreate, TokenBlacklistUpdate, TokenBlacklistUpdate, None]
+CRUDTokenBlacklist = FastCRUD[TokenBlacklist, TokenBlacklistCreate, TokenBlacklistUpdate, TokenBlacklistUpdate, None]
 crud_token_blacklist = CRUDTokenBlacklist(TokenBlacklist)

src/app/core/exceptions/http_exceptions.py

@@ -1,45 +1,11 @@
-from http import HTTPStatus
-
-from fastapi import HTTPException, status
-
-
-class CustomException(HTTPException):
-    def __init__(self, status_code: int = status.HTTP_500_INTERNAL_SERVER_ERROR, detail: str | None = None):
-        if not detail:
-            detail = HTTPStatus(status_code).description
-        super().__init__(status_code=status_code, detail=detail)
-
-
-class BadRequestException(CustomException):
-    def __init__(self, detail: str | None = None):
-        super().__init__(status_code=status.HTTP_400_BAD_REQUEST, detail=detail)
-
-
-class NotFoundException(CustomException):
-    def __init__(self, detail: str | None = None):
-        super().__init__(status_code=status.HTTP_404_NOT_FOUND, detail=detail)
-
-
-class ForbiddenException(CustomException):
-    def __init__(self, detail: str | None = None):
-        super().__init__(status_code=status.HTTP_403_FORBIDDEN, detail=detail)
-
-
-class UnauthorizedException(CustomException):
-    def __init__(self, detail: str | None = None):
-        super().__init__(status_code=status.HTTP_401_UNAUTHORIZED, detail=detail)
-
-
-class UnprocessableEntityException(CustomException):
-    def __init__(self, detail: str | None = None):
-        super().__init__(status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, detail=detail)
-
-
-class DuplicateValueException(CustomException):
-    def __init__(self, detail: str | None = None):
-        super().__init__(status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, detail=detail)
-
-
-class RateLimitException(CustomException):
-    def __init__(self, detail: str | None = None):
-        super().__init__(status_code=status.HTTP_429_TOO_MANY_REQUESTS, detail=detail)
+# ruff: noqa
+from fastcrud.exceptions.http_exceptions import (
+    CustomException,
+    BadRequestException,
+    NotFoundException,
+    ForbiddenException,
+    UnauthorizedException,
+    UnprocessableEntityException,
+    DuplicateValueException,
+    RateLimitException,
+)

src/app/core/worker/functions.py

@@ -1,5 +1,6 @@
 import asyncio
 import logging
+
 import uvloop
 from arq.worker import Worker
 
@@ -16,7 +17,7 @@ async def sample_background_task(ctx: Worker, name: str) -> str:
 
 # -------- base functions --------
 async def startup(ctx: Worker) -> None:
-    logging.info('Worker Started')
+    logging.info("Worker Started")
 
 
 async def shutdown(ctx: Worker) -> None:

src/app/core/worker/settings.py

@@ -1,6 +1,7 @@
 from arq.connections import RedisSettings
+
 from ...core.config import settings
-from .functions import sample_background_task, startup, shutdown
+from .functions import sample_background_task, shutdown, startup
 
 REDIS_QUEUE_HOST = settings.REDIS_QUEUE_HOST
 REDIS_QUEUE_PORT = settings.REDIS_QUEUE_PORT