Skip to content

Cron

Important

This module requires croniter package. Install croniter by pip install aurum-hikari[cron-tasks] or manully.

CronTask #

Bases: BaseTask

Task class.

Parameters:

  • callback (TaskCallbackT[CronTask]) –

    Callback of the task.

  • crontab (str) –

    Instruction for the croniter.

  • name (str | None, default: None ) –

    Name of the task.

Attributes:

  • event_loop (AbstractEventLoop) –

    Event loop to which the task is attached.

  • handler (TimerHandle) –

    Handler of the task.

  • client (Client | None) –

    The client that the task is linked to.

  • name (str) –

    Name of the task.

  • callback (Callable[..., Any]) –

    Callback of the task.

  • croniter (croniter) –

    Execution instruction.

cron_task #

cron_task(crontab: str, *, name: str | None = None) -> Callable[[TaskCallbackT[CronTask]], CronTask]

Decorator for task definition.