hd-crane-gs/backend/app/api/v1/module_system/notice/crud.py

# -*- coding: utf-8 -*-

from typing import 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, preload: list | None = None) -> NoticeModel | None:
        """
        根据ID获取公告详情。
        
        参数:
        - id (int): 公告ID。
        - preload (list | None): 预加载关系，未提供时使用模型默认项
        
        返回:
        - NoticeModel | None: 公告模型实例。
        """
        return await self.get(id=id, preload=preload)
    
    async def get_list_crud(self, search: dict | None = None, order_by: list[dict] | None = None, preload: list | None = None) -> Sequence[NoticeModel]:
        """
        获取公告列表。
        
        参数:
        - search (dict | None): 查询参数。
        - order_by (list[dict] | None): 排序参数。
        - preload (list | None): 预加载关系，未提供时使用模型默认项
        
        返回:
        - Sequence[NoticeModel]: 公告模型实例列表。
        """
        return await self.list(search=search, order_by=order_by, preload=preload)
    
    async def create_crud(self, data: NoticeCreateSchema) -> NoticeModel | None:
        """
        创建公告。
        
        参数:
        - data (NoticeCreateSchema): 公告创建模型。
        
        返回:
        - NoticeModel | None: 公告模型实例。
        """
        return await self.create(data=data)
    
    async def update_crud(self, id: int, data: NoticeUpdateSchema) -> NoticeModel | None:
        """
        更新公告。
        
        参数:
        - id (int): 公告ID。
        - data (NoticeUpdateSchema): 公告更新模型。
        
        返回:
        - NoticeModel | None: 公告模型实例。
        """
        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: str) -> None:
        """
        设置公告的可用状态。
        
        参数:
        - ids (list[int]): 公告ID列表。
        - status (str): 可用状态。
        
        返回:
        - None
        """
        return await self.set(ids=ids, status=status)