c1bf2eb16a960ff07c3826d40467d98b2ed6a687
[tiramisu.git] / tiramisu / storage / dictionary / value.py
1 # -*- coding: utf-8 -*-
2 "default plugin for value: 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 from tiramisu.storage.dictionary.storage import Cache
22
23
24 class Values(Cache):
25     __slots__ = ('_values', '_informations', '__weakref__')
26
27     def __init__(self, storage):
28         """init plugin means create values storage
29         """
30         self._values = {}
31         self._informations = {}
32         # should init cache too
33         super(Values, self).__init__(storage)
34
35     # value
36     def setvalue(self, path, value, owner):
37         """set value for a path
38         a specified value must be associated to an owner
39         """
40         self._values[path] = (owner, value)
41
42     def getvalue(self, path):
43         """get value for a path
44         return: only value, not the owner
45         """
46         return self._values[path][1]
47
48     def hasvalue(self, path):
49         """if path has a value
50         return: boolean
51         """
52         return path in self._values
53
54     def resetvalue(self, path):
55         """remove value means delete value in storage
56         """
57         del(self._values[path])
58
59     def get_modified_values(self):
60         """return all values in a dictionary
61         example: {'path1': (owner, 'value1'), 'path2': (owner, 'value2')}
62         """
63         return self._values
64
65     # owner
66     def setowner(self, path, owner):
67         """change owner for a path
68         """
69         self._values[path] = (owner, self._values[path][1])
70
71     def getowner(self, path, default):
72         """get owner for a path
73         return: owner object
74         """
75         return self._values.get(path, (default, None))[0]
76
77     def set_information(self, key, value):
78         """updates the information's attribute
79         (which is a dictionary)
80
81         :param key: information's key (ex: "help", "doc"
82         :param value: information's value (ex: "the help string")
83         """
84         self._informations[key] = value
85
86     def get_information(self, key):
87         """retrieves one information's item
88
89         :param key: the item string (ex: "help")
90         """
91         if key in self._informations:
92             return self._informations[key]
93         else:
94             raise ValueError("not found")