From b9e8801ad4e80c2a0c823828d2d6515040bc4682 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sun, 4 Jun 2023 19:37:38 +0000 Subject: Deploying to docs from @ python-discord/bot-core@1a362c04eb4d5d8f3c531a590d73cf5d7300ace8 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.scheduling.html | 38 +++++++++++++++------------- 1 file changed, 21 insertions(+), 17 deletions(-) (limited to 'main/output/pydis_core.utils.scheduling.html') diff --git a/main/output/pydis_core.utils.scheduling.html b/main/output/pydis_core.utils.scheduling.html index eecea6cb..d329dcfa 100644 --- a/main/output/pydis_core.utils.scheduling.html +++ b/main/output/pydis_core.utils.scheduling.html @@ -2,17 +2,17 @@ - + - + scheduling - Pydis Core Latest (9.6.0) - + - - + + @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis Core
      +
    • Pydis Core
      • Exts
        • -
      • Utils
          +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.6.0 +
            • +
          • v9.5.1
            • @@ -381,7 +385,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 @@ -395,7 +399,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:
            @@ -412,7 +416,7 @@ the same ID used to schedule it.

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

            Initialize a new Scheduler instance.

            Parameters:
            @@ -423,7 +427,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:
            @@ -437,7 +441,7 @@ the same ID used to schedule it.

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

            Unschedule all known tasks.

            Return type:
            @@ -448,7 +452,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.

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

            @@ -490,14 +494,14 @@ 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.

            Parameters:
              -

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

              • +

            • 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.

            @@ -512,7 +516,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