68482e60d98ad8fc7d95f2a7dadc1028e10d1b13
[tiramisu.git] / tiramisu / storage / util.py
1 # -*- coding: utf-8 -*-
2 "default plugin for cache: set it in a simple dictionary"
3 # Copyright (C) 2013 Team tiramisu (see AUTHORS for all contributors)
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18 #
19 # ____________________________________________________________
20 from tiramisu.setting import owners
21
22
23 class SerializeObject(object):
24     def __getstate__(self):
25         ret = {}
26         for key in dir(self):
27             if not key.startswith('__'):
28                 ret[key] = getattr(self, key)
29         return ret
30
31
32 class Cache(object):
33     __slots__ = ('_cache', '_storage')
34     key_is_path = False
35
36     def __init__(self, storage):
37         self._cache = {}
38         self._storage = storage
39
40     def __getstate__(self):
41         slots = set()
42         for subclass in self.__class__.__mro__:
43             if subclass is not object:
44                 slots.update(subclass.__slots__)
45         slots -= frozenset(['__weakref__', '_storage'])
46         states = {}
47         for slot in slots:
48             try:
49                 value = getattr(self, slot)
50                 #value has owners object, need 'str()' it
51                 if slot == '_values':
52                     _value = {}
53                     for key, values in value.items():
54                         vals = list(values)
55                         vals[0] = str(vals[0])
56                         _value[key] = tuple(vals)
57                     states[slot] = _value
58                 else:
59                     states[slot] = value
60             except AttributeError:
61                 pass
62         return states
63
64     def __setstate__(self, states):
65         for key, value in states.items():
66             #value has owners object, need to reconstruct it
67             if key == '_values':
68                 _value = {}
69                 for key_, values_ in value.items():
70                     vals = list(values_)
71                     try:
72                         vals[0] = getattr(owners, vals[0])
73                     except AttributeError:
74                         owners.addowner(vals[0])
75                         vals[0] = getattr(owners, vals[0])
76                     _value[key_] = tuple(vals)
77                 value = _value
78             setattr(self, key, value)
79
80     def setcache(self, path, val, time):
81         self._cache[path] = (val, time)
82
83     def getcache(self, path, exp):
84         value, created = self._cache[path]
85         if created is None or exp <= created:
86             return True, value
87         return False, None
88
89     def hascache(self, path):
90         """ path is in the cache
91
92         :param path: the path's option
93         """
94         return path in self._cache
95
96     def reset_expired_cache(self, exp):
97         for key in tuple(self._cache.keys()):
98             val, created = self._cache[key]
99             if created is not None and exp > created:
100                 del(self._cache[key])
101
102     def reset_all_cache(self):
103         "empty the cache"
104         self._cache.clear()
105
106     def get_cached(self, context):
107         """return all values in a dictionary
108         example: {'path1': ('value1', 'time1'), 'path2': ('value2', 'time2')}
109         """
110         return self._cache