semantics.py

Go to the documentation of this file.

import copy
import json
import logging
import re
import sys
from collections.abc import MutableMapping, MutableSequence, MutableSet
 
import GaudiKernel.GaudiHandles
from GaudiKernel.DataHandle import DataHandle, DataHandleVector
from GaudiKernel.GaudiHandles import GaudiHandle
 
from . import Configurable, Configurables
 
_log = logging.getLogger(__name__)
is_64bits = sys.maxsize > 2**32
 
 
class PropertySemantics(object):
    """
    Basic property semantics implementation, with no validation/transformation.
 
    Not to be used directly for any actual property, use only specializations.
    """
 
    __handled_types__ = ()
 
    def __init__(self, cpp_type):
        self._name = None
        self.cpp_type = cpp_type
 
    @property
    def name(self):
        return self._name
 
    @name.setter
    def name(self, value):
        self._name = value
 
    @property
    def cpp_type(self):
        return self._cpp_type
 
    @cpp_type.setter
    def cpp_type(self, value):
        if not any(
            h.match(value) if hasattr(h, "match") else h == value
            for h in self.__handled_types__
        ):
            raise TypeError("C++ type {!r} not supported".format(value))
        self._cpp_type = value
 
    def load(self, value):
        """
        Transformation for data when reading the property.
        """
        return value
 
    def store(self, value):
        """
        Validation/transformation of the data to be stored.
        """
        return value
 
    def is_set(self, value):
        """
        Allow overriding the definition of "is set" if we need helper types.
        """
        return True
 
    def opt_value(self, value):
        """
        Option string version of value.
        """
        if hasattr(value, "__opt_value__"):
            return value.__opt_value__()
        return value
 
    def merge(self, a, b):
        """
        "Merge" two values.
 
        Used when merging two Configurable instances, by default just ensure
        the two values do not conflict, but it can be overridden in
        derived semantics to, for example, append to the two lists.
        """
        if self.store(a) != self.store(b):
            raise ValueError("cannot merge values %r and %r" % (a, b))
        return a
 
 
class DefaultSemantics(PropertySemantics):
    """
    Special semantics that makes a deep copy of the default value on first access
    and considers a property set if its value is different from the default.
 
    This semantics is meant to be used whenever there is no specific semantic
    (with proper change detection) implemented for a type.
    """
 
    __handled_types__ = (re.compile(r".*"),)
 
    def default(self, value):
        # remember the default value we got and return a copy
        self._default = value
        self._is_set = False
        return copy.deepcopy(value)
 
    def store(self, value):
        # flag that the value was explicitly set
        self._is_set = True
        return super(DefaultSemantics, self).store(value)
 
    def is_set(self, value):
        try:
            # we assume the property was set if it was changed
            return self._is_set or self._default != value
        except AttributeError:
            # either self._is_set or self._default is not defined,
            # so the value was not explicitly set nor modified
            # from the default
            return False
 
 
class _JSONValue:
    def __init__(self, data, explicitly_set):
        self.data = data
        self.default = copy.deepcopy(data)
        self.explicitly_set = explicitly_set
 
    def __eq__(self, other):
        return isinstance(other, _JSONValue) and self.data == other.data
 
 
class _JSONOption(str):
    def __opt_repr__(self):
        return str(self)
 
 
class JSONSemantics(PropertySemantics):
    __handled_types__ = (
        "nlohmann::json",
        re.compile(r"nlohmann::(?:json_abi[^:]*::)?basic_json<.*>$"),
    )
 
    @staticmethod
    def _normalize(value):
        return json.loads(json.dumps(value, allow_nan=False))
 
    def default(self, value):
        data = json.loads(value) if isinstance(value, str) else self._normalize(value)
        return _JSONValue(data, False)
 
    def load(self, value):
        return value.data
 
    def store(self, value):
        return _JSONValue(self._normalize(value), True)
 
    def is_set(self, value):
        return value.explicitly_set or value.data != value.default
 
    def opt_value(self, value):
        if not isinstance(value, _JSONValue):
            value = self.default(value)
        return _JSONOption(
            json.dumps(
                value.data, allow_nan=False, separators=(",", ":"), sort_keys=True
            )
        )
 
 
class StringSemantics(PropertySemantics):
    __handled_types__ = ("std::string",)
 
    def store(self, value):
        if not isinstance(value, str):
            raise TypeError("cannot set property {} to {!r}".format(self.name, value))
        return value
 
 
class BoolSemantics(PropertySemantics):
    __handled_types__ = ("bool",)
 
    def store(self, value):
        return bool(value)
 
 
class FloatSemantics(PropertySemantics):
    __handled_types__ = ("float", "double")
 
    def store(self, value):
        from numbers import Number
 
        if not isinstance(value, Number):
            raise TypeError(
                "number expected, got {!r} in assignment to {}".format(value, self.name)
            )
        return float(value)
 
 
class IntSemantics(PropertySemantics):
    # dictionary generated with tools/print_limits.cpp
    INT_RANGES = {
        "signed char": (-128, 127),
        "short": (-32768, 32767),
        "int": (-2147483648, 2147483647),
        "long": (
            (-9223372036854775808, 9223372036854775807)
            if is_64bits
            else (-2147483648, 2147483647)
        ),
        "long long": (-9223372036854775808, 9223372036854775807),
        "unsigned char": (0, 255),
        "unsigned short": (0, 65535),
        "unsigned int": (0, 4294967295),
        "unsigned long": (0, 18446744073709551615 if is_64bits else 4294967295),
        "unsigned long long": (0, 18446744073709551615),
    }
 
    __handled_types__ = tuple(INT_RANGES)
 
    def store(self, value):
        from numbers import Number
 
        if not isinstance(value, Number):
            raise TypeError(
                "number expected, got {!r} in assignment to {}".format(value, self.name)
            )
        v = int(value)
        if v != value:
            _log.warning("converted %s to %d in assignment to %s", value, v, self.name)
        min_value, max_value = self.INT_RANGES[self.cpp_type]
        if v < min_value or v > max_value:
            raise ValueError(
                "value {} outside limits for {!r} {}".format(
                    v, self.cpp_type, self.INT_RANGES[self.cpp_type]
                )
            )
        return v
 
 
_IDENTIFIER_RE = r"[a-zA-Z_][a-zA-Z0-9_]*"
_NS_IDENT_RE = r"{ident}(::{ident})*".format(ident=_IDENTIFIER_RE)
_COMMA_SEPARATION_RE = r"{exp}(,{exp})*"
 
 
class ComponentSemantics(PropertySemantics):
    __handled_types__ = (
        "Algorithm",
        "Auditor",
        re.compile(
            r"AlgTool(:{})?$".format(_COMMA_SEPARATION_RE.format(exp=_NS_IDENT_RE))
        ),
        re.compile(
            r"Service(:{})?$".format(_COMMA_SEPARATION_RE.format(exp=_NS_IDENT_RE))
        ),
    )
 
    def __init__(self, cpp_type):
        super(ComponentSemantics, self).__init__(cpp_type)
        if ":" in cpp_type:
            self.cpp_type, self.interfaces = cpp_type.split(":", 1)
            self.interfaces = set(self.interfaces.split(","))
        else:
            self.cpp_type = cpp_type
            self.interfaces = set()
 
    def store(self, value):
        if isinstance(value, Configurable):
            value.name  # make sure the configurable has a name
        elif isinstance(value, str):
            # try to map the sring to an existing Configurable
            if value in Configurable.instances:
                value = Configurable.instances[value]
            else:
                # or create one from type and name
                if "/" in value:
                    t, n = value.split("/")
                else:
                    t = n = value
                value = Configurables.getByType(t).getInstance(n)
        else:
            raise TypeError(
                "cannot assign {!r} to {!r}, requested string or {!r}".format(
                    value, self.name, self.cpp_type
                )
            )
        if value.__component_type__ != self.cpp_type:
            raise TypeError(
                "wrong type for {!r}: expected {!r}, got {!r}".format(
                    self.name, self.cpp_type, value.__component_type__
                )
            )
        try:
            # if no interface is declared we cannot check
            if value.__interfaces__:
                if not self.interfaces.issubset(value.__interfaces__):
                    raise TypeError(
                        "wrong interfaces for {!r}: required {}".format(
                            self.name, list(self.interfaces)
                        )
                    )
        except AttributeError:
            pass  # no interfaces declared by the configrable, cannot check
        return value
 
    def default(self, value):
        return self.store(value)
 
 
class ComponentHandleSemantics(PropertySemantics):
    """
    Semantics for component (tool, service) handles. On access, it will create the
    corresponding Configurable instance and store it in the property.
    """
 
    __handled_types__ = ("PrivateToolHandle", "PublicToolHandle", "ServiceHandle")
 
    def __init__(self, cpp_type):
        super().__init__(cpp_type)
        self.handle_type = getattr(GaudiKernel.GaudiHandles, self.cpp_type)
 
    def store(self, value):
        # Configurable: store if correct type
        if (
            isinstance(value, Configurable)
            and value.getGaudiType() == self.handle_type.componentType
        ):
            return value
 
        # Handle: create Configurable
        elif isinstance(value, GaudiHandle):
            return (
                Configurables.getByType(value.getType()).getInstance(value.getName())
                if value.typeAndName
                else self.handle_type()  # empty handle
            )
 
        # Empty: empty Handle
        elif value is None or value == "":
            return self.handle_type()
 
        # String: create Configurable
        elif isinstance(value, str):
            tn = value.split("/", maxsplit=1)  # type[/name]
            name = tn[1] if len(tn) == 2 else tn[0]
            return Configurables.getByType(tn[0]).getInstance(name)
 
        raise TypeError(f"cannot assign {value!r} ({type(value)}) to {self.name}")
 
    def default(self, value):
        return self.store(value)
 
    def merge(self, b, a):
        return a.merge(b)
 
 
class _GaudiHandleArrayOptionValue(list):
    def __opt_repr__(self):
        return "[" + ",".join(map(repr, self)) + "]"
 
 
class GaudiHandleArraySemantics(DefaultSemantics):
    """Semantics for GaudiHandleArrays."""
 
    __handled_types__ = (
        "PrivateToolHandleArray",
        "PublicToolHandleArray",
        "ServiceHandleArray",
    )
 
    def __init__(self, cpp_type):
        super().__init__(cpp_type)
        self.handle_type = getattr(GaudiKernel.GaudiHandles, self.cpp_type)
 
    def store(self, value):
        # flag that the value was explicitly set (see DefaultSemantics)
        self._is_set = True
 
        # Create HandleArray from value if needed (it does all the type checking)
        if not isinstance(value, self.handle_type):
            value = self.handle_type(value)
        return value
 
    def opt_value(self, value):
        return _GaudiHandleArrayOptionValue(
            handle.toStringProperty() for handle in value
        )
 
    def merge(self, b, a):
        for comp in b:
            try:
                # If a component with that name exists in a, we merge it
                a.__getitem__(comp.getName()).merge(comp)
            except IndexError:
                # Otherwise append it
                a.append(comp)
        return a
 
 
class DataHandleSemantics(PropertySemantics):
    """
    Semantics for data handles.
    """
 
    __handled_types__ = (re.compile(r"DataObject(Read|Write)Handle<.*>$"),)
 
    def __init__(self, cpp_type):
        super().__init__(cpp_type)
        self._type = next(extract_template_args(cpp_type))
        self._isCond = False  # no specific conditions handle in Gaudi yet
 
        if cpp_type.startswith("DataObjectReadHandle"):
            self._mode = "R"
        elif cpp_type.startswith("DataObjectWriteHandle"):
            self._mode = "W"
        else:
            raise TypeError(f"C++ type {cpp_type} not supported")
 
    def store(self, value):
        if isinstance(value, DataHandle):
            v = value.Path
        elif isinstance(value, str):
            v = value
        else:
            raise TypeError(
                f"cannot assign {value!r} ({type(value)}) to {self.name}"
                ", expected string or DataHandle"
            )
        return DataHandle(v, self._mode, self._type, self._isCond)
 
    def opt_value(self, value):
        return value.Path
 
 
def extract_template_args(cpp_type):
    """
    Return an iterator over the list of template arguments in a C++ type
    string.
 
    >>> t = 'map<string, vector<int, allocator<int> >, allocator<v<i>, a<i>> >'
    >>> list(extract_template_args(t))
    ['string', 'vector<int, allocator<int> >', 'allocator<v<i>, a<i>>']
    >>> list(extract_template_args('int'))
    []
    """
    template_level = 0
    arg_start = -1
    for p, c in enumerate(cpp_type):
        if c == ",":
            if template_level == 1:
                yield cpp_type[arg_start:p].strip()
                arg_start = p + 1
        elif c == "<":
            template_level += 1
            if template_level == 1:
                arg_start = p + 1
        elif c == ">":
            template_level -= 1
            if template_level == 0:
                yield cpp_type[arg_start:p].strip()
 
 
class _ListHelper(MutableSequence):
    def __init__(self, semantics):
        self.value_semantics = semantics
        self.default = None
        self._data = []
        self.is_dirty = False
 
    @property
    def data(self):
        return self._data if self.is_dirty else self.default
 
    def __len__(self):
        return len(self.data)
 
    def __getitem__(self, key):
        return self.value_semantics.load(self.data.__getitem__(key))
 
    def __setitem__(self, key, value):
        self.is_dirty = True
        self.data.__setitem__(key, self.value_semantics.store(value))
 
    def __delitem__(self, key):
        if not self.is_dirty:
            raise RuntimeError("cannot remove elements from the default value")
        self.data.__delitem__(key)
 
    def __eq__(self, other):
        return self.data == other
 
    def insert(self, key, value):
        self.is_dirty = True
        self.data.insert(key, self.value_semantics.store(value))
 
    def append(self, value):
        self.is_dirty = True
        self.data.append(self.value_semantics.store(value))
 
    def extend(self, iterable):
        self.is_dirty = True
        self.data.extend(self.value_semantics.store(value) for value in iterable)
 
    def opt_value(self):
        return [self.value_semantics.opt_value(item) for item in self.data]
 
    def __repr__(self):
        return repr(self.data)
 
 
class SequenceSemantics(PropertySemantics):
    __handled_types__ = (re.compile(r"(std::)?(vector|list)<.*>$"),)
 
    def __init__(self, cpp_type, valueSem=None):
        super(SequenceSemantics, self).__init__(cpp_type)
        self.value_semantics = valueSem or getSemanticsFor(
            list(extract_template_args(cpp_type))[0]
        )
 
    @property
    def name(self):
        return self._name
 
    @name.setter
    def name(self, value):
        self._name = value
        self.value_semantics.name = "{} element".format(self._name)
 
    def store(self, value):
        if not isinstance(value, (list, _ListHelper, tuple)):
            raise TypeError(
                "list or tuple expected, got {!r} in assignment to {}".format(
                    value, self.name
                )
            )
        new_value = _ListHelper(self.value_semantics)
        new_value.extend(value)
        return new_value
 
    def default(self, value):
        new_value = _ListHelper(self.value_semantics)
        new_value.default = value
        return new_value
 
    def opt_value(self, value):
        """
        Option string version of value.
        """
        if not isinstance(value, _ListHelper):
            value = self.default(value)
        return value.opt_value()
 
 
class DataHandleVectorSemantics(SequenceSemantics):
    """Sequence semantics whose elements are data handles."""
 
    __handled_types__ = (
        re.compile(r"Gaudi::DataHandleVector<DataObject(Read|Write)Handle,.*>$"),
    )
 
    def __init__(self, cpp_type):
        if not self.__handled_types__[0].match(cpp_type):
            raise TypeError(f"C++ type {cpp_type!r} not supported")
        handle_type, value_type = extract_template_args(cpp_type)
        super().__init__(
            cpp_type, valueSem=DataHandleSemantics(f"{handle_type}<{value_type}>")
        )
 
    def store(self, value):
        if isinstance(value, DataHandleVector):
            value = value.paths()
        handles = super().store(value)
        return DataHandleVector(
            [handle.Path for handle in handles],
            self.value_semantics._mode,
            self.value_semantics._type,
            self.value_semantics._isCond,
        )
 
    def default(self, value):
        return self.store(value)
 
    def opt_value(self, value):
        return value.paths()
 
    def merge(self, b, a):
        paths = a.paths()
        for handle in b:
            path = self.value_semantics.store(handle).Path
            if path not in paths:
                paths.append(path)
        return a
 
 
class _SetHelper(MutableSet):
    def __init__(self, semantics):
        self.value_semantics = semantics
        self.default = set()  # cannot use None due to the way __ior__ is implemented
        self._data = set()
        self.is_dirty = False
 
    # Aliases to match builtin `set`
    union = MutableSet.__ior__
    update = MutableSet.__ior__
    intersection = MutableSet.__iand__
    difference = MutableSet.__isub__
    symmetric_difference = MutableSet.__ixor__
 
    @property
    def data(self):
        return self._data if self.is_dirty else self.default
 
    def __len__(self):
        return len(self.data)
 
    def __contains__(self, value):
        return self.value_semantics.store(value) in self.data
 
    def __eq__(self, other):
        return self.data == other
 
    def __iter__(self):
        for value in self.data:
            yield self.value_semantics.load(value)
 
    def add(self, value):
        self.is_dirty = True
        self.data.add(self.value_semantics.store(value))
 
    def discard(self, value):
        if not self.is_dirty:
            raise RuntimeError("cannot remove elements from the default value")
        self.data.discard(value)
 
    def pop(self):
        if not self.is_dirty:
            raise RuntimeError("cannot remove elements from the default value")
        return self.data.pop()
 
    def opt_value(self):
        return set(self.value_semantics.opt_value(item) for item in self.data)
 
    def __repr__(self):
        if self.data:
            # sort into list but print as set to get reproducible repr
            return "{" + repr(sorted(self.data))[1:-1] + "}"
        else:
            return "set()"
 
 
class SetSemantics(PropertySemantics):
    """Merge semantics for (unordered) sets."""
 
    __handled_types__ = (re.compile(r"(std::)?unordered_set<.*>$"),)
 
    def __init__(self, cpp_type, valueSem=None):
        super(SetSemantics, self).__init__(cpp_type)
        self.value_semantics = valueSem or getSemanticsFor(
            list(extract_template_args(cpp_type))[0]
        )
 
    @property
    def name(self):
        return self._name
 
    @name.setter
    def name(self, value):
        self._name = value
        self.value_semantics.name = "{} element".format(self._name)
 
    def store(self, value):
        # We support assignment from list for backwards compatibility
        if not isinstance(value, (set, _SetHelper, list, _ListHelper)):
            raise TypeError(
                "set expected, got {!r} in assignment to {}".format(value, self.name)
            )
 
        new_value = _SetHelper(self.value_semantics)
        new_value |= value
        return new_value
 
    def default(self, value):
        new_value = _SetHelper(self.value_semantics)
        new_value.default = value
        return new_value
 
    def opt_value(self, value):
        """
        Option string version of value.
        """
        if not isinstance(value, _SetHelper):
            value = self.default(value)
        return value.opt_value()
 
    def merge(self, bb, aa):
        aa |= bb
        return aa
 
 
class OrderedSetSemantics(SequenceSemantics):
    """
    Extend the sequence-semantics with a merge-method to behave like a
    OrderedSet: Values are unique but the order is maintained.
    Use 'OrderedSet<T>' as fifth parameter of the Gaudi::Property<T> constructor
    to invoke this merging method. Also applies to std::set.
    """
 
    __handled_types__ = (
        re.compile(r"(std::)?set<.*>$"),
        re.compile(r"^OrderedSet<.*>$"),
    )
 
    def __init__(self, cpp_type):
        super(OrderedSetSemantics, self).__init__(cpp_type)
 
    def merge(self, bb, aa):
        for b in bb:
            if b not in aa:
                aa.append(b)
        return aa
 
 
class _DictHelper(MutableMapping):
    def __init__(self, key_semantics, value_semantics):
        self.key_semantics = key_semantics
        self.value_semantics = value_semantics
        self.default = None
        self._data = {}
        self.is_dirty = False
 
    @property
    def data(self):
        return self._data if self.is_dirty else self.default
 
    def __len__(self):
        return len(self.data)
 
    def __getitem__(self, key):
        return self.value_semantics.load(
            self.data.__getitem__(self.key_semantics.store(key))
        )
 
    def __setitem__(self, key, value):
        self.is_dirty = True
        self.data.__setitem__(
            self.key_semantics.store(key), self.value_semantics.store(value)
        )
 
    def __delitem__(self, key):
        if not self.is_dirty:
            raise RuntimeError("cannot remove elements from the default value")
        self.data.__delitem__(self.key_semantics.store(key))
 
    def __iter__(self):
        for key in self.data:
            yield self.key_semantics.load(key)
 
    def keys(self):
        return list(self)
 
    def items(self):
        for key, value in self.data.items():
            yield (self.key_semantics.load(key), self.value_semantics.load(value))
 
    def values(self):
        for value in self.data.values():
            yield self.value_semantics.load(value)
 
    def __contains__(self, key):
        return self.key_semantics.store(key) in self.data
 
    def get(self, key, default=None):
        key = self.key_semantics.store(key)
        if key in self.data:
            return self.value_semantics.load(self.data[key])
        return default
 
    #  __contains__, , get, __eq__,  __ne__
    # popitem, clear, setdefault
 
    def update(self, otherMap):
        self.is_dirty = True
        for key, value in otherMap.items():
            self.data[self.key_semantics.store(key)] = self.value_semantics.store(value)
 
    def opt_value(self):
        return {
            self.key_semantics.opt_value(key): self.value_semantics.opt_value(value)
            for key, value in self.data.items()
        }
 
    def __repr__(self):
        return repr(self.data)
 
 
class MappingSemantics(PropertySemantics):
    __handled_types__ = (re.compile(r"(std::)?(unordered_)?map<.*>$"),)
 
    def __init__(self, cpp_type):
        super(MappingSemantics, self).__init__(cpp_type)
        template_args = list(extract_template_args(cpp_type))
        self.key_semantics = getSemanticsFor(template_args[0])
        self.value_semantics = getSemanticsFor(template_args[1])
 
    @property
    def name(self):
        return self._name
 
    @name.setter
    def name(self, value):
        self._name = value
        self.key_semantics.name = "{} key".format(self._name)
        self.value_semantics.name = "{} value".format(self._name)
 
    def store(self, value):
        # No explicit type checking as anything else than dict fails in update call
        new_value = _DictHelper(self.key_semantics, self.value_semantics)
        new_value.update(value)
        return new_value
 
    def default(self, value):
        new_value = _DictHelper(self.key_semantics, self.value_semantics)
        new_value.default = value
        return new_value
 
    def opt_value(self, value):
        """
        Option string version of value.
        """
        if not isinstance(value, _DictHelper):
            value = self.default(value)
        return value.opt_value()
 
    def merge(self, a, b):
        """Merge two maps. Throw ValueError if there are conflicting key/value pairs."""
 
        # Optimization for most common case
        if a == b:
            return a
 
        for k, v in b.items():
            try:
                va = a[k]
            except KeyError:
                a[k] = v
            else:
                if va != v:
                    raise ValueError(
                        f"conflicting values in map for key {k}: {v} and {va}"
                    )
        return a
 
 
SEMANTICS = [
    c
    for c in globals().values()
    if isinstance(c, type)
    and issubclass(c, PropertySemantics)
    and c not in (PropertySemantics, DefaultSemantics)
]
 
 
def getSemanticsFor(cpp_type, strict=False):
    """Return semantics for given type. If no type-specific semantics can be found
    return DefaultSemantics. In strict mode, raise a TypeError instead.
    """
 
    for semantics in SEMANTICS:
        try:
            return semantics(cpp_type)
        except TypeError:
            pass
 
    if strict:
        raise TypeError(f"No semantics found for {cpp_type}")
 
    return DefaultSemantics(cpp_type)