Skip to main content

Compatibility API between asyncio/Twisted/Trollius

Project description

Version 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.7/3.3+ and PyPy 2, on top of Twisted or asyncio. Specifically, txaio is tested on the following platforms:

  • CPython 2.7 on Twisted 12.1, 13.2, 15.4, 16.5, trunk and on Trollius 2.0

  • CPython 3.3 on Twisted 15.4, 16.5, trunk and on Trollius 2.0

  • CPython 3.4 on Twisted 15.4, 16.5, trunk and on asyncio (stdlib)

  • CPython 3.5 on Twisted 15.4, 16.5, trunk and on asyncio (stdlib)

  • PyPy 2 on Twisted 12.1, 13.2, 15.4, 16.5, trunk and on 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:

import txaio
txaio.use_twisted()  # or .use_asyncio()

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"))

Please refer to the documentation for description and usage of the library features.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

txaio-2.8.0.tar.gz (43.5 kB view details)

Uploaded Source

Built Distribution

txaio-2.8.0-py2.py3-none-any.whl (28.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file txaio-2.8.0.tar.gz.

File metadata

  • Download URL: txaio-2.8.0.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for txaio-2.8.0.tar.gz
Algorithm Hash digest
SHA256 8029d956591107ff9a2221d2a288fdd3718713a6991f59b97359d3d4f4b7b564
MD5 643ac20b895b878786cd6a46790367d0
BLAKE2b-256 03862cb7ae81209cc3fc64f68a31d70c20ab4771b520d7e13a5219b1f5e16ee1

See more details on using hashes here.

File details

Details for the file txaio-2.8.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for txaio-2.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e9b5f002f6b8a8c6f91423328eff1bf08b232269ac29812158df2cabb3503246
MD5 abad5ad07b1ea26a4ccb3f7fd8a2783a
BLAKE2b-256 1287c6fc0df3abd71a83375dbca172e8bfc5a04244a28f581d1732f4a0c21bdb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page