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/3, on top of Twisted or asyncio. Specifically, txaio is tested on the following platforms:

Python 2:

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

  • PyPy 2 on Twisted 12.1, 13.2, 15.4, 16.5, trunk and on Trollius 2.0

Python 3:

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

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

  • PyPy 3 on Twisted 15.4, 16.5, trunk and on asyncio (stdlib)

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

Uploaded Source

Built Distribution

txaio-2.10.0-py2.py3-none-any.whl (26.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for txaio-2.10.0.tar.gz
Algorithm Hash digest
SHA256 4797f9f6a9866fe887c96abc0110a226dd5744c894dc3630870542597ad30853
MD5 ca771953d46a9145ff0d486243aef8cb
BLAKE2b-256 b887efcae4040c2a0af9c871116a6dbf02ee582b396e6de3797fb30cdcc4a7e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for txaio-2.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c25acd6c2ef7005a0cd50fa2b65deac409be2f3886e2fcd04f99fae827b179e4
MD5 eb5bd67be54e74e6e0a74ab6ee77147d
BLAKE2b-256 dc2ec8a877b0a5c2798fa93ebcc1465a72a68c089e5f8b0a852ca335751dcc5a

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