From 5ea5368b3a71ab91032ed08b919a4bf740cd676b Mon Sep 17 00:00:00 2001 From: Bob McElrath Date: Fri, 6 Jan 2017 18:23:44 -0500 Subject: [PATCH 1/4] ZMQ example using python3 and asyncio --- contrib/zmq/zmq_sub3.py | 52 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100755 contrib/zmq/zmq_sub3.py diff --git a/contrib/zmq/zmq_sub3.py b/contrib/zmq/zmq_sub3.py new file mode 100755 index 000000000..79cb5b484 --- /dev/null +++ b/contrib/zmq/zmq_sub3.py @@ -0,0 +1,52 @@ +#!/usr/bin/env python3 +# Copyright (c) 2014-2016 The Bitcoin Core developers +# Distributed under the MIT software license, see the accompanying +# file COPYING or http://www.opensource.org/licenses/mit-license.php. + +import array +import binascii +import asyncio, zmq, zmq.asyncio +import struct + +port = 28332 + +zmqContext = zmq.asyncio.Context() + +async def recv_and_process(): + zmqSubSocket = zmqContext.socket(zmq.SUB) + zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "hashblock") + zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "hashtx") + zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "rawblock") + zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "rawtx") + zmqSubSocket.connect("tcp://127.0.0.1:%i" % port) + + poller = zmq.asyncio.Poller() + poller.register(zmqSubSocket, zmq.POLLIN) + while True: + s = await poller.poll() + msg = await s[0][0].recv_multipart() + topic = msg[0] + body = msg[1] + sequence = "Unknown"; + if len(msg[-1]) == 4: + msgSequence = struct.unpack(' Date: Mon, 9 Jan 2017 17:07:13 -0500 Subject: [PATCH 2/4] Rewrite to not use Polling wrapper for asyncio, link to python2.7 example --- contrib/zmq/zmq_sub.py | 80 ++++++++++++++++++++++++++--------------- contrib/zmq/zmq_sub3.py | 52 --------------------------- 2 files changed, 51 insertions(+), 81 deletions(-) delete mode 100755 contrib/zmq/zmq_sub3.py diff --git a/contrib/zmq/zmq_sub.py b/contrib/zmq/zmq_sub.py index 6f57aa47e..e462198bf 100755 --- a/contrib/zmq/zmq_sub.py +++ b/contrib/zmq/zmq_sub.py @@ -1,43 +1,65 @@ -#!/usr/bin/env python2 +#!/usr/bin/env python3 # Copyright (c) 2014-2016 The Bitcoin Core developers # Distributed under the MIT software license, see the accompanying # file COPYING or http://www.opensource.org/licenses/mit-license.php. +# A blocking example using python 2.7 can be obtained from the git history: +# https://github.com/bitcoin/bitcoin/blob/37a7fe9e440b83e2364d5498931253937abe9294/contrib/zmq/zmq_sub.py + +import array import binascii -import zmq +import asyncio, zmq, zmq.asyncio +import signal import struct port = 28332 -zmqContext = zmq.Context() -zmqSubSocket = zmqContext.socket(zmq.SUB) -zmqSubSocket.setsockopt(zmq.SUBSCRIBE, "hashblock") -zmqSubSocket.setsockopt(zmq.SUBSCRIBE, "hashtx") -zmqSubSocket.setsockopt(zmq.SUBSCRIBE, "rawblock") -zmqSubSocket.setsockopt(zmq.SUBSCRIBE, "rawtx") -zmqSubSocket.connect("tcp://127.0.0.1:%i" % port) - -try: - while True: - msg = zmqSubSocket.recv_multipart() - topic = str(msg[0]) +class ZMQHandler(): + def __init__(self): + self.loop = zmq.asyncio.install() + self.zmqContext = zmq.asyncio.Context() + + self.zmqSubSocket = self.zmqContext.socket(zmq.SUB) + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "hashblock") + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "hashtx") + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "rawblock") + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "rawtx") + self.zmqSubSocket.connect("tcp://127.0.0.1:%i" % port) + + async def handle(self) : + msg = await self.zmqSubSocket.recv_multipart() + topic = msg[0] body = msg[1] sequence = "Unknown"; if len(msg[-1]) == 4: msgSequence = struct.unpack(' Date: Tue, 10 Jan 2017 10:54:07 -0500 Subject: [PATCH 3/4] Add python version checks and 3.4 example --- contrib/zmq/zmq_sub.py | 5 +++ contrib/zmq/zmq_sub3.4.py | 71 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100755 contrib/zmq/zmq_sub3.4.py diff --git a/contrib/zmq/zmq_sub.py b/contrib/zmq/zmq_sub.py index e462198bf..4839f401b 100755 --- a/contrib/zmq/zmq_sub.py +++ b/contrib/zmq/zmq_sub.py @@ -11,6 +11,11 @@ import binascii import asyncio, zmq, zmq.asyncio import signal import struct +import sys + +if not (sys.version_info.major >= 3 and sys.version_info.minor >= 5): + print("This example only works with Python 3.5 and greater") + exit(1) port = 28332 diff --git a/contrib/zmq/zmq_sub3.4.py b/contrib/zmq/zmq_sub3.4.py new file mode 100755 index 000000000..bd0c4fb30 --- /dev/null +++ b/contrib/zmq/zmq_sub3.4.py @@ -0,0 +1,71 @@ +#!/usr/bin/env python3 +# Copyright (c) 2014-2016 The Bitcoin Core developers +# Distributed under the MIT software license, see the accompanying +# file COPYING or http://www.opensource.org/licenses/mit-license.php. + +# A blocking example using python 2.7 can be obtained from the git history: +# https://github.com/bitcoin/bitcoin/blob/37a7fe9e440b83e2364d5498931253937abe9294/contrib/zmq/zmq_sub.py + +import array +import binascii +import asyncio, zmq, zmq.asyncio +import signal +import struct +import sys + +if not (sys.version_info.major >= 3 and sys.version_info.minor >= 4): + print("This example only works with Python 3.4 and greater") + exit(1) + +port = 28332 + +class ZMQHandler(): + def __init__(self): + self.loop = zmq.asyncio.install() + self.zmqContext = zmq.asyncio.Context() + + self.zmqSubSocket = self.zmqContext.socket(zmq.SUB) + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "hashblock") + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "hashtx") + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "rawblock") + self.zmqSubSocket.setsockopt_string(zmq.SUBSCRIBE, "rawtx") + self.zmqSubSocket.connect("tcp://127.0.0.1:%i" % port) + + @asyncio.coroutine + def handle(self) : + msg = yield from self.zmqSubSocket.recv_multipart() + topic = msg[0] + body = msg[1] + sequence = "Unknown"; + if len(msg[-1]) == 4: + msgSequence = struct.unpack(' Date: Thu, 19 Jan 2017 17:06:52 -0500 Subject: [PATCH 4/4] Adddress nits, use asyncio signal handling, create_task --- contrib/zmq/zmq_sub.py | 32 +++++++++++++++++++++++--------- contrib/zmq/zmq_sub3.4.py | 36 +++++++++++++++++++++++++++--------- 2 files changed, 50 insertions(+), 18 deletions(-) diff --git a/contrib/zmq/zmq_sub.py b/contrib/zmq/zmq_sub.py index 4839f401b..33a6b4ce6 100755 --- a/contrib/zmq/zmq_sub.py +++ b/contrib/zmq/zmq_sub.py @@ -3,12 +3,29 @@ # Distributed under the MIT software license, see the accompanying # file COPYING or http://www.opensource.org/licenses/mit-license.php. -# A blocking example using python 2.7 can be obtained from the git history: -# https://github.com/bitcoin/bitcoin/blob/37a7fe9e440b83e2364d5498931253937abe9294/contrib/zmq/zmq_sub.py +""" + ZMQ example using python3's asyncio + + Bitcoin should be started with the command line arguments: + bitcoind -testnet -daemon \ + -zmqpubhashblock=tcp://127.0.0.1:28332 \ + -zmqpubrawtx=tcp://127.0.0.1:28332 \ + -zmqpubhashtx=tcp://127.0.0.1:28332 \ + -zmqpubhashblock=tcp://127.0.0.1:28332 + + We use the asyncio library here. `self.handle()` installs itself as a + future at the end of the function. Since it never returns with the event + loop having an empty stack of futures, this creates an infinite loop. An + alternative is to wrap the contents of `handle` inside `while True`. + + A blocking example using python 2.7 can be obtained from the git history: + https://github.com/bitcoin/bitcoin/blob/37a7fe9e440b83e2364d5498931253937abe9294/contrib/zmq/zmq_sub.py +""" -import array import binascii -import asyncio, zmq, zmq.asyncio +import asyncio +import zmq +import zmq.asyncio import signal import struct import sys @@ -55,7 +72,8 @@ class ZMQHandler(): asyncio.ensure_future(self.handle()) def start(self): - asyncio.ensure_future(self.handle()) + self.loop.add_signal_handler(signal.SIGINT, self.stop) + self.loop.create_task(self.handle()) self.loop.run_forever() def stop(self): @@ -63,8 +81,4 @@ class ZMQHandler(): self.zmqContext.destroy() daemon = ZMQHandler() -def signal_handler(num, frame): - daemon.stop() - exit(0) -signal.signal(signal.SIGINT, signal_handler) daemon.start() diff --git a/contrib/zmq/zmq_sub3.4.py b/contrib/zmq/zmq_sub3.4.py index bd0c4fb30..a2ff64b29 100755 --- a/contrib/zmq/zmq_sub3.4.py +++ b/contrib/zmq/zmq_sub3.4.py @@ -3,12 +3,33 @@ # Distributed under the MIT software license, see the accompanying # file COPYING or http://www.opensource.org/licenses/mit-license.php. -# A blocking example using python 2.7 can be obtained from the git history: -# https://github.com/bitcoin/bitcoin/blob/37a7fe9e440b83e2364d5498931253937abe9294/contrib/zmq/zmq_sub.py +""" + ZMQ example using python3's asyncio + + Bitcoin should be started with the command line arguments: + bitcoind -testnet -daemon \ + -zmqpubhashblock=tcp://127.0.0.1:28332 \ + -zmqpubrawtx=tcp://127.0.0.1:28332 \ + -zmqpubhashtx=tcp://127.0.0.1:28332 \ + -zmqpubhashblock=tcp://127.0.0.1:28332 + + We use the asyncio library here. `self.handle()` installs itself as a + future at the end of the function. Since it never returns with the event + loop having an empty stack of futures, this creates an infinite loop. An + alternative is to wrap the contents of `handle` inside `while True`. + + The `@asyncio.coroutine` decorator and the `yield from` syntax found here + was introduced in python 3.4 and has been deprecated in favor of the `async` + and `await` keywords respectively. + + A blocking example using python 2.7 can be obtained from the git history: + https://github.com/bitcoin/bitcoin/blob/37a7fe9e440b83e2364d5498931253937abe9294/contrib/zmq/zmq_sub.py +""" -import array import binascii -import asyncio, zmq, zmq.asyncio +import asyncio +import zmq +import zmq.asyncio import signal import struct import sys @@ -56,7 +77,8 @@ class ZMQHandler(): asyncio.ensure_future(self.handle()) def start(self): - asyncio.ensure_future(self.handle()) + self.loop.add_signal_handler(signal.SIGINT, self.stop) + self.loop.create_task(self.handle()) self.loop.run_forever() def stop(self): @@ -64,8 +86,4 @@ class ZMQHandler(): self.zmqContext.destroy() daemon = ZMQHandler() -def signal_handler(num, frame): - daemon.stop() - exit(0) -signal.signal(signal.SIGINT, signal_handler) daemon.start()