ahopkins / sanic-session

Provides server-backed sessions for Sanic using Redis, Memcache and more.

Sanic session management for humans

sanic-session is session management extension for Sanic that integrates server-backed sessions with most convenient API.

sanic-session provides a number of session interfaces for you to store a client's session data. The interfaces available right now are:

• Redis (supports both drivers aioredis and asyncio_redis)
• Memcache (via aiomcache)
• Mongodb (via sanic_motor and pymongo)
• In-Memory (suitable for testing and development environments)

Installation

Install with pip (there is other options for different drivers, check documentation):

pip install sanic_session

Documentation

Documentation is available at sanic-session.readthedocs.io.

Also, make sure you read OWASP's Session Management Cheat Sheet for some really useful info on session management.

Example

A simple example uses the in-memory session interface.

from sanic import Sanic
from sanic.response import text
from sanic_session import Session, InMemorySessionInterface

app = Sanic(name="ExampleApp")
session = Session(app, interface=InMemorySessionInterface())

@app.route("/")
async def index(request):
    # interact with the session like a normal dict
    if not request.ctx.session.get('foo'):
        request.ctx.session['foo'] = 0

    request.ctx.session['foo'] += 1

    return text(str(request.ctx.session["foo"]))

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

Examples of using redis and memcache backed sessions can be found in the documentation, under Using the Interfaces.

— ⭐️ —