38cf7b5ab5e566c31b09e169653ca52fca1f4dc9
[tiramisu.git] / tiramisu / setting.py
1 # -*- coding: utf-8 -*-
2 "sets the options of the configuration objects Config object itself"
3 # Copyright (C) 2012-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 # 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 from time import time
24 from copy import copy
25 import weakref
26 from tiramisu.error import (RequirementError, PropertiesOptionError,
27                             ConstError, ConfigError)
28 from tiramisu.i18n import _
29
30
31 "Default encoding for display a Config if raise UnicodeEncodeError"
32 default_encoding = 'utf-8'
33
34 """If cache and expire is enable, time before cache is expired.
35 This delay start first time value/setting is set in cache, even if
36 user access several time to value/setting
37 """
38 expires_time = 5
39 """List of default properties (you can add new one if needed).
40
41 For common properties and personalise properties, if a propery is set for
42 an Option and for the Config together, Setting raise a PropertiesOptionError
43
44 * Common properties:
45
46 hidden
47     option with this property can only get value in read only mode. This
48     option is not available in read write mode.
49
50 disabled
51     option with this property cannot be set/get
52
53 frozen
54     cannot set value for option with this properties if 'frozen' is set in
55     config
56
57 mandatory
58     should set value for option with this properties if 'mandatory' is set in
59     config
60
61
62 * Special property:
63
64 permissive
65     option with 'permissive' cannot raise PropertiesOptionError for properties
66     set in permissive
67     config with 'permissive', whole option in this config cannot raise
68     PropertiesOptionError for properties set in permissive
69
70 * Special Config properties:
71
72 cache
73     if set, enable cache settings and values
74
75 expire
76     if set, settings and values in cache expire after ``expires_time``
77
78 everything_frozen
79     whole option in config are frozen (even if option have not frozen
80     property)
81
82 validator
83     launch validator set by user in option (this property has no effect
84     for internal validator)
85 """
86 default_properties = ('cache', 'expire', 'validator')
87
88 """Config can be in two defaut mode:
89
90 read_only
91     you can get all variables not disabled but you cannot set any variables
92     if a value has a callback without any value, callback is launch and value
93     of this variable can change
94     you cannot access to mandatory variable without values
95
96 read_write
97     you can get all variables not disabled and not hidden
98     you can set all variables not frozen
99 """
100 ro_append = set(['frozen', 'disabled', 'validator', 'everything_frozen',
101                 'mandatory'])
102 ro_remove = set(['permissive', 'hidden'])
103 rw_append = set(['frozen', 'disabled', 'validator', 'hidden'])
104 rw_remove = set(['permissive', 'everything_frozen', 'mandatory'])
105
106
107 # ____________________________________________________________
108 class _NameSpace(object):
109     """convenient class that emulates a module
110     and builds constants (that is, unique names)
111     when attribute is added, we cannot delete it
112     """
113
114     def __setattr__(self, name, value):
115         if name in self.__dict__:
116             raise ConstError(_("can't rebind {0}").format(name))
117         self.__dict__[name] = value
118
119     def __delattr__(self, name):
120         if name in self.__dict__:
121             raise ConstError(_("can't unbind {0}").format(name))
122         raise ValueError(name)
123
124
125 class GroupModule(_NameSpace):
126     "emulates a module to manage unique group (OptionDescription) names"
127     class GroupType(str):
128         """allowed normal group (OptionDescription) names
129         *normal* means : groups that are not master
130         """
131         pass
132
133     class DefaultGroupType(GroupType):
134         """groups that are default (typically 'default')"""
135         pass
136
137     class MasterGroupType(GroupType):
138         """allowed normal group (OptionDescription) names
139         *master* means : groups that have the 'master' attribute set
140         """
141         pass
142
143
144 class OwnerModule(_NameSpace):
145     """emulates a module to manage unique owner names.
146
147     owners are living in `Config._cfgimpl_value_owners`
148     """
149     class Owner(str):
150         """allowed owner names
151         """
152         pass
153
154     class DefaultOwner(Owner):
155         """groups that are default (typically 'default')"""
156         pass
157
158
159 class MultiTypeModule(_NameSpace):
160     "namespace for the master/slaves"
161     class MultiType(str):
162         pass
163
164     class DefaultMultiType(MultiType):
165         pass
166
167     class MasterMultiType(MultiType):
168         pass
169
170     class SlaveMultiType(MultiType):
171         pass
172
173
174 # ____________________________________________________________
175 def populate_groups():
176     """populates the available groups in the appropriate namespaces
177
178     groups.default
179         default group set when creating a new optiondescription
180
181     groups.master
182         master group is a special optiondescription, all suboptions should be
183         multi option and all values should have same length, to find master's
184         option, the optiondescription's name should be same than de master's
185         option
186
187     groups.family
188         example of group, no special behavior with this group's type
189     """
190     groups.default = groups.DefaultGroupType('default')
191     groups.master = groups.MasterGroupType('master')
192     groups.family = groups.GroupType('family')
193
194
195 def populate_owners():
196     """populates the available owners in the appropriate namespaces
197
198     default
199         is the config owner after init time
200
201     user
202         is the generic is the generic owner
203     """
204     setattr(owners, 'default', owners.DefaultOwner('default'))
205     setattr(owners, 'user', owners.Owner('user'))
206
207     def addowner(name):
208         """
209         :param name: the name of the new owner
210         """
211         setattr(owners, name, owners.Owner(name))
212     setattr(owners, 'addowner', addowner)
213
214
215 def populate_multitypes():
216     """all multi option should have a type, this type is automaticly set do
217     not touch this
218
219     default
220         default's multi option set if not master or slave
221
222     master
223         master's option in a group with master's type, name of this option
224         should be the same name of the optiondescription
225
226     slave
227         slave's option in a group with master's type
228
229     """
230     setattr(multitypes, 'default', multitypes.DefaultMultiType('default'))
231     setattr(multitypes, 'master', multitypes.MasterMultiType('master'))
232     setattr(multitypes, 'slave', multitypes.SlaveMultiType('slave'))
233
234
235 # ____________________________________________________________
236 # populate groups, owners and multitypes with default attributes
237 groups = GroupModule()
238 populate_groups()
239 owners = OwnerModule()
240 populate_owners()
241 multitypes = MultiTypeModule()
242 populate_multitypes()
243
244
245 # ____________________________________________________________
246 class Undefined():
247     pass
248
249
250 undefined = Undefined()
251
252
253 # ____________________________________________________________
254 class Property(object):
255     "a property is responsible of the option's value access rules"
256     __slots__ = ('_setting', '_properties', '_opt', '_path')
257
258     def __init__(self, setting, prop, opt=None, path=None):
259         self._opt = opt
260         self._path = path
261         self._setting = setting
262         self._properties = prop
263
264     def append(self, propname):
265         """Appends a property named propname
266
267         :param propname: a predefined or user defined property name
268         :type propname: string
269         """
270         if self._opt is not None and self._opt._calc_properties is not None \
271                 and propname in self._opt._calc_properties:
272             raise ValueError(_('cannot append {0} property for option {1}: '
273                                'this property is calculated').format(
274                                    propname, self._opt._name))
275         self._properties.add(propname)
276         self._setting._setproperties(self._properties, self._opt, self._path)
277
278     def remove(self, propname):
279         """Removes a property named propname
280
281         :param propname: a predefined or user defined property name
282         :type propname: string
283         """
284         if propname in self._properties:
285             self._properties.remove(propname)
286             self._setting._setproperties(self._properties, self._opt,
287                                          self._path)
288
289     def extend(self, propnames):
290         """Extends properties to the existing properties
291
292         :param propnames: an iterable made of property names
293         :type propnames: iterable of string
294         """
295         for propname in propnames:
296             self.append(propname)
297
298     def reset(self):
299         """resets the properties (does not **clear** the properties,
300         default properties are still present)
301         """
302         self._setting.reset(_path=self._path)
303
304     def __contains__(self, propname):
305         return propname in self._properties
306
307     def __repr__(self):
308         return str(list(self._properties))
309
310
311 #____________________________________________________________
312 class Settings(object):
313     "``config.Config()``'s configuration options settings"
314     __slots__ = ('context', '_owner', '_p_', '__weakref__')
315
316     def __init__(self, context, storage):
317         """
318         initializer
319
320         :param context: the root config
321         :param storage: the storage type
322
323                         - dictionary -> in memory
324                         - sqlite3 -> persistent
325         """
326         # generic owner
327         self._owner = owners.user
328         self.context = weakref.ref(context)
329         self._p_ = storage
330
331     def _getcontext(self):
332         """context could be None, we need to test it
333         context is None only if all reference to `Config` object is deleted
334         (for example we delete a `Config` and we manipulate a reference to
335         old `SubConfig`, `Values`, `Multi` or `Settings`)
336         """
337         context = self.context()
338         if context is None:
339             raise ConfigError(_('the context does not exist anymore'))
340         return context
341
342     #____________________________________________________________
343     # properties methods
344     def __contains__(self, propname):
345         "enables the pythonic 'in' syntaxic sugar"
346         return propname in self._getproperties()
347
348     def __repr__(self):
349         return str(list(self._getproperties()))
350
351     def __getitem__(self, opt):
352         path = self._get_path_by_opt(opt)
353         return self._getitem(opt, path)
354
355     def _getitem(self, opt, path):
356         return Property(self, self._getproperties(opt, path), opt, path)
357
358     def __setitem__(self, opt, value):
359         raise ValueError('you should only append/remove properties')
360
361     def reset(self, opt=None, _path=None, all_properties=False):
362         if all_properties and (_path or opt):
363             raise ValueError(_('opt and all_properties must not be set '
364                                'together in reset'))
365         if all_properties:
366             self._p_.reset_all_properties()
367         else:
368             if opt is not None and _path is None:
369                 _path = self._get_path_by_opt(opt)
370             self._p_.reset_properties(_path)
371         self._getcontext().cfgimpl_reset_cache()
372
373     def _getproperties(self, opt=None, path=None, is_apply_req=True):
374         if opt is None:
375             props = copy(self._p_.getproperties(path, default_properties))
376         else:
377             if path is None:
378                 raise ValueError(_('if opt is not None, path should not be'
379                                    ' None in _getproperties'))
380             ntime = None
381             if 'cache' in self and self._p_.hascache(path):
382                 if 'expire' in self:
383                     ntime = int(time())
384                 is_cached, props = self._p_.getcache(path, ntime)
385                 if is_cached:
386                     return copy(props)
387             props = copy(self._p_.getproperties(path, opt._properties))
388             if is_apply_req:
389                 props |= self.apply_requires(opt, path)
390             if 'cache' in self:
391                 if 'expire' in self:
392                     if  ntime is None:
393                         ntime = int(time())
394                     ntime = ntime + expires_time
395                 self._p_.setcache(path, props, ntime)
396         return props
397
398     def append(self, propname):
399         "puts property propname in the Config's properties attribute"
400         props = self._p_.getproperties(None, default_properties)
401         props.add(propname)
402         self._setproperties(props, None, None)
403
404     def remove(self, propname):
405         "deletes property propname in the Config's properties attribute"
406         props = self._p_.getproperties(None, default_properties)
407         if propname in props:
408             props.remove(propname)
409             self._setproperties(props, None, None)
410
411     def _setproperties(self, properties, opt, path):
412         """save properties for specified opt
413         (never save properties if same has option properties)
414         """
415         if opt is None:
416             self._p_.setproperties(None, properties)
417         else:
418             if opt._calc_properties is not None:
419                 properties -= opt._calc_properties
420             if set(opt._properties) == properties:
421                 self._p_.reset_properties(path)
422             else:
423                 self._p_.setproperties(path, properties)
424         self._getcontext().cfgimpl_reset_cache()
425
426     #____________________________________________________________
427     def validate_properties(self, opt_or_descr, is_descr, is_write, path,
428                             value=None, force_permissive=False,
429                             force_properties=None, force_permissives=None):
430         """
431         validation upon the properties related to `opt_or_descr`
432
433         :param opt_or_descr: an option or an option description object
434         :param force_permissive: behaves as if the permissive property
435                                  was present
436         :param force_properties: set() with properties that is force to add
437                                  in global properties
438         :param force_permissives: set() with permissives that is force to add
439                                  in global permissives
440         :param is_descr: we have to know if we are in an option description,
441                          just because the mandatory property
442                          doesn't exist here
443
444         :param is_write: in the validation process, an option is to be modified,
445                          the behavior can be different
446                          (typically with the `frozen` property)
447         """
448         # opt properties
449         properties = self._getproperties(opt_or_descr, path)
450         self_properties = self._getproperties()
451         # remove opt permissive
452         # permissive affect option's permission with or without permissive
453         # global property
454         properties -= self._p_.getpermissive(path)
455         # remove global permissive if need
456         if force_permissive is True or 'permissive' in self_properties:
457             properties -= self._p_.getpermissive()
458         if force_permissives is not None:
459             properties -= force_permissives
460
461         # global properties
462         if force_properties is not None:
463             self_properties.update(force_properties)
464
465         # calc properties
466         properties &= self_properties
467         # mandatory and frozen are special properties
468         if is_descr:
469             properties -= frozenset(('mandatory', 'frozen'))
470         else:
471             if 'mandatory' in properties and \
472                     not self._getcontext().cfgimpl_get_values()._isempty(
473                         opt_or_descr, value):
474                 properties.remove('mandatory')
475             if is_write and 'everything_frozen' in self_properties:
476                 properties.add('frozen')
477             elif 'frozen' in properties and not is_write:
478                 properties.remove('frozen')
479         # at this point an option should not remain in properties
480         if properties != frozenset():
481             props = list(properties)
482             if 'frozen' in properties:
483                 raise PropertiesOptionError(_('cannot change the value for '
484                                               'option {0} this option is'
485                                               ' frozen').format(
486                                                   opt_or_descr._name),
487                                             props)
488             else:
489                 raise PropertiesOptionError(_("trying to access to an option "
490                                               "named: {0} with properties {1}"
491                                               "").format(opt_or_descr._name,
492                                                          str(props)), props)
493
494     def setpermissive(self, permissive, opt=None, path=None):
495         """
496         enables us to put the permissives in the storage
497
498         :param path: the option's path
499         :param type: str
500         :param opt: if an option object is set, the path is extracted.
501                     it is better (faster) to set the path parameter
502                     instead of passing a :class:`tiramisu.option.Option()` object.
503         """
504         if opt is not None and path is None:
505             path = self._get_path_by_opt(opt)
506         if not isinstance(permissive, tuple):
507             raise TypeError(_('permissive must be a tuple'))
508         self._p_.setpermissive(path, permissive)
509
510     #____________________________________________________________
511     def setowner(self, owner):
512         ":param owner: sets the default value for owner at the Config level"
513         if not isinstance(owner, owners.Owner):
514             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
515         self._owner = owner
516
517     def getowner(self):
518         return self._owner
519
520     #____________________________________________________________
521     def _read(self, remove, append):
522         for prop in remove:
523             self.remove(prop)
524         for prop in append:
525             self.append(prop)
526
527     def read_only(self):
528         "convenience method to freeze, hide and disable"
529         self._read(ro_remove, ro_append)
530
531     def read_write(self):
532         "convenience method to freeze, hide and disable"
533         self._read(rw_remove, rw_append)
534
535     def reset_cache(self, only_expired):
536         """reset all settings in cache
537
538         :param only_expired: if True reset only expired cached values
539         :type only_expired: boolean
540         """
541         if only_expired:
542             self._p_.reset_expired_cache(int(time()))
543         else:
544             self._p_.reset_all_cache()
545
546     def apply_requires(self, opt, path):
547         """carries out the jit (just in time) requirements between options
548
549         a requirement is a tuple of this form that comes from the option's
550         requirements validation::
551
552             (option, expected, action, inverse, transitive, same_action)
553
554         let's have a look at all the tuple's items:
555
556         - **option** is the target option's
557
558         - **expected** is the target option's value that is going to trigger
559           an action
560
561         - **action** is the (property) action to be accomplished if the target
562           option happens to have the expected value
563
564         - if **inverse** is `True` and if the target option's value does not
565           apply, then the property action must be removed from the option's
566           properties list (wich means that the property is inverted)
567
568         - **transitive**: but what happens if the target option cannot be
569           accessed ? We don't kown the target option's value. Actually if some
570           property in the target option is not present in the permissive, the
571           target option's value cannot be accessed. In this case, the
572           **action** have to be applied to the option. (the **action** property
573           is then added to the option).
574
575         - **same_action**: actually, if **same_action** is `True`, the
576           transitivity is not accomplished. The transitivity is accomplished
577           only if the target option **has the same property** that the demanded
578           action. If the target option's value is not accessible because of
579           another reason, because of a property of another type, then an
580           exception :exc:`~error.RequirementError` is raised.
581
582         And at last, if no target option matches the expected values, the
583         action must be removed from the option's properties list.
584
585         :param opt: the option on wich the requirement occurs
586         :type opt: `option.Option()`
587         :param path: the option's path in the config
588         :type path: str
589         """
590         if opt._requires is None:
591             return frozenset()
592
593         # filters the callbacks
594         calc_properties = set()
595         context = self._getcontext()
596         for requires in opt._requires:
597             for require in requires:
598                 option, expected, action, inverse, \
599                     transitive, same_action = require
600                 reqpath = self._get_path_by_opt(option)
601                 if reqpath == path or reqpath.startswith(path + '.'):
602                     raise RequirementError(_("malformed requirements "
603                                              "imbrication detected for option:"
604                                              " '{0}' with requirement on: "
605                                              "'{1}'").format(path, reqpath))
606                 try:
607                     value = context._getattr(reqpath, force_permissive=True)
608                 except PropertiesOptionError as err:
609                     if not transitive:
610                         continue
611                     properties = err.proptype
612                     if same_action and action not in properties:
613                         raise RequirementError(_("option '{0}' has "
614                                                  "requirement's property "
615                                                  "error: "
616                                                  "{1} {2}").format(opt._name,
617                                                                    reqpath,
618                                                                    properties))
619                     # transitive action, force expected
620                     value = expected[0]
621                     inverse = False
622                 if (not inverse and
623                         value in expected or
624                         inverse and value not in expected):
625                     calc_properties.add(action)
626                     # the calculation cannot be carried out
627                     break
628         return calc_properties
629
630     def _get_path_by_opt(self, opt):
631         """just a wrapper to get path in optiondescription's cache
632
633         :param opt: `Option`'s object
634         :returns: path
635         """
636         return self._getcontext().cfgimpl_get_description().impl_get_path_by_opt(opt)
637
638     def get_modified_properties(self):
639         return self._p_.get_modified_properties()
640
641     def get_modified_permissives(self):
642         return self._p_.get_modified_permissives()
643
644     def __getstate__(self):
645         return {'_p_': self._p_, '_owner': str(self._owner)}
646
647     def _impl_setstate(self, storage):
648         self._p_._storage = storage
649
650     def __setstate__(self, states):
651         self._p_ = states['_p_']
652         try:
653             self._owner = getattr(owners, states['_owner'])
654         except AttributeError:
655             owners.addowner(states['_owner'])
656             self._owner = getattr(owners, states['_owner'])