Skip to main content

Server side HTTP sessions

Project description

Fast WSGI sessions. Zero dependencies. Python 3 ready.

Basic usage:

import obsession

application = obsession.SessionMiddleware(application)

Advanced usage:

# Customize all the options
application = obsession.SessionMiddleware(
    application,
    id_persister=obsession.CookieIdPersistence(cookie_name='mysession',
                                               max_age=86400,
                                               path='/my-site',
                                               domain='mysite.example.org'
                                               secure=True),
    backend=obsession.FileBackend(directory='/tmp/session-store',
                                  prefix='session_')
)

Your application will now have a session object available in environ['ob.session'].

The session object acts like a regular dictionary:

session = environ['ob.session']
session['foo'] = 'bar'
session['bar'] = [1, 2, 3]

The session will be saved automatically whenever you mutate the session object itself - for example by assigning a new key, or reassigning an existing key. However if you change an already stored value then you should call session.save() to ensure your changes are saved.

There are some useful extra properties and methods:

# Persist the session to the backend
session.save()

# What's my session id?
my_session_id = session.id

# Cycle the session id.
# This generates a new session id and invalidates the old one.
session.cycle()

# Load a session with a known id.
# Useful if you need to pass the session through another service that
# does not have access to the cookie.
s = environ['ob.session']
s.load_id('my_session_id')

# Delete the session.
# This removes all data from the backend storage and deletes the client's
# session cookie
session.delete()

0.2 (released 2018-03-12)

  • Added JSON serializer
  • Bugfix: session ids ending in periods are no longer silently dropped
  • Only set a session id cookie when new session are created or when the id has changed, avoiding unnecessary Set-Cookie headers being sent.

0.1

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
obsession-0.2-py2-none-any.whl (7.7 kB) Copy SHA256 hash SHA256 Wheel py2
obsession-0.2.tar.gz (12.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page