summaryrefslogtreecommitdiff
path: root/docs/modules/schedulers/asyncio.rst
blob: ff233d853d65b09b901e5b02a643fb4eeebac2db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
:mod:`apscheduler.schedulers.asyncio`
=====================================

.. automodule:: apscheduler.schedulers.asyncio

API
---

.. autoclass:: AsyncIOScheduler
    :show-inheritance:


Introduction
------------

AsyncIOScheduler was meant to be used with the `AsyncIO <https://docs.python.org/3/library/asyncio.html>`_ event loop.
By default, it will run jobs in the event loop's thread pool.

If you have an application that runs on an AsyncIO event loop, you will want to use this scheduler.

.. list-table::
   :widths: 1 4

   * - Default executor
     - :class:`~apscheduler.executors.asyncio.AsyncIOExecutor`
   * - External dependencies
     - * Python >= 3.4: none
       * Python 3.3: `asyncio <https://pypi.python.org/pypi/asyncio/>`_
       * Python <= 3.2: `trollius <https://pypi.python.org/pypi/trollius/>`_
   * - Example
     - ``examples/schedulers/asyncio_.py``
       (`view online <https://github.com/agronholm/apscheduler/tree/3.x/examples/schedulers/asyncio_.py>`_).