Files
FastapiAdmin/backend/app/api/v1/module_application/job/schema.py
T
zhangtao b678588d13 refactor(schema): 移除重复的模型验证逻辑并简化字段验证
统一移除各模块schema中重复的model_validator前置处理逻辑,改用更简洁的字段验证方式
优化字段验证逻辑,移除冗余的字符串处理和类型转换代码
2025-11-11 23:34:30 +08:00

93 lines
4.0 KiB
Python

# -*- coding: utf-8 -*-
from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
from typing import Optional
from app.core.base_schema import BaseSchema
from app.core.validator import DateTimeStr, datetime_validator
class JobCreateSchema(BaseModel):
"""
定时任务调度表对应pydantic模型
"""
name: Optional[str] = Field(..., max_length=64, description='任务名称')
func: str = Field(..., description='任务函数')
trigger: str = Field(..., description='触发器:控制此作业计划的 trigger 对象')
args: Optional[str] = Field(default=None, description='位置参数')
kwargs: Optional[str] = Field(default=None, description='关键字参数')
coalesce: Optional[bool] = Field(..., description='是否合并运行:是否在多个运行时间到期时仅运行作业一次')
max_instances: Optional[int] = Field(default=1, ge=1, description='最大实例数:允许的最大并发执行实例数')
jobstore: Optional[str] = Field(..., max_length=64, description='任务存储')
executor: Optional[str] = Field(..., max_length=64, description='任务执行器:将运行此作业的执行程序的名称')
trigger_args: Optional[str] = Field(default=None, description='触发器参数')
start_date: Optional[str] = Field(default=None, description='开始时间')
end_date: Optional[str] = Field(default=None, description='结束时间')
description: Optional[str] = Field(default=None, max_length=255, description='描述')
status: Optional[bool] = Field(default=False, description='任务状态:启动,停止')
@field_validator('trigger')
@classmethod
def _validate_trigger(cls, v: str) -> str:
allowed = {'cron', 'interval', 'date'}
v = v.strip()
if v not in allowed:
raise ValueError('触发器必须为 cron/interval/date')
return v
@model_validator(mode='after')
def _validate_dates(self):
"""跨字段校验:结束时间不得早于开始时间。"""
if self.start_date and self.end_date:
try:
start = datetime_validator(self.start_date)
end = datetime_validator(self.end_date)
except Exception:
raise ValueError('时间格式必须为 YYYY-MM-DD HH:MM:SS')
if end < start:
raise ValueError('结束时间不能早于开始时间')
return self
class JobUpdateSchema(JobCreateSchema):
"""定时任务更新模型"""
...
class JobOutSchema(JobCreateSchema, BaseSchema):
"""定时任务响应模型"""
model_config = ConfigDict(from_attributes=True)
...
class JobLogCreateSchema(BaseModel):
"""
定时任务调度日志表对应pydantic模型
"""
model_config = ConfigDict(from_attributes=True)
job_name: Optional[str] = Field(default=None, description='任务名称')
job_group: Optional[str] = Field(default=None, description='任务组名')
job_executor: Optional[str] = Field(default=None, description='任务执行器')
invoke_target: Optional[str] = Field(default=None, description='调用目标字符串')
job_args: Optional[str] = Field(default=None, description='位置参数')
job_kwargs: Optional[str] = Field(default=None, description='关键字参数')
job_trigger: Optional[str] = Field(default=None, description='任务触发器')
job_message: Optional[str] = Field(default=None, description='日志信息')
exception_info: Optional[str] = Field(default=None, description='异常信息')
status: Optional[bool] = Field(default=False, description='任务状态:正常,失败')
create_time: Optional[DateTimeStr] = Field(default=None, description='创建时间')
class JobLogUpdateSchema(JobLogCreateSchema):
"""定时任务调度日志表更新模型"""
...
id: Optional[int] = Field(default=None, description='任务日志ID')
class JobLogOutSchema(JobLogUpdateSchema):
"""定时任务调度日志表响应模型"""
model_config = ConfigDict(from_attributes=True)
...