repository·main·Indexed 26 days ago
https://github.com/zeromq/pyzmqPython bindings for the ZeroMQ (ØMQ) messaging library. pyzmq provides a lightweight and fast messaging implementation, including asynchronous support via zmq.asyncio and zmq.eventloop.future, authentication tools in zmq.auth, and device/proxy management in zmq.devices. It supports Python ≥ 3.9 and libzmq ≥ 3.2.2, and allows high-performance extensions by accessing libzmq functions directly via Cython.
PyZMQ supports stable versions of libzmq (≥ 3.2.2 and ≥ 4.0.1). Note that libzmq 3.0 and 3.1 are not supported.
When installing via binary distributions (wheels on PyPI), PyZMQ ships with a stable version of libzmq built with default configuration, including CURVE support provided by libsodium.
The examples/ directory in this repository contains usage patterns for pyzmq, specifically focusing on features that extend beyond standard libzmq bindings. These include:
PyZMQ has the following compatibility requirements:
zmq.auth module provides tools for implementing authentication in ZeroMQ applications. It includes the Authenticator class for managing authentication processes and utility functions for handling certificates.PyZMQ supports Pythonic resource management using with statements.
zmq.Context as a context manager terminates the context upon exit.zmq.Socket as a context manager closes the socket upon exit.socket.connect(url) or socket.bind(url) as a context manager automatically calls socket.disconnect(url) upon exit.import zmq
# Managing Context and Socket
with zmq.Context() as ctx:
with ctx.socket(zmq.PUSH) as s:
s.connect(url)
s.send_multipart([b"message"])
# exiting Socket context closes socket
# exiting Context context terminates context
# Managing connection lifecycle
with socket.connect(url):
s.send_multipart([b"message"])
# exiting connect context calls socket.disconnect(url)setup.py, include the directories provided by zmq.get_includes() in your include_dirs configuration.Since pyzmq 19, you can use Cython to access the underlying libzmq functions and type definitions directly. This allows for high-performance extensions by bypassing some of the Python overhead.
To import the zmq definitions in a Cython file, use:
cimport zmqTo access the underlying wrapped libzmq specifically, use:
from zmq cimport libzmqcimport zmq
# or
from zmq cimport libzmqIf you want to force PyZMQ to be compiled from source (which is often preferable if you already have a specific libzmq installed and configured), use the --no-binary flag. Note that building from the GitHub repository requires a recent version of Cython installed.
pip install --no-binary=pyzmq pyzmqCross-compiling Python extensions requires specific environment configurations. To cross-compile pyzmq, you generally need:
aarch64-linux-gnu-gcc).crossenv are recommended).Best Practice: It is highly recommended to build libzmq and libsodium separately and link them using the ZMQ_PREFIX environment variable. Cross-compiling the bundled versions of these libraries is not guaranteed to work.
zmq.Context objects are thread-safe and can be shared across your entire multithreaded application (e.g., via zmq.Context.instance()). However, Sockets are NOT thread-safe. You should create sockets on a per-thread basis. Sharing sockets across threads without a threading.Lock can lead to uncatchable C-level application crashes.You can tunnel ØMQ socket connections across machines or untrusted networks using the zmq.ssh.tunnel module. This module allows you to connect to a remote ØMQ endpoint by routing the traffic through an SSH server.
By default, PyZMQ uses the system's ssh command via pexpect, but it also supports paramiko, making it compatible with Windows.
An SSH tunnel consists of:
user@server:port).127.0.0.1).Once established, connections to the local ip:local port are transparently forwarded to remote ip:remote port.