key is now always path and change opt by path dictionary storage
[tiramisu.git] / tiramisu / storage / dictionary / storage.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
21
22 from tiramisu.i18n import _
23
24
25 class Storage(object):
26     __slots__ = tuple()
27     def __init__(self, config_id, is_persistent):
28         if is_persistent:
29             raise ValueError(_('a dictionary cannot be persistent'))
30
31
32 class Cache(object):
33     __slots__ = ('_cache',)
34     key_is_path = False
35
36     def __init__(self):
37         self._cache = {}
38
39     def setcache(self, cache_type, path, val, time):
40         self._cache[path] = (val, time)
41
42     def getcache(self, cache_type, path, exp):
43         value, created = self._cache[path]
44         if exp < created:
45             return True, value
46         return False, None
47
48     def hascache(self, cache_type, path):
49         """ path is in the cache
50
51         :param cache_type: value | property
52         :param path: the path's option
53         """
54         return path in self._cache
55
56     def reset_expired_cache(self, cache_type, exp):
57         keys = self._cache.keys()
58         for key in keys:
59             val, created = self._cache[key]
60             if exp > created:
61                 del(self._cache[key])
62
63     def reset_all_cache(self, cache_type):
64         "empty the cache"
65         self._cache.clear()
66
67     def get_cached(self, cache_type, context):
68         """return all values in a dictionary
69         example: {'path1': ('value1', 'time1'), 'path2': ('value2', 'time2')}
70         """
71         return self._cache