From 3eb5ff4e3f0a841d28d8c742eba2e562f9fc2231 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Mon, 4 Mar 2024 14:53:52 +0000 Subject: Deploying to docs from @ python-discord/bot-core@c72b515aec03b1d9df49a3d58bfa90a3d864160e 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.utils.scheduling.html | 100 +++------------------------ 1 file changed, 10 insertions(+), 90 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 b7d15836..366fa6db 100644 --- a/main/output/pydis_core.utils.scheduling.html +++ b/main/output/pydis_core.utils.scheduling.html @@ -279,86 +279,6 @@ v9.0.0 -
  • - v8.3.0-beta -
    • - -
  • - v8.2.1 -
    • - -
  • - v8.2.0 -
    • - -
  • - v8.1.0 -
    • - -
  • - v8.0.0-beta.4 -
    • - -
  • - v8.0.0-beta.3 -
    • - -
  • - v8.0.0-beta.2 -
    • - -
  • - v8.0.0-beta.1 -
    • - -
  • - v8.0.0 -
    • - -
  • - v7.5.0 -
    • - -
  • - v7.4.0-beta1 -
    • - -
  • - v7.4.0 -
    • - -
  • - v7.3.1 -
    • - -
  • - v7.3.0 -
    • - -
  • - v7.2.2 -
    • - -
  • - v7.2.1 -
    • - -
  • - v7.2.0 -
    • - -
  • - v7.1.3 -
    • - -
  • - v7.1.2 -
    • - -
  • - v7.1.1 -
    • -
  • v10.7.0
    • @@ -455,7 +375,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 @@ -469,7 +389,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:
    @@ -486,7 +406,7 @@ the same ID used to schedule it.

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

    Initialize a new Scheduler instance.

    Parameters:
    @@ -497,7 +417,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:
    @@ -511,7 +431,7 @@ the same ID used to schedule it.

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

    Unschedule all known tasks.

    Return type:
    @@ -522,7 +442,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.

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

    @@ -564,14 +484,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 (int | float) – How long to wait before starting the task.

      • +

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

    @@ -586,7 +506,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