refactoring, the values are in an OptionValues object
[tiramisu.git] / tiramisu / setting.py
1 # -*- coding: utf-8 -*-
2 "sets the options of the configuration objects Config object itself"
3 # Copyright (C) 2012 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 # The original `Config` design model is unproudly borrowed from
20 # the rough pypy's guys: http://codespeak.net/svn/pypy/dist/pypy/config/
21 # the whole pypy projet is under MIT licence
22 # ____________________________________________________________
23 class _const:
24     """convenient class that emulates a module
25     and builds constants (that is, unique names)"""
26     class ConstError(TypeError): pass
27
28     def __setattr__(self, name, value):
29         if self.__dict__.has_key(name):
30             raise self.ConstError, "Can't rebind group (%s)"%name
31         self.__dict__[name] = value
32
33     def __delattr__(self, name):
34         if self.__dict__.has_key(name):
35             raise self.ConstError, "Can't unbind group (%s)"%name
36         raise NameError, name
37 # ____________________________________________________________
38 class GroupModule(_const):
39     "emulates a module to manage unique group (OptionDescription) names"
40     class GroupType(str):
41         """allowed normal group (OptionDescription) names
42         *normal* means : groups that are not master
43         """
44         pass
45     class DefaultGroupType(GroupType):
46         """groups that are default (typically 'default')"""
47         pass
48
49     class MasterGroupType(GroupType):
50         """allowed normal group (OptionDescription) names
51         *master* means : groups that have the 'master' attribute set
52         """
53         pass
54 # setting.groups (emulates a module)
55 groups = GroupModule()
56
57 def populate_groups():
58     "populates the available groups in the appropriate namespaces"
59     groups.master = groups.MasterGroupType('master')
60     groups.default = groups.DefaultGroupType('default')
61     groups.family = groups.GroupType('family')
62
63 # names are in the module now
64 populate_groups()
65 # ____________________________________________________________
66 class OwnerModule(_const):
67     """emulates a module to manage unique owner names.
68
69     owners are living in `Config._cfgimpl_value_owners`
70     """
71     class Owner(str):
72         """allowed owner names
73         """
74         pass
75     class DefaultOwner(Owner):
76         """groups that are default (typically 'default')"""
77         pass
78 # setting.owners (emulates a module)
79 owners = OwnerModule()
80
81 def populate_owners():
82     """populates the available owners in the appropriate namespaces
83
84     - 'user' is the generic is the generic owner.
85     - 'default' is the config owner after init time
86     """
87     setattr(owners, 'default', owners.DefaultOwner('default'))
88     setattr(owners,'user', owners.Owner('user'))
89     def add_owner(name):
90         """
91         :param name: the name of the new owner
92         """
93         setattr(owners, name, owners.Owner(name))
94     setattr(owners, 'add_owner', add_owner)
95
96 # names are in the module now
97 populate_owners()
98 #____________________________________________________________
99 class Setting():
100     "``Config()``'s configuration options"
101     # properties attribute: the name of a property enables this property
102     properties = ['hidden', 'disabled']
103     # overrides the validations in the acces of the option values
104     permissive = []
105     # a mandatory option must have a value that is not None
106     mandatory = True
107     frozen = True
108     # enables validation function for options if set
109     validator = False
110     # generic owner
111     owner = owners.user
112     # in order to freeze everything, not **only** the frozen options
113     everything_frozen = False
114     #____________________________________________________________
115     # properties methods
116     def has_properties(self):
117         "has properties means the Config's properties attribute is not empty"
118         return bool(len(self.properties))
119
120     def has_property(self, propname):
121         """has property propname in the Config's properties attribute
122         :param property: string wich is the name of the property"""
123         return propname in self.properties
124
125     def enable_property(self, propname):
126         "puts property propname in the Config's properties attribute"
127         if propname not in self.properties:
128             self.properties.append(propname)
129
130     def disable_property(self, propname):
131         "deletes property propname in the Config's properties attribute"
132         if self.has_property(propname):
133             self.properties.remove(propname)
134     #____________________________________________________________
135     def set_permissive(self, permissive):
136         if not isinstance(permissive, list):
137             raise TypeError('permissive must be a list')
138         self.permissive = permissive
139     #____________________________________________________________
140     # complete freeze methods
141     def freeze_everything(self):
142         """everything is frozen, not only the option that are tagged "frozen"
143         """
144         self.everything_frozen = True
145
146     def un_freeze_everything(self):
147         """everything is frozen, not only the option that are tagged "frozen"
148         """
149         self.everything_frozen = False
150
151     def is_frozen_for_everything(self):
152         """frozen for a whole config (not only the options
153         that have been set to frozen)"""
154         return self.everything_frozen
155     #____________________________________________________________
156     def read_only(self):
157         "convenience method to freeze, hidde and disable"
158         self.freeze_everything()
159         self.freeze() # can be usefull...
160         self.disable_property('hidden')
161         self.enable_property('disabled')
162         self.mandatory = True
163         self.validator = True
164
165     def read_write(self):
166         "convenience method to freeze, hidde and disable"
167         self.un_freeze_everything()
168         self.freeze()
169         self.enable_property('hidden')
170         self.enable_property('disabled')
171         self.mandatory = False
172         self.validator = False
173
174     def non_mandatory(self):
175         """mandatory at the Config level means that the Config raises an error
176         if a mandatory option is found"""
177         self.mandatory = False
178
179     def mandatory(self):
180         """mandatory at the Config level means that the Config raises an error
181         if a mandatory option is found"""
182         self.mandatory = True
183
184     def is_mandatory(self):
185         "all mandatory Options shall have a value"
186         return self.mandatory
187
188     def freeze(self):
189         "cannot modify the frozen `Option`'s"
190         self.frozen = True
191
192     def unfreeze(self):
193         "can modify the Options that are frozen"
194         self.frozen = False
195
196     def is_frozen(self):
197         "freeze flag at Config level"
198         return self.frozen
199
200     def setowner(self, owner):
201         ":param owner: sets the default value for owner at the Config level"
202         if not isinstance(owner, owners.Owner):
203             raise TypeError("invalid generic owner {0}".format(str(owner)))
204         self.owner = owner
205
206     def getowner(self):
207         return self.owner