chore: update .gitignore and enhance docstrings across multiple files

- Added *.pyc and *.pyo to .gitignore to prevent compiled Python files from being tracked.
- Improved docstrings in various modules, providing clearer descriptions of functions, parameters, and return values to enhance code readability and maintainability.
This commit is contained in:
zhangtao
2026-04-04 01:21:59 +08:00
parent dcf8844453
commit b0ae6af3b1
96 changed files with 5089 additions and 304 deletions
@@ -12,10 +12,13 @@ class ParamsCRUD(CRUDBase[ParamsModel, ParamsCreateSchema, ParamsUpdateSchema]):
def __init__(self, auth: AuthSchema) -> None:
"""
初始化配置CRUD
初始化系统参数配置数据层。
参数:
- auth (AuthSchema): 认证信息模型
- auth (AuthSchema): 认证信息模型(含 DB 会话等上下文)。
返回:
- None
"""
self.auth = auth
super().__init__(model=ParamsModel, auth=auth)
@@ -112,7 +112,19 @@ class ParamsService:
search: ParamsQueryParam | None = None,
order_by: list[dict[str, str]] | None = None,
) -> dict:
"""分页查询参数(数据库 OFFSET/LIMIT)。"""
"""
分页查询系统参数(数据库 OFFSET/LIMIT)。
参数:
- auth (AuthSchema): 认证信息模型
- page_no (int): 页码(从 1 开始)
- page_size (int): 每页条数
- search (ParamsQueryParam | None): 查询条件
- order_by (list[dict[str, str]] | None): 排序字段列表
返回:
- dict: 分页结果(结构由 `CRUD.page` 返回约定)
"""
offset = (page_no - 1) * page_size
return await ParamsCRUD(auth).page(
offset=offset,