mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-27 06:41:12 +00:00
zhangtao
c2ca6d19ac
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): 完善工具函数的文档字符串
97 lines
2.7 KiB
Python
97 lines
2.7 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 NoticeModel
|
|
from .schema import NoticeCreateSchema, NoticeUpdateSchema
|
|
|
|
|
|
class NoticeCRUD(CRUDBase[NoticeModel, NoticeCreateSchema, NoticeUpdateSchema]):
|
|
"""公告数据层"""
|
|
|
|
def __init__(self, auth: AuthSchema) -> None:
|
|
"""
|
|
初始化公告数据层。
|
|
|
|
参数:
|
|
- auth (AuthSchema): 认证信息模型。
|
|
"""
|
|
self.auth = auth
|
|
super().__init__(model=NoticeModel, auth=auth)
|
|
|
|
async def get_by_id_crud(self, id: int) -> Optional[NoticeModel]:
|
|
"""
|
|
根据ID获取公告详情。
|
|
|
|
参数:
|
|
- id (int): 公告ID。
|
|
|
|
返回:
|
|
- Optional[NoticeModel]: 公告模型实例。
|
|
"""
|
|
return await self.get(id=id)
|
|
|
|
async def get_list_crud(self, search: Optional[Dict] = None, order_by: Optional[List[Dict[str, str]]] = None) -> Sequence[NoticeModel]:
|
|
"""
|
|
获取公告列表。
|
|
|
|
参数:
|
|
- search (Optional[Dict]): 查询参数。
|
|
- order_by (Optional[List[Dict[str, str]]]): 排序参数。
|
|
|
|
返回:
|
|
- Sequence[NoticeModel]: 公告模型实例列表。
|
|
"""
|
|
return await self.list(search=search, order_by=order_by)
|
|
|
|
async def create_crud(self, data: NoticeCreateSchema) -> Optional[NoticeModel]:
|
|
"""
|
|
创建公告。
|
|
|
|
参数:
|
|
- data (NoticeCreateSchema): 公告创建模型。
|
|
|
|
返回:
|
|
- Optional[NoticeModel]: 公告模型实例。
|
|
"""
|
|
return await self.create(data=data)
|
|
|
|
async def update_crud(self, id: int, data: NoticeUpdateSchema) -> Optional[NoticeModel]:
|
|
"""
|
|
更新公告。
|
|
|
|
参数:
|
|
- id (int): 公告ID。
|
|
- data (NoticeUpdateSchema): 公告更新模型。
|
|
|
|
返回:
|
|
- Optional[NoticeModel]: 公告模型实例。
|
|
"""
|
|
return await self.update(id=id, data=data)
|
|
|
|
async def delete_crud(self, ids: List[int]) -> None:
|
|
"""
|
|
删除公告。
|
|
|
|
参数:
|
|
- ids (List[int]): 公告ID列表。
|
|
|
|
返回:
|
|
- None
|
|
"""
|
|
return await self.delete(ids=ids)
|
|
|
|
async def set_available_crud(self, ids: List[int], status: bool) -> None:
|
|
"""
|
|
设置公告的可用状态。
|
|
|
|
参数:
|
|
- ids (List[int]): 公告ID列表。
|
|
- status (bool): 可用状态。
|
|
|
|
返回:
|
|
- None
|
|
"""
|
|
return await self.set(ids=ids, status=status) |