twisted API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Module Index

  • twisted - Twisted: The Framework Of Your Internet.
    • application - Configuration objects for Twisted Applications.
      • app - No module docstring; 2/10 functions, 7/8 classes documented
      • internet - Reactor-based Services
      • reactors - Plugin-based system for enumerating available reactors and installing one of them.
      • runner - Facilities for running a Twisted application.
        • test - Tests for twisted.application.runner.
          • test_exit - Tests for twisted.application.runner._exit.
          • test_pidfile - Tests for twisted.application.runner._pidfile.
          • test_runner - Tests for twisted.application.runner._runner.
        • _exit - System exit support.
        • _pidfile - PID file.
        • _runner - Twisted application runner.
      • service - Service architecture for Twisted.
      • strports - Construct listening port services from a simple string description.
      • test - Tests for twisted.internet.application.
        • test_internet - Tests for (new code in) twisted.application.internet.
        • test_service - Tests for twisted.application.service.
      • twist - twist command line tool.
        • test - Tests for twisted.application.twist.
          • test_options - Tests for twisted.application.twist._options.
          • test_twist - Tests for twisted.application.twist._twist.
        • _options - Command line options for twist.
        • _twist - Run a Twisted application.
      • _client_service - Implementation of twisted.application.internet.ClientService, particularly its automat state machine.
    • conch - Twisted Conch: The Twisted Shell. Terminal emulation, SSHv2 and telnet.
      • avatar - Undocumented
      • checkers - Provide ICredentialsChecker implementations to be used in Conch protocols.
      • client - Client support code for Conch.
        • agent - Accesses the key agent for user authentication.
        • connect - Undocumented
        • default - Various classes and functions for implementing user-interaction in the command-line conch client.
        • direct - Undocumented
        • knownhosts - An implementation of the OpenSSH known_hosts database.
        • options - Undocumented
      • endpoints - Endpoint implementations of various SSH interactions.
      • error - An error to represent bad things happening in Conch.
      • insults - Insults: a replacement for Curses/S-Lang.
        • helper - Partial in-memory terminal emulator
        • insults - VT102 and VT220 terminal manipulation.
        • text - Character attribute manipulation API.
        • window - Simple insults-based widget library
      • interfaces - This module contains interfaces defined for the twisted.conch package.
      • ls - No module docstring; 0/1 constant, 1/1 function documented
      • manhole - Line-input oriented interactive interpreter loop.
      • manhole_ssh - insults/SSH integration support.
      • manhole_tap - TAP plugin for creating telnet- and ssh-accessible manhole servers.
      • mixin - Experimental optimization
      • openssh_compat - Support for OpenSSH configuration files.
        • factory - Factory for reading openssh configuration files: public keys, private keys, and moduli file.
        • primes - Parsing for the moduli file, which contains Diffie-Hellman prime groups.
      • recvline - Basic line editing support.
      • scripts - conch scripts
        • cftp - Implementation module for the cftp command.
        • ckeygen - Implementation module for the `ckeygen` command.
        • conch - Undocumented
        • tkconch - Implementation module for the `tkconch` command.
      • ssh - An SSHv2 implementation for Twisted. Part of the Twisted.Conch package.
        • address - Address object for SSH network connections.
        • agent - Implements the SSH v2 key agent protocol. This protocol is documented in the SSH source code, in the file PROTOCOL.agent.
        • channel - The parent class for all the SSH Channels. Currently implemented channels are session, direct-tcp, and forwarded-tcp.
        • common - Common functions for the SSH classes.
        • connection - This module contains the implementation of the ssh-connection service, which allows access to the shell and port-forwarding.
        • factory - A Factory for SSH servers.
        • filetransfer - Undocumented
        • forwarding - This module contains the implementation of the TCP forwarding, which allows clients and servers to forward arbitrary TCP data across the connection.
        • keys - Handling of RSA, DSA, ECDSA, and Ed25519 keys.
        • service - The parent class for all the SSH services. Currently implemented services are ssh-userauth and ssh-connection.
        • session - This module contains the implementation of SSHSession, which (by default) allows access to a shell and a python interpreter over SSH.
        • sexpy - Undocumented
        • transport - The lowest level SSH protocol. This handles the key negotiation, the encryption and the compression. The transport layer is described in RFC 4253.
        • userauth - Implementation of the ssh-userauth service. Currently implemented authentication types are public-key and password.
        • _kex - SSH key exchange handling.
      • stdio - Asynchronous local terminal input handling
      • tap - Support module for making SSH servers with twistd.
      • telnet - Telnet protocol implementation.
      • test - conch tests
        • keydata - Data used by test_keys as well as others.
        • loopback - Loopback helper used in test_ssh and test_recvline
        • test_address - Tests for SSHTransportAddrress in ssh/address.py
        • test_agent - Tests for twisted.conch.ssh.agent.
        • test_cftp - Tests for twisted.conch.scripts.cftp.
        • test_channel - Test ssh/channel.py.
        • test_checkers - Tests for twisted.conch.checkers.
        • test_ckeygen - Tests for twisted.conch.scripts.ckeygen.
        • test_conch - No module docstring; 0/2 variable, 0/1 function, 13/17 classes documented
        • test_connection - This module tests twisted.conch.ssh.connection.
        • test_default - Tests for twisted.conch.client.default.
        • test_endpoints - Tests for twisted.conch.endpoints.
        • test_filetransfer - Tests for twisted.conch.ssh.filetransfer.
        • test_forwarding - Tests for twisted.conch.ssh.forwarding.
        • test_helper - No module docstring; 0/2 constant, 1/5 class documented
        • test_insults - No module docstring; 0/4 variable, 1/6 function, 2/9 classes documented
        • test_keys - Tests for twisted.conch.ssh.keys.
        • test_knownhosts - Tests for twisted.conch.client.knownhosts.
        • test_manhole - Tests for twisted.conch.manhole.
        • test_manhole_tap - Tests for twisted.conch.manhole_tap.
        • test_mixin - Undocumented
        • test_openssh_compat - Tests for twisted.conch.openssh_compat.
        • test_recvline - Tests for twisted.conch.recvline and fixtures for testing related functionality.
        • test_scripts - Tests for the command-line interfaces to conch.
        • test_session - Tests for the 'session' channel implementation in twisted.conch.ssh.session.
        • test_ssh - Tests for twisted.conch.ssh.
        • test_tap - Tests for twisted.conch.tap.
        • test_telnet - Tests for twisted.conch.telnet.
        • test_text - No module docstring; 1/1 class documented
        • test_transport - Tests for ssh/transport.py and the classes therein.
        • test_unix - No module docstring; 0/3 variable, 2/3 classes documented
        • test_userauth - Tests for the implementation of the ssh-userauth service.
        • test_window - Tests for the insults windowing module, twisted.conch.insults.window.
      • ttymodes - Undocumented
      • ui - twisted.conch.ui is home to the UI elements for tkconch.
        • ansi - Module to parse ANSI escape sequences
        • tkvt100 - Module to emulate a VT100 terminal in Tkinter.
      • unix - A UNIX SSH server.
    • copyright - Copyright information for Twisted.
    • cred - Twisted Cred: Support for verifying credentials, and providing services to user based on those credentials.
      • checkers - Basic credential checkers
      • credentials - This module defines ICredentials, an interface for objects that represent authentication credentials to provide, and also includes a number of useful implementations of that interface.
      • error - Cred errors.
      • portal - The point of integration of application and authentication.
      • strcred - Support for resolving command-line strings that represent different checkers available to cred.
      • test - Unit tests for twisted.cred.
        • test_cramauth - Tests for twisted.cred's implementation of CRAM-MD5.
        • test_cred - Tests for twisted.cred, now with 30% more starch.
        • test_digestauth - Tests for twisted.cred._digest and the associated bits in twisted.cred.credentials.
        • test_simpleauth - Tests for basic constructs of twisted.cred.credentials.
        • test_strcred - twisted.cred.strcred.
      • _digest - Calculations for HTTP Digest authentication.
    • enterprise - Twisted Enterprise: Database support for Twisted services.
      • adbapi - An asynchronous mapping to DB-API 2.0.
    • internet - Twisted Internet: Asynchronous I/O and Events.
      • abstract - Support for generic select()able objects.
      • address - Address objects for network connections.
      • asyncioreactor - asyncio-based reactor implementation.
      • base - Very basic functionality for a Reactor implementation.
      • cfreactor - A reactor for integrating with CFRunLoop, the CoreFoundation main loop used by macOS.
      • default - The most suitable default reactor for the current platform.
      • defer - Support for results that aren't immediately available.
      • endpoints - Implementations of IStreamServerEndpoint and IStreamClientEndpoint that wrap the IReactorTCP, IReactorSSL, and IReactorUNIX interfaces.
      • epollreactor - An epoll() based implementation of the twisted main loop.
      • error - Exceptions and errors for use in twisted.internet modules.
      • fdesc - Utility functions for dealing with POSIX file descriptors.
      • gireactor - This module provides support for Twisted to interact with the glib mainloop via GObject Introspection.
      • glib2reactor - This module provides support for Twisted to interact with the glib mainloop. This is like gtk2, but slightly faster and does not require a working $DISPLAY. However, you cannot run GUIs under this reactor: for that you must use the gtk2reactor instead.
      • gtk2reactor - This module provides support for Twisted to interact with the glib/gtk2 mainloop.
      • gtk3reactor - This module is a legacy compatibility alias for twisted.internet.gireactor. See that module instead.
      • inotify - This module provides support for Twisted to linux inotify API.
      • interfaces - Interface documentation.
      • iocpreactor - I/O Completion Ports reactor
        • abstract - Abstract file handle class
        • const - Windows constants for IOCP
        • interfaces - Interfaces for iocpreactor
        • iocpsupport - Undocumented
        • reactor - Reactor that uses IO completion ports
        • tcp - TCP support for IOCP reactor
        • udp - UDP support for IOCP reactor
      • kqreactor - A kqueue()/kevent() based implementation of the Twisted main loop.
      • main - Backwards compatibility, and utility functions.
      • pollreactor - A poll() based implementation of the twisted main loop.
      • posixbase - Posix reactor base class
      • process - UNIX Process management.
      • protocol - Standard implementations of Twisted protocol-related interfaces.
      • pyuisupport - This module integrates PyUI with twisted.internet's mainloop.
      • reactor - The reactor is the Twisted event loop within Twisted, the loop which drives applications using Twisted. The reactor provides APIs for networking, threading, dispatching events, and more.
      • selectreactor - Select reactor
      • serialport - Serial Port Protocol
      • ssl - This module implements Transport Layer Security (TLS) support for Twisted. It requires PyOpenSSL.
      • stdio - Standard input/out/err support.
      • task - Scheduling utility methods and classes.
      • tcp - Various asynchronous TCP/IP classes.
      • test - Tests for twisted.internet.
        • connectionmixins, fakeendpoint, modulehelpers, process_cli, process_connectionlost, process_gireactornocompat, process_helper, reactormixins, test_abstract, test_address, test_asyncioreactor, test_base, test_baseprocess, test_cfreactor, test_core, test_default, test_defer_await, test_defer_yieldfrom, test_endpoints, test_epollreactor, test_error, test_fdset, test_filedescriptor, test_gireactor, test_glibbase, test_inlinecb, test_inotify, test_iocp, test_kqueuereactor, test_main, test_newtls, test_pollingfile, test_posixbase, test_posixprocess, test_process, test_protocol, test_reactormixins, test_resolver, test_serialport, test_sigchld, test_socket, test_stdio, test_tcp, test_testing, test_threads, test_time, test_tls, test_udp, test_udp_internals, test_unix, test_win32events, test_win32serialport, _posixifaces, _win32ifaces
      • testing - Assorted functionality which is commonly useful when writing unit tests.
      • threads - Extended thread dispatching support.
      • tksupport - This module integrates Tkinter with twisted.internet's mainloop.
      • udp - Various asynchronous UDP classes.
      • unix - UNIX socket support for Twisted.
      • utils - Utility methods.
      • win32eventreactor - A win32event based implementation of the Twisted main loop.
      • wxreactor - This module provides wxPython event loop support for Twisted.
      • wxsupport - Old method of wxPython support for Twisted.
      • _baseprocess - Cross-platform process-related functionality used by different IReactorProcess implementations.
      • _deprecate - Support similar deprecation of several reactors.
      • _dumbwin32proc - Windows Process Management, used with reactor.spawnProcess
      • _glibbase - This module provides base support for Twisted to interact with the glib/gtk mainloops.
      • _idna - Shared interface to IDNA encoding and decoding, using the idna PyPI package if available, otherwise the stdlib implementation.
      • _multicast - No module docstring; 0/1 function, 1/1 class documented
      • _newtls - This module implements memory BIO based TLS support. It is the preferred implementation and will be used whenever pyOpenSSL 0.10 or newer is installed (whenever twisted.protocols.tls is importable).
      • _pollingfile - Implements a simple polling interface for file descriptors that don't work with select() - this is pretty much only useful on Windows.
      • _posixserialport - Serial Port Protocol
      • _posixstdio - Standard input/out/err support.
      • _producer_helpers - Helpers for working with producers.
      • _resolver - IPv6-aware hostname resolution.
      • _signals - This module is used to integrate child process termination into a reactor event loop. This is a challenging feature to provide because most platforms indicate process termination via SIGCHLD and do not provide a way to wait for that signal and arbitrary I/O events at the same time...
      • _sslverify - No module docstring; 0/7 variable, 10/10 functions, 1/1 exception, 6/6 classes, 1/1 interface documented
      • _threadedselect - Threaded select reactor
      • _win32serialport - Serial port support for Windows.
      • _win32stdio - Windows-specific implementation of the twisted.internet.stdio interface.
    • logger - Twisted Logger: Classes and functions to do granular logging.
      • test - Unit tests for twisted.logger.
        • test_buffer - Test cases for twisted.logger._buffer.
        • test_capture - Test cases for twisted.logger._capture.
        • test_file - Test cases for twisted.logger._file.
        • test_filter - Test cases for twisted.logger._filter.
        • test_flatten - Test cases for twisted.logger._format.
        • test_format - Test cases for twisted.logger._format.
        • test_global - Test cases for twisted.logger._global.
        • test_io - Test cases for twisted.logger._io.
        • test_json - Tests for twisted.logger._json.
        • test_legacy - Test cases for twisted.logger._legacy.
        • test_levels - Test cases for twisted.logger._levels.
        • test_logger - Test cases for twisted.logger._logger.
        • test_observer - Test cases for twisted.logger._observer.
        • test_stdlib - Test cases for twisted.logger._format.
        • test_util - Test cases for twisted.logger._util.
      • _buffer - Log observer that maintains a buffer.
      • _capture - Context manager for capturing logs.
      • _file - File log observer.
      • _filter - Filtering log observer.
      • _flatten - Code related to "flattening" events; that is, extracting a description of all relevant fields from the format string and persisting them for later examination.
      • _format - Tools for formatting logging events.
      • _global - This module includes process-global state associated with the logging system, and implementation of logic for managing that global state.
      • _interfaces - Logger interfaces.
      • _io - File-like object that logs.
      • _json - Tools for saving and loading log events in a structured format.
      • _legacy - Integration with twisted.python.log.
      • _levels - Log levels.
      • _logger - Logger class.
      • _observer - Basic log observers.
      • _stdlib - Integration with Python standard library logging.
      • _util - Logging utilities.
    • mail - Twisted Mail: Servers and clients for POP3, ESMTP, and IMAP.
      • alias - Support for aliases(5) configuration files.
      • bounce - Support for bounce message generation.
      • imap4 - An IMAP4 protocol implementation
      • interfaces - Interfaces for twisted.mail.
      • mail - Mail service support.
      • maildir - Maildir-style mailbox support.
      • pb - Undocumented
      • pop3 - Post-office Protocol version 3.
      • pop3client - Deprecated POP3 client protocol implementation.
      • protocols - Mail protocol support.
      • relay - Support for relaying mail.
      • relaymanager - Infrastructure for relaying mail through a smart host.
      • scripts - mail scripts
        • mailmail - Implementation module for the mailmail command.
      • smtp - Simple Mail Transfer Protocol implementation.
      • tap - Support for creating mail servers with twistd.
      • test - Tests for twistd.mail
        • pop3testserver - No module docstring; 0/1 variable, 1/29 constant, 0/3 function, 0/1 class documented
        • test_bounce - No module docstring; 1/1 class documented
        • test_imap - Test case for twisted.mail.imap4
        • test_mail - Tests for large portions of twisted.mail.
        • test_mailmail - Tests for twisted.mail.scripts.mailmail, the implementation of the command line program mailmail.
        • test_options - Tests for twisted.mail.tap.
        • test_pop3 - Test cases for twisted.mail.pop3 module.
        • test_pop3client - No module docstring; 0/1 variable, 0/2 function, 2/13 classes documented
        • test_scripts - Tests for the command-line mailer tool provided by Twisted Mail.
        • test_smtp - Test cases for twisted.mail.smtp module.
      • _cred - Credential managers for twisted.mail.
      • _except - Exceptions in twisted.mail.
      • _pop3client - A POP3 client protocol implementation.
    • names - Twisted Names: DNS server and client implementations.
      • authority - Authoritative resolvers.
      • cache - An in-memory caching resolver.
      • client - Asynchronous client DNS
      • common - Base functionality useful to various parts of Twisted Names.
      • dns - DNS protocol implementation.
      • error - Exception class definitions for Twisted Names.
      • hosts - hosts(5) support.
      • resolve - Lookup a name using multiple resolvers.
      • root - Resolver implementation for querying successive authoritative servers to lookup a record, starting from the root nameservers.
      • secondary - No module docstring; 2/2 classes documented
      • server - Async DNS server
      • srvconnect - No module docstring; 1/2 class documented
      • tap - Domain Name Server
      • test - Tests for twisted.names
        • test_cache - Tests for twisted.names.cache.
        • test_client - Test cases for twisted.names.client.
        • test_common - Tests for twisted.names.common.
        • test_dns - Tests for twisted.names.dns.
        • test_examples - Tests for twisted.names example scripts.
        • test_hosts - Tests for the hosts(5)-based resolver, twisted.names.hosts.
        • test_names - Test cases for twisted.names.
        • test_resolve - Tests for twisted.names.resolve.
        • test_rfc1982 - Test cases for twisted.names.rfc1982.
        • test_rootresolve - Test cases for Twisted.names' root resolver.
        • test_server - Test cases for twisted.names.server.
        • test_srvconnect - Test cases for twisted.names.srvconnect.
        • test_tap - Tests for twisted.names.tap.
        • test_util - Utilities for Twisted.names tests.
      • _rfc1982 - Utilities for handling RFC1982 Serial Number Arithmetic.
    • pair - Twisted Pair: The framework of your ethernet.
      • ethernet - Support for working directly with ethernet frames
      • ip - Support for working directly with IP packets
      • raw - Interface definitions for working with raw packets
      • rawudp - Implementation of raw packet interfaces for UDP
      • test - pair tests
        • test_ethernet - Undocumented
        • test_ip - Undocumented
        • test_rawudp - Undocumented
        • test_tuntap - Tests for twisted.pair.tuntap.
      • testing - Tools for automated testing of twisted.pair-based applications.
      • tuntap - Support for Linux ethernet and IP tunnel devices.
    • persisted - Twisted Persisted: Utilities for managing persistence.
      • aot - AOT: Abstract Object Trees The source-code-marshallin'est abstract-object-serializin'est persister this side of Marmalade!
      • crefutil - Utility classes for dealing with circular references.
      • dirdbm - DBM-style interface to a directory.
      • sob - Save and load Small OBjects to and from files, using various formats.
      • styles - Different styles of persisted objects.
      • test - Tests for twisted.persisted.
        • test_styles - Tests for twisted.persisted.styles.
      • _token - FIXME:https://github.com/twisted/twisted/issues/3843 This can be removed once t.persisted.aot is removed. New code should not make use of this.
      • _tokenize - FIXME:https://github.com/twisted/twisted/issues/3843 This can be removed once t.persisted.aot is removed. New code should not make use of this.
    • plugin - Plugin system for Twisted.
    • plugins - Plugins for services implemented in Twisted.
      • cred_anonymous - Cred plugin for anonymous logins.
      • cred_file - Cred plugin for a file of the format 'username:password'.
      • cred_memory - Cred plugin for an in-memory user database.
      • cred_sshkeys - Cred plugin for ssh key login.
      • cred_unix - Cred plugin for UNIX user accounts.
      • twisted_conch - Undocumented
      • twisted_core - Undocumented
      • twisted_ftp - Undocumented
      • twisted_inet - Undocumented
      • twisted_mail - Undocumented
      • twisted_names - Undocumented
      • twisted_portforward - Undocumented
      • twisted_reactors - Undocumented
      • twisted_runner - Undocumented
      • twisted_socks - Undocumented
      • twisted_trial - Undocumented
      • twisted_web - Undocumented
      • twisted_words - Undocumented
    • positioning - Twisted Positioning: Framework for applications that make use of positioning.
      • base - Generic positioning base classes.
      • ipositioning - Positioning interfaces.
      • nmea - Classes for working with NMEA 0183 sentence producing devices. This standard is generally just called "NMEA", which is actually the name of the body that produces the standard, not the standard itself..
      • test - Tests for the Twisted positioning framework.
        • receiver - Receivers for use in tests.
        • test_base - Test cases for positioning primitives.
        • test_nmea - Test cases for using NMEA sentences.
        • test_sentence - Tests for positioning sentences.
      • _sentence - Generic sentence handling tools: hopefully reusable.
    • protocols - Twisted Protocols: A collection of internet protocol implementations.
      • amp - This module implements AMP, the Asynchronous Messaging Protocol.
      • basic - Basic protocols, such as line-oriented, netstring, and int prefixed strings.
      • finger - The Finger User Information Protocol (RFC 1288)
      • ftp - An FTP protocol implementation
      • haproxy - HAProxy PROXY protocol implementations.
        • test - Unit tests for twisted.protocols.haproxy.
          • test_parser - Tests for twisted.protocols.haproxy._parser.
          • test_v1parser - Test cases for twisted.protocols.haproxy.V1Parser.
          • test_v2parser - Test cases for twisted.protocols.haproxy.V2Parser.
          • test_wrapper - Test cases for twisted.protocols.haproxy.HAProxyProtocol.
        • _exceptions - HAProxy specific exceptions.
        • _info - IProxyInfo implementation.
        • _interfaces - Interfaces used by the PROXY protocol modules.
        • _parser - Parser for 'haproxy:' string endpoint.
        • _v1parser - IProxyParser implementation for version one of the PROXY protocol.
        • _v2parser - IProxyParser implementation for version two of the PROXY protocol.
        • _wrapper - Protocol wrapper that provides HAProxy PROXY protocol support.
      • htb - Hierarchical Token Bucket traffic shaping.
      • ident - Ident protocol implementation.
      • loopback - Testing support for protocols -- loopback between client and server.
      • memcache - Memcache client protocol. Memcached is a caching server, storing data in the form of pairs key/value, and memcache is the protocol to talk with it.
      • pcp - Producer-Consumer Proxy.
      • policies - Resource limiting policies.
      • portforward - A simple port forwarder.
      • postfix - Postfix mail transport agent related protocols.
      • shoutcast - Chop up shoutcast stream into MP3s and metadata, if available.
      • sip - Session Initialization Protocol.
      • socks - Implementation of the SOCKSv4 protocol.
      • stateful - No module docstring; 1/1 class documented
      • test - Unit tests for twisted.protocols.
        • test_basic - Test cases for twisted.protocols.basic.
        • test_tls - Tests for twisted.protocols.tls.
      • tls - Implementation of a TLS transport (ISSLTransport) as an IProtocol layered on top of any ITransport implementation, based on OpenSSL's memory BIO features.
      • wire - Implement standard (and unused) TCP protocols.
    • python - Twisted Python: Utilities and Enhancements for Python.
      • compat - Compatibility module to provide backwards compatibility for useful Python features.
      • components - Component architecture for Twisted, based on Zope3 components.
      • context - Dynamic pseudo-scoping for Python.
      • deprecate - Deprecation framework for Twisted.
      • failure - Asynchronous-friendly error mechanism.
      • fakepwd - twisted.python.fakepwd provides a fake implementation of the pwd API.
      • filepath - Object-oriented filesystem path representation.
      • formmethod - Form-based method objects.
      • htmlizer - HTML rendering of Python source.
      • lockfile - Filesystem-based interprocess mutex.
      • log - Logging and metrics infrastructure.
      • logfile - A rotating, browsable log file.
      • modules - This module aims to provide a unified, object-oriented view of Python's runtime hierarchy.
      • monkey - No module docstring; 1/1 class documented
      • procutils - Utilities for dealing with processes.
      • randbytes - Cryptographically secure random implementation, with fallback on normal random.
      • rebuild - *Real* reloading support for Python.
      • reflect - Standardized versions of various cool and/or strange things that you can do with Python's reflection capabilities.
      • release - A release-automation toolkit.
      • roots - Twisted Python Roots: an abstract hierarchy representation for Twisted.
      • runtime - No module docstring; 0/3 variable, 1/1 function, 1/1 class documented
      • sendmsg - sendmsg(2) and recvmsg(2) support for Python.
      • shortcut - Creation of Windows shortcuts.
      • syslog - Classes and utility functions for integrating Twisted and syslog.
      • systemd - Integration with systemd.
      • test - Unit tests for twisted.python.
        • deprecatedattributes - A module that is deprecated, used by twisted.python.test.test_deprecate for testing purposes.
        • modules_helpers - Facilities for helping test code which interacts with Python's module system to load code.
        • pullpipe - No module docstring; 1/1 function documented
        • strategies - Hypothesis strategies for values related to twisted.python.
        • test_appdirs - Tests for the data directory support.
        • test_components - Test cases for Twisted component architecture.
        • test_deprecate - Tests for Twisted's deprecation framework, twisted.python.deprecate.
        • test_fakepwd - Tests for twisted.python.fakepwd.
        • test_htmlizer - Tests for twisted.python.htmlizer.
        • test_inotify - Tests for twisted.python._inotify.
        • test_release - Tests for twisted.python.release and twisted.python._release.
        • test_runtime - Tests for twisted.python.runtime.
        • test_sendmsg - Tests for twisted.python.sendmsg.
        • test_shellcomp - Test cases for twisted.python._shellcomp
        • test_syslog - No module docstring; 1/1 class documented
        • test_systemd - Tests for twisted.python.systemd.
        • test_textattributes - Tests for twisted.python.textattributes.
        • test_tzhelper - Tests for twisted.python._tzhelper.
        • test_url - Tests for twisted.python.url.
        • test_urlpath - Tests for twisted.python.urlpath.
        • test_util - Tests for twisted.python.util.
        • test_win32 - Tests for twisted.python.win32.
        • test_zippath - Test cases covering twisted.python.zippath.
        • test_zipstream - Tests for twisted.python.zipstream
      • text - Miscellany of text-munging functions.
      • threadable - A module to provide some very basic threading primitives, such as synchronization.
      • threadpool - twisted.python.threadpool: a pool of threads to which we dispatch tasks.
      • url - URL parsing, construction and rendering.
      • urlpath - URLPath, a representation of a URL.
      • usage - twisted.python.usage is a module for parsing/handling the command line of your program.
      • util - No module docstring; 0/1 type variable, 18/22 functions, 5/6 classes documented
      • versions - Versions for Python packages.
      • win32 - Win32 utilities.
      • zippath - This module contains implementations of IFilePath for zip files.
      • zipstream - An incremental approach to unzipping files. This allows you to unzip a little bit of a file at a time, which means you can report progress as a file unzips.
      • _appdirs - Application data directory support.
      • _inotify - Very low-level ctypes-based interface to Linux inotify(7).
      • _release - Twisted's automated release system.
      • _shellcomp - No public APIs are provided by this module. Internal use only.
      • _textattributes - This module provides some common functionality for the manipulation of formatting states.
      • _tzhelper - Time zone utilities.
      • _url - URL parsing, construction and rendering.
    • runner - Twisted Runner: Run and monitor processes.
      • inetd - Twisted inetd.
      • inetdconf - Parser for inetd.conf files
      • inetdtap - Twisted inetd TAP support
      • procmon - Support for starting, monitoring, and restarting child process.
      • procmontap - Support for creating a service which runs a process monitor.
      • test - Test package for Twisted Runner.
        • test_inetdconf - Tests for implementations of inetdconf.
        • test_procmon - Tests for twisted.runner.procmon.
        • test_procmontap - Tests for twisted.runner.procmontap.
    • scripts - Subpackage containing the modules that implement the command line tools.
      • htmlizer - HTML pretty-printing for Python source code.
      • test - Test package for twisted.scripts.
        • test_scripts - Tests for the command-line scripts in the top-level bin/ directory.
      • trial - No module docstring; 0/1 variable, 0/1 constant, 8/14 functions, 1/1 exception, 2/2 classes documented
      • twistd - The Twisted Daemon: platform-independent interface.
      • _twistd_unix - No module docstring; 0/3 function, 2/3 classes documented
      • _twistw - No module docstring; 1/2 class documented
    • spread - Twisted Spread: Spreadable (Distributed) Computing.
      • banana - Banana -- s-exp based protocol.
      • flavors - This module represents flavors of remotely accessible objects.
      • interfaces - Twisted Spread Interfaces.
      • jelly - S-expression-based persistence of python objects.
      • pb - Perspective Broker
      • publish - Persistently cached objects for PB.
      • test - Tests for twisted.spread.
        • test_banana - No module docstring; 0/1 variable, 2/2 functions, 4/5 classes documented
        • test_jelly - Test cases for jelly object serialization.
        • test_pb - Tests for Perspective Broker module.
        • test_pbfailure - Tests for error handling in PB.
      • util - Utility classes for spread.
    • tap - Twisted TAP: Twisted Application Persistence builders for other Twisted servers.
      • ftp - I am the support module for making a ftp server with twistd.
      • portforward - Support module for making a port forwarder with twistd.
      • socks - I am a support module for making SOCKSv4 servers with twistd.
    • test - Twisted's unit tests.
      • crash_test_dummy, iosim, mock_win32process, myrebuilder1, myrebuilder2, plugin_basic, plugin_extra1, plugin_extra2, process_cmdline, process_echoer, process_fds, process_getargv, process_getenv, process_linger, process_reader, process_signal, process_stdinreader, process_tester, process_tty, process_twisted, proto_helpers, reflect_helper_IE, reflect_helper_VE, reflect_helper_ZDE, ssl_helpers, stdio_test_consumer, stdio_test_halfclose, stdio_test_halfclose_buggy, stdio_test_halfclose_buggy_write, stdio_test_hostpeer, stdio_test_lastwrite, stdio_test_loseconn, stdio_test_producer, stdio_test_write, stdio_test_writeseq, test_abstract, test_adbapi, test_amp, test_application, test_compat, test_context, test_cooperator, test_defer, test_defgen, test_dirdbm, test_error, test_factories, test_failure, test_fdesc, test_finger, test_formmethod, test_ftp, test_ftp_options, test_htb, test_ident, test_internet, test_iosim, test_iutils, test_lockfile, test_log, test_logfile, test_loopback, test_main, test_memcache, test_modules, test_monkey, test_paths, test_pcp, test_persisted, test_plugin, test_policies, test_postfix, test_process, test_protocols, test_randbytes, test_rebuild, test_reflect, test_roots, test_shortcut, test_sip, test_sob, test_socks, test_ssl, test_sslverify, test_stateful, test_stdio, test_strerror, test_strports, test_task, test_tcp, test_tcp_internals, test_text, test_threadable, test_threadpool, test_threads, test_tpfile, test_twistd, test_twisted, test_udp, test_unix, test_usage, testutils
    • trial - Twisted Trial: Asynchronous unit testing framework.
      • itrial - Interfaces for Trial.
      • reporter - Defines classes that handle the results of tests.
      • runner - A miscellany of code used to run Trial tests.
      • test - Unit tests for the Trial unit-testing framework.
        • detests - Tests for Deferred handling by twisted.trial.unittest.TestCase.
        • erroneous - Definitions of test cases with various interesting error-related behaviors, to be used by test modules to exercise different features of trial's test runner.
        • matchers - Hamcrest matchers useful throughout the test suite.
        • mockcustomsuite - Mock test module that contains a test_suite method. runner.TestLoader should load the tests from the test_suite, not from the Foo TestCase.
        • mockcustomsuite2 - Mock test module that contains a testSuite method. runner.TestLoader should load the tests from the testSuite, not from the Foo TestCase.
        • mockcustomsuite3 - Mock test module that contains both a test_suite and a testSuite method. runner.TestLoader should load the tests from the testSuite, not from the Foo TestCase nor from the test_suite method.
        • mockdoctest - No module docstring; 1/1 class documented
        • moduleself - Undocumented
        • moduletest - Undocumented
        • novars - Undocumented
        • ordertests - Tests for handling of trial's --order option.
        • packages - Classes and functions used by twisted.trial.test.test_util and twisted.trial.test.test_loader.
        • pyunitcases - Sample test cases defined using the standard library unittest.TestCase class which are used as data by test cases which are actually part of the trial test suite to verify handling of handling of such cases.
        • sample - This module is used by test_loader to test the Trial test loading functionality. Do NOT change the number of tests in this module. Do NOT change the names the tests in this module.
        • scripttest - Undocumented
        • skipping - Definitions of test cases with various interesting behaviors, to be used by twisted.trial.test.test_tests and other test modules to exercise different features of trial's test runner.
        • suppression - Test cases used to make sure that warning suppression works at the module, method, and class levels.
        • test_assertions - Tests for assertions provided by SynchronousTestCase and TestCase, provided by twisted.trial.unittest.
        • test_asyncassertions - Tests for async assertions provided by twisted.trial.unittest.TestCase.
        • test_deferred - Tests for returning Deferreds from a TestCase.
        • test_doctest - Test Twisted's doctest support.
        • test_keyboard - Tests for interrupting tests with Control-C.
        • test_loader - Tests for loading tests by name.
        • test_log - Test the interaction between trial and errors logged during test run.
        • test_matchers - Tests for twisted.trial.test.matchers.
        • test_output - Tests for the output generated by trial.
        • test_plugins - Tests for twisted.plugins.twisted_trial.
        • test_pyunitcompat - No module docstring; 1/2 class documented
        • test_reporter - Tests for twisted.trial.reporter.
        • test_runner - No module docstring; 18/24 classes documented
        • test_script - No module docstring; 0/2 variable, 4/4 functions, 12/13 classes documented
        • test_skip - Tests for twisted.trial.util
        • test_suppression - Tests for warning suppression features of Trial.
        • test_testcase - Direct unit tests for twisted.trial.unittest.SynchronousTestCase and twisted.trial.unittest.TestCase.
        • test_tests - Tests for the behaviour of unit tests.
        • test_util - Tests for twisted.trial.util
        • test_warning - Tests for Trial's interaction with the Python warning system.
        • weird - No module docstring; 1/1 class documented
      • unittest - Things likely to be used by writers of unit tests.
      • util - A collection of utility functions and classes, used internally by Trial.
      • __main__ - Undocumented
      • _asyncrunner - Infrastructure for test running and suites.
      • _asynctest - Things likely to be used by writers of unit tests.
      • _dist - This package implements the distributed Trial test runner:
        • distreporter - The reporter is not made to support concurrent test running, so we will hold test results in here and only send them to the reporter once the test is over.
        • disttrial - This module contains the trial distributed runner, the management class responsible for coordinating all of trial's behavior at the highest level.
        • functional - General functional-style helpers for disttrial.
        • managercommands - Commands for reporting test success of failure to the manager.
        • options - Options handling specific to trial's workers.
        • stream - Buffer byte streams.
        • test - Distributed trial test runner tests.
          • matchers - Hamcrest matchers useful throughout the test suite.
          • test_distreporter - Tests for twisted.trial._dist.distreporter.
          • test_disttrial - Tests for twisted.trial._dist.disttrial.
          • test_matchers - Tests for twisted.trial._dist.test.matchers.
          • test_options - Tests for distributed trial's options management.
          • test_stream - Tests for twisted.trial._dist.stream.
          • test_worker - Test for distributed trial worker side.
          • test_workerreporter - Tests for twisted.trial._dist.workerreporter.
          • test_workertrial - Tests for twisted.trial._dist.workertrial.
        • worker - This module implements the worker classes.
        • workercommands - Commands for telling a worker to load tests or run tests.
        • workerreporter - Test reporter forwarding test results over trial distributed AMP commands.
        • workertrial - Implementation of AMP worker commands, and main executable entry point for the workers.
      • _synctest - Things likely to be used by writers of unit tests.
    • web - Twisted Web: HTTP clients and servers, plus tools for implementing them.
      • client - HTTP client.
      • demo - I am a simple test resource.
      • distrib - Distributed web servers.
      • domhelpers - A library for performing interesting tasks with DOM objects.
      • error - Exception definitions for twisted.web.
      • guard - Resource traversal integration with twisted.cred to allow for authentication and authorization of HTTP requests.
      • html - I hold HTML generation helpers.
      • http - HyperText Transfer Protocol implementation.
      • http_headers - An API for storing HTTP header names and values.
      • iweb - Interface definitions for twisted.web.
      • microdom - Micro Document Object Model: a partial DOM implementation with SUX.
      • pages - Utility implementations of IResource.
      • proxy - Simplistic HTTP proxy support.
      • resource - Implementation of the lowest-level Resource class.
      • rewrite - No module docstring; 1/2 function, 0/1 class documented
      • script - I contain PythonScript, which is a very simple python script resource.
      • server - This is a web server which integrates with the twisted.internet infrastructure.
      • static - Static resources for twisted.web.
      • sux - *S*mall, *U*ncomplicated *X*ML.
      • tap - Support for creating a service which runs a web server.
      • template - HTML rendering for twisted.web.
      • test - Tests for twisted.web.
        • injectionhelpers - Helpers for URI and method injection tests.
        • requesthelper - Helpers related to HTTP requests, used by tests.
        • test_abnf - Tests for twisted.web._abnf.
        • test_agent - Tests for twisted.web.client.Agent and related new client APIs.
        • test_cgi - Tests for twisted.web.twcgi.
        • test_client - Tests for various parts of twisted.web.
        • test_distrib - Tests for twisted.web.distrib.
        • test_domhelpers - Specific tests for (some of) the methods in twisted.web.domhelpers.
        • test_error - HTTP errors.
        • test_flatten - Tests for the flattening portion of twisted.web.template, implemented in twisted.web._flatten.
        • test_html - No module docstring; 1/1 class documented
        • test_http - Test HTTP support.
        • test_http2 - Test HTTP/2 support.
        • test_http_headers - Tests for twisted.web.http_headers.
        • test_httpauth - Tests for twisted.web._auth.
        • test_newclient - Tests for twisted.web._newclient.
        • test_pages - Test twisted.web.pages
        • test_proxy - Test for twisted.web.proxy.
        • test_resource - Tests for twisted.web.resource.
        • test_script - Tests for twisted.web.script.
        • test_stan - Tests for twisted.web._stan portion of the twisted.web.template implementation.
        • test_static - Tests for twisted.web.static.
        • test_tap - Tests for twisted.web.tap.
        • test_template - Tests for twisted.web.template
        • test_util - Tests for twisted.web.util.
        • test_vhost - Tests for twisted.web.vhost.
        • test_web - Tests for various parts of twisted.web.
        • test_web__responses - The _response module contains constants for all standard HTTP codes, along with a mapping to the corresponding phrases.
        • test_webclient - Tests twisted.web.client helper APIs
        • test_wsgi - Tests for twisted.web.wsgi.
        • test_xml - Some fairly inadequate testcases for Twisted XML support.
        • test_xmlrpc - Tests for XML-RPC support in twisted.web.xmlrpc.
        • _util - General helpers for twisted.web unit tests.
      • twcgi - I hold resource classes and helper classes that deal with CGI scripts.
      • util - An assortment of web server-related utilities.
      • vhost - I am a virtual hosts implementation.
      • wsgi - An implementation of Python Web Server Gateway Interface v1.0.1.
      • xmlrpc - A generic resource for publishing objects via XML-RPC.
      • _abnf - Tools for pedantically processing the HTTP protocol.
      • _auth - HTTP header-based authentication migrated from web2
        • basic - HTTP BASIC authentication.
        • digest - Implementation of RFC2617: HTTP Digest Authentication
        • wrapper - A guard implementation which supports HTTP header-based authentication schemes.
      • _element - No module docstring; 0/2 type variable, 0/1 function, 1/1 class documented
      • _flatten - Context-free flattener/serializer for rendering Python objects, possibly complex or arbitrarily nested, as strings.
      • _http2 - HTTP2 Implementation
      • _newclient - An HTTP 1.1 client.
      • _responses - HTTP response code definitions.
      • _stan - An s-expression-like syntax for expressing xml in pure python.
      • _template_util - twisted.web.util and twisted.web.template merged to avoid cyclic deps
    • words - Twisted Words: Client and server implementations for IRC, XMPP, and other chat services.
      • ewords - Exception definitions for Words
      • im - Instance Messenger, Pan-protocol chat client.
        • baseaccount - No module docstring; 1/1 class documented
        • basechat - Base classes for Instance Messenger clients.
        • basesupport - Instance Messenger base classes for protocol support.
        • interfaces - Pan-protocol chat client.
        • ircsupport - IRC support for Instance Messenger.
        • locals - No module docstring; 0/3 constant, 1/1 exception, 0/2 class documented
        • pbsupport - twisted.words support for Instance Messenger.
      • iwords - No module docstring; 3/5 interfaces documented
      • protocols - Chat protocols.
        • irc - Internet Relay Chat protocol for client and server.
        • jabber - Twisted Jabber: Jabber Protocol Helpers
          • client - No module docstring; 0/2 variable, 0/4 constant, 1/2 function, 7/7 classes documented
          • component - External server-side components.
          • error - XMPP Error support.
          • ijabber - Public Jabber Interfaces.
          • jid - Jabber Identifier support.
          • jstrports - A temporary placeholder for client-capable strports, until we sufficient use cases get identified
          • sasl - XMPP-specific SASL profile.
          • sasl_mechanisms - Protocol agnostic implementations of SASL authentication mechanisms.
          • xmlstream - XMPP XML Streams
          • xmpp_stringprep - No module docstring; 0/4 variable, 0/13 constant, 1/6 class, 2/2 interfaces documented
      • service - A module that needs a better name.
      • tap - Shiny new words service maker
      • test - Words tests
        • test_basechat - Tests for twisted.words.im.basechat.
        • test_basesupport - No module docstring; 2/3 classes documented
        • test_domish - Tests for twisted.words.xish.domish, a DOM-like library for XMPP.
        • test_irc - Tests for twisted.words.protocols.irc.
        • test_irc_service - Tests for IRC portions of twisted.words.service.
        • test_ircsupport - Tests for twisted.words.im.ircsupport.
        • test_jabberclient - Tests for twisted.words.protocols.jabber.client
        • test_jabbercomponent - Tests for twisted.words.protocols.jabber.component
        • test_jabbererror - Tests for twisted.words.protocols.jabber.error.
        • test_jabberjid - Tests for twisted.words.protocols.jabber.jid.
        • test_jabberjstrports - Tests for twisted.words.protocols.jabber.jstrports.
        • test_jabbersasl - No module docstring; 0/1 constant, 4/4 classes documented
        • test_jabbersaslmechanisms - Tests for twisted.words.protocols.jabber.sasl_mechanisms.
        • test_jabberxmlstream - Tests for twisted.words.protocols.jabber.xmlstream.
        • test_jabberxmppstringprep - No module docstring; 2/2 classes documented
        • test_service - Tests for twisted.words.service.
        • test_tap - No module docstring; 1/1 class documented
        • test_xishutil - Test cases for twisted.words.xish.utility
        • test_xmlstream - Tests for twisted.words.xish.xmlstream.
        • test_xmpproutertap - Tests for twisted.words.xmpproutertap.
        • test_xpath - Undocumented
      • xish - Twisted X-ish: XML-ish DOM and XPath-ish engine
        • domish - DOM-like XML processing support.
        • utility - Event Dispatching and Callback utilities.
        • xmlstream - XML Stream processing.
        • xpath - XPath query support.
        • xpathparser - XPath Parser.
      • xmpproutertap - Undocumented
    • __main__ - Undocumented
    • _threads - Twisted integration with operating system threads.
      • test - Tests for twisted._threads.
        • test_convenience - Test cases for convenience functionality in twisted._threads._convenience.
        • test_memory - Tests for twisted._threads._memory.
        • test_team - Tests for twisted._threads._team.
        • test_threadworker - Tests for twisted._threads._threadworker.
      • _convenience - Common functionality used within the implementation of various workers.
      • _ithreads - Interfaces related to threads.
      • _memory - Implementation of an in-memory worker that defers execution.
      • _pool - Top level thread pool interface, used to implement twisted.python.threadpool.
      • _team - Implementation of a Team of workers; a thread-pool that can allocate work to workers.
      • _threadworker - Implementation of an IWorker based on native threads and queues.
    • _version - Provides Twisted version information.
API Documentation for twisted, generated by pydoctor 24.11.1 at 2024-12-17 20:28:29.