From 4579ee8f7565651b2ff8799dcb4bf0ab1717fa0c Mon Sep 17 00:00:00 2001
From: ChrisLovering
Date: Tue, 28 Jun 2022 11:02:39 +0000
Subject: Deploying to docs from @
python-discord/bot-core@109da8bdde367e85d334b8f96dfaf28e7a52afee 🚀
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
main/output/botcore.utils.scheduling.html | 25 +++++++++++++------------
1 file changed, 13 insertions(+), 12 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 8a3bf1b9..7a6c4350 100644
--- a/main/output/botcore.utils.scheduling.html
+++ b/main/output/botcore.utils.scheduling.html
@@ -1,11 +1,11 @@
-
+
-
+
scheduling - Bot Core Latest (7.1.1)
@@ -271,11 +271,11 @@
-scheduling
+scheduling
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
@@ -289,7 +289,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
@@ -306,7 +306,7 @@ the same ID used to schedule it.
-__init__ ( name ) [source]
+__init__ ( name ) [source]
Initialize a new Scheduler instance.
Parameters
@@ -317,7 +317,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
@@ -331,7 +331,7 @@ the same ID used to schedule it.
-cancel_all ( ) [source]
+cancel_all ( ) [source]
Unschedule all known tasks.
Return type
@@ -342,7 +342,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.
@@ -361,7 +361,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.
@@ -384,7 +384,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.
@@ -406,7 +406,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.
@@ -484,6 +484,7 @@ otherwise the running loop is used.
+
--
cgit v1.2.3