Package: bunny-storm
AboutRabbitMQ connector library for Python that is fully integrated with theaio-pika framework.IntroductionBunnyStorm is here to simplify working with RabbitMQ while using aio-pika.
This library offers an asynchronous implementation of a RabbitMQ connector which is fully integrated withasyncio.
BunnyStorm provides an all-in-one adapter with the following functionalities:publish - Publish a message.receive - Consume messages from a queue. Can automatically reply to desired routes if the received message
contains a "reply_to" property.rpc - Implement RPC (Remote procedure call) logic using RabbitMQ. Publish a message with a reply_to property, wait for a reply message and return the reply's content.Installationpipinstall-Ubunny_stormExamplesSimple Receiver (print messages from queue)importasynciofrombunny_stormimportAsyncAdapter,RabbitMQConnectionDataRABBIT_URI="amqp://guest:guest@127.0.0.1:5672/"if__name__=="__main__":loop=asyncio.get_event_loop()configuration=dict(publish=dict(exchange="some_ex",exchange_type="direct",routing_key="some_rk",),receive=dict(exchange="some_receive_ex",exchange_type="direct",routing_key="some_rk",queue="some_q",))connection_data=RabbitMQConnectionData(username="guest",password="guest",connection_name="example")adapter=AsyncAdapter(rabbitmq_connection_data=connection_data,configuration=configuration,loop=loop)loop.create_task(adapter.receive(handler=lambdamsg:print(msg.body),queue="some_q"))loop.run_forever()Full Microservices Using RPC patternExample of 2 Microservices implementing a fully scalable application that calculates a number in the Fibonacci series while implementingRabbitMQ Remote procedure call (RPC)pattern, can be found at the examples directory.Class DiagramArchitectureRabbitMQConnectionData-
A simple dataclass which contains all the relevant credentials and parameters necessary for opening a connection
to a RabbitMQ server.AsyncConnection-
A class responsible for the management of a single connection to a RabbitMQ server.
The class connects to a server whose credentials are specified in aRabbitMQConnectionDataobject passed to it.
The main function of this class isget_connectionwhich uses aio-pika to open a robust connection to the server.ChannelConfiguration-
A class which manages a single channel within a given RabbitMQ connection.
This class encapsulates an AsyncConnection object, and exposes functionality to declare exchanges and queues.
This class receives a connection (AsyncConnection from the previous paragraph) and parameters relevant to the creation of the channel.Publisher-
A class which creates and uses aChannelConfigurationobject to publish messages to a given exchange.
Automatically declares the desired exchange with various configurable parameters, such as exchange type.
The main function of this class ispublish, which ensures that the instance's channel is open and that
the relevant exchange has been declared, following which, it publishes a message to the exchange.Consumer-
A class which creates and uses aChannelConfigurationobject to consume messages from a given queue.
Automatically declares the desired queue, and optionally an exchange as well, with various configurable parameters.
The main functionality of this class isconsume, which ensures that the instance's channel is open and that
the relevant queue and exchange have been declared and bound as desired, following which, it consumes messages from
the queue.AsyncAdapter-
A class which exposes all the desired functionality for this framework:publish: Publish a message to a given exchange.receive: Receive messages from a given queue. Messages received which have theirreply_toparameter set will automatically have a response sent to them containing the message handler's result.rpc: Perform an RPC by publishing a message with itsreply_toparameter set to the relevant value.To perform these operations, each adapter instance receives aRabbitMQConnectionDatainstance,
which is used to create aAsyncConnectioninstance. This is in turn used to create thePublisherandConsumerinstances necessary to work with the queues and exchanges specified
in the configurations given to theAsyncAdapterin its constructor.
Each instance of the class also maintains a dictionary of correlation IDs relevant to messages
we are waiting on a response for, namely RPC requests.TodoImplement Prometheus metrics support.Server example - refactor it to render real HTMLNotesThis package is inspired by various implementations that I have encountered over the years.
The current version includes improvements and adjustments designed to improve integration
with technologies and frameworks developed over the last few years:Python 3.9aio-pika 6.8.0RabbitMQ Server 3.8.3 on Ubuntu 18=======
History0.1.0 (2020-04-11)First release on PyPI.