README.md

Reliable queue implementation with Redis backend and python-asyncio client

Requirements:

• python3.5
• aioredis (we only need Redis object with awaitable methods)

Basic usage:

Redis object should be created before Queue init. This way you may use the same connecton to Redis for different purposes in your program.

import asyncio
import aioredis
import aioredisqueue

loop = asyncio.get_event_loop()

async def process_jobs():
    redis = await aioredis.create_reconnecting_redis(...)
    queue = aioredisqueue.Queue(redis)
    await q.put(b'abc')

    task = await q.get()
    print(task.payload)

    await task.ack()


loop.run_until_complete(process_jobs)

Serialization methods:

There are several serialization methods available by default : json, pickle (default), raw. If pyyaml library is installed, yaml can be used as well. If serialization_method is specified when initializing Queue, it is used for all the tasks created in the queue. It can be also overridden for each task in Queue.put().

Custom serialization methods can be registered. To do it one needs to provide two callables, one for decoding the payload from binary representation and one for encoding. A very naive example that works in Python3.6+ (by default we encode and decode JSON strings to and from bytes):

from aioredisqueue.serializers import register

register(
    'my_json',
    json.loads,
    lambda obj: json.dumps(obj, ensure_ascii=False).encode('utf8'),
)

Non-standard features:

All methods are coroutines, even get_nowait. That's because calls to redis are performed during each such call.

What can change soon

API changes

• loop may be deleted from constructor params

New features

• max_items limit support: current version of put method will be renamed into put_nowait.
• get_multi and put_multi methods, allowing getting and putting multiple items from queue with one call
• method for periodical requeueing of not acknowledged tasks
• keeping track of times a task was requeued, dropping too old tasks or tasks with too many retries.