Browse files

Fixed #7398 -- Allow for custom cache-backends to be used.

Based on a patch from Lau Bech Lauritzen and Brenton Simpson.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
malcolmt committed Jul 25, 2008
1 parent 7c0cf54 commit 7c33cc7f5ef4597b55dde561c1752db4d0feaca1
Showing with 33 additions and 7 deletions.
  1. +2 −0 AUTHORS
  2. +8 −5 django/core/cache/
  3. +23 −2 docs/cache.txt
@@ -236,6 +236,7 @@ answer newbie questions, and generally made Django that much better:
Stuart Langridge <>
Paul Lanier <>
Nicola Larosa <>
+ Lau Bech Lauritzen
Rune Rønde Laursen <>
Eugene Lazutkin <>
@@ -341,6 +342,7 @@ answer newbie questions, and generally made Django that much better:
Pete Shinners <>
Leo Shklovskii
+ Brenton Simpson <>
Jozko Skrablin <>
Ben Slavin <>
sloonz <>
@@ -19,8 +19,10 @@
from django.conf import settings
from django.core.cache.backends.base import InvalidCacheBackendError
+# Name for use in settings file --> name of module in "backends" directory.
+# Any backend scheme that is not in this dictionary is treated as a Python
+# import path to a custom backend.
- # name for use in settings file --> name of module in "backends" directory
'memcached': 'memcached',
'locmem': 'locmem',
'file': 'filebased',
@@ -44,8 +46,6 @@ def get_cache(backend_uri):
warnings.warn("'%s' backend is deprecated. Use '%s' instead." %
(scheme, DEPRECATED_BACKENDS[scheme]), DeprecationWarning)
scheme = DEPRECATED_BACKENDS[scheme]
- if scheme not in BACKENDS:
- raise InvalidCacheBackendError, "%r is not a valid cache backend" % scheme
host = rest[2:]
qpos = rest.find('?')
@@ -57,7 +57,10 @@ def get_cache(backend_uri):
if host.endswith('/'):
host = host[:-1]
- cache_class = getattr(__import__('django.core.cache.backends.%s' % BACKENDS[scheme], {}, {}, ['']), 'CacheClass')
- return cache_class(host, params)
+ if scheme in BACKENDS:
+ module = __import__('django.core.cache.backends.%s' % BACKENDS[scheme], {}, {}, [''])
+ else:
+ module = __import__(scheme, {}, {}, [''])
+ return getattr(module, 'CacheClass')(host, params)
cache = get_cache(settings.CACHE_BACKEND)
@@ -6,8 +6,8 @@ A fundamental tradeoff in dynamic Web sites is, well, they're dynamic. Each
time a user requests a page, the Web server makes all sorts of calculations --
from database queries to template rendering to business logic -- to create the
page that your site's visitor sees. This is a lot more expensive, from a
-processing-overhead perspective, than your standard read-a-file-off-the-filesystem
-server arrangement.
+processing-overhead perspective, than your standard
+read-a-file-off-the-filesystem server arrangement.
For most Web applications, this overhead isn't a big deal. Most Web
applications aren't or; they're simply small-
@@ -186,6 +186,27 @@ production environment still will. To activate dummy caching, set
CACHE_BACKEND = 'dummy:///'
+Using a custom cache backend
+**New in Django development version**
+While Django includes support for a number of cache backends out-of-the-box,
+sometimes you will want to use a customised verison or your own backend. To
+use an external cache backend with Django, use a Python import path as the
+scheme portion (the part before the initial colon) of the ``CACHE_BACKEND``
+URI, like so::
+If you're building your own backend, you can use the standard cache backends
+as reference implementations. You'll find the code in the
+``django/core/cache/backends/`` directory of the Django source.
+Note: Without a really compelling reason, like a host that doesn't support the
+them, you should stick to the cache backends included with Django. They've
+been really well-tested and are quite easy to use.

0 comments on commit 7c33cc7

Please sign in to comment.