Socket
Socket
Sign inDemoInstall

obsession

Package Overview
Dependencies
0
Maintainers
1
Alerts
File Explorer

Install Socket

Protect your apps from supply chain attacks

Install

obsession

Server-side HTTP sessions

    1.2.1

Maintainers
1

Readme

Obsession
=========

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()

Keywords

FAQs


Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc