Skip to main content

A Session and Caching library with WSGI Middleware

Project description

About

Beaker is a web session and general caching library that includes WSGI middleware for use in web applications.

As a general caching library, Beaker can handle storing for various times any Python object that can be pickled with optional back-ends on a fine-grained basis.

Beaker was built largely on the code from MyghtyUtils, then refactored and extended with database support.

Beaker includes Cache and Session WSGI middleware to ease integration with WSGI capable frameworks, and is automatically used by Pylons.

Features

  • Fast, robust performance

  • Multiple reader/single writer lock system to avoid duplicate simultaneous cache creation

  • Cache back-ends include dbm, file, memory, memcached, and database (Using SQLAlchemy for multiple-db vendor support)

  • Signed cookie’s to prevent session hijacking/spoofing

  • Cookie-only sessions to remove the need for a db or file backend (ideal for clustered systems)

  • Extensible Container object to support new back-ends

  • Cache’s can be divided into namespaces (to represent templates, objects, etc.) then keyed for different copies

  • Create functions for automatic call-backs to create new cache copies after expiration

  • Fine-grained toggling of back-ends, keys, and expiration per Cache object

Documentation

Documentation can be found on the Official Beaker Docs site.

Examples

Caching

Basic Example:

from beaker.cache import CacheManager
cm = CacheManager(type='dbm', data_dir='./cache')

cache = cm.get_cache('mytemplate')

def somethingslow():
    # slow stuff
    db_lookups()

# Get the value, this will create the cache copy the first time
# and any time it expires (in seconds, so 3600 = one hour)
result = mycache.get_value(day, createfunc=somethingslow, expiretime=3600)

Using WSGI:

from beaker.middleware import CacheMiddleware

def simple_app(environ, start_response):
    cache = environ['beaker.cache'].get_cache('testcache')
    try:
        value = cache.get_value('value')
    except KeyError:
        value = 0
    cache.set_value('value', value+1)
    start_response('200 OK', [('Content-type', 'text/plain')])
    return ['The current value is: %s' % cache.get_value('value')]

app = CacheMiddleware(simple_app, type='dbm', data_dir='./cache')

Sessions

Using WSGI:

from beaker.middleware import SessionMiddleware

def simple_app(environ, start_response):
    session = environ['beaker.session']
    if not session.has_key('value'):
        session['value'] = 0
    session['value'] += 1
    session.save()
    start_response('200 OK', [('Content-type', 'text/plain')])
    return ['The current value is: %d' % session['value']]

wsgi_app = SessionMiddleware(simple_app, type='dbm', data_dir='./cache')

Source

The latest developer version is available in a Mercurial repository.

Project details


Download files

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

Source Distribution

Beaker-0.9.tar.gz (39.3 kB view details)

Uploaded Source

Built Distribution

Beaker-0.9-py2.5.egg (83.7 kB view details)

Uploaded Egg

File details

Details for the file Beaker-0.9.tar.gz.

File metadata

  • Download URL: Beaker-0.9.tar.gz
  • Upload date:
  • Size: 39.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Beaker-0.9.tar.gz
Algorithm Hash digest
SHA256 98f90dd3689e1fd1e69e21ac165ed129232cd3b06edef4b0f9dc11aad4ad140b
MD5 12fee26725ecd73cbf8774eca3edec97
BLAKE2b-256 59ea4d42b63daf79ede9dd6cac61ef665601c38d783fd34808ce0588c3bdfc92

See more details on using hashes here.

File details

Details for the file Beaker-0.9-py2.5.egg.

File metadata

  • Download URL: Beaker-0.9-py2.5.egg
  • Upload date:
  • Size: 83.7 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Beaker-0.9-py2.5.egg
Algorithm Hash digest
SHA256 34ccdaf03f1243c931de603ee3b3af53e21c8c01922085aaf62ac2f9fb63261c
MD5 491176a77ccdd2f79295d432151e1a33
BLAKE2b-256 6f3304be0b71783262ed3a1242d1bcb7de7fefc608b51e19e6a2c9c990b9246a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page