more types!

add annotations on more sugar methods, auth, devices

as well as proper types on most async wrappers

examples/asyncio/coroutines.py

@@ -13,14 +13,14 @@
 ctx = Context.instance()
 
 
-async def ping():
+async def ping() -> None:
     """print dots to indicate idleness"""
     while True:
         await asyncio.sleep(0.5)
         print('.')
 
 
-async def receiver():
+async def receiver() -> None:
     """receive messages with polling"""
     pull = ctx.socket(zmq.PULL)
     pull.connect(url)
@@ -34,7 +34,7 @@ async def receiver():
             print('recvd', msg)
 
 
-async def sender():
+async def sender() -> None:
     """send a message every second"""
     tic = time.time()
     push = ctx.socket(zmq.PUSH)

examples/asyncio/helloworld_pubsub_dealerrouter.py

@@ -12,17 +12,18 @@
 import logging
 import traceback
 
+import zmq
 import zmq.asyncio
 from zmq.asyncio import Context
 
 
 # set message based on language
 class HelloWorld:
-    def __init__(self):
+    def __init__(self) -> None:
         self.lang = 'eng'
         self.msg = "Hello World"
 
-    def change_language(self):
+    def change_language(self) -> None:
         if self.lang == 'eng':
             self.lang = 'jap'
             self.msg = "Hello Sekai"
@@ -31,21 +32,21 @@ def change_language(self):
             self.lang = 'eng'
             self.msg = "Hello World"
 
-    def msg_pub(self):
+    def msg_pub(self) -> str:
         return self.msg
 
 
 # receives "Hello World" from topic 'world'
 # changes "World" to "Sekai" and returns message 'sekai'
 class HelloWorldPrinter:
     # process received message
-    def msg_sub(self, msg):
+    def msg_sub(self, msg: str) -> None:
         print(f"message received world: {msg}")
 
 
 # manages message flow between publishers and subscribers
 class HelloWorldMessage:
-    def __init__(self, url='127.0.0.1', port='5555'):
+    def __init__(self, url: str = '127.0.0.1', port: int = 5555):
         # get ZeroMQ version
         print("Current libzmq version is %s" % zmq.zmq_version())
         print("Current  pyzmq version is %s" % zmq.__version__)
@@ -57,6 +58,8 @@ def __init__(self, url='127.0.0.1', port='5555'):
         # init hello world publisher obj
         self.hello_world = HelloWorld()
 
+    def main(self) -> None:
+
         # activate publishers / subscribers
         asyncio.get_event_loop().run_until_complete(
             asyncio.wait(
@@ -70,7 +73,7 @@ def __init__(self, url='127.0.0.1', port='5555'):
         )
 
     # generates message "Hello World" and publish to topic 'world'
-    async def hello_world_pub(self):
+    async def hello_world_pub(self) -> None:
         pub = self.ctx.socket(zmq.PUB)
         pub.connect(self.url)
 
@@ -106,7 +109,7 @@ async def hello_world_pub(self):
             pass
 
     # processes message topic 'world'; "Hello World" or "Hello Sekai"
-    async def hello_world_sub(self):
+    async def hello_world_sub(self) -> None:
         print("Setting up world sub")
         obj = HelloWorldPrinter()
         # setup subscriber
@@ -120,7 +123,7 @@ async def hello_world_sub(self):
             # keep listening to all published message on topic 'world'
             while True:
                 [topic, msg] = await sub.recv_multipart()
-                print(f"world sub; topic: {topic}\tmessage: {msg}")
+                print(f"world sub; topic: {topic.decode()}\tmessage: {msg.decode()}")
                 # process message
                 obj.msg_sub(msg.decode('utf-8'))
 
@@ -141,7 +144,7 @@ async def hello_world_sub(self):
             pass
 
     # Deal a message to topic 'lang' that language should be changed
-    async def lang_changer_dealer(self):
+    async def lang_changer_dealer(self) -> None:
         # setup dealer
         deal = self.ctx.socket(zmq.DEALER)
         deal.setsockopt(zmq.IDENTITY, b'lang_dealer')
@@ -176,7 +179,7 @@ async def lang_changer_dealer(self):
             pass
 
     # changes Hello xxx message when a command is received from topic 'lang'; keeps listening for commands
-    async def lang_changer_router(self):
+    async def lang_changer_router(self) -> None:
         # setup router
         rout = self.ctx.socket(zmq.ROUTER)
         rout.bind(self.url[:-1] + f"{int(self.url[-1]) + 1}")
@@ -188,7 +191,9 @@ async def lang_changer_router(self):
             # keep listening to all published message on topic 'world'
             while True:
                 [id_dealer, msg] = await rout.recv_multipart()
-                print(f"Command rout; Sender ID: {id_dealer};\tmessage: {msg}")
+                print(
+                    f"Command rout; Sender ID: {id_dealer!r};\tmessage: {msg.decode()}"
+                )
 
                 self.hello_world.change_language()
                 print(
@@ -208,5 +213,10 @@ async def lang_changer_router(self):
             pass
 
 
+def main() -> None:
+    hello_world = HelloWorldMessage()
+    hello_world.main()
+
+
 if __name__ == '__main__':
-    HelloWorldMessage()
+    main()

examples/asyncio/tornado_asyncio.py

@@ -5,40 +5,32 @@
 import asyncio
 
 from tornado.ioloop import IOLoop
-from tornado.platform.asyncio import AsyncIOMainLoop
 
 import zmq.asyncio
 
-# Tell tornado to use asyncio
-AsyncIOMainLoop().install()
 
-# This must be instantiated after the installing the IOLoop
-queue = asyncio.Queue()  # type: ignore
-ctx = zmq.asyncio.Context()
-
-
-async def pushing():
-    server = ctx.socket(zmq.PUSH)
+async def pushing() -> None:
+    server = zmq.asyncio.Context.instance().socket(zmq.PUSH)
     server.bind('tcp://*:9000')
     while True:
         await server.send(b"Hello")
         await asyncio.sleep(1)
 
 
-async def pulling():
-    client = ctx.socket(zmq.PULL)
+async def pulling() -> None:
+    client = zmq.asyncio.Context.instance().socket(zmq.PULL)
     client.connect('tcp://127.0.0.1:9000')
     while True:
         greeting = await client.recv()
         print(greeting)
 
 
-def zmq_tornado_loop():
+def main() -> None:
     loop = IOLoop.current()
     loop.spawn_callback(pushing)
     loop.spawn_callback(pulling)
     loop.start()
 
 
 if __name__ == '__main__':
-    zmq_tornado_loop()
+    main()

examples/chat/display.py

@@ -17,11 +17,12 @@
 #
 #    You should have received a copy of the Lesser GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+from typing import List
 
 import zmq
 
 
-def main(addrs):
+def main(addrs: List[str]):
 
     context = zmq.Context()
     socket = context.socket(zmq.SUB)

examples/chat/prompt.py

@@ -21,7 +21,7 @@
 import zmq
 
 
-def main(addr, who):
+def main(addr: str, who: str):
 
     ctx = zmq.Context()
     socket = ctx.socket(zmq.PUB)

examples/cython/example.py

@@ -7,7 +7,7 @@
 import zmq
 
 
-def python_sender(url, n):
+def python_sender(url: str, n: int) -> None:
     """Use entirely high-level Python APIs to send messages"""
     ctx = zmq.Context()
     s = ctx.socket(zmq.PUSH)
@@ -23,7 +23,7 @@ def python_sender(url, n):
     s.send(buf)
 
 
-def main():
+def main() -> None:
     import argparse
 
     parser = argparse.ArgumentParser(description="send & recv messages with Cython")

examples/draft/radio-dish.py

@@ -13,13 +13,13 @@
 
 for i in range(10):
     time.sleep(0.1)
-    radio.send(b'%03i' % i, group='numbers')
+    radio.send(f'{i:03}'.encode('ascii'), group='numbers')
     try:
         msg = dish.recv(copy=False)
     except zmq.Again:
         print('missed a message')
         continue
-    print("Received {}:{}".format(msg.group, msg.bytes.decode('utf8')))
+    print(f"Received {msg.group}:{msg.bytes.decode('utf8')}")
 
 dish.close()
 radio.close()

examples/eventloop/asyncweb.py

@@ -20,7 +20,7 @@
 from zmq.eventloop.future import Context as FutureContext
 
 
-def slow_responder():
+def slow_responder() -> None:
     """thread for slowly responding to replies."""
     ctx = zmq.Context()
     socket = ctx.socket(zmq.ROUTER)
@@ -35,14 +35,14 @@ def slow_responder():
         i += 1
 
 
-def dot():
+def dot() -> None:
     """callback for showing that IOLoop is still responsive while we wait"""
     sys.stdout.write('.')
     sys.stdout.flush()
 
 
 class TestHandler(web.RequestHandler):
-    async def get(self):
+    async def get(self) -> None:
         ctx = FutureContext.instance()
         s = ctx.socket(zmq.DEALER)
 
@@ -56,7 +56,7 @@ async def get(self):
         self.write(reply)
 
 
-def main():
+def main() -> None:
     worker = threading.Thread(target=slow_responder)
     worker.daemon = True
     worker.start()

examples/eventloop/echostream.py

@@ -1,19 +1,22 @@
 #!/usr/bin/env python
 """Adapted echo.py to put the send in the event loop using a ZMQStream.
 """
+from typing import List
+
+from tornado import ioloop
 
 import zmq
-from zmq.eventloop import ioloop, zmqstream
+from zmq.eventloop import zmqstream
 
-loop = ioloop.IOLoop.instance()
+loop = ioloop.IOLoop.current()
 
 ctx = zmq.Context()
 s = ctx.socket(zmq.ROUTER)
 s.bind('tcp://127.0.0.1:5555')
-stream = zmqstream.ZMQStream(s, loop)
+stream = zmqstream.ZMQStream(s)
 
 
-def echo(msg):
+def echo(msg: List[bytes]):
     print(" ".join(map(repr, msg)))
     stream.send_multipart(msg)
 

examples/gevent/poll.py

@@ -34,11 +34,11 @@ def sender():
 while msgcnt < 10:
     socks = dict(poller.poll())
     if receiver1 in socks and socks[receiver1] == zmq.POLLIN:
-        print("Message from receiver1: %s" % receiver1.recv())
+        print(f"Message from receiver1: {receiver1.recv()!r}")
         msgcnt += 1
 
     if receiver2 in socks and socks[receiver2] == zmq.POLLIN:
-        print("Message from receiver2: %s" % receiver2.recv())
+        print(f"Message from receiver2: {receiver2.recv()!r}")
         msgcnt += 1
 
-print("%d messages received" % msgcnt)
+print(f"{msgcnt} messages received")

examples/gevent/simple.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from gevent import spawn, spawn_later
 
 import zmq.green as zmq
@@ -23,7 +25,7 @@
 sock.connect('ipc:///tmp/zmqtest')
 
 
-def get_objs(sock):
+def get_objs(sock: zmq.Socket):
     while True:
         o = sock.recv_pyobj()
         print('received python object:', o)
@@ -32,7 +34,7 @@ def get_objs(sock):
             break
 
 
-def print_every(s, t=None):
+def print_every(s: str, t: Optional[float] = None):
     print(s)
     if t:
         spawn_later(t, print_every, s, t)