.. image:: https://img.shields.io/badge/chat-join%20now-blue.svg :target: https://gitter.im/python-trio/general :alt: Join chatroom
.. image:: https://img.shields.io/badge/docs-read%20now-blue.svg :target: https://trio-asyncio.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://travis-ci.org/python-trio/trio-asyncio.svg?branch=master :target: https://travis-ci.org/python-trio/trio-asyncio :alt: Automated test status (Linux and MacOS)
.. image:: https://ci.appveyor.com/api/projects/status/github/python-trio/trio-asyncio?svg=true;branch=master :target: https://ci.appveyor.com/project/python-trio/trio-asyncio/history :alt: Automated test status (Windows)
.. image:: https://codecov.io/gh/python-trio/trio-asyncio/branch/master/graph/badge.svg :target: https://codecov.io/gh/python-trio/trio-asyncio :alt: Test coverage
trio-asyncio is a re-implementation of the
asyncio mainloop on top of
Trio-Asyncio requires at least Python 3.6. It is tested on recent versions of 3.6, 3.7, 3.8, and nightly.
+++++++++++ Rationale +++++++++++
Trio has native concepts of tasks and task cancellation. Asyncio is based on callbacks and chaining Futures, albeit with nicer syntax, making handling failures and timeouts fundamentally less reliable, especially in larger programs. Thus, you really want to base your async project on Trio.
On the other hand, there are quite a few asyncio-enhanced libraries. You really don't want to re-invent any wheels in your project.
Thus, being able to use asyncio libraries from Trio is useful. trio-asyncio enables you to do that and more.
trio_asyncio does not try to magically allow calling
await trio_code() from asyncio or vice versa. There are multiple reasons for
this; the executive summary is that cross-domain calls can't be made to
work correctly, and any such call is likely to result in an irrecoverable
error. You need to keep your code's
Fortunately, this is not difficult.
+++++++ Usage +++++++
Trio-Asyncio's documentation is too large for a README.
For further information,
see the manual on readthedocs <http://trio-asyncio.readthedocs.io/en/latest/>_.
++++++++++++++ Contributing ++++++++++++++
Like Trio, trio-asyncio is licensed under both the MIT and Apache licenses. Submitting a patch or pull request implies your acceptance of these licenses.
Testing is done with
pytest. Test coverage is pretty thorough; please
keep it that way when adding new code.
Trio contributor guide <https://trio.readthedocs.io/en/stable/contributing.html>__ for much
more detail on how to get involved.
Contributors are requested to follow our
code of conduct <https://trio.readthedocs.io/en/stable/code-of-conduct.html>__ in all
++++++++ Author ++++++++
Matthias Urlichs firstname.lastname@example.org originally wrote trio-asyncio.
It is now maintained by the
Trio project <https://github.com/python-trio>_.