adds a freeze_everything possibility
[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     _available_group_names = ('default', 'family', 'group')
60     _available_groups_with_a_master = ('group', )
61     _available_default_groups = ('default', )
62     # populates normal or master groups
63     for grp in _available_group_names:
64         if grp in _available_groups_with_a_master:
65             setattr(groups, grp, groups.MasterGroupType(grp))
66         elif grp in _available_default_groups:
67             setattr(groups, grp, groups.DefaultGroupType(grp))
68         else:
69             setattr(groups, grp, groups.GroupType(grp))
70 # names are in the module now
71 populate_groups()
72 # ____________________________________________________________
73 class OwnerModule(_const):
74     """emulates a module to manage unique owner names.
75
76     owners are living in `Config._cfgimpl_value_owners`
77     """
78     class Owner(str):
79         """allowed owner names
80         """
81         pass
82     class DefaultOwner(Owner):
83         """groups that are default (typically 'default')"""
84         pass
85 # setting.owners (emulates a module)
86 owners = OwnerModule()
87
88 def populate_owners():
89     """populates the available owners in the appropriate namespaces
90
91     - 'user' is the generic is the generic owner.
92     - 'default' is the config owner after init time
93     """
94     setattr(owners, 'default', owners.DefaultOwner('default'))
95     setattr(owners,'user', owners.Owner('user'))
96     def add_owner(name):
97         """
98         :param name: the name of the new owner
99         """
100         setattr(owners, name, owners.Owner(name))
101     setattr(owners, 'add_owner', add_owner)
102
103 # names are in the module now
104 populate_owners()
105 #____________________________________________________________
106 class Setting():
107     "``Config()``'s configuration options"
108     # properties attribute: the name of a property enables this property
109     properties = ['hidden', 'disabled']
110     # overrides the validations in the acces of the option values
111     permissive = []
112     # a mandatory option must have a value that is not None
113     mandatory = True
114     frozen = True
115     # enables validation function for options if set
116     validator = False
117     # generic owner
118     owner = owners.user
119     # in order to freeze everything, not **only** the frozen options
120     everything_frozen = False
121     #____________________________________________________________
122     # properties methods
123     def has_properties(self):
124         "has properties means the Config's properties attribute is not empty"
125         return bool(len(self.properties))
126
127     def has_property(self, propname):
128         """has property propname in the Config's properties attribute
129         :param property: string wich is the name of the property"""
130         return propname in self.properties
131
132     def enable_property(self, propname):
133         "puts property propname in the Config's properties attribute"
134         if propname not in self.properties:
135             self.properties.append(propname)
136
137     def disable_property(self, propname):
138         "deletes property propname in the Config's properties attribute"
139         if self.has_property(propname):
140             self.properties.remove(propname)
141     #____________________________________________________________
142     def set_permissive(self, permissive):
143         if not isinstance(permissive, list):
144             raise TypeError('permissive must be a list')
145         self.permissive = permissive
146     #____________________________________________________________
147     # complete freeze methods
148     def freeze_everything(self):
149         """everything is frozen, not only the option that are tagged "frozen"
150         """
151         self.everything_frozen = True
152
153     def un_freeze_everything(self):
154         """everything is frozen, not only the option that are tagged "frozen"
155         """
156         self.everything_frozen = False
157
158     def is_frozen_for_everything(self):
159         """frozen for a whole config (not only the options
160         that have been set to frozen)"""
161         return self.everything_frozen
162     #____________________________________________________________
163     def read_only(self):
164         "convenience method to freeze, hidde and disable"
165         self.freeze_everything()
166         self.freeze() # can be usefull...
167         self.disable_property('hidden')
168         self.enable_property('disabled')
169         self.mandatory = True
170         self.validator = True
171
172     def read_write(self):
173         "convenience method to freeze, hidde and disable"
174         self.un_freeze_everything()
175         self.freeze()
176         self.enable_property('hidden')
177         self.enable_property('disabled')
178         self.mandatory = False
179         self.validator = False
180
181     def non_mandatory(self):
182         """mandatory at the Config level means that the Config raises an error
183         if a mandatory option is found"""
184         self.mandatory = False
185
186     def mandatory(self):
187         """mandatory at the Config level means that the Config raises an error
188         if a mandatory option is found"""
189         self.mandatory = True
190
191     def is_mandatory(self):
192         "all mandatory Options shall have a value"
193         return self.mandatory
194
195     def freeze(self):
196         "cannot modify the frozen `Option`'s"
197         self.frozen = True
198
199     def unfreeze(self):
200         "can modify the Options that are frozen"
201         self.frozen = False
202
203     def is_frozen(self):
204         "freeze flag at Config level"
205         return self.frozen
206
207     def set_owner(self, owner):
208         ":param owner: sets the default value for owner at the Config level"
209         if not isinstance(owner, owners.Owner):
210             raise TypeError("invalid generic owner {0}".format(str(owner)))
211         self.owner = owner
212
213     def get_owner(self):
214         return self.owner
215
216 # Setting is actually a singleton
217 settings = Setting()