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 from tiramisu.i18n import _
  21 from tiramisu.error import ConfigError
  22
  23
  24 class Setting(object):
  25     pass
  26
  27
  28 setting = Setting()
  29 _list_sessions = []
  30
  31
  32 def list_sessions():
  33     return _list_sessions
  34
  35
  36 def delete_session(session_id):
  37     raise ConfigError(_('dictionary storage cannot delete session'))
  38
  39
  40 class Storage(object):
  41     __slots__ = ('session_id',)
  42     storage = 'dictionary'
  43
  44     def __init__(self, session_id, persistent):
  45         if session_id in _list_sessions:
  46             raise ValueError(_('session already used'))
  47         if persistent:
  48             raise ValueError(_('a dictionary cannot be persistent'))
  49         self.session_id = session_id
  50         _list_sessions.append(self.session_id)
  51
  52     def __del__(self):
  53         try:
  54             _list_sessions.remove(self.session_id)
  55         except AttributeError:
  56             pass
  57
  58
  59 class Cache(object):
  60     __slots__ = ('_cache', 'storage')
  61     key_is_path = False
  62
  63     def __init__(self, storage):
  64         self._cache = {}
  65         self.storage = storage
  66
  67     def setcache(self, cache_type, path, val, time):
  68         self._cache[path] = (val, time)
  69
  70     def getcache(self, cache_type, path, exp):
  71         value, created = self._cache[path]
  72         if exp < created:
  73             return True, value
  74         return False, None
  75
  76     def hascache(self, cache_type, path):
  77         """ path is in the cache
  78
  79         :param cache_type: value | property
  80         :param path: the path's option
  81         """
  82         return path in self._cache
  83
  84     def reset_expired_cache(self, cache_type, exp):
  85         for key in tuple(self._cache.keys()):
  86             val, created = self._cache[key]
  87             if exp > created:
  88                 del(self._cache[key])
  89
  90     def reset_all_cache(self, cache_type):
  91         "empty the cache"
  92         self._cache.clear()
  93
  94     def get_cached(self, cache_type, context):
  95         """return all values in a dictionary
  96         example: {'path1': ('value1', 'time1'), 'path2': ('value2', 'time2')}
  97         """
  98         return self._cache