illest.py 2.3.1

Tasks (ext.tasks)

Read from the library itself: every signature and every word here is its own docstring.

loop

decorator

illest.ext.tasks.loop

loop(*, seconds: 'float' = <object object>, minutes: 'float' = <object object>, hours: 'float' = <object object>, time: 'dt.time | Sequence[dt.time]' = <object object>, count: 'int | None' = None, reconnect: 'bool' = True, name: 'str | None' = None) -> 'Callable[[Callable[..., Awaitable[Any]]], Loop[Any]]'

Make a function a Loop.

Loop

classfrom Generic

illest.ext.tasks.Loop

class Loop(coro: 'Callable[..., Awaitable[Any]]', seconds: 'float', hours: 'float', minutes: 'float', time: 'dt.time | Sequence[dt.time]', count: 'int | None', reconnect: 'bool', name: 'str | None')

A repeating task. Made by @tasks.loop(...); bound to its cog like a method when it is one.

seconds

property

minutes

property

hours

property

time

property

current_loop

property

next_iteration

property

change_interval

change_interval(*, seconds: 'float' = 0, minutes: 'float' = 0, hours: 'float' = 0, time: 'dt.time | Sequence[dt.time]' = <object object>) -> 'None'

start

start(*args: 'Any', **kwargs: 'Any') -> 'asyncio.Task'

Start the loop in the running event loop. Raises when it is already running.

stop

stop() -> 'None'

Finish the run in progress, then stop (after_loop still runs).

cancel

cancel() -> 'None'

Stop now, cancelling the run in progress.

restart

restart(*args: 'Any', **kwargs: 'Any') -> 'None'

get_task

get_task() -> 'asyncio.Task | None'

is_being_cancelled

is_being_cancelled() -> 'bool'

failed

failed() -> 'bool'

is_running

is_running() -> 'bool'

add_exception_type

add_exception_type(*exceptions: 'type[BaseException]') -> 'None'

clear_exception_types

clear_exception_types() -> 'None'

remove_exception_type

remove_exception_type(*exceptions: 'type[BaseException]') -> 'bool'

before_loop

before_loop(coro: 'Callable[..., Awaitable[Any]]') -> 'Callable[..., Awaitable[Any]]'

after_loop

after_loop(coro: 'Callable[..., Awaitable[Any]]') -> 'Callable[..., Awaitable[Any]]'

error

error(coro: 'Callable[..., Awaitable[Any]]') -> 'Callable[..., Awaitable[Any]]'