Redis client for Python asyncio (PEP 3156)
OTHER License
|Build Status|
.. # Don't show the Build status on drone.io. Update script first. It's still # using an older Redis version. # |Build Status2|
Redis client for the PEP 3156
_ Python event loop.
.. _PEP 3156: http://legacy.python.org/dev/peps/pep-3156/
This Redis library is a completely asynchronous, non-blocking client for a Redis server.
It depends on asyncio (PEP 3156) and requires Python 3.6 or greater. If you're new to
asyncio, it can be helpful to check out the asyncio documentation
_ first.
.. _the asyncio documentation: http://docs.python.org/dev/library/asyncio.html
Right now, this library is working fine, but not actively maintained, due to lack of time and shift of priorities on my side (Jonathan). Most of my time doing open source goes to prompt_toolkt community.
I still merge pull request when they are fine, especially for bug/security fixes. But for a while now, we don't have new features. If you are already using it, then there's not really a need to worry, asyncio-redis will keep working fine, and we fix bugs, but it's not really evolving.
If anyone is interested to seriously take over development, please let me know.
Also keep in mind that there is a competing library called aioredis
, which
does have a lot of activity.
See issue https://github.com/jonathanslenders/asyncio-redis/issues/134 to discuss.
Trollius support: There is a fork by Ben Jolitz
_ that has the necessary
changes for using this asyncio-redis library with Trollius.
.. _a fork by Ben Jolitz: https://github.com/benjolitz/trollius-redis
.. code::
pip install asyncio_redis
View documentation at read-the-docs
_
.. _read-the-docs: http://asyncio-redis.readthedocs.org/en/latest/
A asyncio_redis.Connection
instance will take care of the connection and
will automatically reconnect, using a new transport when the connection drops.
This connection class also acts as a proxy to a asyncio_redis.RedisProtocol
instance; any Redis command of the protocol can be called directly at the
connection.
.. code:: python
import asyncio
import asyncio_redis
async def example():
# Create Redis connection
connection = await asyncio_redis.Connection.create(host='localhost', port=6379)
# Set a key
await connection.set('my_key', 'my_value')
# When finished, close the connection.
connection.close()
if __name__ == '__main__':
loop = asyncio.get_event_loop()
loop.run_until_complete(example())
Requests will automatically be distributed among all connections in a pool. If a connection is blocking because of --for instance-- a blocking rpop, another connection will be used for new commands.
.. code:: python
import asyncio
import asyncio_redis
async def example():
# Create Redis connection
connection = await asyncio_redis.Pool.create(host='localhost', port=6379, poolsize=10)
# Set a key
await connection.set('my_key', 'my_value')
# When finished, close the connection pool.
connection.close()
.. code:: python
import asyncio
import asyncio_redis
async def example(loop):
# Create Redis connection
connection = await asyncio_redis.Pool.create(host='localhost', port=6379, poolsize=10)
# Create transaction
transaction = await connection.multi()
# Run commands in transaction (they return future objects)
f1 = await transaction.set('key', 'value')
f2 = await transaction.set('another_key', 'another_value')
# Commit transaction
await transaction.exec()
# Retrieve results
result1 = await f1
result2 = await f2
# When finished, close the connection pool.
connection.close()
It's recommended to use a large enough poolsize. A connection will be occupied as long as there's a transaction running in there.
.. code:: python
import asyncio
import asyncio_redis
async def example():
# Create connection
connection = await asyncio_redis.Connection.create(host='localhost', port=6379)
# Create subscriber.
subscriber = await connection.start_subscribe()
# Subscribe to channel.
await subscriber.subscribe([ 'our-channel' ])
# Inside a while loop, wait for incoming events.
while True:
reply = await subscriber.next_published()
print('Received: ', repr(reply.value), 'on channel', reply.channel)
# When finished, close the connection.
connection.close()
.. code:: python
import asyncio
import asyncio_redis
code = \
"""
local value = redis.call('GET', KEYS[1])
value = tonumber(value)
return value * ARGV[1]
"""
async def example():
connection = await asyncio_redis.Connection.create(host='localhost', port=6379)
# Set a key
await connection.set('my_key', '2')
# Register script
multiply = await connection.register_script(code)
# Run script
script_reply = await multiply.run(keys=['my_key'], args=['5'])
result = await script_reply.return_value()
print(result) # prints 2 * 5
# When finished, close the connection.
connection.close()
.. code:: python
import asyncio
import asyncio_redis
async def example():
loop = asyncio.get_event_loop()
# Create Redis connection
transport, protocol = await loop.create_connection(
asyncio_redis.RedisProtocol, 'localhost', 6379)
# Set a key
await protocol.set('my_key', 'my_value')
# Get a key
result = await protocol.get('my_key')
print(result)
# Close transport when finished.
transport.close()
if __name__ == '__main__':
asyncio.get_event_loop().run_until_complete(example())
.. |Build Status| image:: https://travis-ci.org/jonathanslenders/asyncio-redis.png :target: https://travis-ci.org/jonathanslenders/asyncio-redis#
.. |Build Status2| image:: https://drone.io/github.com/jonathanslenders/asyncio-redis/status.png :target: https://drone.io/github.com/jonathanslenders/asyncio-redis/latest