Skip to main content

Compatibility API between asyncio/Twisted/Trollius

Project description

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.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, 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)

  • CPython 3.5 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:

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

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

Uploaded Source

Built Distribution

txaio-2.5.0-py2.py3-none-any.whl (26.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for txaio-2.5.0.tar.gz
Algorithm Hash digest
SHA256 997a75e7a677d47256ddf59d252e004b0ac2fe4cfecdeb85e72cd4b84a21799e
MD5 eb18ab049a20f21f86b58950de1e2ce7
BLAKE2b-256 91c9b2873e5a3e84c1b91a2d59b6d1efbc741da3bccc8c35e11f9e64365bd092

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for txaio-2.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 748c7ac781680264eaa3da1f3c17ee0a6c1df1a044d96274611f425319f171ed
MD5 a7de6485f7334a2209fff4c51684d44c
BLAKE2b-256 42e29e5499d2da47f852ce3c4b02973392db48cbe6d478cb109619a2c4243051

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