From 05394fec96b65e6f97d53a5b4d5fe47b07fcebc2 Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Tue, 28 Jun 2022 12:11:54 +0000 Subject: Deploying to docs from @ python-discord/bot-core@28be7e1e8b712084a883a9199028c0cab876361c 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v7.1.3/output/botcore.utils.scheduling.html | 54 ++++++++++++++--------------- 1 file changed, 27 insertions(+), 27 deletions(-) (limited to 'v7.1.3/output/botcore.utils.scheduling.html') diff --git a/v7.1.3/output/botcore.utils.scheduling.html b/v7.1.3/output/botcore.utils.scheduling.html index 5fca6407..57640d83 100644 --- a/v7.1.3/output/botcore.utils.scheduling.html +++ b/v7.1.3/output/botcore.utils.scheduling.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -280,7 +280,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 @@ -294,16 +294,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.

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

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

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

    Unschedule all known tasks.

    Return type:
    -

    None

    +

    None

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

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

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

    @@ -411,23 +411,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:
      -

    • coro (Awaitable) – The function to call.

      • -

    • suppressed_exceptions (tuple[Type[Exception]]) – Exceptions to be handled by the task.

      • -

    • event_loop (asyncio.AbstractEventLoop) – The loop to create the task from.

      • -

    • kwargs – Passed to asyncio.create_task().

      • +

    • coro (Awaitable) – The function to call.

      • +

    • suppressed_exceptions (tuple[Type[Exception]]) – Exceptions to be handled by the task.

      • +

    • event_loop (asyncio.AbstractEventLoop) – The loop to create the task from.

      • +

    • kwargs – Passed to asyncio.create_task().

    Returns:

    The wrapped task.

    Return type:
    -

    asyncio.Task

    +

    asyncio.Task

    -- cgit v1.2.3