schema.py 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. # -*- coding: utf-8 -*-
  2. from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
  3. from fastapi import Query
  4. from app.core.base_schema import BaseSchema, UserBySchema
  5. from app.core.validator import DateTimeStr, datetime_validator
  6. class JobCreateSchema(BaseModel):
  7. """
  8. 定时任务调度表对应pydantic模型
  9. """
  10. name: str = Field(..., max_length=64, description='任务名称')
  11. func: str = Field(..., description='任务函数')
  12. trigger: str = Field(..., description='触发器:控制此作业计划的 trigger 对象')
  13. args: str | None = Field(default=None, description='位置参数')
  14. kwargs: str | None = Field(default=None, description='关键字参数')
  15. coalesce: bool | None = Field(..., description='是否合并运行:是否在多个运行时间到期时仅运行作业一次')
  16. max_instances: int | None = Field(default=1, ge=1, description='最大实例数:允许的最大并发执行实例数')
  17. jobstore: str | None = Field(..., max_length=64, description='任务存储')
  18. executor: str | None = Field(..., max_length=64, description='任务执行器:将运行此作业的执行程序的名称')
  19. trigger_args: str | None = Field(default=None, description='触发器参数')
  20. start_date: str | None = Field(default=None, description='开始时间')
  21. end_date: str | None = Field(default=None, description='结束时间')
  22. description: str | None = Field(default=None, max_length=255, description='描述')
  23. status: str = Field(default='0', description='任务状态:启动,停止')
  24. @field_validator('trigger')
  25. @classmethod
  26. def _validate_trigger(cls, v: str) -> str:
  27. allowed = {'cron', 'interval', 'date'}
  28. v = v.strip()
  29. if v not in allowed:
  30. raise ValueError('触发器必须为 cron/interval/date')
  31. return v
  32. @model_validator(mode='after')
  33. def _validate_dates(self):
  34. """跨字段校验:结束时间不得早于开始时间。"""
  35. if self.start_date and self.end_date:
  36. try:
  37. start = datetime_validator(self.start_date)
  38. end = datetime_validator(self.end_date)
  39. except Exception:
  40. raise ValueError('时间格式必须为 YYYY-MM-DD HH:MM:SS')
  41. if end < start:
  42. raise ValueError('结束时间不能早于开始时间')
  43. return self
  44. class JobUpdateSchema(JobCreateSchema):
  45. """定时任务更新模型"""
  46. ...
  47. class JobOutSchema(JobCreateSchema, BaseSchema, UserBySchema):
  48. """定时任务响应模型"""
  49. model_config = ConfigDict(from_attributes=True)
  50. ...
  51. class JobLogCreateSchema(BaseModel):
  52. """
  53. 定时任务调度日志表对应pydantic模型
  54. """
  55. model_config = ConfigDict(from_attributes=True)
  56. job_name: str = Field(..., description='任务名称')
  57. job_group: str | None = Field(default=None, description='任务组名')
  58. job_executor: str | None = Field(default=None, description='任务执行器')
  59. invoke_target: str | None = Field(default=None, description='调用目标字符串')
  60. job_args: str | None = Field(default=None, description='位置参数')
  61. job_kwargs: str | None = Field(default=None, description='关键字参数')
  62. job_trigger: str | None = Field(default=None, description='任务触发器')
  63. job_message: str | None = Field(default=None, description='日志信息')
  64. exception_info: str | None = Field(default=None, description='异常信息')
  65. status: str = Field(default='0', description='任务状态:正常,失败')
  66. description: str | None = Field(default=None, max_length=255, description='描述')
  67. created_time: DateTimeStr | None = Field(default=None, description='创建时间')
  68. updated_time: DateTimeStr | None = Field(default=None, description='更新时间')
  69. class JobLogUpdateSchema(JobLogCreateSchema):
  70. """定时任务调度日志表更新模型"""
  71. ...
  72. id: int | None = Field(default=None, description='任务日志ID')
  73. class JobLogOutSchema(JobLogUpdateSchema, BaseSchema, UserBySchema):
  74. """定时任务调度日志表响应模型"""
  75. model_config = ConfigDict(from_attributes=True)
  76. ...
  77. class JobQueryParam:
  78. """定时任务查询参数"""
  79. def __init__(
  80. self,
  81. name: str | None = Query(None, description="任务名称"),
  82. status: str | None = Query(None, description="状态: 启动,停止"),
  83. created_time: list[DateTimeStr] | None = Query(None, description="创建时间范围", examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"]),
  84. updated_time: list[DateTimeStr] | None = Query(None, description="更新时间范围", examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"]),
  85. created_id: int | None = Query(None, description="创建人"),
  86. updated_id: int | None = Query(None, description="更新人"),
  87. ) -> None:
  88. # 模糊查询字段
  89. self.name = ("like", f"%{name}%") if name else None
  90. # 精确查询字段
  91. self.created_id = created_id
  92. self.updated_id = updated_id
  93. self.status = status
  94. # 时间范围查询
  95. if created_time and len(created_time) == 2:
  96. self.created_time = ("between", (created_time[0], created_time[1]))
  97. if updated_time and len(updated_time) == 2:
  98. self.updated_time = ("between", (updated_time[0], updated_time[1]))
  99. class JobLogQueryParam:
  100. """定时任务查询参数"""
  101. def __init__(
  102. self,
  103. job_id: int | None = Query(None, description="定时任务ID"),
  104. job_name: str | None = Query(None, description="任务名称"),
  105. status: str | None = Query(None, description="状态: 正常,失败"),
  106. created_time: list[DateTimeStr] | None = Query(None, description="创建时间范围", examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"]),
  107. updated_time: list[DateTimeStr] | None = Query(None, description="更新时间范围", examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"]),
  108. ) -> None:
  109. # 定时任务ID查询
  110. self.job_id = job_id
  111. # 模糊查询字段
  112. self.job_name = ("like", job_name)
  113. # 精确查询字段
  114. self.status = status
  115. # 时间范围查询
  116. if created_time and len(created_time) == 2:
  117. self.created_time = ("between", (created_time[0], created_time[1]))
  118. if updated_time and len(updated_time) == 2:
  119. self.updated_time = ("between", (updated_time[0], updated_time[1]))