https://github.com/aio-libs/aiohttp-session

Web sessions for aiohttp.web
https://github.com/aio-libs/aiohttp-session

aiohttp asyncio

Last synced: 8 months ago
JSON representation

Web sessions for aiohttp.web

• Host: GitHub
• URL: https://github.com/aio-libs/aiohttp-session
• Owner: aio-libs
• License: other
• Created: 2015-01-15T19:03:01.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2025-05-14T00:35:36.000Z (8 months ago)
• Last Synced: 2025-05-15T02:37:03.762Z (8 months ago)
• Topics: aiohttp, asyncio
• Language: Python
• Homepage: http://aiohttp-session.readthedocs.io/
• Size: 962 KB
• Stars: 240
• Watchers: 12
• Forks: 89
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt
  • License: LICENSE

Awesome Lists containing this project

README

          
aiohttp_session

===============

.. image:: https://github.com/aio-libs/aiohttp-session/actions/workflows/ci.yaml/badge.svg?branch=master

    :target: https://github.com/aio-libs/aiohttp-session/actions/workflows/ci.yaml

.. image:: https://codecov.io/github/aio-libs/aiohttp-session/coverage.svg?branch=master

    :target: https://codecov.io/github/aio-libs/aiohttp-session

.. image:: https://readthedocs.org/projects/aiohttp-session/badge/?version=latest

    :target: https://aiohttp-session.readthedocs.io/

.. image:: https://img.shields.io/pypi/v/aiohttp-session.svg

    :target: https://pypi.python.org/pypi/aiohttp-session

The library provides sessions for `aiohttp.web`__.

.. _aiohttp_web: https://aiohttp.readthedocs.io/en/latest/web.html

__ aiohttp_web_

Usage

-----

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:

.. code:: python

    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 as ``SimpleCookieStorage`` but

  encodes it via AES cipher. ``secrect_key`` is a ``bytes`` key for AES

  encryption/decryption, the length should be 32 bytes.

  Requires ``cryptography`` library::

      $ 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_pool`` is a ``redis`` object, created by

  ``await aioredis.from_url(...)`` call.

      $ pip install aiohttp_session[aioredis]

Developing

----------

Install for local development::

    $ make setup

Run linters::

    $ make lint

Run tests::

    $ make test

Third party extensions

----------------------

* `aiohttp_session_mongo

  `_

* `aiohttp_session_dynamodb

  `_

License

-------

``aiohttp_session`` is offered under the Apache 2 license.