"I love Twisted "

2022-05-02 08:16:38

HOME FAQ DOCS DOWNLOAD GitHub LoginPreferences WikiTimelineRoadmapView TicketsSearch wiki:WikiStart Context Navigation Start PageIndexHistory DownloadsGet Started with Pip$virtualenvtry-twisted$ . try-twisted/bin/activate$ pip install twisted[tls]$ twist --helpDownload Direct from PyPI​https://pypi.org/project/Twisted/Optional Dependencies​Install ExtrasCommunitySee the code ​for Twisted (​and more) on GitHubRead ​our blogJoin ​the discussion listCome ​chat with us on IRCReport a ?security issueAsk ​on Stack OverflowFollow us ​on TwitterDonate to TwistedDonations are tax-deductible. Twisted SponsorsParticipate in the Twisted Project Sponsorship Program! For Silver Sidewinder and higher-level sponsors, we will display your logo here on the front page for one year. VM Hosting sponsored by Microsoft AzureGolden Tree SnakeSilver SidewinderWhat is Twisted?Twisted is an event-driven networking engine written in Python and licensed under the open source ​MIT license. It supports CPython 3.6+ and PyPy3.​Twisted 22.4.0 was the last version with Python 3.6 and PyPy3.6 support​Twisted 21.2.0 was the last version with Python 3.5 support​Twisted 20.3.0 was the last version with Python 2.7 and PyPy2 support.Code Examples Echo Server Web Server Publish/Subscribe Mail Client SSH ClientTwisted makes it easy to implement custom network applications. Here's a TCP server that echoes back everything that's written to it:from twisted.internet import protocol, reactor, endpointsclass Echo(protocol.Protocol): def dataReceived(self, data): self.transport.write(data)class EchoFactory(protocol.Factory): def buildProtocol(self, addr): return Echo()endpoints.serverFromString(reactor, "tcp:1234").listen(EchoFactory())reactor.run()Learn more about ​writing servers, ​writing clients and the ​core networking libraries , including support for SSL, UDP, scheduled events, unit testing infrastructure, and much more.Twisted includes an event-driven web server. Here's a sample web application; notice how the resource object persists in memory, rather than being recreated on each request:from twisted.web import server, resourcefrom twisted.internet import reactor, endpointsclass Counter(resource.Resource): isLeaf = True numberRequests = 0 def render_GET(self, request): self.numberRequests += 1 request.setHeader(b"content-type", b"text/plain") content = u"I am request #{}\n".format(self.numberRequests) return content.encode("ascii")endpoints.serverFromString(reactor, "tcp:8080").listen(server.Site(Counter()))reactor.run()Learn more about ​web application development, ​templates and Twisted's ​HTTP client.Here's a simple publish/subscribe server, where clients see all messages posted by other clients:from twisted.internet import reactor, protocol, endpointsfrom twisted.protocols import basicclass PubProtocol(basic.LineReceiver): def __init__(self, factory): self.factory = factory def connectionMade(self): self.factory.clients.add(self) def connectionLost(self, reason): self.factory.clients.remove(self) def lineReceived(self, line): for c in self.factory.clients: source = u" ".format(self.transport.getHost()).encode("ascii") c.sendLine(source + line)class PubFactory(protocol.Factory): def __init__(self): self.clients = set() def buildProtocol(self, addr): return PubProtocol(self)endpoints.serverFromString(reactor, "tcp:1025").listen(PubFactory())reactor.run()You can test this out by opening two terminals and doing telnet localhost 1025 in each, then typing things.Twisted includes a sophisticated IMAP4 client library.import sysfrom twisted.internet import protocol, defer, endpoints, taskfrom twisted.mail import imap4from twisted.python import failureasync def main( reactor, username="alice", password="secret", strport="tls:example.com:993"): endpoint = endpoints.clientFromString(reactor, strport) factory = protocol.Factory.forProtocol(imap4.IMAP4Client) try: client = await endpoint.connect(factory) await client.login(username.encode("utf-8"), password.encode("utf-8")) await client.select("INBOX") info = await client.fetchEnvelope(imap4.MessageSet(1)) print("First message subject:", info[1]["ENVELOPE"][1]) except: print("IMAP4 client interaction failed") print(failure.Failure().getTraceback())task.react(lambda *a, **k: defer.ensureDeferred(main(*a, **k)), sys.argv[1:])Give this a try, supplying your IMAP4 username, app password (​generate one for gmail, ​generate one for fastmail), and ​client endpoint description for your IMAP4 server. You'll see the subject of the first message in your mailbox printed.See the TwistedMail documentation for more information.Twisted includes an SSH client & server, "conch" (i.e.: the Twisted Shell).import sys, osfrom twisted.internet import protocol, defer, endpoints, taskfrom twisted.conch.endpoints import SSHCommandClientEndpointasync def main(reactor, username="alice", sshhost="example.com", portno="22"): envAgent = endpoints.UNIXClientEndpoint(reactor, os.environ["SSH_AUTH_SOCK"]) endpoint = SSHCommandClientEndpoint.newConnection( reactor, "echo 'hello world'", username, sshhost, int(portno), agentEndpoint=envAgent, ) class ShowOutput(protocol.Protocol): received = b"" def dataReceived(self, data): self.received += data def connectionLost(self, reason): finished.callback(self.received) finished = defer.Deferred() factory = protocol.Factory.forProtocol(ShowOutput) await endpoint.connect(factory) print("SSH response:", await finished)task.react(lambda *a, **k: defer.ensureDeferred(main(*a, **k)), sys.argv[1:])You can use this client to run "hello world" on any SSH server that your local SSH agent can authenticate to, if you pass your username, host name, and optionally port number on the command line.More ProtocolsTwisted also supports many common network protocols, including SMTP, POP3, IMAP, SSHv2, and DNS. For more information see our documentation and ​API reference.CommunityGet in touch with the Twisted community through email, ​Stack Overflow or IRC;Learn about the Twisted development process and how to contribute;Read about software using Twisted and their success stories;Find out what Twisted Matrix Laboratories is;Learn about the individuals and organisations that aid Twisted with donations of hardware, software, hosting and other things;Help improve Twisted on Windows!Human beings, please do not send messages to this email address! Last modified 6 days ago Last modified on 04/26/22 14:41:59 Download in other formats: Plain Text Site design credits