mirror of https://github.com/MagicStack/uvloop.git
asyncasync-awaitasyncioasync-pythonevent-loophigh-performancelibuvnetworkingpythonpython-3starred-magicstack-repostarred-repo
318e593e3f
* `transport.get_extra_info('socket')` from now on will return a
socket-like object. That object will allow socket calls like
`getsockopt()` and `setsockopt()` but will deny `close()`,
`send()`, `recv()` and other invasive operations that might
interfere with libuv.
* We no longer dup sockets when they are passed to APIs like
`loop.create_server(sock=sock)`. We now use `socket._io_refs`
private API and new pseudo-sockets to guarantee that transports
will work correctly even when users try to close the original
socket object.
|
||
|---|---|---|
| .ci | ||
| .github | ||
| docs | ||
| examples/bench | ||
| tests | ||
| uvloop | ||
| vendor | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| MANIFEST.in | ||
| Makefile | ||
| README.rst | ||
| performance.png | ||
| pytest.ini | ||
| requirements.dev.txt | ||
| setup.py | ||
README.rst
.. 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
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
`performance <http://magic.io/blog/uvloop-blazing-fast-python-networking/>`_.
Installation
------------
uvloop requires Python 3.5 and is available on PyPI.
Use pip to install it::
$ pip install uvloop
Using uvloop
------------
To make asyncio use uvloop, you can install the uvloop event
loop policy:
.. code:: python
import asyncio
import uvloop
asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
Alternatively, you can create an instance of the loop
manually, using:
.. code:: python
loop = uvloop.new_event_loop()
asyncio.set_event_loop(loop)
Development of uvloop
---------------------
To build uvloop, you'll need Cython and Python 3.5. The best way
is to create a virtual env, so that you'll have ``cython`` and
``python`` commands pointing to the correct tools.
1. ``git clone --recursive git@github.com:MagicStack/uvloop.git``
2. ``cd uvloop``
3. ``make``
4. ``make test``
License
-------
uvloop is dual-licensed under MIT and Apache 2.0 licenses.