-

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 @@ -397,7 +397,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:
@@ -414,7 +414,7 @@ the same ID used to schedule it.

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

Initialize a new Scheduler instance.

Parameters:
@@ -425,7 +425,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:
@@ -439,7 +439,7 @@ the same ID used to schedule it.

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

Unschedule all known tasks.

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

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

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

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

@@ -617,7 +617,7 @@ otherwise the running loop is used.

- + -- cgit v1.2.3