Update tree data return type hints

Author: wu-clan

backend/app/admin/api/v1/sys/dept.py

@@ -6,8 +6,8 @@
 
 from backend.app.admin.schema.dept import CreateDeptParam, GetDeptDetail, UpdateDeptParam
 from backend.app.admin.service.dept_service import dept_service
-from backend.common.pagination import PageData
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
+from backend.common.schema import CustomTreeData
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
@@ -29,7 +29,7 @@ async def get_all_depts_tree(
     leader: Annotated[str | None, Query()] = None,
     phone: Annotated[str | None, Query()] = None,
     status: Annotated[int | None, Query()] = None,
-) -> ResponseSchemaModel[PageData[GetDeptDetail]]:
+) -> ResponseSchemaModel[CustomTreeData]:
     dept = await dept_service.get_dept_tree(name=name, leader=leader, phone=phone, status=status)
     return response_base.success(data=dept)
 

backend/app/admin/api/v1/sys/menu.py

@@ -1,12 +1,13 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from typing import Annotated, Any
+from typing import Annotated
 
 from fastapi import APIRouter, Depends, Path, Query, Request
 
 from backend.app.admin.schema.menu import CreateMenuParam, GetMenuDetail, UpdateMenuParam
 from backend.app.admin.service.menu_service import menu_service
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
+from backend.common.schema import CustomTreeData
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
@@ -16,7 +17,7 @@
 
 
 @router.get('/sidebar', summary='获取用户菜单展示树', dependencies=[DependsJwtAuth])
-async def get_user_sidebar_tree(request: Request) -> ResponseSchemaModel[list[dict[str, Any]]]:
+async def get_user_sidebar_tree(request: Request) -> ResponseSchemaModel[CustomTreeData]:
     menu = await menu_service.get_user_menu_tree(request=request)
     return response_base.success(data=menu)
 
@@ -31,7 +32,7 @@ async def get_menu(pk: Annotated[int, Path(...)]) -> ResponseSchemaModel[GetMenu
 @router.get('', summary='获取所有菜单展示树', dependencies=[DependsJwtAuth])
 async def get_all_menus(
     title: Annotated[str | None, Query()] = None, status: Annotated[int | None, Query()] = None
-) -> ResponseSchemaModel[list[dict[str, Any]]]:
+) -> ResponseSchemaModel[CustomTreeData]:
     menu = await menu_service.get_menu_tree(title=title, status=status)
     return response_base.success(data=menu)
 

backend/app/admin/api/v1/sys/role.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from typing import Annotated, Any
+from typing import Annotated
 
 from fastapi import APIRouter, Depends, Path, Query, Request
 
@@ -16,6 +16,7 @@
 from backend.app.admin.service.role_service import role_service
 from backend.common.pagination import DependsPagination, PageData, paging_data
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
+from backend.common.schema import CustomTreeData
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
@@ -40,7 +41,7 @@ async def get_user_all_roles(pk: Annotated[int, Path(...)]) -> ResponseSchemaMod
 
 
 @router.get('/{pk}/menus', summary='获取角色所有菜单', dependencies=[DependsJwtAuth])
-async def get_role_all_menus(pk: Annotated[int, Path(...)]) -> ResponseSchemaModel[list[dict[str, Any]]]:
+async def get_role_all_menus(pk: Annotated[int, Path(...)]) -> ResponseSchemaModel[CustomTreeData]:
     menu = await menu_service.get_role_menu_tree(pk=pk)
     return response_base.success(data=menu)
 

backend/app/generator/api/v1/gen_business.py

@@ -35,7 +35,7 @@ async def get_business(pk: Annotated[int, Path(...)]) -> ResponseModel:
 
 
 @router.get('/{pk}/models', summary='获取代码生成业务所有模型', dependencies=[DependsJwtAuth])
-async def get_business_models(pk: Annotated[int, Path(...)]) -> ResponseModel:
+async def get_business_all_models(pk: Annotated[int, Path(...)]) -> ResponseModel:
     models = await gen_model_service.get_by_business(business_id=pk)
     data = select_list_serialize(models)
     return response_base.success(data=data)

backend/common/schema.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from pydantic import BaseModel, ConfigDict, EmailStr, validate_email
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, EmailStr, Field, validate_email
 from pydantic_extra_types.phone_numbers import PhoneNumber
 
 # 自定义验证错误信息不包含验证预期内容（也就是输入内容），受支持的预期内容字段参考以下链接
@@ -148,5 +150,13 @@ def _validate(cls, __input_value: str) -> str:
         return None if __input_value == '' else validate_email(__input_value)[1]
 
 
+class CustomTreeData(BaseModel):
+    """由于树形数据无法固定其数据结构，可使用此类型做为文档说明"""
+
+    tree_data: list[dict[str, Any]] = Field(
+        description='此参数并不是实际参数，仅表示此接口返回为树形数据，具体数据结构请以接口返回内容为准'
+    )
+
+
 class SchemaBase(BaseModel):
     model_config = ConfigDict(use_enum_values=True)

backend/utils/serializers.py

@@ -30,7 +30,7 @@ def select_columns_serialize(row: R) -> dict:
     return result
 
 
-def select_list_serialize(row: Sequence[R]) -> list:
+def select_list_serialize(row: Sequence[R]) -> list[dict[str, Any]]:
     """
     Serialize SQLAlchemy select list
 
@@ -59,7 +59,7 @@ def select_as_dict(row: R, use_alias: bool = False) -> dict:
             del result['_sa_instance_state']
     else:
         result = {}
-        mapper = class_mapper(row.__class__)
+        mapper = class_mapper(row.__class__)  # type: ignore
         for prop in mapper.iterate_properties:
             if isinstance(prop, (ColumnProperty, SynonymProperty)):
                 key = prop.key