src/nepi/core/attributes.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 class AttributesMap(object):
   5     """AttributesMap is the base class for every object whose attributes
   6     are going to be manipulated by the end-user in a script or GUI.
   7     """
   8     def __init__(self):
   9         self._attributes = dict()
  10
  11     @property
  12     def attributes(self):
  13         return self._attributes.values()
  14
  15     @property
  16     def attributes_name(self):
  17         return self._attributes.keys()
  18
  19     def set_attribute_value(self, name, value):
  20         self._attributes[name].value = value
  21
  22     def set_attribute_readonly(self, name, value):
  23         self._attributes[name].readonly = value
  24
  25     def get_attribute_value(self, name):
  26         return self._attributes[name].value
  27
  28     def get_attribute_help(self, name):
  29         return self._attributes[name].help
  30
  31     def get_attribute_type(self, name):
  32         return self._attributes[name].type
  33
  34     def get_attribute_range(self, name):
  35         return self._attributes[name].range
  36
  37     def get_attribute_allowed(self, name):
  38         return self._attributes[name].allowed
  39
  40     def get_attribute_readonly(self, name):
  41         return self._attributes[name].readonly
  42
  43     def add_attribute(self, name, help, type, value = None, range = None,
  44         allowed = None, readonly = False, validation_function = None):
  45         if name in self._attributes:
  46             raise AttributeError("Attribute %s already exists" % name)
  47         attribute = Attribute(name, help, type, value, range, allowed, readonly,
  48                 validation_function)
  49         self._attributes[name] = attribute
  50
  51     def del_attribute(self, name):
  52         del self._attributes[name]
  53
  54     def has_attribute(self, name):
  55         return name in self._attributes
  56
  57     def destroy(self):
  58         self._attributes = dict()
  59
  60 class Attribute(object):
  61     STRING, BOOL, ENUM, DOUBLE, INTEGER = (
  62                 "STRING", "BOOL", "ENUM", "DOUBLE", "INTEGER")
  63
  64     types = [STRING, BOOL, ENUM, DOUBLE, INTEGER]
  65
  66     def __init__(self, name, help, type, value = None, range = None,
  67         allowed = None, readonly = False, validation_function = None):
  68         if not type in Attribute.types:
  69             raise AttributeError("invalid type %s " % type)
  70         self.name = name
  71         self._type = type
  72         self._help = help
  73         self._value = value
  74         self._validation_function = validation_function
  75         self._readonly = (readonly == True)
  76         self._modified = False
  77         # range: max and min possible values
  78         self._range = range
  79         # list of possible values
  80         self._allowed = allowed
  81
  82     @property
  83     def type(self):
  84         return self._type
  85
  86     @property
  87     def help(self):
  88         return self._help
  89
  90     @property
  91     def readonly(self):
  92         return self._readonly
  93
  94     @property
  95     def modified(self):
  96         return self._modified
  97
  98     @property
  99     def range(self):
 100         return self._range
 101
 102     @property
 103     def allowed(self):
 104         return self._allowed
 105
 106     @property
 107     def validation_function(self):
 108         return self._validation_function
 109
 110     def get_value(self):
 111         return self._value
 112
 113     def set_value(self, value):
 114         if self._is_in_range(value) and \
 115                 self._is_in_allowed_values(value) and \
 116                 self._is_valid(value):
 117             self._value = value
 118             self._modified = True
 119         else:
 120             raise RuntimeError("Invalid value %s for attribute %s" %
 121                     (str(value), self.name))
 122
 123     value = property(get_value, set_value)
 124
 125     def _is_in_range(self, value):
 126         return not self.range or \
 127                 (value >= self.range[0] and value <= self.range[1])
 128
 129     def _is_in_allowed_values(self, value):
 130         return not self.allowed or value in self._allowed
 131
 132     def _is_valid(self, value):
 133         return not self._validation_function or self._validation_function(value)
 134