This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Opening Pandora's box by making django's request object available in a thread local.

Project Description

django-pandora

This is Pandora’s box. Don’t open it if you cannot live with the consequences.

django-pandora is a utility library for django that lets you easily store values in a thread-local. This makes it possible to introduce global variables that are thread safe and don’t interfere with other requests to the server.

However a global state is a common anti-pattern in software development that you usually want to avoid. But at the end of the day it might be the easiest way to solve some of your problems.

The most common use case for django-pandora might be to store the current request in Pandora’s box to make it available in places of your code that doesn’t get the request passed in as argument.

Installation

  1. pip install django-pandora
  2. Add 'pandora.middleware.RequestMiddleware' to your MIDDLEWARE_CLASSES setting. (optional)

Usage

The pandora.box object implements a dict like interface which you can use to store thread local values. It’s really as simple as using a dictionary:

>>> from pandora import box
>>> box['foo'] = 'Hello world!'
>>> box['foo']
'Hello world!'
>>> 'foo' in box
True
>>> 'bar' in box
False
>>> box['bar']
Traceback (most recent call last):
  ...
KeyError: 'bar'
>>> box.get('bar', None)
None

As mentioned above, you might want to use the box to store the current request object. Pandora ships with a custom middleware for this purpose. Just append 'pandora.middleware.RequestMiddleware' to your MIDDLEWARE_CLASSES setting. You can then access the request with box['request'].

There is also another middleware that stores the current user object in box['user']. To use this, add 'pandora.middleware.UserMiddleware' to your MIDDLEWARE_CLASSES setting, but make sure that it is listed after 'django.contrib.auth.middleware.AuthenticationMiddleware'.

Tips

  • You don’t need to import the box object into your module if you think the name is too generic and might clash with some of your local names. Just use

    >>> import pandora
    >>> pandora.box['request']
    ...
    
  • Even if opening Pandora’s box might not seem too evil at the first glance, please try to avoid it and pass the request object or any other dependency around where possible. Having a global state makes things more difficult for everyone - especially to reliably test your code.

  • Read the Wikipedia article about Pandora’s box.

Changlog

0.1.0

Initial release.

Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-pandora-0.1.0.tar.gz (4.4 kB) Copy SHA256 Checksum SHA256 Source Nov 25, 2010

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting