Skip to main content

An asynchronous networking framework written in Python

Project description

gitter rtd pypi mypy

For information on changes in this release, see the NEWS file.

What is this?

Twisted is an event-based framework for internet applications, supporting Python 3.6+. It includes modules for many different purposes, including the following:

  • twisted.web: HTTP clients and servers, HTML templating, and a WSGI server

  • twisted.conch: SSHv2 and Telnet clients and servers and terminal emulators

  • twisted.words: Clients and servers for IRC, XMPP, and other IM protocols

  • twisted.mail: IMAPv4, POP3, SMTP clients and servers

  • twisted.positioning: Tools for communicating with NMEA-compatible GPS receivers

  • twisted.names: DNS client and tools for making your own DNS servers

  • twisted.trial: A unit testing framework that integrates well with Twisted-based code.

Twisted supports all major system event loops – select (all platforms), poll (most POSIX platforms), epoll (Linux), kqueue (FreeBSD, macOS), IOCP (Windows), and various GUI event loops (GTK+2/3, Qt, wxWidgets). Third-party reactors can plug into Twisted, and provide support for additional event loops.

Installing

To install the latest version of Twisted using pip:

$ pip install twisted

Additional instructions for installing this software are in the installation instructions.

Documentation and Support

Twisted’s documentation is available from the Twisted Matrix website. This documentation contains how-tos, code examples, and an API reference.

Help is also available on the Twisted mailing list.

There is also an IRC channel, #twisted, on the Libera.Chat network. A web client is available at web.libera.chat.

Unit Tests

Twisted has a comprehensive test suite, which can be run by tox:

$ tox -l                       # to view all test environments
$ tox -e nocov                 # to run all the tests without coverage
$ tox -e withcov               # to run all the tests with coverage
$ tox -e alldeps-withcov-posix # install all dependencies, run tests with coverage on POSIX platform

You can test running the test suite under the different reactors with the TWISTED_REACTOR environment variable:

$ env TWISTED_REACTOR=epoll tox -e alldeps-withcov-posix

Some of these tests may fail if you:

  • don’t have the dependencies required for a particular subsystem installed,

  • have a firewall blocking some ports (or things like Multicast, which Linux NAT has shown itself to do), or

  • run them as root.

Static Code Checkers

You can ensure that code complies to Twisted coding standards:

$ tox -e lint   # run pre-commit to check coding stanards
$ tox -e mypy   # run MyPy static type checker to check for type errors

Or, for speed, use pre-commit directly:

$ pipx run pre-commit run

Warranty

THIS SOFTWARE IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE USE OF THIS SOFTWARE IS WITH YOU.

IN NO EVENT WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY, BE LIABLE TO YOU FOR ANY DAMAGES, EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Again, see the included LICENSE file for specific legal details.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Twisted-22.10.0rc1.tar.gz (3.5 MB view details)

Uploaded Source

Built Distribution

Twisted-22.10.0rc1-py3-none-any.whl (3.1 MB view details)

Uploaded Python 3

File details

Details for the file Twisted-22.10.0rc1.tar.gz.

File metadata

  • Download URL: Twisted-22.10.0rc1.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for Twisted-22.10.0rc1.tar.gz
Algorithm Hash digest
SHA256 e6c7017d7a06e7d22b349d83a6e7f67260a47bb4706589424453704d86a0f550
MD5 81d74e3fd0abed838441d5a2fa39e6bb
BLAKE2b-256 659b2565275574604ada270dc240e73ff674a03510c42699f36975a9cb874f0d

See more details on using hashes here.

File details

Details for the file Twisted-22.10.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for Twisted-22.10.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 736253897b267e81b97bb2cf470979314a8a8d97e1ecaf1f44f8728635c4ba8a
MD5 5c9ade0f264382655352dd24355bd977
BLAKE2b-256 f85e3ead7c218cdc56843119e1ec55bf8e40028a99208c1cbd9ee54f7ec476d8

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