sqlalchemy has a storage
[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)
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.impl_getrequires() is not None \
271                 and propname in self._opt.impl_getrequires():
272             raise ValueError(_('cannot append {0} property for option {1}: '
273                                'this property is calculated').format(
274                                    propname, self._opt.impl_getname()))
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     #____________________________________________________________
332     # properties methods
333     def __contains__(self, propname):
334         "enables the pythonic 'in' syntaxic sugar"
335         return propname in self._getproperties()
336
337     def __repr__(self):
338         return str(list(self._getproperties()))
339
340     def __getitem__(self, opt):
341         path = self._get_path_by_opt(opt)
342         return self._getitem(opt, path)
343
344     def _getitem(self, opt, path):
345         return Property(self, self._getproperties(opt, path), opt, path)
346
347     def __setitem__(self, opt, value):
348         raise ValueError('you should only append/remove properties')
349
350     def reset(self, opt=None, _path=None, all_properties=False):
351         if all_properties and (_path or opt):
352             raise ValueError(_('opt and all_properties must not be set '
353                                'together in reset'))
354         if all_properties:
355             self._p_.reset_all_propertives()
356         else:
357             if opt is not None and _path is None:
358                 _path = self._get_path_by_opt(opt)
359             self._p_.reset_properties(_path)
360         self.context().cfgimpl_reset_cache()
361
362     def _getproperties(self, opt=None, path=None, is_apply_req=True):
363         if opt is None:
364             props = self._p_.getproperties(path, default_properties)
365         else:
366             if path is None:
367                 raise ValueError(_('if opt is not None, path should not be'
368                                    ' None in _getproperties'))
369             ntime = None
370             if 'cache' in self and self._p_.hascache(path):
371                 if 'expire' in self:
372                     ntime = int(time())
373                 is_cached, props = self._p_.getcache(path, ntime)
374                 if is_cached:
375                     return props
376             #FIXME
377             props = self._p_.getproperties(path, opt.impl_getproperties())
378             if is_apply_req:
379                 props |= self.apply_requires(opt, path)
380             if 'cache' in self:
381                 if 'expire' in self:
382                     if  ntime is None:
383                         ntime = int(time())
384                     ntime = ntime + expires_time
385                 self._p_.setcache(path, props, ntime)
386         return props
387
388     def append(self, propname):
389         "puts property propname in the Config's properties attribute"
390         props = self._p_.getproperties(None, default_properties)
391         props.add(propname)
392         self._setproperties(props, None, None)
393
394     def remove(self, propname):
395         "deletes property propname in the Config's properties attribute"
396         props = self._p_.getproperties(None, default_properties)
397         if propname in props:
398             props.remove(propname)
399             self._setproperties(props, None, None)
400
401     def _setproperties(self, properties, opt, path):
402         """save properties for specified opt
403         (never save properties if same has option properties)
404         """
405         if opt is None:
406             self._p_.setproperties(None, properties)
407         else:
408             #if opt._calc_properties is not None:
409             #    properties -= opt._calc_properties
410             #FIXME a revoir ---------
411             #if set(opt._properties) == properties:
412             #    self._p_.reset_properties(path)
413             #else:
414             #    self._p_.setproperties(path, properties)
415             self._p_.setproperties(path, properties)
416             #FIXME fin revoir -----
417         self.context().cfgimpl_reset_cache()
418
419     #____________________________________________________________
420     def validate_properties(self, opt_or_descr, is_descr, is_write, path,
421                             value=None, force_permissive=False,
422                             force_properties=None, force_permissives=None):
423         """
424         validation upon the properties related to `opt_or_descr`
425
426         :param opt_or_descr: an option or an option description object
427         :param force_permissive: behaves as if the permissive property
428                                  was present
429         :param force_properties: set() with properties that is force to add
430                                  in global properties
431         :param force_permissives: set() with permissives that is force to add
432                                  in global permissives
433         :param is_descr: we have to know if we are in an option description,
434                          just because the mandatory property
435                          doesn't exist here
436
437         :param is_write: in the validation process, an option is to be modified,
438                          the behavior can be different
439                          (typically with the `frozen` property)
440         """
441         # opt properties
442         properties = copy(self._getproperties(opt_or_descr, path))
443         self_properties = copy(self._getproperties())
444         # remove opt permissive
445         # permissive affect option's permission with or without permissive
446         # global property
447         properties -= self._p_.getpermissive(path)
448         # remove global permissive if need
449         if force_permissive is True or 'permissive' in self_properties:
450             properties -= self._p_.getpermissive()
451         if force_permissives is not None:
452             properties -= force_permissives
453
454         # global properties
455         if force_properties is not None:
456             self_properties.update(force_properties)
457
458         # calc properties
459         properties &= self_properties
460         # mandatory and frozen are special properties
461         if is_descr:
462             properties -= frozenset(('mandatory', 'frozen'))
463         else:
464             if 'mandatory' in properties and \
465                     not self.context().cfgimpl_get_values()._isempty(
466                         opt_or_descr, value):
467                 properties.remove('mandatory')
468             if is_write and 'everything_frozen' in self_properties:
469                 properties.add('frozen')
470             elif 'frozen' in properties and not is_write:
471                 properties.remove('frozen')
472         # at this point an option should not remain in properties
473         if properties != frozenset():
474             props = list(properties)
475             if 'frozen' in properties:
476                 raise PropertiesOptionError(_('cannot change the value for '
477                                               'option {0} this option is'
478                                               ' frozen').format(
479                                                   opt_or_descr.impl_getname()),
480                                             props)
481             else:
482                 raise PropertiesOptionError(_("trying to access to an option "
483                                               "named: {0} with properties {1}"
484                                               "").format(opt_or_descr.impl_getname(),
485                                                          str(props)), props)
486
487     def setpermissive(self, permissive, opt=None, path=None):
488         """
489         enables us to put the permissives in the storage
490
491         :param path: the option's path
492         :param type: str
493         :param opt: if an option object is set, the path is extracted.
494                     it is better (faster) to set the path parameter
495                     instead of passing a :class:`tiramisu.option.Option()` object.
496         """
497         if opt is not None and path is None:
498             path = self._get_path_by_opt(opt)
499         if not isinstance(permissive, tuple):
500             raise TypeError(_('permissive must be a tuple'))
501         self._p_.setpermissive(path, permissive)
502
503     #____________________________________________________________
504     def setowner(self, owner):
505         ":param owner: sets the default value for owner at the Config level"
506         if not isinstance(owner, owners.Owner):
507             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
508         self._owner = owner
509
510     def getowner(self):
511         return self._owner
512
513     #____________________________________________________________
514     def _read(self, remove, append):
515         for prop in remove:
516             self.remove(prop)
517         for prop in append:
518             self.append(prop)
519
520     def read_only(self):
521         "convenience method to freeze, hide and disable"
522         self._read(ro_remove, ro_append)
523
524     def read_write(self):
525         "convenience method to freeze, hide and disable"
526         self._read(rw_remove, rw_append)
527
528     def reset_cache(self, only_expired):
529         """reset all settings in cache
530
531         :param only_expired: if True reset only expired cached values
532         :type only_expired: boolean
533         """
534         if only_expired:
535             self._p_.reset_expired_cache(int(time()))
536         else:
537             self._p_.reset_all_cache()
538
539     def apply_requires(self, opt, path):
540         """carries out the jit (just in time) requirements between options
541
542         a requirement is a tuple of this form that comes from the option's
543         requirements validation::
544
545             (option, expected, action, inverse, transitive, same_action)
546
547         let's have a look at all the tuple's items:
548
549         - **option** is the target option's
550
551         - **expected** is the target option's value that is going to trigger
552           an action
553
554         - **action** is the (property) action to be accomplished if the target
555           option happens to have the expected value
556
557         - if **inverse** is `True` and if the target option's value does not
558           apply, then the property action must be removed from the option's
559           properties list (wich means that the property is inverted)
560
561         - **transitive**: but what happens if the target option cannot be
562           accessed ? We don't kown the target option's value. Actually if some
563           property in the target option is not present in the permissive, the
564           target option's value cannot be accessed. In this case, the
565           **action** have to be applied to the option. (the **action** property
566           is then added to the option).
567
568         - **same_action**: actually, if **same_action** is `True`, the
569           transitivity is not accomplished. The transitivity is accomplished
570           only if the target option **has the same property** that the demanded
571           action. If the target option's value is not accessible because of
572           another reason, because of a property of another type, then an
573           exception :exc:`~error.RequirementError` is raised.
574
575         And at last, if no target option matches the expected values, the
576         action must be removed from the option's properties list.
577
578         :param opt: the option on wich the requirement occurs
579         :type opt: `option.Option()`
580         :param path: the option's path in the config
581         :type path: str
582         """
583         if opt.impl_getrequires() is None:
584             return frozenset()
585
586         # filters the callbacks
587         calc_properties = set()
588         for require in opt.impl_getrequires():
589             expected = tuple(require.get_expected())
590             inverse = require.inverse
591             option = require.option
592             reqpath = self._get_path_by_opt(option)
593             if reqpath == path or reqpath.startswith(path + '.'):
594                 raise RequirementError(_("malformed requirements "
595                                          "imbrication detected for option:"
596                                          " '{0}' with requirement on: "
597                                          "'{1}'").format(path, reqpath))
598             try:
599                 value = self.context()._getattr(reqpath,
600                                                 force_permissive=True)
601             except PropertiesOptionError as err:
602                 if not require.transitive:
603                     continue
604                 properties = err.proptype
605                 if require.same_action and require.action not in properties:
606                     raise RequirementError(_("option '{0}' has "
607                                              "requirement's property "
608                                              "error: "
609                                              "{1} {2}").format(opt.impl_getname(),
610                                                                reqpath,
611                                                                properties))
612                 # transitive action, force expected
613                 value = expected[0]
614                 inverse = False
615             if not inverse and value in expected or \
616                     inverse and value not in expected:
617                 calc_properties.add(require.action)
618                 # the calculation cannot be carried out
619                 #break
620         return calc_properties
621
622     def _get_path_by_opt(self, opt):
623         """just a wrapper to get path in optiondescription's cache
624
625         :param opt: `Option`'s object
626         :returns: path
627         """
628         return self.context().cfgimpl_get_description().impl_get_path_by_opt(opt)
629
630     def get_modified_properties(self):
631         return self._p_.get_modified_properties()
632
633     def get_modified_permissives(self):
634         return self._p_.get_modified_permissives()
635
636     def __getstate__(self):
637         return {'_p_': self._p_, '_owner': str(self._owner)}
638
639     def _impl_setstate(self, storage):
640         self._p_._storage = storage
641
642     def __setstate__(self, states):
643         self._p_ = states['_p_']
644         try:
645             self._owner = getattr(owners, states['_owner'])
646         except AttributeError:
647             owners.addowner(states['_owner'])
648             self._owner = getattr(owners, states['_owner'])