Tasks

discord_http.tasks module

class discord_http.tasks.Loop(*, func: Callable, seconds: float | None, minutes: float | None, hours: float | None, time: time | list[time] | None = None, count: int | None = None, reconnect: bool = True)

Bases: object

add_exception(*exceptions: Exception) → None

Adds exceptions to the whitelist of exceptions that are ignored

after_loop() → Callable

Decorator that registers a custom after_loop handler for the loop

before_loop() → Callable

Decorator that registers a custom before_loop handler for the loop

cancel() → None

Cancels the loop if possible

property failed: bool

Returns whether the loop has failed or not

fetch_task() → Task | None

Returns the task that is running the loop

handle_interval(*, seconds: float | None = 0, minutes: float | None = 0, hours: float | None = 0, time: time | list[time] | None = None) → None

Sets the interval of the loop.

Parameters:

• seconds (float) – Amount of seconds between each iteration of the loop

• minutes (float) – Amount of minutes between each iteration of the loop

• hours (float) – Amount of hours between each iteration of the loop

• time (dtime) – The time of day to run the loop at

Raises:

• ValueError –

  • The sleep timer cannot be 0 - count must be greater than 0 or None

• TypeError – time must be a datetime.time object

is_being_cancelled() → bool

Returns whether the loop is being cancelled or not

is_running() → bool

Returns whether the loop is running or not

property loop_count: int

Returns the number of times the loop has been run

on_error() → Callable

Decorator that registers a custom error handler for the loop

remove_exception(*exceptions: Exception) → None

Removes exceptions from the whitelist of exceptions that are ignored

reset_exceptions() → None

Resets the whitelist of exceptions that are ignored back to the default

start(*args, **kwargs) → Task

Starts the loop

stop() → None

Stops the loop

class discord_http.tasks.Sleeper(dt: datetime, *, loop: AbstractEventLoop)

Bases: object

cancel() → None

done() → bool

recalculate(dt: datetime) → None

wait() → Future

discord_http.tasks.loop(*, seconds: float | None = None, minutes: float | None = None, hours: float | None = None, time: time | list[time] | None = None, count: int | None = None, reconnect: bool = True) → Callable[[Callable], Loop]

Decorator that registers a function as a loop.

Parameters:

• seconds (float) – The number of seconds between each iteration of the loop.

• minutes (float) – The number of minutes between each iteration of the loop.

• hours (float) – The number of hours between each iteration of the loop.

• time (datetime.time) – The time of day to run the loop at. (UTC only)

• count (int) – The number of times to run the loop. If None, the loop will run forever.

• reconnect (bool) – Whether the loop should reconnect if it fails or not.