sanic-session 0.1.5

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

sanic_session is an extension for sanic that integrates server-backed sessions with a Flask-like 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

• Memcache

• In-Memory (suitable for testing and development environments)

Installation

Install with pip:

pip install sanic_session

Documentation

Documentation is available at PythonHosted.

Example

A simple example uses the in-memory session interface.

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


app = Sanic()
session_interface = InMemorySessionInterface()

@app.middleware('request')
async def add_session_to_request(request):
    # before each request initialize a session
    # using the client's request
    await session_interface.open(request)


@app.middleware('response')
async def save_session(request, response):
    # after each request save the session,
    # pass the response to set client cookies
    await session_interface.save(request, response)

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

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

    return text(request['session']['foo'])

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

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