cacheable support msgpack.pack cached item

Author: shuwen5

cacheable/README.md

@@ -103,7 +103,7 @@ Least Recently Used Cache.
 ##  cacheable.Cacheable
 
 **syntax**:
-`cacheable.Cacheable(capacity=1024 * 4, timeout=60, is_deepcopy=True, mutex_update=False)`
+`cacheable.Cacheable(capacity=1024 * 4, timeout=60, is_deepcopy=True, is_pack=False, mutex_update=False)`
 
 Create a `LRU` object, all items will be cached in it.
 
@@ -120,6 +120,13 @@ Create a `LRU` object, all items will be cached in it.
 
     -   `False`: return reference of cached item
 
+-   `is_pack`: `cacheable.cache` return a decorator that use `is_pack`
+    to return `msgpack.pack` item.
+
+    -   `True`: return `msgpack.pack` of cached item
+
+    -   `False`: return reference of cached item
+
 -   `mutex_update`: allows only one thread to update the cache item.
      Default is `False`.
 
@@ -187,7 +194,7 @@ so can get value and set value like `dict`
 ##  cacheable.cache
 
 **syntax**:
-`cacheable.cache(name, capacity=1024 * 4, timeout=60, is_deepcopy=True, mutex_update=False)`
+`cacheable.cache(name, capacity=1024 * 4, timeout=60, is_deepcopy=True, is_pack=False, mutex_update=False)`
 
 If not exist, create a `cacheable.Cacheable` and save it, else use exist one.
 

cacheable/cacheable.py

@@ -5,6 +5,7 @@
 import logging
 import threading
 import time
+import msgpack
 
 logger = logging.getLogger(__name__)
 _lock_mutex_update = threading.RLock()
@@ -95,10 +96,11 @@ def _cleanup(self):
 class Cacheable(object):
 
     def __init__(self, capacity=1024 * 4, timeout=60,
-                    is_deepcopy=True, mutex_update=False):
+                    is_deepcopy=True, is_pack=False, mutex_update=False):
 
         self.lru = LRU(capacity, timeout)
         self.is_deepcopy = is_deepcopy
+        self.is_pack = is_pack
         self.mutex_update = mutex_update
 
     def _arg_str(self, args, argkv):
@@ -124,11 +126,18 @@ def func_wrapper(*args, **argkv):
                             val = self.lru[generate_key]
                         except KeyError:
                             val = fun(*args, **argkv)
+                            if self.is_pack:
+                                val = msgpack.packb(val, use_bin_type=True)
                             self.lru[generate_key] = val
                 else:
                     val = fun(*args, **argkv)
+                    if self.is_pack:
+                        val = msgpack.packb(val, use_bin_type=True)
                     self.lru[generate_key] = val
 
+            if self.is_pack:
+                val = msgpack.unpackb(val, raw=False)
+
             if self.is_deepcopy:
                 return copy.deepcopy(val)
             else:
@@ -140,7 +149,8 @@ def func_wrapper(*args, **argkv):
 caches = {}
 
 
-def cache(name, capacity=1024 * 4, timeout=60, is_deepcopy=True, mutex_update=False):
+def cache(name, capacity=1024 * 4, timeout=60,
+        is_deepcopy=True, is_pack=False, mutex_update=False):
 
     c = caches.get(name)
     if c is None:

requirements.txt

@@ -62,3 +62,6 @@ objgraph==3.1.0
 
 # geventwebsocket
 gevent-websocket==0.10.1
+
+# msgpack
+msgpack==0.6.1