tiramisu/tiramisu/storage/util.py

# -*- coding: utf-8 -*-
"utils used by storage"
# Copyright (C) 2013-2018 Team tiramisu (see AUTHORS for all contributors)
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
# ____________________________________________________________
def _display_classname(obj):
    return(obj.__class__.__name__.lower())

DEBUG = False
#DEBUG = True


class Cache(object):
    __slots__ = ('_cache', '_storage')
    key_is_path = False

    def __init__(self, storage):
        self._cache = {}
        self._storage = storage

    def setcache(self, path, val, time, index):
        """add val in cache for a specified path
        if slave, add index
        """
        if DEBUG:
            print('setcache', path, val, _display_classname(self), id(self))
        self._cache.setdefault(path, {})[index] = (val, time)

    def getcache(self, path, exp, index):
        value, created = self._cache[path][index]
        if created is None or exp is None or exp <= created:
            if DEBUG:
                print('getcache in cache', path, value, _display_classname(self), id(self), index, exp)
            return True, value
        if DEBUG:
            print('getcache not in cache')
        return False, None  # pragma: no cover

    def delcache(self, path):
        """remove cache for a specified path
        """
        if DEBUG:
            print('delcache', path, _display_classname(self), id(self))
        if path in  self._cache:
            del self._cache[path]

    def hascache(self, path, index):
        """ path is in the cache

        :param path: the path's option
        """
        if DEBUG:
            print('hascache', path, _display_classname(self), id(self))
        return path in self._cache and index in self._cache[path]

    def reset_expired_cache(self, exp):
        cache_keys = list(self._cache.keys())
        for key in cache_keys:
            key_cache_keys = list(self._cache[key].keys())
            for index in key_cache_keys:
                val, created = self._cache[key][index]
                if created is not None and exp > created:
                    del(self._cache[key][index])
                    if self._cache[key] == {}:
                        del(self._cache[key])

    def reset_all_cache(self):
        "empty the cache"
        if DEBUG:
            print('reset_all_cache', _display_classname(self), id(self))
        self._cache.clear()

    def get_cached(self):
        """return all values in a dictionary
        example: {'path1': {'index1': ('value1', 'time1')}, 'path2': {'index2': ('value2', 'time2', )}}
        """
        return self._cache