storage no more in setting.py, code is now in storage/__init__.py
[tiramisu.git] / tiramisu / storage / dictionary / cache.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 class Cache(object):
23     __slots__ = ('_cache', 'storage')
24     key_is_path = False
25
26     def __init__(self, storage):
27         self._cache = {}
28         self.storage = storage
29
30     def setcache(self, cache_type, path, val, time):
31         self._cache[path] = (val, time)
32
33     def getcache(self, cache_type, path, exp):
34         value, created = self._cache[path]
35         if exp < created:
36             return True, value
37         return False, None
38
39     def hascache(self, cache_type, path):
40         """ path is in the cache
41
42         :param cache_type: value | property
43         :param path: the path's option
44         """
45         return path in self._cache
46
47     def reset_expired_cache(self, cache_type, exp):
48         for key in tuple(self._cache.keys()):
49             val, created = self._cache[key]
50             if exp > created:
51                 del(self._cache[key])
52
53     def reset_all_cache(self, cache_type):
54         "empty the cache"
55         self._cache.clear()
56
57     def get_cached(self, cache_type, context):
58         """return all values in a dictionary
59         example: {'path1': ('value1', 'time1'), 'path2': ('value2', 'time2')}
60         """
61         return self._cache