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-1.0.3.tar.gz (34.4 kB view details)

Uploaded Source

Built Distribution

Beaker-1.0.3-py2.5.egg (73.0 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for Beaker-1.0.3.tar.gz
Algorithm Hash digest
SHA256 6df80c412cc2a66c073a90b28f1b2bb67367a57597d4d5f5663a36d9cd3d9742
MD5 9233040099a17b3038f590ef005a8185
BLAKE2b-256 39f2c9a70d883ddd5c312a7eec63fe64742428c037c9c3e39944638fdafba974

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for Beaker-1.0.3-py2.5.egg
Algorithm Hash digest
SHA256 86817555e7d4d6c2a63376155663847f12e03501949f20a340bd69b0089b4f3d
MD5 e5f55a21acc729013623b536a4bb2a5e
BLAKE2b-256 d442929ce44bf28809ef26b6e4c0a99d83fdbfed6171093fb45ce41383958c6b

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