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.7.1.tar.gz (43.6 kB view details)

Uploaded Source

Built Distribution

txaio-2.7.1-py2.py3-none-any.whl (28.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for txaio-2.7.1.tar.gz
Algorithm Hash digest
SHA256 9eea85c27ff8ac28049a29b55383f5c162351f855860e5081ff4632d65a5b4d2
MD5 11a5960d8f5e5b6d1da0b3bc5e8165ec
BLAKE2b-256 a5973fe0c5674e1eb8eb850a885df8df193ba83ba0eda6c5eb6c33ac49730bb9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for txaio-2.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0fe5bdb1c5b0efbc0f436db7b08e3e6e239f6e8b2c763666faff7ea258808f50
MD5 d28d1db0472169c3cf632430bb5e505c
BLAKE2b-256 3fa52fd4b71722cafba76f204719150ba49e1c007a3daaab4628292f433a9905

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