mirror of https://github.com/MagicStack/uvloop.git
asyncasync-awaitasyncioasync-pythonevent-loophigh-performancelibuvnetworkingpythonpython-3starred-magicstack-repostarred-repo
c32c7039cd
When uvloop is run in the main thread we *always* want to set up a self-pipe and a signal wakeup FD. That's the only way how libuv can be notified that a ^C happened and break away from selecting on sockets. asyncio does not need to do that, as the 'selectors' module it uses is already aware of the way Python implements ^C handling. This translates to a slightly different behavior between asyncio & uvloop: 1. uvloop needs to always call signal.set_wakeup_fd() when run in the main thread; 2. asyncio only needs to call signal.set_wakeup_fd() when a user registers a signal handler. (2) means that if the user had not set up any signals, the signal wakeup FD stays the same between different asyncio runs. This commit fixes uvloop signal implementation to make sure that uvloop behaves the same way as asyncio in regards to signal wakeup FD between the loop runs. It also ensures that uvloop always have a proper self-pipe set up so that ^C is always supported when it is run in the main thread. Issue #295. |
||
|---|---|---|
| .ci | ||
| .github | ||
| docs | ||
| examples/bench | ||
| tests | ||
| uvloop | ||
| vendor | ||
| .editorconfig | ||
| .flake8 | ||
| .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
.. 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.