Add type annotations to example and check it in CI

Author: bluetech

example/synchronous_client.py

@@ -22,7 +22,7 @@
 RECEIVE_BYTES = 4096
 
 
-def main():
+def main() -> None:
     """Run the client."""
     try:
         host = sys.argv[1]
@@ -37,7 +37,7 @@ def main():
         print("\nReceived SIGINT: shutting down…")
 
 
-def wsproto_demo(host, port):
+def wsproto_demo(host: str, port: int) -> None:
     """
     Demonstrate wsproto:
 
@@ -46,8 +46,6 @@ def wsproto_demo(host, port):
     2) Send a message and display response
     3) Send ping and display pong
     4) Negotiate WebSocket closing handshake
-
-    :param stream: a socket stream
     """
 
     # 0) Open TCP connection
@@ -89,13 +87,13 @@ def wsproto_demo(host, port):
     net_recv(ws, conn)
 
 
-def net_send(out_data, conn):
+def net_send(out_data: bytes, conn: socket.socket) -> None:
     """ Write pending data from websocket to network. """
     print("Sending {} bytes".format(len(out_data)))
     conn.send(out_data)
 
 
-def net_recv(ws, conn):
+def net_recv(ws: WSConnection, conn: socket.socket) -> None:
     """ Read pending data from network into websocket. """
     in_data = conn.recv(RECEIVE_BYTES)
     if not in_data:
@@ -108,7 +106,7 @@ def net_recv(ws, conn):
         ws.receive_data(in_data)
 
 
-def handle_events(ws):
+def handle_events(ws: WSConnection) -> None:
     for event in ws.events():
         if isinstance(event, AcceptConnection):
             print("WebSocket negotiation complete")

example/synchronous_server.py

@@ -22,7 +22,7 @@
 RECEIVE_BYTES = 4096
 
 
-def main():
+def main() -> None:
     """Run the server."""
     try:
         ip = sys.argv[1]
@@ -48,7 +48,7 @@ def main():
         print("Received SIGINT: shutting down…")
 
 
-def handle_connection(stream):
+def handle_connection(stream: socket.socket) -> None:
     """
     Handle a connection.
 
@@ -80,8 +80,8 @@ def handle_connection(stream):
             elif isinstance(event, CloseConnection):
                 # Print log message and break out
                 print(
-                    "Connection closed: code={}/{} reason={}".format(
-                        event.code.value, event.code.name, event.reason
+                    "Connection closed: code={} reason={}".format(
+                        event.code, event.reason
                     )
                 )
                 out_data += ws.send(event.response())

tox.ini

@@ -36,7 +36,7 @@ commands =
 basepython = python3.7
 deps = mypy
 commands =
-    mypy wsproto/ test/
+    mypy wsproto/ test/ example/
 
 [testenv:lint]
 basepython = python3.6