From cf16350107a4ffd6a48d258a47fffc0733c138b2 Mon Sep 17 00:00:00 2001 From: jb3 Date: Fri, 17 Oct 2025 18:04:11 +0000 Subject: Deploying to docs from @ python-discord/bot-core@9f0162c0869ee8e0ae158636c8f0eac96159a675 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v9.0.0/output/pydis_core.utils.scheduling.html | 54 +++++++++++++------------- 1 file changed, 27 insertions(+), 27 deletions(-) (limited to 'v9.0.0/output/pydis_core.utils.scheduling.html') diff --git a/v9.0.0/output/pydis_core.utils.scheduling.html b/v9.0.0/output/pydis_core.utils.scheduling.html index 30c4ba60..5f14f65d 100644 --- a/v9.0.0/output/pydis_core.utils.scheduling.html +++ b/v9.0.0/output/pydis_core.utils.scheduling.html @@ -10,8 +10,8 @@ - + @@ -468,7 +468,7 @@
class Scheduler(name)[source]¶
-

Bases: object

+

Bases: object

Schedule the execution of coroutines and keep track of them.

When instantiating a Scheduler, a name must be provided. This name is used to distinguish the instance’s log messages from other instances. Using the name of the class or module containing @@ -482,16 +482,16 @@ the same ID used to schedule it.

__contains__(task_id)[source]¶
-

Return True if a task with the given task_id is currently scheduled.

+

Return True if a task with the given task_id is currently scheduled.

Parameters:
-

task_id (Hashable) – The task to look for.

+

task_id (Hashable) – The task to look for.

Return type:
-

bool

+

bool

Returns:
-

True if the task was found.

+

True if the task was found.

@@ -502,7 +502,7 @@ the same ID used to schedule it.

Initialize a new Scheduler instance.

Parameters:
-

name (str) – The name of the Scheduler. Used in logging, and namespacing.

+

name (str) – The name of the Scheduler. Used in logging, and namespacing.

@@ -513,10 +513,10 @@ the same ID used to schedule it.

Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

Parameters:
-

task_id (Hashable) – The task’s unique ID.

+

task_id (Hashable) – The task’s unique ID.

Return type:
-

None

+

None

@@ -527,7 +527,7 @@ the same ID used to schedule it.

Unschedule all known tasks.

Return type:
-

None

+

None

@@ -541,12 +541,12 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
Parameters:
    -

  • task_id (Hashable) – A unique ID to create the task with.

    • -

  • coroutine (Coroutine) – The function to be called.

    • +

  • task_id (Hashable) – A unique ID to create the task with.

    • +

  • coroutine (Coroutine) – The function to be called.

Return type:
-

None

+

None

@@ -563,13 +563,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
Parameters:
    -

  • time (datetime) – The time to start the task.

    • -

  • task_id (Hashable) – A unique ID to create the task with.

    • -

  • coroutine (Coroutine) – The function to be called.

    • +

  • time (datetime) – The time to start the task.

    • +

  • task_id (Hashable) – A unique ID to create the task with.

    • +

  • coroutine (Coroutine) – The function to be called.

Return type:
-

None

+

None

@@ -583,13 +583,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
Parameters:
    -

  • delay (Union[int, float]) – How long to wait before starting the task.

    • -

  • task_id (Hashable) – A unique ID to create the task with.

    • -

  • coroutine (Coroutine) – The function to be called.

    • +

  • delay (Union[int, float]) – How long to wait before starting the task.

    • +

  • task_id (Hashable) – A unique ID to create the task with.

    • +

  • coroutine (Coroutine) – The function to be called.

Return type:
-

None

+

None

@@ -599,23 +599,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]¶
-

Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

+

Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

If the event_loop kwarg is provided, the task is created from that event loop, otherwise the running loop is used.

Parameters:
Returns:

The wrapped task.

Return type:
-

asyncio.Task

+

asyncio.Task

-- cgit v1.2.3