Files
FastapiAdmin/backend/app/api/v1/module_system/params/crud.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

97 lines
2.8 KiB
Python

# -*- coding: utf-8 -*-
from typing import Dict, List, Optional, Sequence
from app.core.base_crud import CRUDBase
from ..auth.schema import AuthSchema
from .model import ParamsModel
from .schema import ParamsCreateSchema, ParamsUpdateSchema
class ParamsCRUD(CRUDBase[ParamsModel, ParamsCreateSchema, ParamsUpdateSchema]):
"""配置管理数据层"""
def __init__(self, auth: AuthSchema) -> None:
"""
初始化配置CRUD
参数:
- auth (AuthSchema): 认证信息模型
"""
self.auth = auth
super().__init__(model=ParamsModel, auth=auth)
async def get_obj_by_id_crud(self, id: int) -> Optional[ParamsModel]:
"""
获取配置管理型详情
参数:
- id (int): 配置管理型ID
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.get(id=id)
async def get_obj_by_key_crud(self, key: str) -> Optional[ParamsModel]:
"""
根据key获取配置管理型详情
参数:
- key (str): 配置管理型key
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.get(config_key=key)
async def get_obj_list_crud(self, search: Optional[Dict] = None, order_by: Optional[List[Dict[str, str]]] = None) -> Sequence[ParamsModel]:
"""
获取配置管理型列表
参数:
- search (Dict | None): 查询参数对象。
- order_by (List[Dict[str, str]] | None): 排序参数列表。
返回:
- Sequence[ParamsModel]: 配置管理型模型实例列表
"""
return await self.list(search=search, order_by=order_by)
async def create_obj_crud(self, data: ParamsCreateSchema) -> Optional[ParamsModel]:
"""
创建配置管理型
参数:
- data (ParamsCreateSchema): 创建配置管理型负载模型
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.create(data=data)
async def update_obj_crud(self, id: int, data: ParamsUpdateSchema) -> Optional[ParamsModel]:
"""
更新配置管理型
参数:
- id (int): 配置管理型ID
- data (ParamsUpdateSchema): 更新配置管理型负载模型
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.update(id=id, data=data)
async def delete_obj_crud(self, ids: List[int]) -> None:
"""
删除配置管理型
参数:
- ids (List[int]): 配置管理型ID列表
返回:
- None
"""
return await self.delete(ids=ids)