The library provides sessions for aiohttp.web.
The library allows us to store user-specific data into a session object.
The session object has a dict-like interface (operations like
session[key] = value, value = session[key] etc. are present).
Before processing the session in a web-handler, you have to register the
session middleware in aiohttp.web.Application.
A trivial usage example:
import time
from cryptography import fernet
from aiohttp import web
from aiohttp_session import setup, get_session
from aiohttp_session.cookie_storage import EncryptedCookieStorage
async def handler(request):
session = await get_session(request)
last_visit = session['last_visit'] if 'last_visit' in session else None
session['last_visit'] = time.time()
text = 'Last visited: {}'.format(last_visit)
return web.Response(text=text)
def make_app():
app = web.Application()
fernet_key = fernet.Fernet.generate_key()
f = fernet.Fernet(fernet_key)
setup(app, EncryptedCookieStorage(f))
app.router.add_get('/', handler)
return app
web.run_app(make_app())All storages use an HTTP Cookie named AIOHTTP_SESSION for storing
data. This can be modified by passing the keyword argument cookie_name to
the storage class of your choice.
Available session storages are:
aiohttp_session.SimpleCookieStorage()-- keeps session data as a plain JSON string in the cookie body. Use the storage only for testing purposes, it's very non-secure.aiohttp_session.cookie_storage.EncryptedCookieStorage(secret_key)-- stores the session data into a cookie asSimpleCookieStoragebut encodes it via AES cipher.secrect_keyis abyteskey for AES encryption/decryption, the length should be 32 bytes.Requires
cryptographylibrary:$ pip install aiohttp_session[secure]
aiohttp_session.redis_storage.RedisStorage(redis_pool)-- stores JSON encoded data in redis, keeping only the redis key (a random UUID) in the cookie.redis_poolis aredisobject, created byawait aioredis.from_url(...)call.$ pip install aiohttp_session[aioredis]
Install for local development:
$ make setup
Run linters:
$ make lint
Run tests:
$ make test
aiohttp_session is offered under the Apache 2 license.