Optimize plugin

Author: wu-clan

backend/app/admin/model/config.py

@@ -9,7 +9,7 @@
 
 
 class Config(Base):
-    """系统配置表"""
+    """配置表"""
 
     __tablename__ = 'sys_config'
 

backend/app/admin/model/dict_data.py

@@ -16,7 +16,7 @@
 
 
 class DictData(Base):
-    """字典数据"""
+    """字典数据表"""
 
     __tablename__ = 'sys_dict_data'
 

backend/app/admin/model/dict_type.py

@@ -16,7 +16,7 @@
 
 
 class DictType(Base):
-    """字典类型"""
+    """字典类型表"""
 
     __tablename__ = 'sys_dict_type'
 

backend/plugin/casbin/api/v1/sys/casbin.py

@@ -36,25 +36,25 @@
 )
 async def get_pagination_casbin(
     db: CurrentSession,
-    ptype: Annotated[str | None, Query(description='策略类型, p / g')] = None,
-    sub: Annotated[str | None, Query(description='用户 uuid / 角色')] = None,
+    ptype: Annotated[str | None, Query(description='策略类型：p / g')] = None,
+    sub: Annotated[str | None, Query(description='用户 UUID / 角色 ID')] = None,
 ) -> ResponseSchemaModel[PageData[GetPolicyDetail]]:
     casbin_select = await casbin_service.get_casbin_list(ptype=ptype, sub=sub)
     page_data = await paging_data(db, casbin_select)
     return response_base.success(data=page_data)
 
 
-@router.get('/policies', summary='获取所有P权限策略', dependencies=[DependsJwtAuth])
+@router.get('/policies', summary='获取所有 P 权限策略', dependencies=[DependsJwtAuth])
 async def get_all_policies(
-    role: Annotated[int | None, Query(description='角色ID')] = None,
+    role: Annotated[int | None, Query(description='角色 ID')] = None,
 ) -> ResponseSchemaModel[list[list[str]]]:
     policies = await casbin_service.get_policy_list(role=role)
     return response_base.success(data=policies)
 
 
 @router.post(
     '/policy',
-    summary='添加P权限策略',
+    summary='添加 P 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:p:add')),
         DependsRBAC,
@@ -76,7 +76,7 @@ async def create_policy(p: CreatePolicyParam) -> ResponseSchemaModel[bool]:
 
 @router.post(
     '/policies',
-    summary='添加多组P权限策略',
+    summary='添加多组 P 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:p:group:add')),
         DependsRBAC,
@@ -89,7 +89,7 @@ async def create_policies(ps: list[CreatePolicyParam]) -> ResponseSchemaModel[bo
 
 @router.put(
     '/policy',
-    summary='更新P权限策略',
+    summary='更新 P 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:p:edit')),
         DependsRBAC,
@@ -102,7 +102,7 @@ async def update_policy(obj: UpdatePolicyParam) -> ResponseSchemaModel[bool]:
 
 @router.put(
     '/policies',
-    summary='更新多组P权限策略',
+    summary='更新多组 P 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:p:group:edit')),
         DependsRBAC,
@@ -115,7 +115,7 @@ async def update_policies(obj: UpdatePoliciesParam) -> ResponseSchemaModel[bool]
 
 @router.delete(
     '/policy',
-    summary='删除P权限策略',
+    summary='删除 P 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:p:del')),
         DependsRBAC,
@@ -128,7 +128,7 @@ async def delete_policy(p: DeletePolicyParam) -> ResponseSchemaModel[bool]:
 
 @router.delete(
     '/policies',
-    summary='删除多组P权限策略',
+    summary='删除多组 P 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:p:group:del')),
         DependsRBAC,
@@ -141,7 +141,7 @@ async def delete_policies(ps: list[DeletePolicyParam]) -> ResponseSchemaModel[bo
 
 @router.delete(
     '/policies/all',
-    summary='删除所有P权限策略',
+    summary='删除所有 P 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:p:empty')),
         DependsRBAC,
@@ -154,15 +154,15 @@ async def delete_all_policies(sub: DeleteAllPoliciesParam) -> ResponseModel:
     return response_base.fail()
 
 
-@router.get('/groups', summary='获取所有G权限策略', dependencies=[DependsJwtAuth])
+@router.get('/groups', summary='获取所有 G 权限策略', dependencies=[DependsJwtAuth])
 async def get_all_groups() -> ResponseSchemaModel[list[list[str]]]:
     data = await casbin_service.get_group_list()
     return response_base.success(data=data)
 
 
 @router.post(
     '/group',
-    summary='添加G权限策略',
+    summary='添加 G 权限策略',
     dependencies=[
         Depends(RequestPermission('casbin:g:add')),
         DependsRBAC,

backend/plugin/casbin/conf.py

@@ -8,9 +8,9 @@
 
 
 class CasbinSettings(BaseSettings):
-    """Casbin Settings"""
+    """Casbin 配置类"""
 
-    # RBAC
+    # RBAC 配置
     RBAC_CASBIN_EXCLUDE: set[tuple[str, str]] = {
         ('POST', f'{settings.FASTAPI_API_V1_PATH}/auth/logout'),
         ('POST', f'{settings.FASTAPI_API_V1_PATH}/auth/token/new'),
@@ -19,7 +19,7 @@ class CasbinSettings(BaseSettings):
 
 @lru_cache
 def get_casbin_settings() -> CasbinSettings:
-    """获取 xxx 配置"""
+    """获取 Casbin 配置"""
     return CasbinSettings()
 
 

backend/plugin/casbin/crud/crud_api.py

@@ -13,12 +13,14 @@
 
 
 class CRUDApi(CRUDPlus[Api]):
+    """API 数据库操作类"""
+
     async def get(self, db: AsyncSession, pk: int) -> Api | None:
         """
         获取 API
 
-        :param db:
-        :param pk:
+        :param db: 数据库会话
+        :param pk: 主键
         :return:
         """
         return await self.select_model(db, pk)
@@ -27,10 +29,10 @@ async def get_list(self, request: Request, name: str = None, method: str = None,
         """
         获取 API 列表
 
-        :param request:
-        :param name:
-        :param method:
-        :param path:
+        :param request: FastAPI 请求对象
+        :param name: API 名称
+        :param method: 请求方法
+        :param path: API 路径
         :return:
         """
         filters = {}
@@ -47,17 +49,17 @@ async def get_all(self, db: AsyncSession) -> Sequence[Api]:
         """
         获取所有 API
 
-        :param db:
+        :param db: 数据库会话
         :return:
         """
         return await self.select_models(db)
 
     async def get_by_name(self, db: AsyncSession, name: str) -> Api | None:
         """
-        通过 name 获取 API
+        通过名称获取 API
 
-        :param db:
-        :param name:
+        :param db: 数据库会话
+        :param name: API 名称
         :return:
         """
         return await self.select_model_by_column(db, name=name)
@@ -66,8 +68,8 @@ async def create(self, db: AsyncSession, obj_in: CreateApiParam) -> None:
         """
         创建 API
 
-        :param db:
-        :param obj_in:
+        :param db: 数据库会话
+        :param obj_in: 创建参数
         :return:
         """
         await self.create_model(db, obj_in)
@@ -76,9 +78,9 @@ async def update(self, db: AsyncSession, pk: int, obj_in: UpdateApiParam) -> int
         """
         更新 API
 
-        :param db:
-        :param pk:
-        :param obj_in:
+        :param db: 数据库会话
+        :param pk: 主键
+        :param obj_in: 更新参数
         :return:
         """
         return await self.update_model(db, pk, obj_in)
@@ -87,8 +89,8 @@ async def delete(self, db: AsyncSession, pk: list[int]) -> int:
         """
         删除 API
 
-        :param db:
-        :param pk:
+        :param db: 数据库会话
+        :param pk: 主键列表
         :return:
         """
         return await self.delete_model_by_column(db, allow_multiple=True, id__in=pk)

backend/plugin/casbin/crud/crud_casbin.py

@@ -11,22 +11,24 @@
 
 
 class CRUDCasbin(CRUDPlus[CasbinRule]):
+    """Casbin 规则数据库操作类"""
+
     async def get_list(self, ptype: str, sub: str) -> Select:
         """
         获取策略列表
 
-        :param ptype:
-        :param sub:
+        :param ptype: 策略类型
+        :param sub: 用户 UUID / 角色 ID
         :return:
         """
         return await self.select_order('id', 'desc', ptype=ptype, v0__like=f'%{sub}%')
 
     async def delete_policies_by_sub(self, db: AsyncSession, sub: DeleteAllPoliciesParam) -> int:
         """
-        删除角色所有P策略
+        删除角色所有 P 策略
 
-        :param db:
-        :param sub:
+        :param db: 数据库会话
+        :param sub: 删除参数
         :return:
         """
         where_list = [sub.role]
@@ -36,10 +38,10 @@ async def delete_policies_by_sub(self, db: AsyncSession, sub: DeleteAllPoliciesP
 
     async def delete_groups_by_uuid(self, db: AsyncSession, uuid: UUID) -> int:
         """
-        删除用户所有G策略
+        删除用户所有 G 策略
 
-        :param db:
-        :param uuid:
+        :param db: 数据库会话
+        :param uuid: 用户uuid
         :return:
         """
         return await self.delete_model_by_column(db, allow_multiple=True, v0=str(uuid))

backend/plugin/casbin/model/api.py

@@ -9,12 +9,12 @@
 
 
 class Api(Base):
-    """系统api"""
+    """API 表"""
 
     __tablename__ = 'sys_api'
 
     id: Mapped[id_key] = mapped_column(init=False)
-    name: Mapped[str] = mapped_column(String(50), unique=True, comment='api名称')
+    name: Mapped[str] = mapped_column(String(50), unique=True, comment='API 名称')
     method: Mapped[str] = mapped_column(String(16), comment='请求方法')
-    path: Mapped[str] = mapped_column(String(500), comment='api路径')
+    path: Mapped[str] = mapped_column(String(500), comment='API 路径')
     remark: Mapped[str | None] = mapped_column(LONGTEXT().with_variant(TEXT, 'postgresql'), comment='备注')

backend/plugin/casbin/model/casbin_rule.py

@@ -9,26 +9,26 @@
 
 
 class CasbinRule(MappedBase):
-    """重写 casbin 中的 CasbinRule model 类, 使用自定义 Base, 避免产生 alembic 迁移问题"""
+    """Casbin 规则表"""
 
     __tablename__ = 'sys_casbin_rule'
 
     id: Mapped[id_key]
     ptype: Mapped[str] = mapped_column(String(255), comment='策略类型: p / g')
-    v0: Mapped[str] = mapped_column(String(255), comment='角色ID / 用户uuid')
-    v1: Mapped[str] = mapped_column(LONGTEXT().with_variant(TEXT, 'postgresql'), comment='api路径 / 角色名称')
+    v0: Mapped[str] = mapped_column(String(255), comment='用户 UUID / 角色 ID')
+    v1: Mapped[str] = mapped_column(LONGTEXT().with_variant(TEXT, 'postgresql'), comment='API 路径 / 角色名称')
     v2: Mapped[str | None] = mapped_column(String(255), comment='请求方法')
-    v3: Mapped[str | None] = mapped_column(String(255))
-    v4: Mapped[str | None] = mapped_column(String(255))
-    v5: Mapped[str | None] = mapped_column(String(255))
+    v3: Mapped[str | None] = mapped_column(String(255), comment='预留字段')
+    v4: Mapped[str | None] = mapped_column(String(255), comment='预留字段')
+    v5: Mapped[str | None] = mapped_column(String(255), comment='预留字段')
 
-    def __str__(self):
+    def __str__(self) -> str:
         arr = [self.ptype]
         for v in (self.v0, self.v1, self.v2, self.v3, self.v4, self.v5):
             if v is None:
                 break
             arr.append(v)
         return ', '.join(arr)
 
-    def __repr__(self):
-        return '<CasbinRule {}: "{}">'.format(self.id, str(self))
+    def __repr__(self) -> str:
+        return f'<CasbinRule {self.id}: "{str(self)}">'

backend/plugin/casbin/schema/api.py

@@ -9,23 +9,27 @@
 
 
 class ApiSchemaBase(SchemaBase):
-    name: str
+    """API 基础模型"""
+
+    name: str = Field(description='API 名称')
     method: MethodType = Field(default=MethodType.GET, description='请求方法')
-    path: str = Field(description='api路径')
-    remark: str | None = None
+    path: str = Field(description='API 路径')
+    remark: str | None = Field(default=None, description='备注')
 
 
 class CreateApiParam(ApiSchemaBase):
-    pass
+    """创建 API 参数"""
 
 
 class UpdateApiParam(ApiSchemaBase):
-    pass
+    """更新 API 参数"""
 
 
 class GetApiDetail(ApiSchemaBase):
+    """API 详情"""
+
     model_config = ConfigDict(from_attributes=True)
 
-    id: int
-    created_time: datetime
-    updated_time: datetime | None = None
+    id: int = Field(description='API ID')
+    created_time: datetime = Field(description='创建时间')
+    updated_time: datetime | None = Field(default=None, description='更新时间')