Files
FastapiAdmin/backend/app/api/v1/module_system/position/crud.py
T
zhangtao b0ae6af3b1 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.
2026-04-04 01:21:59 +08:00

90 lines
2.5 KiB
Python

from collections.abc import Sequence
from typing import Any
from app.api.v1.module_system.auth.schema import AuthSchema
from app.core.base_crud import CRUDBase
from .model import PositionModel
from .schema import PositionCreateSchema, PositionUpdateSchema
class PositionCRUD(CRUDBase[PositionModel, PositionCreateSchema, PositionUpdateSchema]):
"""岗位模块数据层"""
def __init__(self, auth: AuthSchema) -> None:
"""
初始化岗位数据层。
参数:
- auth (AuthSchema): 认证信息模型(含 DB 会话等上下文)。
返回:
- None
"""
self.auth = auth
super().__init__(model=PositionModel, auth=auth)
async def get_by_id_crud(
self, id: int, preload: list[str] | None = None
) -> PositionModel | None:
"""
根据 id 获取岗位信息。
参数:
- id (int): 岗位 ID。
- preload (list[str] | None): 预加载关系,未提供时使用模型默认项
返回:
- PositionModel | None: 岗位信息,未找到返回 None。
"""
return await self.get(id=id, preload=preload)
async def get_list_crud(
self,
search: dict | None = None,
order_by: list[dict[str, Any]] | None = None,
preload: list[str] | None = None,
) -> Sequence[PositionModel]:
"""
获取岗位列表。
参数:
- search (dict | None): 搜索条件。
- order_by (list[dict[str, Any]] | None): 排序字段列表。
- preload (list[str] | None): 预加载关系,未提供时使用模型默认项
返回:
- Sequence[PositionModel]: 岗位列表。
"""
return await self.list(search=search, order_by=order_by, preload=preload)
async def set_available_crud(self, ids: list[int], status: str) -> None:
"""
批量设置岗位可用状态。
参数:
- ids (list[int]): 岗位 ID 列表。
- status (bool): 可用状态。
返回:
- None
"""
await self.set(ids=ids, status=status)
async def get_name_crud(self, ids: list[int]) -> list[str]:
"""
根据 id 列表获取岗位名称。
参数:
- ids (list[int]): 岗位 ID 列表。
返回:
- list[str]: 岗位名称列表。
"""
position_names = []
for id in ids:
obj = await self.get(id=id)
if obj:
position_names.append(obj.name)
return position_names