Django Session Management with Custom Backend

Snippet

Django Session Management with Custom Backend

Django's session framework is extensible and allows custom storage backends beyond the default database, cache, or file-based options. This implementation demonstrates a Redis-backed session store that provides sub-millisecond read/write operations, automatic expiration via TTL, and atomic save operations with CreateError handling for must_create scenarios. Custom backends are essential for high-traffic applications requiring horizontal scaling.

snippet.py
python
import json
from django.contrib.sessions.backends.base import SessionBase, CreateError
from django.db import transaction
 
class RedisSessionStore(SessionBase):
    engine = 'django.contrib.sessions'
    prefix = 'session:'
    
    def __init__(self, session_key=None):
        super().__init__(session_key)
        self._redis = self._get_redis_client()
    
    def _get_redis_client(self):
        import django.conf as conf
        cfg = conf.settings.SESSION_ENGINE_CONFIG
        import redis
        return redis.Redis(
            host=cfg.get('HOST', 'localhost'),
            port=cfg.get('PORT', 6379),
            db=cfg.get('DB', 0),
            password=cfg.get('PASSWORD', None)
        )
    
    @property
    def key(self):
        return self._get_or_create_session_key()
    
    def _get_redis_key(self, key=None):
        return f"{self.prefix}{key or self._get_or_create_session_key()}"
    
    def load(self):
        data = self._redis.get(self._get_redis_key())
        return json.loads(data) if data else {}
    
    def exists(self, session_key):
        return self._redis.exists(self._get_redis_key(session_key)) > 0
    
    @transaction.atomic
    def save(self, must_create=False):
        key = self._get_or_create_session_key()
        if must_create and self.exists(key):
            raise CreateError
        data = json.dumps(self._session)
        self._redis.setex(self._get_redis_key(key), self.get_expiry_age(), data)
    
    def delete(self, session_key=None):
        self._redis.delete(self._get_redis_key(session_key or self._session_key))

django

Breakdown

class RedisSessionStore(SessionBase):

Custom session store inheriting from Django's SessionBase abstract class

def load(self):

Retrieves session data from Redis, returns empty dict if missing

def exists(self, session_key):

Checks if session key exists in Redis using EXISTS command

@transaction.atomic

Ensures save operation is atomic to prevent partial writes

def save(self, must_create=False):

Persists session to Redis with expiration using SETEX command

self._redis.setex(..., self.get_expiry_age(), data)

SETEX sets value with expiration time in seconds (Redis built-in TTL)

Previous snippet Next snippet

More Expert Python exercises →

From your library

Django Session Management with Custom Backend

Related