132 lines
5.3 KiB
Plaintext
132 lines
5.3 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: txaio
|
|
Version: 23.1.1
|
|
Summary: Compatibility API between asyncio/Twisted/Trollius
|
|
Home-page: https://github.com/crossbario/txaio
|
|
Author: typedef int GmbH
|
|
Author-email: autobahnws@googlegroups.com
|
|
License: MIT License
|
|
Keywords: asyncio twisted trollius coroutine
|
|
Platform: Any
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Environment :: Console
|
|
Classifier: Framework :: Twisted
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Classifier: Topic :: Software Development :: Libraries
|
|
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
|
Requires-Python: >=3.7
|
|
License-File: LICENSE
|
|
Provides-Extra: all
|
|
Requires-Dist: zope.interface (>=5.2.0) ; extra == 'all'
|
|
Requires-Dist: twisted (>=20.3.0) ; extra == 'all'
|
|
Provides-Extra: asyncio
|
|
Provides-Extra: dev
|
|
Requires-Dist: wheel ; extra == 'dev'
|
|
Requires-Dist: pytest (>=2.6.4) ; extra == 'dev'
|
|
Requires-Dist: pytest-cov (>=1.8.1) ; extra == 'dev'
|
|
Requires-Dist: pep8 (>=1.6.2) ; extra == 'dev'
|
|
Requires-Dist: sphinx (>=1.2.3) ; extra == 'dev'
|
|
Requires-Dist: pyenchant (>=1.6.6) ; extra == 'dev'
|
|
Requires-Dist: sphinxcontrib-spelling (>=2.1.2) ; extra == 'dev'
|
|
Requires-Dist: sphinx-rtd-theme (>=0.1.9) ; extra == 'dev'
|
|
Requires-Dist: tox (>=2.1.1) ; extra == 'dev'
|
|
Requires-Dist: twine (>=1.6.5) ; extra == 'dev'
|
|
Requires-Dist: tox-gh-actions (>=2.2.0) ; extra == 'dev'
|
|
Provides-Extra: twisted
|
|
Requires-Dist: zope.interface (>=5.2.0) ; extra == 'twisted'
|
|
Requires-Dist: twisted (>=20.3.0) ; extra == 'twisted'
|
|
|
|
txaio
|
|
=====
|
|
|
|
| |Version| |Build| |Deploy| |Coverage| |Docs|
|
|
|
|
--------------
|
|
|
|
**txaio** is a helper library for writing code that runs unmodified on
|
|
both `Twisted <https://twistedmatrix.com/>`_ and `asyncio <https://docs.python.org/3/library/asyncio.html>`_ / `Trollius <http://trollius.readthedocs.org/en/latest/index.html>`_.
|
|
|
|
This is like `six <http://pythonhosted.org/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:
|
|
|
|
.. sourcecode:: python
|
|
|
|
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 <https://txaio.readthedocs.io/en/latest/>`_ for description and usage of the library features.
|
|
|
|
|
|
.. |Version| image:: https://img.shields.io/pypi/v/txaio.svg
|
|
:target: https://pypi.python.org/pypi/txaio
|
|
:alt: Version
|
|
|
|
.. |Build| image:: https://github.com/crossbario/txaio/workflows/main/badge.svg
|
|
:target: https://github.com/crossbario/txaio/actions?query=workflow%3Amain
|
|
:alt: Build Workflow
|
|
|
|
.. |Deploy| image:: https://github.com/crossbario/txaio/workflows/deploy/badge.svg
|
|
:target: https://github.com/crossbario/txaio/actions?query=workflow%3Adeploy
|
|
:alt: Deploy Workflow
|
|
|
|
.. |Coverage| image:: https://codecov.io/github/crossbario/txaio/coverage.svg?branch=master
|
|
:target: https://codecov.io/github/crossbario/txaio
|
|
:alt: Coverage
|
|
|
|
.. |Docs| image:: https://readthedocs.org/projects/txaio/badge/?version=latest
|
|
:target: https://txaio.readthedocs.io/en/latest/
|
|
:alt: Docs
|