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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
Eventlet Documentation
######################
Warning
=======
**New usages of eventlet are now heavily discouraged! Please read the
following.**
Eventlet was created almost 18 years ago, at a time where async
features were absent from the CPython stdlib. With time eventlet evolved and
CPython too, but since several years the maintenance activity of eventlet
decreased leading to a growing gap between eventlet and the CPython
implementation.
This gap is now too high and can lead you to unexpected side effects and bugs
in your applications.
Eventlet now follows a new maintenance policy. **Only maintenance for
stability and bug fixing** will be provided. **No new features will be
accepted**, except those related to the asyncio migration. **Usages in new
projects are discouraged**. **Our goal is to plan the retirement of eventlet**
and to give you ways to move away from eventlet.
If you are looking for a library to manage async network programming,
and if you do not yet use eventlet, then, we encourage you to use `asyncio`_,
which is the official async library of the CPython stdlib.
If you already use eventlet, we hope to enable migration to asyncio for some use
cases; see :ref:`migration-guide`. Only new features related to the migration
solution will be accepted.
If you have questions concerning maintenance goals or concerning
the migration do not hesitate to `open a new issue`_, we will be happy to
answer them.
.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _open a new issue: https://github.com/eventlet/eventlet/issues/new
Installation
============
The easiest way to get Eventlet is to use pip::
pip install -U eventlet
To install latest development version once::
pip install -U https://github.com/eventlet/eventlet/archive/master.zip
Usage
=====
Code talks! This is a simple web crawler that fetches a bunch of urls concurrently:
.. code-block:: python
urls = [
"http://www.google.com/intl/en_ALL/images/logo.gif",
"http://python.org/images/python-logo.gif",
"http://us.i1.yimg.com/us.yimg.com/i/ww/beta/y3.gif",
]
import eventlet
from eventlet.green.urllib.request import urlopen
def fetch(url):
return urlopen(url).read()
pool = eventlet.GreenPool()
for body in pool.imap(fetch, urls):
print("got body", len(body))
Supported Python Versions
=========================
Currently supporting CPython 3.9+.
Concepts & References
=====================
.. toctree::
:maxdepth: 2
asyncio/asyncio
basic_usage
design_patterns
patching
examples
ssl
threading
zeromq
hubs
environment
fork
modules
Want to contribute?
===================
.. toctree::
:maxdepth: 2
contribute
testing
maintenance
License
=======
Eventlet is made available under the terms of the open source `MIT license <http://www.opensource.org/licenses/mit-license.php>`_
Changelog
=========
For further details about released versions of Eventlet please take a
look at the `changelog`_.
Authors & History
=================
You have questions or you may have find a bug and you want to contact authors
or maintainers, then please take a look at :ref:`authors`.
You want to learn more about the history of Eventlet, then, please take a
look at :ref:`history`.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* `changelog`_
.. _changelog: https://github.com/eventlet/eventlet/blob/master/NEWS
|
