refactor&perf: 增强ruff规则，完善类型提示

ruoyi-fastapi-backend/module_admin/controller/menu_controller.py

@@ -1,8 +1,10 @@
 from datetime import datetime
-from fastapi import APIRouter, Depends, Request
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, Path, Query, Request, Response
 from pydantic_validation_decorator import ValidateFields
 from sqlalchemy.ext.asyncio import AsyncSession
-from typing import List
+
 from config.enums import BusinessType
 from config.get_db import get_db
 from module_admin.annotation.log_annotation import Log
@@ -14,59 +16,58 @@ from module_admin.service.menu_service import MenuService
 from utils.log_util import logger
 from utils.response_util import ResponseUtil
 
-
-menuController = APIRouter(prefix='/system/menu', dependencies=[Depends(LoginService.get_current_user)])
+menu_controller = APIRouter(prefix='/system/menu', dependencies=[Depends(LoginService.get_current_user)])
 
 
-@menuController.get('/treeselect')
+@menu_controller.get('/treeselect')
 async def get_system_menu_tree(
     request: Request,
-    query_db: AsyncSession = Depends(get_db),
-    current_user: CurrentUserModel = Depends(LoginService.get_current_user),
-):
+    query_db: Annotated[AsyncSession, Depends(get_db)],
+    current_user: Annotated[CurrentUserModel, Depends(LoginService.get_current_user)],
+) -> Response:
     menu_query_result = await MenuService.get_menu_tree_services(query_db, current_user)
     logger.info('获取成功')
 
     return ResponseUtil.success(data=menu_query_result)
 
 
-@menuController.get('/roleMenuTreeselect/{role_id}')
+@menu_controller.get('/roleMenuTreeselect/{role_id}')
 async def get_system_role_menu_tree(
     request: Request,
-    role_id: int,
-    query_db: AsyncSession = Depends(get_db),
-    current_user: CurrentUserModel = Depends(LoginService.get_current_user),
-):
+    role_id: Annotated[int, Path(description='角色ID')],
+    query_db: Annotated[AsyncSession, Depends(get_db)],
+    current_user: Annotated[CurrentUserModel, Depends(LoginService.get_current_user)],
+) -> Response:
     role_menu_query_result = await MenuService.get_role_menu_tree_services(query_db, role_id, current_user)
     logger.info('获取成功')
 
     return ResponseUtil.success(model_content=role_menu_query_result)
 
 
-@menuController.get(
-    '/list', response_model=List[MenuModel], dependencies=[Depends(CheckUserInterfaceAuth('system:menu:list'))]
+@menu_controller.get(
+    '/list', response_model=list[MenuModel], dependencies=[Depends(CheckUserInterfaceAuth('system:menu:list'))]
 )
 async def get_system_menu_list(
     request: Request,
-    menu_query: MenuQueryModel = Depends(MenuQueryModel.as_query),
-    query_db: AsyncSession = Depends(get_db),
-    current_user: CurrentUserModel = Depends(LoginService.get_current_user),
-):
+    menu_query: Annotated[MenuQueryModel, Query()],
+    query_db: Annotated[AsyncSession, Depends(get_db)],
+    current_user: Annotated[CurrentUserModel, Depends(LoginService.get_current_user)],
+) -> Response:
     menu_query_result = await MenuService.get_menu_list_services(query_db, menu_query, current_user)
     logger.info('获取成功')
 
     return ResponseUtil.success(data=menu_query_result)
 
 
-@menuController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:add'))])
+@menu_controller.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:add'))])
 @ValidateFields(validate_model='add_menu')
 @Log(title='菜单管理', business_type=BusinessType.INSERT)
 async def add_system_menu(
     request: Request,
     add_menu: MenuModel,
-    query_db: AsyncSession = Depends(get_db),
-    current_user: CurrentUserModel = Depends(LoginService.get_current_user),
-):
+    query_db: Annotated[AsyncSession, Depends(get_db)],
+    current_user: Annotated[CurrentUserModel, Depends(LoginService.get_current_user)],
+) -> Response:
     add_menu.create_by = current_user.user.user_name
     add_menu.create_time = datetime.now()
     add_menu.update_by = current_user.user.user_name
@@ -77,15 +78,15 @@ async def add_system_menu(
     return ResponseUtil.success(msg=add_menu_result.message)
 
 
-@menuController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:edit'))])
+@menu_controller.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:edit'))])
 @ValidateFields(validate_model='edit_menu')
 @Log(title='菜单管理', business_type=BusinessType.UPDATE)
 async def edit_system_menu(
     request: Request,
     edit_menu: MenuModel,
-    query_db: AsyncSession = Depends(get_db),
-    current_user: CurrentUserModel = Depends(LoginService.get_current_user),
-):
+    query_db: Annotated[AsyncSession, Depends(get_db)],
+    current_user: Annotated[CurrentUserModel, Depends(LoginService.get_current_user)],
+) -> Response:
     edit_menu.update_by = current_user.user.user_name
     edit_menu.update_time = datetime.now()
     edit_menu_result = await MenuService.edit_menu_services(query_db, edit_menu)
@@ -94,9 +95,13 @@ async def edit_system_menu(
     return ResponseUtil.success(msg=edit_menu_result.message)
 
 
-@menuController.delete('/{menu_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:remove'))])
+@menu_controller.delete('/{menu_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:remove'))])
 @Log(title='菜单管理', business_type=BusinessType.DELETE)
-async def delete_system_menu(request: Request, menu_ids: str, query_db: AsyncSession = Depends(get_db)):
+async def delete_system_menu(
+    request: Request,
+    menu_ids: Annotated[str, Path(description='需要删除的菜单ID')],
+    query_db: Annotated[AsyncSession, Depends(get_db)],
+) -> Response:
     delete_menu = DeleteMenuModel(menuIds=menu_ids)
     delete_menu_result = await MenuService.delete_menu_services(query_db, delete_menu)
     logger.info(delete_menu_result.message)
@@ -104,10 +109,14 @@ async def delete_system_menu(request: Request, menu_ids: str, query_db: AsyncSes
     return ResponseUtil.success(msg=delete_menu_result.message)
 
 
-@menuController.get(
+@menu_controller.get(
     '/{menu_id}', response_model=MenuModel, dependencies=[Depends(CheckUserInterfaceAuth('system:menu:query'))]
 )
-async def query_detail_system_menu(request: Request, menu_id: int, query_db: AsyncSession = Depends(get_db)):
+async def query_detail_system_menu(
+    request: Request,
+    menu_id: Annotated[int, Path(description='菜单ID')],
+    query_db: Annotated[AsyncSession, Depends(get_db)],
+) -> Response:
     menu_detail_result = await MenuService.menu_detail_services(query_db, menu_id)
     logger.info(f'获取menu_id为{menu_id}的信息成功')