| 1 |
.. _asyncio-index: |
| 2 |
|
| 3 |
Asyncio in Eventlet |
| 4 |
################### |
| 5 |
|
| 6 |
Asyncio Compatibility |
| 7 |
===================== |
| 8 |
|
| 9 |
Compatibility between Asyncio and Eventlet has been recently introduced. |
| 10 |
|
| 11 |
You may be interested by the state of the art of this compatibility and by |
| 12 |
the potential limitations, so please take a look at |
| 13 |
:ref:`asyncio-compatibility`. |
| 14 |
|
| 15 |
Asyncio Hub & Functions |
| 16 |
======================= |
| 17 |
|
| 18 |
Discover the :mod:`Asyncio Hub <eventlet.hubs.asyncio>` |
| 19 |
|
| 20 |
You may also want to take a look to the |
| 21 |
:mod:`Asyncio compatibility functions <eventlet.asyncio>`. |
| 22 |
|
| 23 |
Migrating from Eventlet to Asyncio |
| 24 |
================================== |
| 25 |
|
| 26 |
Why Migrating? |
| 27 |
-------------- |
| 28 |
|
| 29 |
Eventlet is a broken and outdated technology. |
| 30 |
|
| 31 |
Eventlet was created almost 20 years ago (See the :ref:`history` of Eventlet), |
| 32 |
at a time where Python did not provided non-blocking features. |
| 33 |
|
| 34 |
Time passed and Python now provide AsyncIO. |
| 35 |
|
| 36 |
In parallel of the evolution of Python, the maintenance of Eventlet was |
| 37 |
discontinued during several versions of Python, increasing the gap between |
| 38 |
the monkey patching of Eventlet and the recent implementation of Python. |
| 39 |
|
| 40 |
This gap is now not recoverable. For this reason, we decided to officially |
| 41 |
abandon the maintenance of Eventlet in an incremental way. |
| 42 |
|
| 43 |
In a last effort, we want to lead Eventlet to a well deserved rest. |
| 44 |
Our goal is to provide you a guide to migrate off of Eventlet and then |
| 45 |
to properly retire Eventlet. |
| 46 |
|
| 47 |
For more details about the reasons who motivated this effort we invite the |
| 48 |
readers to show the discussions related to this scheduled abandon: |
| 49 |
|
| 50 |
https://review.opendev.org/c/openstack/governance/+/902585 |
| 51 |
|
| 52 |
Getting Started |
| 53 |
--------------- |
| 54 |
|
| 55 |
Want to use Asyncio and Eventlet together or you simply want to migrate |
| 56 |
off of Eventlet? |
| 57 |
|
| 58 |
Follow the :ref:`official migration guide <migration-guide>`. |
| 59 |
|
| 60 |
We encourage readers to first look at the :ref:`glossary_guide` to |
| 61 |
learn about the various terms that may be encountered during the migration. |
| 62 |
|
| 63 |
Alternatives & Tips |
| 64 |
------------------- |
| 65 |
|
| 66 |
You want to refactor your code to replace Eventlet usages? See the proposed |
| 67 |
alternatives and tips: |
| 68 |
|
| 69 |
- :ref:`awaitlet_alternative` |
| 70 |
- :ref:`manage-your-deprecations` |