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 is_attribute_modified(self, name):
  44         return self._attributes[name].modified
  45
  46     def add_attribute(self, name, help, type, value = None, range = None,
  47         allowed = None, readonly = False, validation_function = None):
  48         if name in self._attributes:
  49             raise AttributeError("Attribute %s already exists" % name)
  50         attribute = Attribute(name, help, type, value, range, allowed, readonly,
  51                 validation_function)
  52         self._attributes[name] = attribute
  53
  54     def del_attribute(self, name):
  55         del self._attributes[name]
  56
  57     def has_attribute(self, name):
  58         return name in self._attributes
  59
  60     def destroy(self):
  61         self._attributes = dict()
  62
  63 class Attribute(object):
  64     STRING, BOOL, ENUM, DOUBLE, INTEGER = (
  65                 "STRING", "BOOL", "ENUM", "DOUBLE", "INTEGER")
  66
  67     types = [STRING, BOOL, ENUM, DOUBLE, INTEGER]
  68
  69     def __init__(self, name, help, type, value = None, range = None,
  70         allowed = None, readonly = False, validation_function = None):
  71         if not type in Attribute.types:
  72             raise AttributeError("invalid type %s " % type)
  73         self.name = name
  74         self._type = type
  75         self._help = help
  76         self._value = value
  77         self._validation_function = validation_function
  78         self._readonly = (readonly == True)
  79         self._modified = False
  80         # range: max and min possible values
  81         self._range = range
  82         # list of possible values
  83         self._allowed = allowed
  84
  85     @property
  86     def type(self):
  87         return self._type
  88
  89     @property
  90     def help(self):
  91         return self._help
  92
  93     @property
  94     def readonly(self):
  95         return self._readonly
  96
  97     @property
  98     def modified(self):
  99         return self._modified
 100
 101     @property
 102     def range(self):
 103         return self._range
 104
 105     @property
 106     def allowed(self):
 107         return self._allowed
 108
 109     @property
 110     def validation_function(self):
 111         return self._validation_function
 112
 113     def get_value(self):
 114         return self._value
 115
 116     def set_value(self, value):
 117         if self._is_in_range(value) and \
 118                 self._is_in_allowed_values(value) and \
 119                 self._is_valid(value):
 120             self._value = value
 121             self._modified = True
 122         else:
 123             raise RuntimeError("Invalid value %s for attribute %s" %
 124                     (str(value), self.name))
 125
 126     value = property(get_value, set_value)
 127
 128     def _is_in_range(self, value):
 129         return not self.range or \
 130                 (value >= self.range[0] and value <= self.range[1])
 131
 132     def _is_in_allowed_values(self, value):
 133         return not self.allowed or value in self._allowed
 134
 135     def _is_valid(self, value):
 136         return not self._validation_function or self._validation_function(value)
 137