aiozmq

asyncio (PEP 3156) support for ZeroMQ.

The difference between aiozmq and vanilla pyzmq (zmq.asyncio) is:

zmq.asyncio works only by replacing the base event loop with a custom one. This approach works but has two disadvantages:

zmq.asyncio.ZMQEventLoop cannot be combined with other loop implementations (most notable is the ultra fast uvloop).
It uses the internal ZMQ Poller which has fast ZMQ Sockets support but isn’t intended to work fast with many (thousands) regular TCP sockets.

In practice it means that zmq.asyncio is not recommended to be used with web servers like aiohttp.

See also https://github.com/zeromq/pyzmq/issues/894

Documentation

See http://aiozmq.readthedocs.org

Simple high-level client-server RPC example:

import asyncio
import aiozmq.rpc


class ServerHandler(aiozmq.rpc.AttrHandler):

    @aiozmq.rpc.method
    def remote_func(self, a:int, b:int) -> int:
        return a + b


async def go():
    server = await aiozmq.rpc.serve_rpc(
        ServerHandler(), bind='tcp://127.0.0.1:5555')
    client = await aiozmq.rpc.connect_rpc(
        connect='tcp://127.0.0.1:5555')

    ret = await client.call.remote_func(1, 2)
    assert 3 == ret

    server.close()
    client.close()

asyncio.run(go())

Low-level request-reply example:

import asyncio
import aiozmq
import zmq

async def go():
    router = await aiozmq.create_zmq_stream(
        zmq.ROUTER,
        bind='tcp://127.0.0.1:*')

    addr = list(router.transport.bindings())[0]
    dealer = await aiozmq.create_zmq_stream(
        zmq.DEALER,
        connect=addr)

    for i in range(10):
        msg = (b'data', b'ask', str(i).encode('utf-8'))
        dealer.write(msg)
        data = await router.read()
        router.write(data)
        answer = await dealer.read()
        print(answer)
    dealer.close()
    router.close()

asyncio.run(go())

Comparison to pyzmq

zmq.asyncio provides an asyncio compatible loop implementation.

But it’s based on zmq.Poller which doesn’t work well with massive non-zmq socket usage.

E.g. if you build a web server for handling at least thousands of parallel web requests (1000-5000) pyzmq’s internal poller will be slow.

aiozmq works with epoll natively, it doesn’t need a custom loop implementation and cooperates pretty well with uvloop for example.

For details see https://github.com/zeromq/pyzmq/issues/894

Requirements

Python 3.6+
pyzmq 13.1+
optional submodule aiozmq.rpc requires msgpack 0.5+

License

aiozmq is offered under the BSD license.

CHANGES

1.0.0 (2022-11-02)

Support Python 3.9, 3.10, and 3.11 (thanks in part to Esben Sonne)
Drop support for Python 3.5
Remove support for using annotations as conversion functions

0.9.0 (2020-01-25)

Support Python 3.7 and 3.8

0.8.0 (2016-12-07)

Respect events_backlog parameter in zmq stream creation #86

0.7.1 (2015-09-20)

Fix monitoring events implementation
Make the library compatible with Python 3.5

0.7.0 (2015-07-31)

Implement monitoring ZMQ events #50
Do deeper lookup for inhereted classes #54
Relax endpont check #56
Implement monitoring events for stream api #52

0.6.1 (2015-05-19)

Dynamically get list of pyzmq socket types

0.6.0 (2015-02-14)

Process asyncio specific exceptions as builtins.
Add repr(exception) to rpc server call logs if any
Add transport.get_write_buffer_limits() method
Add __repr__ to transport
Add zmq_type to tr.get_extra_info()
Add zmq streams

0.5.2 (2014-10-09)

Poll events after sending zmq message for eventless transport

0.5.1 (2014-09-27)

Fix loopless transport implementation.

0.5.0 (2014-08-23)

Support zmq devices in aiozmq.rpc.serve_rpc()
Add loopless 0MQ transport

0.4.1 (2014-07-03)

Add exclude_log_exceptions parameter to rpc servers.

0.4.0 (2014-05-28)

Implement pause_reading/resume_reading methods in ZmqTransport.

0.3.0 (2014-05-17)

Add limited support for Windows.
Fix unstable test execution, change ZmqEventLoop to use global shared zmq.Context by default.
Process cancellation on rpc servers and clients.

0.2.0 (2014-04-18)

msg in msg_received now is a list, not tuple
Allow to send empty msg by trsansport.write()
Add benchmarks
Derive ServiceClosedError from aiozmq.rpc.Error, not Exception
Implement logging from remote calls at server side (log_exceptions parameter).
Optimize byte counting in ZmqTransport.

0.1.3 (2014-04-10)

Function default values are not passed to an annotaion. Add check for libzmq version (should be >= 3.0)

0.1.2 (2014-04-01)

Function default values are not passed to an annotaion.

0.1.1 (2014-03-31)

Rename plural module names to single ones.

0.1.0 (2014-03-30)

Implement ZmqEventLoop with create_zmq_connection method which operates on zmq transport and protocol.
Implement ZmqEventLoopPolicy.
Introduce ZmqTransport and ZmqProtocol.
Implement zmq.rpc with RPC, PUSHPULL and PUBSUB protocols.

Metadata

Release files for aiozmq 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiozmq 1.0.0
File	Size	Uploaded	Provenance
aiozmq-1.0.0.tar.gz	94.3 kB	Nov 3, 2022	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for aiozmq 1.0.0
File	Interpreter	ABI	Platform	Reset
aiozmq-1.0.0-py3-none-any.whl 35.6 kB Nov 3, 2022 Without provenance	Python 3	none	any	Details

Total release size: 129.9 kB

Release files / aiozmq-1.0.0.tar.gz

Download URL	aiozmq-1.0.0.tar.gz
Size	94.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`dac9069d36a47da439fa852ed37caaed3887b5928cb781e06a6a82e43682c6bb`
BLAKE2b-256 checksum How to use checksums	`f61a02537050681c6bf52a815f37e9c9087e031b09b44cd9ac885d87770fe87a`
Upload date	Nov 3, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.4`

Release files / aiozmq-1.0.0-py3-none-any.whl

Download URL	aiozmq-1.0.0-py3-none-any.whl
Size	35.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7e0d89489fcfc65de4157712de8a4ca613eaba3b33af06b471ceffc3e89537e6`
BLAKE2b-256 checksum How to use checksums	`9991f441fa327c4b0dc4e550e0833d8fc685902a48d9f77d0b5a81ec13d405ee`
Upload date	Nov 3, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.4`

Security for aiozmq 1.0.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.