Update tutorial; fix up code listings.

Author: habnabit

doc/_static/listings/tutorial3-netstring-reversal.py

@@ -0,0 +1,85 @@
+from twisted.internet.defer import Deferred
+from twisted.internet.endpoints import TCP4ServerEndpoint
+from twisted.internet.protocol import Factory
+from twisted.internet.task import react
+
+from parsley import makeProtocol, stack
+
+
+grammar = """
+
+nonzeroDigit = digit:x ?(x != '0')
+digits = <'0' | nonzeroDigit digit*>:i -> int(i)
+
+netstring = digits:length ':' <anything{length}>:string ',' -> string
+
+receiveNetstring = netstring:string -> receiver.netstringReceived(string)
+
+"""
+
+
+class NetstringReversalWrapper(object):
+    def __init__(self, wrapped):
+        self.wrapped = wrapped
+
+    def sendNetstring(self, string):
+        self.wrapped.sendNetstring(string[::-1])
+
+
+class NetstringSender(object):
+    def __init__(self, transport):
+        self.transport = transport
+
+    def sendNetstring(self, string):
+        self.transport.write('%d:%s,' % (len(string), string))
+
+
+class NetstringSplittingWrapper(object):
+    def __init__(self, wrapped):
+        self.wrapped = wrapped
+
+    def netstringReceived(self, string):
+        splitpoint = len(string) // 2
+        self.wrapped.netstringFirstHalfReceived(string[:splitpoint])
+        self.wrapped.netstringSecondHalfReceived(string[splitpoint:])
+
+    def __getattr__(self, attr):
+        return getattr(self.wrapped, attr)
+
+
+class SplitNetstringReceiver(object):
+    currentRule = 'receiveNetstring'
+
+    def __init__(self, sender):
+        self.sender = sender
+
+    def prepareParsing(self):
+        pass
+
+    def finishParsing(self, reason):
+        pass
+
+    def netstringFirstHalfReceived(self, string):
+        self.sender.sendNetstring(string)
+
+    def netstringSecondHalfReceived(self, string):
+        pass
+
+
+NetstringProtocol = makeProtocol(
+    grammar,
+    stack(NetstringReversalWrapper, NetstringSender),
+    stack(NetstringSplittingWrapper, SplitNetstringReceiver))
+
+class NetstringFactory(Factory):
+    protocol = NetstringProtocol
+
+
+def main(reactor):
+    server = TCP4ServerEndpoint(reactor, 1234)
+    d = server.listen(NetstringFactory())
+    d.addCallback(lambda p: Deferred())  # listen forever
+    return d
+
+
+react(main, [])

doc/_static/listings/tutorial3-netstrings.py

@@ -0,0 +1,60 @@
+from twisted.internet.defer import Deferred
+from twisted.internet.endpoints import TCP4ServerEndpoint
+from twisted.internet.protocol import Factory
+from twisted.internet.task import react
+
+from parsley import makeProtocol
+
+
+grammar = """
+
+nonzeroDigit = digit:x ?(x != '0')
+digits = <'0' | nonzeroDigit digit*>:i -> int(i)
+
+netstring = digits:length ':' <anything{length}>:string ',' -> string
+
+receiveNetstring = netstring:string -> receiver.netstringReceived(string)
+
+"""
+
+
+class NetstringSender(object):
+    def __init__(self, transport):
+        self.transport = transport
+
+    def sendNetstring(self, string):
+        self.transport.write('%d:%s,' % (len(string), string))
+
+
+class NetstringReceiver(object):
+    currentRule = 'receiveNetstring'
+
+    def __init__(self, sender):
+        self.sender = sender
+
+    def prepareParsing(self):
+        pass
+
+    def finishParsing(self, reason):
+        pass
+
+    def netstringReceived(self, string):
+        self.sender.sendNetstring(string)
+
+
+NetstringProtocol = makeProtocol(
+    grammar, NetstringSender, NetstringReceiver)
+
+
+class NetstringFactory(Factory):
+    protocol = NetstringProtocol
+
+
+def main(reactor):
+    server = TCP4ServerEndpoint(reactor, 1234)
+    d = server.listen(NetstringFactory())
+    d.addCallback(lambda p: Deferred())  # listen forever
+    return d
+
+
+react(main, [])

doc/_static/listings/tutorial3-netstrings2.py

@@ -0,0 +1,64 @@
+from twisted.internet.defer import Deferred
+from twisted.internet.endpoints import TCP4ServerEndpoint
+from twisted.internet.protocol import Factory
+from twisted.internet.task import react
+
+from parsley import makeProtocol
+
+
+grammar = """
+
+nonzeroDigit = digit:x ?(x != '0')
+digits = <'0' | nonzeroDigit digit*>:i -> int(i)
+netstring :delimiter = digits:length delimiter <anything{length}>:string ',' -> string
+
+colon = digits:length ':' <anything{length}>:string ',' -> receiver.netstringReceived(':', string)
+semicolon = digits:length ';' <anything{length}>:string ',' -> receiver.netstringReceived(';', string)
+
+"""
+
+
+class NetstringSender(object):
+    def __init__(self, transport):
+        self.transport = transport
+
+    def sendNetstring(self, string):
+        print 'received', repr(string)
+
+
+class NetstringReceiver(object):
+    currentRule = 'colon'
+
+    def __init__(self, sender):
+        self.sender = sender
+
+    def prepareParsing(self):
+        pass
+
+    def finishParsing(self, reason):
+        reason.printTraceback()
+
+    def netstringReceived(self, delimiter, string):
+        self.sender.sendNetstring(string)
+        if delimiter == ':':
+            self.currentRule = 'semicolon'
+        else:
+            self.currentRule = 'colon'
+
+
+NetstringProtocol = makeProtocol(
+    grammar, NetstringSender, NetstringReceiver)
+
+
+class NetstringFactory(Factory):
+    protocol = NetstringProtocol
+
+
+def main(reactor):
+    server = TCP4ServerEndpoint(reactor, 1234)
+    d = server.listen(NetstringFactory())
+    d.addCallback(lambda p: Deferred())  # listen forever
+    return d
+
+
+react(main, [])