Wrapper around the aiormq for asyncio and humans
Project description
aio-pika
A wrapper around aiormq for asyncio and humans.
Check out the examples and the tutorial in the documentation.
If you are a newcomer to RabbitMQ, please start with the adopted official RabbitMQ tutorial.
Features
Completely asynchronous API.
Object oriented API.
Transparent auto-reconnects with complete state recovery with connect_robust (e.g. declared queues or exchanges, consuming state and bindings).
Python 3.7+ compatible.
For python 3.5 users, aio-pika is available via aio-pika<7.
Transparent publisher confirms support.
Transactions support.
Complete type-hints coverage.
Installation
pip install aio-pikaUsage example
Simple consumer:
import asyncio
import aio_pika
import aio_pika.abc
async def main(loop):
# Connect with the givien parameters is also valiable.
# aio_pika.connect_robust(host="host", login="login", password="password")
# You can only choose one option to create a connection, url or kw-based params.
connection = await aio_pika.connect_robust(
"amqp://guest:guest@127.0.0.1/", loop=loop
)
async with connection:
queue_name = "test_queue"
# Creating channel
channel: aio_pika.abc.AbstractChannel = await connection.channel()
# Declaring queue
queue: aio_pika.abc.AbstractQueue = await channel.declare_queue(
queue_name,
auto_delete=True
)
async with queue.iterator() as queue_iter:
# Cancel consuming after __aexit__
async for message in queue_iter:
async with message.process():
print(message.body)
if queue.name in message.body.decode():
break
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main(loop))
loop.close()Simple publisher:
import asyncio
import aio_pika
import aio_pika.abc
async def main(loop):
# Explicit type annotation
connection: aio_pika.RobustConnection = await aio_pika.connect_robust(
"amqp://guest:guest@127.0.0.1/", loop=loop
)
routing_key = "test_queue"
channel: aio_pika.abc.AbstractChannel = await connection.channel()
await channel.default_exchange.publish(
aio_pika.Message(
body='Hello {}'.format(routing_key).encode()
),
routing_key=routing_key
)
await connection.close()
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main(loop))
loop.close()Get single message example:
import asyncio
from aio_pika import connect_robust, Message
async def main(loop):
connection = await connect_robust(
"amqp://guest:guest@127.0.0.1/",
loop=loop
)
queue_name = "test_queue"
routing_key = "test_queue"
# Creating channel
channel = await connection.channel()
# Declaring exchange
exchange = await channel.declare_exchange('direct', auto_delete=True)
# Declaring queue
queue = await channel.declare_queue(queue_name, auto_delete=True)
# Binding queue
await queue.bind(exchange, routing_key)
await exchange.publish(
Message(
bytes('Hello', 'utf-8'),
content_type='text/plain',
headers={'foo': 'bar'}
),
routing_key
)
# Receiving message
incoming_message = await queue.get(timeout=5)
# Confirm message
await incoming_message.ack()
await queue.unbind(exchange, routing_key)
await queue.delete()
await connection.close()
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main(loop))There are more examples and the RabbitMQ tutorial in the documentation.
Versioning
This software follows Semantic Versioning
For contributors
Setting up development environment
Clone the project:
git clone https://github.com/mosquito/aio-pika.git
cd aio-pikaCreate a new virtualenv for aio-pika:
python3 -m venv env
source env/bin/activateInstall all requirements for aio-pika:
pip install -e '.[develop]'Running Tests
NOTE: In order to run the tests locally you need to run a RabbitMQ instance with default user/password (guest/guest) and port (5672).
The Makefile provides a command to run an appropriate RabbitMQ Docker image:
make rabbitmqTo test just run:
make testEditing Documentation
To iterate quickly on the documentation live in your browser, try:
nox -s docs -- serveCreating Pull Requests
Please feel free to create pull requests, but you should describe your use cases and add some examples.
Changes should follow a few simple rules:
When your changes break the public API, you must increase the major version.
When your changes are safe for public API (e.g. added an argument with default value)
You have to add test cases (see tests/ folder)
You must add docstrings
Feel free to add yourself to “thank’s to” section
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aio_pika-9.1.4.tar.gz.
File metadata
- Download URL: aio_pika-9.1.4.tar.gz
- Upload date:
- Size: 38.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.10.2 Darwin/22.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fdfd966217e191a601c78b0869dd2d646ef64c11f7a16c88494a17c8b22b001a |
|
| MD5 | c6ba9b30a0eac08b7d2c2d2f8eee77d7 |
|
| BLAKE2b-256 | 9b1037f4e05372f6ceb3c2ce925f32ed2cfe8591fb423c9d22bb0391e0c473be |
File details
Details for the file aio_pika-9.1.4-py3-none-any.whl.
File metadata
- Download URL: aio_pika-9.1.4-py3-none-any.whl
- Upload date:
- Size: 50.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.10.2 Darwin/22.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d51738779c8a16f9f64801b71115c7270f761b7869cc19a429165ad715db9e33 |
|
| MD5 | c2fa4296ad17a5803d249b675b330937 |
|
| BLAKE2b-256 | 4e2bb7a1f9d35e3a48e91c41480a054a7cdf205267d6b5d05a76ec0f932164d6 |
