simplify crud method naming (#75)

* simplify crud method naming

* update get_user_list to get_select

Author: wu-clan

backend/__init__.py

@@ -50,8 +50,8 @@ async def update_avatar(username: str, avatar: Avatar, current_user: CurrentUser
 
 @router.get('', summary='获取所有用户', dependencies=[DependsUser, PageDepends])
 async def get_all_users(db: CurrentSession):
-    user_list = await UserService.get_user_list()
-    page_data = await paging_data(db, user_list, GetUserInfo)
+    user_select = await UserService.get_select()
+    page_data = await paging_data(db, user_select, GetUserInfo)
     return response_base.success(data=page_data)
 
 

backend/app/api/v1/user.py

@@ -150,7 +150,7 @@ async def get_current_user(db: CurrentSession, data: dict = Depends(jwt_authenti
     :return:
     """
     user_id = data.get('sub')
-    user = await UserDao.get_user_with_relation(db, user_id=user_id)
+    user = await UserDao.get_with_relation(db, user_id=user_id)
     if not user:
         raise TokenError
     return user

backend/app/common/jwt.py

@@ -3,8 +3,6 @@
 from contextlib import asynccontextmanager
 
 from fastapi import FastAPI
-from fastapi.middleware.cors import CORSMiddleware
-from fastapi.middleware.gzip import GZipMiddleware
 from fastapi_limiter import FastAPILimiter
 from fastapi_pagination import add_pagination
 
@@ -14,9 +12,8 @@
 from backend.app.common.task import scheduler
 from backend.app.core.conf import settings
 from backend.app.database.db_mysql import create_table
-from backend.app.middleware.access_middleware import AccessMiddleware
-from backend.app.utils.openapi import simplify_operation_ids
 from backend.app.utils.health_check import ensure_unique_route_names
+from backend.app.utils.openapi import simplify_operation_ids
 
 
 @asynccontextmanager
@@ -57,9 +54,8 @@ def register_app():
         lifespan=register_init,
     )
 
-    if settings.STATIC_FILES:
-        # 注册静态文件
-        register_static_file(app)
+    # 静态文件
+    register_static_file(app)
 
     # 中间件
     register_middleware(app)
@@ -83,17 +79,20 @@ def register_static_file(app: FastAPI):
     :param app:
     :return:
     """
-    import os
-    from fastapi.staticfiles import StaticFiles
+    if settings.STATIC_FILES:
+        import os
+        from fastapi.staticfiles import StaticFiles
 
-    if not os.path.exists('./static'):
-        os.mkdir('./static')
-    app.mount('/static', StaticFiles(directory='static'), name='static')
+        if not os.path.exists('./static'):
+            os.mkdir('./static')
+        app.mount('/static', StaticFiles(directory='static'), name='static')
 
 
 def register_middleware(app: FastAPI):
     # CORS
     if settings.MIDDLEWARE_CORS:
+        from fastapi.middleware.cors import CORSMiddleware
+
         app.add_middleware(
             CORSMiddleware,
             allow_origins=['*'],
@@ -103,9 +102,13 @@ def register_middleware(app: FastAPI):
         )
     # Gzip
     if settings.MIDDLEWARE_GZIP:
+        from fastapi.middleware.gzip import GZipMiddleware
+
         app.add_middleware(GZipMiddleware)
     # Api access logs
     if settings.MIDDLEWARE_ACCESS:
+        from backend.app.middleware.access_middleware import AccessMiddleware
+
         app.add_middleware(AccessMiddleware)
 
 
@@ -118,7 +121,7 @@ def register_router(app: FastAPI):
     """
     app.include_router(v1)
 
-    # extra
+    # Extra
     ensure_unique_route_names(app)
     simplify_operation_ids(app)
 

backend/app/core/registrar.py

@@ -17,7 +17,7 @@ class CRUDBase(Generic[ModelType, CreateSchemaType, UpdateSchemaType]):
     def __init__(self, model: Type[ModelType]):
         self.model = model
 
-    async def get(self, db: AsyncSession, pk: int) -> ModelType | None:
+    async def get_(self, db: AsyncSession, pk: int) -> ModelType | None:
         """
         通过主键 id 获取一条数据
 
@@ -28,7 +28,7 @@ async def get(self, db: AsyncSession, pk: int) -> ModelType | None:
         model = await db.execute(select(self.model).where(self.model.id == pk))
         return model.scalars().first()
 
-    async def create(self, db: AsyncSession, obj_in: CreateSchemaType, user_id: int | None = None) -> NoReturn:
+    async def create_(self, db: AsyncSession, obj_in: CreateSchemaType, user_id: int | None = None) -> NoReturn:
         """
         新增一条数据
 
@@ -43,7 +43,7 @@ async def create(self, db: AsyncSession, obj_in: CreateSchemaType, user_id: int
             db_obj = self.model(**obj_in.dict())
         db.add(db_obj)
 
-    async def update(
+    async def update_(
         self, db: AsyncSession, pk: int, obj_in: UpdateSchemaType | Dict[str, Any], user_id: int | None = None
     ) -> int:
         """
@@ -64,7 +64,7 @@ async def update(
         model = await db.execute(update(self.model).where(self.model.id == pk).values(**update_data))
         return model.rowcount
 
-    async def delete(self, db: AsyncSession, pk: int) -> int:
+    async def delete_(self, db: AsyncSession, pk: int) -> int:
         """
         通过主键 id 删除一条数据
 

backend/app/crud/base.py

@@ -6,8 +6,8 @@
 
 
 class CRUDDept(CRUDBase[Dept, CreateDept, UpdateDept]):
-    async def get_dept_by_id(self, db, dept_id):
-        return await self.get(db, dept_id)
+    async def get(self, db, dept_id: int):
+        return await self.get_(db, dept_id)
 
 
 DeptDao: CRUDDept = CRUDDept(Dept)

backend/app/crud/crud_dept.py

@@ -6,8 +6,8 @@
 
 
 class CRUDRole(CRUDBase[Role, CreateRole, UpdateRole]):
-    async def get_role_by_id(self, db, role_id):
-        return await self.get(db, role_id)
+    async def get(self, db, role_id: int):
+        return await self.get_(db, role_id)
 
 
 RoleDao: CRUDRole = CRUDRole(Role)

backend/app/crud/crud_role.py

@@ -14,18 +14,18 @@
 
 
 class CRUDUser(CRUDBase[User, CreateUser, UpdateUser]):
-    async def get_user_by_id(self, db: AsyncSession, user_id: int) -> User | None:
-        return await self.get(db, user_id)
+    async def get(self, db: AsyncSession, user_id: int) -> User | None:
+        return await self.get_(db, user_id)
 
-    async def get_user_by_username(self, db: AsyncSession, username: str) -> User | None:
+    async def get_by_username(self, db: AsyncSession, username: str) -> User | None:
         user = await db.execute(select(self.model).where(self.model.username == username))
         return user.scalars().first()
 
-    async def update_user_login_time(self, db: AsyncSession, username: str) -> int:
+    async def update_login_time(self, db: AsyncSession, username: str) -> int:
         user = await db.execute(update(self.model).where(self.model.username == username).values(last_login=func.now()))
         return user.rowcount
 
-    async def create_user(self, db: AsyncSession, create: CreateUser) -> NoReturn:
+    async def create(self, db: AsyncSession, create: CreateUser) -> NoReturn:
         create.password = jwt.get_hash_password(create.password)
         new_user = self.model(**create.dict(exclude={'roles'}))
         role_list = []
@@ -52,8 +52,8 @@ async def update_avatar(self, db: AsyncSession, current_user: User, avatar: Avat
         user = await db.execute(update(self.model).where(self.model.id == current_user.id).values(avatar=avatar))
         return user.rowcount
 
-    async def delete_user(self, db: AsyncSession, user_id: int) -> int:
-        return await self.delete(db, user_id)
+    async def delete(self, db: AsyncSession, user_id: int) -> int:
+        return await super().delete_(db, user_id)
 
     async def check_email(self, db: AsyncSession, email: str) -> User | None:
         mail = await db.execute(select(self.model).where(self.model.email == email))
@@ -65,45 +65,43 @@ async def reset_password(self, db: AsyncSession, pk: int, password: str) -> int:
         )
         return user.rowcount
 
-    def get_users(self) -> Select:
+    def get_all(self) -> Select:
         return (
             select(self.model)
             .options(selectinload(self.model.roles).selectinload(Role.menus))
             .order_by(desc(self.model.time_joined))
         )
 
-    async def get_user_is_super(self, db: AsyncSession, user_id: int) -> bool:
-        user = await self.get_user_by_id(db, user_id)
+    async def get_super(self, db: AsyncSession, user_id: int) -> bool:
+        user = await self.get(db, user_id)
         return user.is_superuser
 
-    async def get_user_is_active(self, db: AsyncSession, user_id: int) -> bool:
-        user = await self.get_user_by_id(db, user_id)
+    async def get_active(self, db: AsyncSession, user_id: int) -> bool:
+        user = await self.get(db, user_id)
         return user.is_active
 
-    async def super_set(self, db: AsyncSession, user_id: int) -> int:
-        super_status = await self.get_user_is_super(db, user_id)
+    async def set_super(self, db: AsyncSession, user_id: int) -> int:
+        super_status = await self.get_super(db, user_id)
         user = await db.execute(
             update(self.model).where(self.model.id == user_id).values(is_superuser=False if super_status else True)
         )
         return user.rowcount
 
-    async def active_set(self, db: AsyncSession, user_id: int) -> int:
-        active_status = await self.get_user_is_active(db, user_id)
+    async def set_active(self, db: AsyncSession, user_id: int) -> int:
+        active_status = await self.get_active(db, user_id)
         user = await db.execute(
             update(self.model).where(self.model.id == user_id).values(is_active=False if active_status else True)
         )
         return user.rowcount
 
-    async def get_user_role_ids(self, db: AsyncSession, user_id: int) -> list[int]:
+    async def get_role_ids(self, db: AsyncSession, user_id: int) -> list[int]:
         user = await db.execute(
             select(self.model).where(self.model.id == user_id).options(selectinload(self.model.roles))
         )
         roles_id = [role.id for role in user.scalars().first().roles]
         return roles_id
 
-    async def get_user_with_relation(
-        self, db: AsyncSession, *, user_id: int = None, username: str = None
-    ) -> User | None:
+    async def get_with_relation(self, db: AsyncSession, *, user_id: int = None, username: str = None) -> User | None:
         where = []
         if user_id:
             where.append(self.model.id == user_id)