Files
FastapiAdmin/backend/app/common/request.py
T
zhangtao c2ca6d19ac refactor: 优化代码注释和文档字符串格式
style: 统一代码风格和格式

docs: 完善函数和方法的文档字符串

refactor(base_model): 移除冗余的表名和表参数生成方法

refactor(constant): 更新返回码注释格式

refactor(router_class): 添加路由处理器的详细文档

refactor(database): 完善数据库连接函数的文档

refactor(security): 添加认证类和方法的详细文档

refactor(validator): 更新验证器函数的文档格式

refactor(serialize): 优化序列化工具类的文档

refactor(response): 完善响应类的文档字符串

refactor(dependencies): 添加依赖函数的详细文档

refactor(initialize): 完善初始化脚本的文档

refactor(plugin): 添加生命周期和中间件注册的文档

refactor(service): 完善服务层方法的文档

refactor(controller): 添加控制器方法的详细文档

refactor(crud): 完善CRUD操作的文档字符串

refactor(schema): 简化模型类并移除冗余字段

refactor(param): 更新查询参数类的注释格式

refactor(template): 优化代码生成模板的格式

refactor(console): 添加控制台输出功能的实现

refactor(util): 完善工具函数的文档字符串
2025-10-18 16:31:28 +08:00

75 lines
2.6 KiB
Python

# -*- coding: utf-8 -*-
from typing import Any, Dict, List, Optional
from pydantic import ConfigDict, Field, BaseModel
from pydantic.alias_generators import to_camel
from app.common.constant import RET
from app.core.exceptions import CustomException
class PageResultSchema(BaseModel):
"""分页查询结果模型"""
model_config = ConfigDict(alias_generator=to_camel, from_attributes=True)
page_no: Optional[int] = Field(default=None, ge=1, description="页码,默认为1")
page_size: Optional[int] = Field(default=None, ge=1, description="页面大小,默认为10")
total: int = Field(default=0, ge=0, description="总记录数")
has_next: Optional[bool] = Field(default=False, description="是否有下一页")
items: Optional[List[Any]] = Field(default_factory=list, description="分页后的数据列表")
class PaginationService:
"""分页服务类"""
@staticmethod
async def paginate(data_list: List[Any], page_no: Optional[int] = None, page_size: Optional[int] = None) -> Dict[str, Any]:
"""
分页数据处理。
输入数据列表和分页信息,返回分页或非分页数据列表结果。
未传入 page_no 和 page_size 时,返回全部数据。
参数:
- data_list (List[Any]): 原始数据列表。
- page_no (int | None): 当前页码,默认 None。
- page_size (int | None): 每页数据量,默认 None。
返回:
- Dict[str, Any]: 分页或非分页数据对象。
异常:
- CustomException: 当分页参数不合法时抛出。
"""
total = len(data_list)
# 如果page_no和page_size都为None,返回全部数据
if page_no is None or page_size is None:
return {
"items": data_list,
"total": total,
"page_no": None,
"page_size": None,
"has_next": False
}
# 验证分页参数
if page_no < 1 or page_size < 1:
raise CustomException(code=RET.ERROR.code, msg="分页参数不合法")
# 计算起始索引和结束索引
start = (page_no - 1) * page_size
end = min(start + page_size, total)
# 根据计算得到的起始索引和结束索引对数据列表进行切片
paginated_data = data_list[start:end]
# 判断是否有下一页
has_next = end < total
return {
"items": paginated_data,
"total": total,
"page_no": page_no,
"page_size": page_size,
"has_next": has_next
}