apscheduler.schedulers.tornado

class apscheduler.schedulers.tornado.TornadoScheduler(gconfig={}, **options)

Bases: BaseScheduler

A scheduler that runs on a Tornado IOLoop.

The default executor can run jobs based on native coroutines (async def).

io_loop

Tornado IOLoop instance to use (defaults to the global IO loop)

shutdown(wait=True)

Shuts down the scheduler, along with its executors and job stores.

Does not interrupt any currently running jobs.

Parameters:

wait (bool) – True to wait until all currently executing jobs have finished

Raises:

SchedulerNotRunningError – if the scheduler has not been started yet

wakeup()

Notifies the scheduler that there may be jobs due for execution. Triggers _process_jobs() to be run in an implementation specific manner.

API

class apscheduler.schedulers.tornado.TornadoScheduler(gconfig={}, **options)

Bases: BaseScheduler

A scheduler that runs on a Tornado IOLoop.

The default executor can run jobs based on native coroutines (async def).

io_loop

Tornado IOLoop instance to use (defaults to the global IO loop)

shutdown(wait=True)

Shuts down the scheduler, along with its executors and job stores.

Does not interrupt any currently running jobs.

Parameters:

wait (bool) – True to wait until all currently executing jobs have finished

Raises:

SchedulerNotRunningError – if the scheduler has not been started yet

wakeup()

Notifies the scheduler that there may be jobs due for execution. Triggers _process_jobs() to be run in an implementation specific manner.

Introduction

TornadoScheduler was meant to be used in Tornado applications.

Default executor	PoolExecutor
External dependencies	tornado
Example	examples/schedulers/tornado_.py (view online)