| 1 |
:mod:`apscheduler.schedulers.asyncio` |
| 2 |
===================================== |
| 3 |
|
| 4 |
.. automodule:: apscheduler.schedulers.asyncio |
| 5 |
|
| 6 |
API |
| 7 |
--- |
| 8 |
|
| 9 |
.. autoclass:: AsyncIOScheduler |
| 10 |
:show-inheritance: |
| 11 |
|
| 12 |
|
| 13 |
Introduction |
| 14 |
------------ |
| 15 |
|
| 16 |
AsyncIOScheduler was meant to be used with the `AsyncIO <https://docs.python.org/3/library/asyncio.html>`_ event loop. |
| 17 |
By default, it will run jobs in the event loop's thread pool. |
| 18 |
|
| 19 |
If you have an application that runs on an AsyncIO event loop, you will want to use this scheduler. |
| 20 |
|
| 21 |
.. list-table:: |
| 22 |
:widths: 1 4 |
| 23 |
|
| 24 |
* - Default executor |
| 25 |
- :class:`~apscheduler.executors.asyncio.AsyncIOExecutor` |
| 26 |
* - External dependencies |
| 27 |
- none |
| 28 |
* - Example |
| 29 |
- ``examples/schedulers/asyncio_.py`` |
| 30 |
(`view online <https://github.com/agronholm/apscheduler/tree/3.x/examples/schedulers/asyncio_.py>`_). |