From 71117376b610d01b0083b09111d19f4be1d44f80 Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Sun, 26 Jun 2022 15:29:39 +0000 Subject: Deploying to docs from @ python-discord/bot-core@e00696e8996686686496edfbca51200afe951aee 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/botcore.utils.scheduling.html | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) (limited to 'main/output/botcore.utils.scheduling.html') diff --git a/main/output/botcore.utils.scheduling.html b/main/output/botcore.utils.scheduling.html index 4c836144..d51c2896 100644 --- a/main/output/botcore.utils.scheduling.html +++ b/main/output/botcore.utils.scheduling.html @@ -10,9 +10,9 @@ + - @@ -204,6 +204,14 @@ main +
  • + v7.1.3 +
    • + +
  • + v7.1.2 +
    • +
  • v7.1.1
    • @@ -266,7 +274,7 @@

    Generic python scheduler.

    -class Scheduler(name)[source]#
    +class Scheduler(name)[source]#

    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 @@ -280,7 +288,7 @@ the same ID used to schedule it.

    Any exception raised in a scheduled task is logged when the task is done.

    -__contains__(task_id)[source]#
    +__contains__(task_id)[source]#

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

    Parameters
    @@ -296,7 +304,7 @@ the same ID used to schedule it.

    -__init__(name)[source]#
    +__init__(name)[source]#

    Initialize a new Scheduler instance.

    Parameters
    @@ -306,7 +314,7 @@ the same ID used to schedule it.

    -cancel(task_id)[source]#
    +cancel(task_id)[source]#

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

    Parameters
    @@ -319,7 +327,7 @@ the same ID used to schedule it.

    -cancel_all()[source]#
    +cancel_all()[source]#

    Unschedule all known tasks.

    Return type
    @@ -329,7 +337,7 @@ the same ID used to schedule it.

    -schedule(task_id, coroutine)[source]#
    +schedule(task_id, coroutine)[source]#

    Schedule the execution of a coroutine.

    If a task with task_id already exists, close coroutine instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

    @@ -347,7 +355,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
    -schedule_at(time, task_id, coroutine)[source]#
    +schedule_at(time, task_id, coroutine)[source]#

    Schedule coroutine to be executed at the given time.

    If time is timezone aware, then use that timezone to calculate now() when subtracting. If time is naĂŻve, then use UTC.

    @@ -369,7 +377,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
    -schedule_later(delay, task_id, coroutine)[source]#
    +schedule_later(delay, task_id, coroutine)[source]#

    Schedule coroutine to be executed after delay seconds.

    If a task with task_id already exists, close coroutine instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

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

    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.

    -- cgit v1.2.3