summaryrefslogtreecommitdiff
path: root/docs/modules/schedulers/gevent.rst
blob: 56f63a5d6773566fcab71af2034b405083aaf48e (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
:mod:`apscheduler.schedulers.gevent`
====================================

.. automodule:: apscheduler.schedulers.gevent

API
---

.. autoclass:: GeventScheduler
    :show-inheritance:


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

GeventScheduler was meant to be used with applications that use `gevent <http://www.gevent.org/>`_.
GeventScheduler uses gevent natively, so it doesn't require monkey patching. By default it executes jobs as greenlets.

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

   * - Default executor
     - :class:`~apscheduler.executors.gevent.GeventExecutor`
   * - External dependencies
     - `gevent <https://pypi.python.org/pypi/gevent/>`_
   * - Example
     - ``examples/schedulers/gevent_.py``
       (`view online <https://github.com/agronholm/apscheduler/tree/master/examples/schedulers/gevent_.py>`_).

.. tip:: Until there is an official Python 3 compatible release of gevent, you can use an
   `unofficial port <https://github.com/fantix/gevent>`_.