Task API

Task

Task(func, config)

表示一个带有执行逻辑的定时任务。

初始化任务。

参数

func: 要执行的异步函数 config: 任务配置

execute(*args, **kwargs) async

使用重试逻辑执行任务。

cancel() async

取消任务。

is_cancelled()

检查任务是否已被取消。

__repr__()

任务的字符串表示形式。

TaskConfig

TaskConfig

Bases: BaseModel

定时任务配置。

get_next_run_time(after=None, use_timezone=None)

根据调度计算下次运行时间。

参数

after: 参考时间点,默认使用当前时间 use_timezone: 使用的时区,可以是timezone对象、ZoneInfo字符串或None(使用UTC)

注意

• 返回时区感知的datetime以确保与调度器的时间比较一致
• 如果传入的after无时区信息,会自动添加指定的时区

TaskStatus

TaskStatus

Bases: str, Enum

任务执行状态。

ScheduleType

ScheduleType

Bases: str, Enum

任务调度类型。