Skip to main content

txaio

Version Build Workflow Deploy Workflow 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 3.6+ and PyPy 3, on top of Twisted or asyncio. Specifically, txaio is tested on the following platforms:

  • CPython 3.6 and 3.9 on Twisted 18.7, 19.10, trunk and on asyncio (stdlib)

  • PyPy 3.6 an 3.7 on Twisted 18.7, 19.10, trunk and on asyncio (stdlib)

> Note: txaio up to version 18.8.1 also supported Python 2.7 and Python 3.4. Beginning with release v20.1.1, txaio only supports Python 3.5+. Beginning with release v20.12.1, txaio only supports Python 3.6+.

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.

Metadata

Release files for txaio 21.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for txaio 21.2.1
File Size Uploaded
txaio-21.2.1.tar.gz 53.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for txaio 21.2.1
File Interpreter ABI Platform
txaio-21.2.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 83.9 kB

Release files / txaio-21.2.1.tar.gz

Download URL txaio-21.2.1.tar.gz
Size 53.4 kB
Tags Source
SHA-256 checksum
How to use checksums
7d6f89745680233f1c4db9ddb748df5e88d2a7a37962be174c0fd04c8dba1dc8
BLAKE2b-256 checksum
How to use checksums
c5392e715062283f8443d8ceeea32276db71741664d78d43c3edd3675498e926
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.1

Release files / txaio-21.2.1-py2.py3-none-any.whl

Download URL txaio-21.2.1-py2.py3-none-any.whl
Size 30.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
c16b55f9a67b2419cfdf8846576e2ec9ba94fe6978a83080c352a80db31c93fb
BLAKE2b-256 checksum
How to use checksums
5553c9b89497ba46395bbf84a8c511550626cc5c507c0b76680df54435553e53
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.1

Release history Release notifications | RSS feed

26.6.1

2 release files

25.9.2

2 release files

25.6.1

2 release files

23.6.1

2 release files

23.1.1

2 release files

22.2.1

2 release files

This release

21.2.1 This release

2 release files

20.4.1

2 release files

20.3.1

2 release files

20.1.1

2 release files

18.8.1

2 release files

18.7.1

2 release files

2.9.0

2 release files

2.8.2

2 release files

2.8.1

2 release files

2.8.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.2

2 release files

2.6.1

2 release files

2.6.0

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

1 release file

2.2.2

1 release file

2.2.1

1 release file

2.2.0

1 release file

2.1.0

1 release file

2.0.4

1 release file

2.0.3

1 release file

2.0.2

1 release file

2.0.1

2.0.0

1 release file

1.1.0

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page