15d38d7cc1
Change-Id: I53a4d79c3ebc50b8aed43a5ef1fa6538f8059a47 Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/32251 Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de> Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de> Reviewed-by: Alexander Zaft <a.zaft@fz-juelich.de>
191 lines
8.2 KiB
Python
191 lines
8.2 KiB
Python
# *****************************************************************************
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify it under
|
|
# the terms of the GNU General Public License as published by the Free Software
|
|
# Foundation; either version 2 of the License, or (at your option) any later
|
|
# version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful, but WITHOUT
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
# details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License along with
|
|
# this program; if not, write to the Free Software Foundation, Inc.,
|
|
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
#
|
|
# Module authors:
|
|
# Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
|
|
# Markus Zolliker <markus.zolliker@psi.ch>
|
|
#
|
|
# *****************************************************************************
|
|
"""Define validated data types."""
|
|
|
|
|
|
import inspect
|
|
|
|
from frappy.errors import BadValueError, ConfigError, ProgrammingError
|
|
from frappy.lib import UniqueObject
|
|
|
|
UNSET = UniqueObject('undefined value') #: an unset value, not even None
|
|
|
|
|
|
class HasDescriptors:
|
|
@classmethod
|
|
def __init_subclass__(cls):
|
|
# when migrating old style declarations, sometimes the trailing comma is not removed
|
|
bad = [k for k, v in cls.__dict__.items()
|
|
if isinstance(v, tuple) and len(v) == 1 and hasattr(v[0], '__set_name__')]
|
|
if bad:
|
|
raise ProgrammingError(f"misplaced trailing comma after {cls.__name__}.{'/'.join(bad)}")
|
|
|
|
|
|
# storage for 'properties of a property'
|
|
class Property:
|
|
"""base class holding info about a property
|
|
|
|
:param description: mandatory
|
|
:param datatype: the datatype to be accepted. not only to the SECoP datatypes are allowed!
|
|
also for example ``ValueType()`` (any type!), ``NoneOr(...)``, etc.
|
|
:param default: a default value. SECoP properties are normally not sent to the ECS,
|
|
when they match the default
|
|
:param extname: external name
|
|
:param export: sent to the ECS when True. defaults to True, when ``extname`` is given.
|
|
special value 'always': export also when matching the default
|
|
:param mandatory: defaults to True, when ``default`` is not given. indicates that it must have a value
|
|
assigned from the cfg file (or, in case of a module property, it may be assigned as a class attribute)
|
|
:param settable: settable from the cfg file
|
|
"""
|
|
|
|
# note: this is intended to be used on base classes.
|
|
# the VALUES of the properties are on the instances!
|
|
def __init__(self, description, datatype, default=UNSET, extname='', export=False, mandatory=None,
|
|
settable=True, value=UNSET, name=''):
|
|
if not callable(datatype):
|
|
raise ValueError('datatype MUST be a valid DataType or a basic_validator')
|
|
self.description = inspect.cleandoc(description)
|
|
self.default = datatype.default if default is UNSET else datatype.validate(default)
|
|
self.datatype = datatype
|
|
self.extname = extname
|
|
self.export = export or bool(extname)
|
|
if mandatory is None:
|
|
mandatory = default is UNSET
|
|
self.mandatory = mandatory
|
|
self.settable = settable or mandatory # settable means settable from the cfg file
|
|
self.value = UNSET if value is UNSET else datatype.validate(value)
|
|
self.name = name
|
|
|
|
def __get__(self, instance, owner):
|
|
if instance is None:
|
|
return self
|
|
return instance.propertyValues.get(self.name, self.default)
|
|
|
|
def __set__(self, instance, value):
|
|
instance.propertyValues[self.name] = self.datatype.validate(value)
|
|
|
|
def __set_name__(self, owner, name):
|
|
self.name = name
|
|
if self.export and not self.extname:
|
|
self.extname = '_' + name
|
|
|
|
def copy(self):
|
|
return type(self)(**self.__dict__)
|
|
|
|
def __repr__(self):
|
|
extras = [f'default={repr(self.default)}']
|
|
if self.export:
|
|
extras.append(f'extname={self.extname!r}')
|
|
extras.append(f'export={self.export!r}')
|
|
if self.mandatory:
|
|
extras.append('mandatory=True')
|
|
if not self.settable:
|
|
extras.append('settable=False')
|
|
if self.value is not UNSET:
|
|
extras.append(f'value={repr(self.value)}')
|
|
if not self.name:
|
|
extras.append(f'name={self.name!r}')
|
|
return f"Property({self.description!r}, {self.datatype}, {', '.join(extras)})"
|
|
|
|
|
|
class HasProperties(HasDescriptors):
|
|
"""mixin for classes with properties
|
|
|
|
- properties are collected in cls.propertyDict
|
|
- bare values overriding properties should be kept as properties
|
|
- include also attributes of type Property on base classes not inheriting HasProperties
|
|
"""
|
|
propertyValues = None
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
# store property values in the instance, keep descriptors on the class
|
|
self.propertyValues = {}
|
|
# pre-init
|
|
for pn, po in self.propertyDict.items():
|
|
if po.value is not UNSET:
|
|
self.setProperty(pn, po.value)
|
|
|
|
@classmethod
|
|
def __init_subclass__(cls):
|
|
super().__init_subclass__()
|
|
properties = {}
|
|
# using cls.__bases__ and base.propertyDict for this would fail on some multiple inheritance cases
|
|
for base in reversed(cls.__mro__):
|
|
properties.update({k: v for k, v in base.__dict__.items() if isinstance(v, Property)})
|
|
cls.propertyDict = properties
|
|
# treat overriding properties with bare values
|
|
for pn, po in list(properties.items()):
|
|
value = getattr(cls, pn, po)
|
|
if isinstance(value, HasProperties): # value is a Parameter, allow override
|
|
properties.pop(pn)
|
|
elif not isinstance(value, Property): # attribute may be a bare value
|
|
po = po.copy()
|
|
try:
|
|
# try to apply bare value to Property
|
|
po.value = po.datatype.validate(value)
|
|
except BadValueError:
|
|
if callable(value):
|
|
raise ProgrammingError(f'method {cls.__name__}.{pn} collides with property of {base.__name__}') from None
|
|
raise ProgrammingError(f'can not set property {cls.__name__}.{pn} to {value!r}') from None
|
|
cls.propertyDict[pn] = po
|
|
|
|
def checkProperties(self):
|
|
"""validates properties and checks for min... <= max..."""
|
|
for pn, po in self.propertyDict.items():
|
|
if po.mandatory:
|
|
try:
|
|
self.propertyValues[pn] = po.datatype.validate(self.propertyValues[pn])
|
|
except (KeyError, BadValueError):
|
|
raise ConfigError(f'{pn} needs a value of type {po.datatype!r}!') from None
|
|
for pn, po in self.propertyDict.items():
|
|
if pn.startswith('min'):
|
|
maxname = 'max' + pn[3:]
|
|
minval = self.propertyValues.get(pn, po.default)
|
|
maxval = self.propertyValues.get(maxname, minval)
|
|
if minval > maxval:
|
|
raise ConfigError(f'{pn}={minval!r} must be <= {maxname}={maxval!r} for {self!r}')
|
|
|
|
def getProperties(self):
|
|
return self.propertyDict
|
|
|
|
def exportProperties(self):
|
|
# export properties which have
|
|
# export=True and
|
|
# mandatory=True or non_default=True
|
|
res = {}
|
|
for pn, po in self.propertyDict.items():
|
|
val = self.propertyValues.get(pn, po.default)
|
|
if po.export and (po.export == 'always' or val != po.default):
|
|
try:
|
|
val = po.datatype.export_value(val)
|
|
except AttributeError:
|
|
pass # for properties, accept simple datatypes without export_value
|
|
res[po.extname] = val
|
|
return res
|
|
|
|
def setProperty(self, key, value):
|
|
# this is overwritten by Param.setProperty and DataType.setProperty
|
|
# in oder to extend setting to inner properties
|
|
# otherwise direct setting of self.<key> = value is preferred
|
|
self.propertyValues[key] = self.propertyDict[key].datatype.validate(value)
|