Ensure cache regions always have a default key length, fixes bbangert#71

Author: amol-

beaker/cache.py

@@ -34,11 +34,11 @@
     from beaker.cache import cache_regions
     cache_regions.update({
         'short_term':{
-            'expire':'60',
+            'expire':60,
             'type':'memory'
         },
         'long_term':{
-            'expire':'1800',
+            'expire':1800,
             'type':'dbm',
             'data_dir':'/tmp',
         }
@@ -130,7 +130,7 @@ def cache_region(region, *args):
         # configure regions
         cache_regions.update({
             'short_term':{
-                'expire':'60',
+                'expire':60,
                 'type':'memory'
             }
         })
@@ -215,7 +215,7 @@ def region_invalidate(namespace, region, *args):
         # configure regions
         cache_regions.update({
             'short_term':{
-                'expire':'60',
+                'expire':60,
                 'type':'memory'
             }
         })
@@ -256,7 +256,9 @@ def invalidate_search(self, search_term, limit, offset):
         region = cache_regions[region]
 
     cache = Cache._get_cache(namespace, region)
-    _cache_decorator_invalidate(cache, region['key_length'], args)
+    _cache_decorator_invalidate(cache,
+                                region.get('key_length', util.DEFAULT_CACHE_KEY_LENGTH),
+                                args)
 
 
 class Cache(object):
@@ -518,9 +520,10 @@ def load(search_term, limit, offset):
 
         cache = self.get_cache(namespace, **kwargs)
         if hasattr(func, '_arg_region'):
-            key_length = cache_regions[func._arg_region]['key_length']
+            cachereg = cache_regions[func._arg_region]
+            key_length = cachereg.get('key_length', util.DEFAULT_CACHE_KEY_LENGTH)
         else:
-            key_length = kwargs.pop('key_length', 250)
+            key_length = kwargs.pop('key_length', util.DEFAULT_CACHE_KEY_LENGTH)
         _cache_decorator_invalidate(cache, key_length, args)
 
 
@@ -560,9 +563,10 @@ def cached(*args):
                 except UnicodeEncodeError:
                     cache_key = " ".join(map(unicode, deco_args + args))
             if region:
-                key_length = cache_regions[region]['key_length']
+                cachereg = cache_regions[region]
+                key_length = cachereg.get('key_length', util.DEFAULT_CACHE_KEY_LENGTH)
             else:
-                key_length = kwargs.pop('key_length', 250)
+                key_length = kwargs.pop('key_length', util.DEFAULT_CACHE_KEY_LENGTH)
             if len(cache_key) + len(namespace) > int(key_length):
                 if util.py3k:
                     cache_key = cache_key.encode('utf-8')

beaker/util.py

@@ -30,6 +30,7 @@
 from beaker import exceptions
 from threading import local as _tlocal
 
+DEFAULT_CACHE_KEY_LENGTH = 250
 
 __all__ = ["ThreadLocal", "WeakValuedRegistry", "SyncDict", "encoded_path",
            "verify_directory"]
@@ -423,7 +424,7 @@ def parse_cache_config_options(config, include_defaults=True):
                                   type=options.get('type'),
                                   enabled=options['enabled'],
                                   expire=options.get('expire'),
-                                  key_length=options.get('key_length', 250))
+                                  key_length=options.get('key_length', DEFAULT_CACHE_KEY_LENGTH))
             region_prefix = '%s.' % region
             region_len = len(region_prefix)
             for key in options.keys():

tests/test_cachemanager.py

@@ -1,7 +1,7 @@
 import time
 from datetime import datetime
 
-from beaker.cache import CacheManager
+from beaker.cache import CacheManager, cache_regions
 from beaker.util import parse_cache_config_options
 
 defaults = {'cache.data_dir':'./cache', 'cache.type':'dbm', 'cache.expire': 2}
@@ -130,3 +130,34 @@ def test_long_name():
     _cache_obj.invalidate(func, 'loader', name)
     result4 = func(name)
     assert result3 != result4
+
+
+def test_cache_region_has_default_key_length():
+    try:
+        cache = CacheManager(cache_regions={
+            'short_term_without_key_length':{
+                'expire': 60,
+                'type': 'memory'
+            }
+        })
+
+        # Check CacheManager registered the region in global regions
+        assert 'short_term_without_key_length' in cache_regions
+
+        @cache.region('short_term_without_key_length')
+        def load(person):
+            now = datetime.now()
+            return "Hi there %s, its currently %s" % (person, now)
+
+        # Ensure that same person gets same time
+        msg = load('fred')
+        msg2 = load('fred')
+        assert msg == msg2, (msg, msg2)
+
+        # Ensure that different person gets different time
+        msg3 = load('george')
+        assert msg3.split(',')[-1] != msg2.split(',')[-1]
+
+    finally:
+        # throw away region for this test
+        cache_regions.pop('short_term_without_key_length', None)