[Python-checkins] bpo-31294: Fix ZeroMQSocketListener and ZeroMQSocketHandler examples (#3229)
Christian Heimes
webhook-mailer at python.org
Thu Sep 7 16:53:15 EDT 2017
https://github.com/python/cpython/commit/586c0502b5eb9a39cabe0bc2707a8ff63114265c
commit: 586c0502b5eb9a39cabe0bc2707a8ff63114265c
branch: master
author: Pablo Galindo <Pablogsal at gmail.com>
committer: Christian Heimes <christian at python.org>
date: 2017-09-07T13:53:13-07:00
summary:
bpo-31294: Fix ZeroMQSocketListener and ZeroMQSocketHandler examples (#3229)
* Fix ZeroMQSocketListener and ZeroMQSocketHandler examples
* Use send_json and recv_json to simplify pyzmq interfacing
* Add News entry
files:
A Misc/NEWS.d/next/Documentation/2017-09-07-20-49-09.bpo-31294.WgI18w.rst
M Doc/howto/logging-cookbook.rst
M Misc/ACKS
diff --git a/Doc/howto/logging-cookbook.rst b/Doc/howto/logging-cookbook.rst
index 24cf76b8ba4..71ee417f2bc 100644
--- a/Doc/howto/logging-cookbook.rst
+++ b/Doc/howto/logging-cookbook.rst
@@ -1258,8 +1258,8 @@ socket is created separately and passed to the handler (as its 'queue')::
class ZeroMQSocketHandler(QueueHandler):
def enqueue(self, record):
- data = json.dumps(record.__dict__)
- self.queue.send(data)
+ self.queue.send_json(record.__dict__)
+
handler = ZeroMQSocketHandler(sock)
@@ -1272,11 +1272,10 @@ data needed by the handler to create the socket::
self.ctx = ctx or zmq.Context()
socket = zmq.Socket(self.ctx, socktype)
socket.bind(uri)
- QueueHandler.__init__(self, socket)
+ super().__init__(socket)
def enqueue(self, record):
- data = json.dumps(record.__dict__)
- self.queue.send(data)
+ self.queue.send_json(record.__dict__)
def close(self):
self.queue.close()
@@ -1292,12 +1291,13 @@ of queues, for example a ZeroMQ 'subscribe' socket. Here's an example::
def __init__(self, uri, *handlers, **kwargs):
self.ctx = kwargs.get('ctx') or zmq.Context()
socket = zmq.Socket(self.ctx, zmq.SUB)
- socket.setsockopt(zmq.SUBSCRIBE, '') # subscribe to everything
+ socket.setsockopt_string(zmq.SUBSCRIBE, '') # subscribe to everything
socket.connect(uri)
+ super().__init__(socket, *handlers, **kwargs)
def dequeue(self):
- msg = self.queue.recv()
- return logging.makeLogRecord(json.loads(msg))
+ msg = self.queue.recv_json()
+ return logging.makeLogRecord(msg)
.. seealso::
diff --git a/Misc/ACKS b/Misc/ACKS
index eadc5d34c40..462a74eb056 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1561,6 +1561,7 @@ Martin Teichmann
Gustavo Temple
Mikhail Terekhov
Victor Terrón
+Pablo Galindo
Richard M. Tew
Tobias Thelen
Christian Theune
diff --git a/Misc/NEWS.d/next/Documentation/2017-09-07-20-49-09.bpo-31294.WgI18w.rst b/Misc/NEWS.d/next/Documentation/2017-09-07-20-49-09.bpo-31294.WgI18w.rst
new file mode 100644
index 00000000000..2c8f8507697
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2017-09-07-20-49-09.bpo-31294.WgI18w.rst
@@ -0,0 +1,2 @@
+Fix incomplete code snippet in the ZeroMQSocketListener and
+ZeroMQSocketHandler examples and adapt them to Python 3.
More information about the Python-checkins
mailing list