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
|
.. image:: https://travis-ci.org/MagicStack/uvloop.svg?branch=master
:target: https://travis-ci.org/MagicStack/uvloop
.. image:: https://img.shields.io/pypi/v/uvloop.svg
:target: https://pypi.python.org/pypi/uvloop
.. image:: https://pepy.tech/badge/uvloop
:target: https://pepy.tech/project/uvloop
:alt: PyPI - Downloads
uvloop is a fast, drop-in replacement of the built-in asyncio
event loop. uvloop is implemented in Cython and uses libuv
under the hood.
The project documentation can be found
`here <http://uvloop.readthedocs.org/>`_. Please also check out the
`wiki <https://github.com/MagicStack/uvloop/wiki>`_.
Performance
-----------
uvloop makes asyncio 2-4x faster.
.. image:: performance.png
:target: http://magic.io/blog/uvloop-blazing-fast-python-networking/
The above chart shows the performance of an echo server with different
message sizes. The *sockets* benchmark uses ``loop.sock_recv()`` and
``loop.sock_sendall()`` methods; the *streams* benchmark uses asyncio
high-level streams, created by the ``asyncio.start_server()`` function;
and the *protocol* benchmark uses ``loop.create_server()`` with a simple
echo protocol. Read more about uvloop in a
`blog post <http://magic.io/blog/uvloop-blazing-fast-python-networking/>`_
about it.
Installation
------------
uvloop requires Python 3.5 or greater and is available on PyPI.
Use pip to install it::
$ pip install uvloop
Note that it is highly recommended to **upgrade pip before** installing
uvloop with::
$ pip install -U pip
Using uvloop
------------
Call ``uvloop.install()`` before calling ``asyncio.run()`` or
manually creating an asyncio event loop:
.. code:: python
import asyncio
import uvloop
async def main():
# Main entry-point.
...
uvloop.install()
asyncio.run(main())
Building From Source
--------------------
To build uvloop, you'll need Python 3.5 or greater:
1. Clone the repository:
.. code::
$ git clone --recursive git@github.com:MagicStack/uvloop.git
$ cd uvloop
2. Create a virtual environment and activate it:
.. code::
$ python3.7 -m venv uvloop-dev
$ source uvloop-dev/bin/activate
3. Install development dependencies:
.. code::
$ pip install -r requirements.dev.txt
4. Build and run tests:
.. code::
$ make
$ make test
License
-------
uvloop is dual-licensed under MIT and Apache 2.0 licenses.
|
