RETIRED, further work has moved to Debian project infrastructure
Go to file
meejah 57fb7cf6e5 fix README.rst and docs/* paths in MANIFEST 2015-10-08 09:44:57 -06:00
docs renaming 2015-09-25 16:12:44 +02:00
examples add license headers 2015-04-07 13:37:07 +02:00
test handle an error we create in a test 2015-09-25 09:56:56 -06:00
txaio fix README.rst and docs/* paths in MANIFEST 2015-10-08 09:44:57 -06:00
.gitignore ignore spelling build stuff 2015-09-25 16:38:24 +02:00
.travis.yml try one-line coverage command 2015-09-26 12:14:53 -06:00
LICENSE add license headers 2015-04-07 13:37:07 +02:00
MANIFEST.in fix README.rst and docs/* paths in MANIFEST 2015-10-08 09:44:57 -06:00
Makefile ensure single version of coverage, fix makefile 2015-09-26 14:02:16 -06:00
README.rst fix symlink 2015-09-25 16:14:05 +02:00
setup.py force travis 2015-09-26 11:54:41 +02:00
tox.ini ensure single version of coverage, fix makefile 2015-09-26 14:02:16 -06:00

README.rst

txaio

Version Downloads Build Status Coverage Docs

txaio is a helper library for writing code that runs unmodified on both Twisted and asyncio / Trollius.

This is like six, but for wrapping over differences between Twisted and asyncio so one can write code that runs unmodified on both (aka source code compatibility). In other words: your users can choose if they want asyncio or Twisted as a dependency.

Note that, with this approach, user code runs under the native event loop of either Twisted or asyncio. This is different from attaching either one's event loop to the other using some event loop adapter.

Platform support

txaio runs on CPython 2.6+ and PyPy 2, on top of Twisted or asyncio. Specifically, txaio is tested on the following platforms:

  • CPython 2.6 on Twisted 12.1, 13.2, 15.4 and Trollius 2.0
  • CPython 2.7 on Twisted 12.1, 13.2, 15.4, trunk and Trollius 2.0
  • CPython 3.3 on Twisted 15.4, trunk and Trollius 2.0
  • CPython 3.4 on Twisted 15.4, trunk and asyncio (stdlib)
  • PyPy 2.5 on Twisted 12.1, 13.2, 15.4, trunk and Trollius 2.0

How it works

Instead of directly importing, instantiating and using Deferred (for Twisted) or Future (for asyncio) objects, txaio provides helper-functions to do that for you, as well as associated things like adding callbacks or errbacks.

This obviously changes the style of your code, but then you can choose at runtime (or import time) which underlying event-loop to use. This means you can write one code-base that can run on Twisted or asyncio (without a Twisted dependency) as you or your users see fit.

Code like the following can then run on either system:

f0 = txaio.create_future()
f1 = txaio.as_future(some_func, 1, 2, key='word')
txaio.add_callbacks(f0, callback, errback)
txaio.add_callbacks(f1, callback, errback)
# ...
txaio.resolve(f0, "value")
txaio.reject(f1, RuntimeError("it failed"))