From 4497a82c504818d61ab18c5251ae2bc42bae279e Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 23 Nov 2024 18:47:50 +0000 Subject: Deploying to docs from @ python-discord/bot-core@bdaaa2e76d4cb32843754757532ef8d73ac97761 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v10.2.0/output/pydis_core.utils.scheduling.html | 66 ++++++++++++++----------- 1 file changed, 37 insertions(+), 29 deletions(-) (limited to 'v10.2.0/output/pydis_core.utils.scheduling.html') diff --git a/v10.2.0/output/pydis_core.utils.scheduling.html b/v10.2.0/output/pydis_core.utils.scheduling.html index b1959e3a..0b793336 100644 --- a/v10.2.0/output/pydis_core.utils.scheduling.html +++ b/v10.2.0/output/pydis_core.utils.scheduling.html @@ -5,13 +5,13 @@ - + scheduling - Pydis Core v10.2.0 - + @@ -319,6 +319,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -446,7 +454,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 @@ -460,16 +468,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.

    @@ -480,7 +488,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.

    @@ -491,10 +499,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

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

    Unschedule all known tasks.

    Return type:
    -

    None

    +

    None

    @@ -519,12 +527,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

    @@ -541,13 +549,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

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

    • delay (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 (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

    @@ -577,23 +585,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

    @@ -679,7 +687,7 @@ otherwise the running loop is used.

    - + -- cgit v1.2.3