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

Uploaded Source

Built Distribution

txaio-2.5.2-py2.py3-none-any.whl (26.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for txaio-2.5.2.tar.gz
Algorithm Hash digest
SHA256 321d441b336447b72dbe81a4d73470414454baf0543ec701fcfecbf4dcbda0fe
MD5 81b041315b8d034655dec90a3c258de2
BLAKE2b-256 ca756f32fad1ba168863402de3a83cfa80a748fb5e871123a540b054fbad5bb0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for txaio-2.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 161494c82cf031afb2bc32277fd70be664029e785d8d12ac8d579d257abbfd6d
MD5 a91352fd91eb388714d31ba876335720
BLAKE2b-256 3520ad4693c904cc0167433b4ba35bf1bcb08174e1d17901fb5fafc64e40e6d6

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