django-async-redis 0.1.0

Full featured async Redis cache backend for Django.

Django Async Redis

Introduction

django-async-redis is a full featured Redis cache and session backend for Django.

• Free software: Apache Software License 2.0

• Documentation: https://django-async-redis.readthedocs.io.

Requirements

• Python 3.6+

• Django 3.0+

• aioredis 1.0+

• Redis server 2.8+

User guide

Installation

Install with pip:

$ python -m pip install django-async-redis

Configure as cache backend

To start using django-async-redis, you should change your Django cache settings to something like:

CACHES = {
    "default": {
        "BACKEND": "django_async_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_async_redis.client.DefaultClient",
        }
    }
}

django-async-redis uses the aioredis native URL notation for connection strings, it allows better interoperability and has a connection string in more “standard” way. Some examples:

• redis://[:password]@localhost:6379/0

• rediss://[:password]@localhost:6379/0

• unix://[:password]@/path/to/socket.sock?db=0

Three URL schemes are supported:

• redis://: creates a normal TCP socket connection

• rediss://: creates a SSL wrapped TCP socket connection

• unix:// creates a Unix Domain Socket connection

There are several ways to specify a database number:

• A db querystring option, e.g. redis://localhost?db=0

• If using the redis:// scheme, the path argument of the URL, e.g. redis://localhost/0

In some circumstances the password you should use to connect Redis is not URL-safe, in this case you can escape it or just use the convenience option in OPTIONS dict:

CACHES = {
    "default": {
        "BACKEND": "django_async_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_async_redis.client.DefaultClient",
            "PASSWORD": "mysecret"
        }
    }
}

Take care, that this option does not overwrites the password in the uri, so if you have set the password in the uri, this settings will be ignored.

Notes

Since the majority of this code was ported from django-redis, there was one case that had needed a monkeypatch. In django_async_redis.util, we implement CacheKey which subclasses str which helps us know if a cache key was already created. Since aioredis, checks if the cache key is of type str (and others), I had to monkeypatch that check so that a CacheKey instance could also be accepted.

Credit

• Hey, I’m Andrew. I’m busy in college, but I wanted to help contribute to Django’s async ecosystem.

• Lots of code is taken from django-redis, including the tests. I just needed to port everything to asyncio and aioredis.

• I used cookiecutter-pypackage to generate this project.

• Thank you to Python Discord server’s async topical chat for helping me understand when to use coroutines over sync functions and @Bast and @hmmmm in general because they’re OG.

History

0.1.0 (2020-09-25)

• First release on PyPI.