Merge pull request #2878 from alicevision/dev/attributeValues

[core] Add support for keyable attributes

Author: cbentejac

meshroom/core/attribute.py

@@ -9,7 +9,7 @@
 from string import Template
 from meshroom.common import BaseObject, Property, Variant, Signal, ListModel, DictModel, Slot
 from meshroom.core import desc, hashValue
-
+from meshroom.core.keyValues import KeyValues
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -77,6 +77,7 @@ def __init__(self, node, attributeDesc: desc.Attribute, isOutput: bool, root=Non
         self._invalidate = False if self._isOutput else attributeDesc.invalidate
         self._invalidationValue = "" # invalidation value for output attributes
         self._value = None
+        self._keyValues = None # list of pairs (key, value) for keyable attribute
         self._initValue()
 
     def _getFullName(self) -> str:
@@ -119,7 +120,12 @@ def _initValue(self):
         Initialize the attribute value.
         Called in the attribute factory for each attributes.
         """
-        if self._desc._valueType is not None:
+        if self._desc.keyable:
+            # Keyable attribute, initialize keyValues from attribute description
+            self._keyValues = KeyValues(self._desc)
+            # Send signal and updates if keyValues changed
+            self._keyValues.pairsChanged.connect(self._onKeyValuesChanged)
+        elif self._desc._valueType is not None:
             self._value = self._desc._valueType()
 
     def _getEvalValue(self):
@@ -144,6 +150,8 @@ def _getValue(self):
         """
         Return the value of the attribute or the linked attribute value.
         """
+        if self.keyable:
+            raise RuntimeError(f"Cannot get value of {self._getFullName()}, the attribute is keyable.")
         if self.isLink:
             return self._getInputLink().value
         return self._value
@@ -157,6 +165,14 @@ def _setValue(self, value):
         if isinstance(value, Attribute) or Attribute.isLinkExpression(value):
             # if we set a link to another attribute
             self._value = value
+            if self.keyable:
+                self._keyValues.reset()
+        elif self.keyable and isinstance(value, dict):
+            # keyable attribute initialize from a dict
+            self.keyValues.resetFromDict(value)
+        elif self.keyable:
+            # keyable attribute but value is not a dict
+            raise RuntimeError(f"Cannot set value of {self._getFullName()}, the attribute is keyable.")
         elif callable(value):
             # evaluate the function
             self._value = value(self)
@@ -178,6 +194,16 @@ def _setValue(self, value):
             self.requestNodeUpdate()
         self.valueChanged.emit()
 
+    def _getKeyValues(self):
+        """
+        Return the per-key values object of the attribute or of the linked attribute.
+        """
+        if not self.keyable:
+            raise RuntimeError(f"Cannot get keyValues of {self._getFullName()}, the attribute is not keyable.")
+        if self.isLink:
+            return self._getInputLink().keyValues
+        return self._keyValues
+
     def _applyExpr(self):
         """
         For string parameters with an expression (when loaded from file),
@@ -214,7 +240,11 @@ def resetToDefaultValue(self):
         """
         Reset the attribute to its default value.
         """
-        self._setValue(copy.copy(self.getDefaultValue()))
+        if self.keyable:
+            self._value = None
+            self._keyValues.reset()
+        else:
+            self._setValue(copy.copy(self.getDefaultValue()))
 
     def getDefaultValue(self):
         """
@@ -227,6 +257,9 @@ def getDefaultValue(self):
                 if not self.node.isCompatibilityNode:
                     logging.warning(f"Failed to evaluate 'defaultValue' (node lambda) for attribute '{self.fullName}': {e}")
                 return None
+        # keyable attribute default value
+        if self.keyable:
+            return {}
         # Need to force a copy, for the case where the value is a list
         # (avoid reference to the desc value)
         return copy.copy(self._desc.value)
@@ -237,6 +270,8 @@ def getSerializedValue(self):
         """
         if self.isLink:
             return self._getInputLink().asLinkExpr()
+        if self.keyable:
+            return self._keyValues.getSerializedValues()
         if self.isOutput and self._desc.isExpression:
             return self.getDefaultValue()
         return self.value
@@ -252,6 +287,9 @@ def getValueStr(self, withQuotes=True) -> str:
         If it is an empty list, it will returns a really empty string.
         If it is a list with one empty string element, it will returns 2 quotes.
         """
+        # Keyable attribute, for now return the list of pairs as a JSON sting
+        if self.keyable:
+            return self._keyValues.getJson()
         # ChoiceParam with multiple values should be combined
         if isinstance(self._desc, desc.ChoiceParam) and not self._desc.exclusive:
             # Ensure value is a list as expected
@@ -278,6 +316,12 @@ def upgradeValue(self, exportedValue):
         """
         self._setValue(exportedValue)
 
+    def _isDefault(self):
+        if self.keyable:
+            return len(self._keyValues.pairs) == 0
+        else:
+            return self._getValue() == self.getDefaultValue()
+        
     def _isValid(self):
         """
         Check attribute description validValue:
@@ -333,6 +377,8 @@ def uid(self) -> str:
         if self.isLink:
             linkRootAttribute = self._getInputLink(recursive=True)
             return linkRootAttribute.uid()
+        if self.keyable:
+            return self._keyValues.uid()
         if isinstance(self._value, (list, tuple, set,)):
             # non-exclusive choice param
             # hash of sorted values hashed
@@ -425,6 +471,17 @@ def _hasAnyOutputLinks(self) -> bool:
 
     # Slots
 
+    @Slot()
+    def _onKeyValuesChanged(self):
+        """
+        For keyable attribute, when the list or pairs (key, value) is modified this method should be called.
+        Emit Attribute.valueChanged and update node / graph like _setValue().
+        """
+        if self.isInput:
+            self.requestGraphUpdate()
+            self.requestNodeUpdate()
+        self.valueChanged.emit()
+
     @Slot()
     def _onValueChanged(self):
         self.node._onAttributeChanged(self)
@@ -469,9 +526,13 @@ def matchText(self, text: str) -> bool:
     valueChanged = Signal()
     value = Property(Variant, _getValue, _setValue, notify=valueChanged)
     evalValue = Property(Variant, _getEvalValue, notify=valueChanged)
+    # Whether the attribute can have a distinct value per key.
+    keyable = Property(bool, lambda self: self._desc.keyable, constant=True)
+    # The list of pairs (key, value) of the attribute.
+    keyValues = Property(Variant, _getKeyValues, notify=valueChanged)
 
     # Whether the attribute value is the default value.
-    isDefault = Property(bool, lambda self: self.value == self.getDefaultValue(), notify=valueChanged)
+    isDefault = Property(bool, _isDefault, notify=valueChanged)
     # Whether the attribute value is valid.
     isValid = Property(bool, _isValid, notify=valueChanged)
     # Whether the attribute value is displayable in 2d.

meshroom/core/desc/attribute.py

@@ -10,13 +10,16 @@ class Attribute(BaseObject):
     """
     """
 
-    def __init__(self, name, label, description, value, advanced, semantic, group, enabled, invalidate=True,
-                 uidIgnoreValue=None, validValue=True, errorMessage="", visible=True, exposed=False):
+    def __init__(self, name, label, description, value, advanced, semantic, group, enabled, 
+                 keyable=False, keyType=None, invalidate=True, uidIgnoreValue=None, 
+                 validValue=True, errorMessage="", visible=True, exposed=False):
         super(Attribute, self).__init__()
         self._name = name
         self._label = label
         self._description = description
         self._value = value
+        self._keyable = keyable
+        self._keyType = keyType
         self._group = group
         self._advanced = advanced
         self._enabled = enabled
@@ -46,6 +49,15 @@ def validateValue(self, value):
         """
         raise NotImplementedError("Attribute.validateValue is an abstract function that should be "
                                   "implemented in the derived class.")
+    
+    def validateKeyValues(self, keyValues):
+        """ Return validated/conformed 'keyValues'.
+
+        Raises:
+            ValueError: if a value does not have the proper type
+        """
+        return isinstance(keyValues, dict) and \
+               all(isinstance(k, str) and self.validateValue(v) for k,v in keyValues.items())
 
     def checkValueTypes(self):
         """ Returns the attribute's name if the default value's type is invalid or if the range's type (when available)
@@ -65,7 +77,10 @@ def matchDescription(self, value, strict=True):
             strict: strict test for the match (for instance, regarding a group with some parameter changes)
         """
         try:
-            self.validateValue(value)
+            if self._keyable:
+                self.validateKeyValues(value)
+            else:
+                self.validateValue(value)
         except ValueError:
             return False
         return True
@@ -82,6 +97,14 @@ def matchDescription(self, value, strict=True):
     #   The default value of the attribute's descriptor is None, so it is not an input value,
     #   but an output value that is computed during the Node's process execution.
     isDynamicValue = Property(bool, lambda self: self._isDynamicValue, constant=True)
+    # keyable:
+    #   Whether the attribute can have a distinct value per key.
+    #   By default, atribute value is not keyable.
+    keyable = Property(bool, lambda self: self._keyable, constant=True)
+    # keyType:
+    #   The type of key corresponding to the attribute value.
+    #   This property only makes sense for keyable attributes.
+    keyType = Property(str, lambda self: self._keyType, constant=True)
     group = Property(str, lambda self: self._group, constant=True)
     advanced = Property(bool, lambda self: self._advanced, constant=True)
     enabled = Property(Variant, lambda self: self._enabled, constant=True)
@@ -265,11 +288,13 @@ def retrieveChildrenInvalidations(self):
 class Param(Attribute):
     """
     """
-    def __init__(self, name, label, description, value, group, advanced, semantic, enabled, invalidate=True,
-                 uidIgnoreValue=None, validValue=True, errorMessage="", visible=True, exposed=False):
+    def __init__(self, name, label, description, value, group, advanced, semantic, enabled, 
+                 keyable=False, keyType=None, invalidate=True, uidIgnoreValue=None, 
+                 validValue=True, errorMessage="", visible=True, exposed=False):
         super(Param, self).__init__(name=name, label=label, description=description, value=value,
-                                    group=group, advanced=advanced, enabled=enabled, invalidate=invalidate,
-                                    semantic=semantic, uidIgnoreValue=uidIgnoreValue, validValue=validValue,
+                                    keyable=keyable, keyType=keyType, group=group, advanced=advanced, 
+                                    enabled=enabled, invalidate=invalidate, semantic=semantic, 
+                                    uidIgnoreValue=uidIgnoreValue, validValue=validValue,
                                     errorMessage=errorMessage, visible=visible, exposed=exposed)
 
 
@@ -302,11 +327,13 @@ def checkValueTypes(self):
 class BoolParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, group="allParams", advanced=False, enabled=True,
-                 invalidate=True, semantic="", visible=True, exposed=False):
+    def __init__(self, name, label, description, value, keyable=False, keyType=None, 
+                 group="allParams", advanced=False, enabled=True, invalidate=True, 
+                 semantic="", visible=True, exposed=False):
         super(BoolParam, self).__init__(name=name, label=label, description=description, value=value,
-                                        group=group, advanced=advanced, enabled=enabled, invalidate=invalidate,
-                                        semantic=semantic, visible=visible, exposed=exposed)
+                                        keyable=keyable, keyType=keyType, group=group, advanced=advanced, 
+                                        enabled=enabled, invalidate=invalidate, semantic=semantic, 
+                                        visible=visible, exposed=exposed)
         self._valueType = bool
 
     def validateValue(self, value):
@@ -330,12 +357,14 @@ def checkValueTypes(self):
 class IntParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, range=None, group="allParams", advanced=False, enabled=True,
-                 invalidate=True, semantic="", validValue=True, errorMessage="", visible=True, exposed=False):
+    def __init__(self, name, label, description, value, range=None, keyable=False, keyType=None, 
+                 group="allParams", advanced=False, enabled=True, invalidate=True, semantic="", 
+                 validValue=True, errorMessage="", visible=True, exposed=False):
         self._range = range
         super(IntParam, self).__init__(name=name, label=label, description=description, value=value,
-                                       group=group, advanced=advanced, enabled=enabled, invalidate=invalidate,
-                                       semantic=semantic, validValue=validValue, errorMessage=errorMessage,
+                                       keyable=keyable, keyType=keyType, group=group, advanced=advanced, 
+                                       enabled=enabled, invalidate=invalidate, semantic=semantic, 
+                                       validValue=validValue, errorMessage=errorMessage,
                                        visible=visible, exposed=exposed)
         self._valueType = int
 
@@ -360,12 +389,14 @@ def checkValueTypes(self):
 class FloatParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, range=None, group="allParams", advanced=False, enabled=True,
-                 invalidate=True, semantic="", validValue=True, errorMessage="", visible=True, exposed=False):
+    def __init__(self, name, label, description, value, range=None, keyable=False, keyType=None, 
+                 group="allParams", advanced=False, enabled=True, invalidate=True, semantic="", 
+                 validValue=True, errorMessage="", visible=True, exposed=False):
         self._range = range
         super(FloatParam, self).__init__(name=name, label=label, description=description, value=value,
-                                         group=group, advanced=advanced, enabled=enabled, invalidate=invalidate,
-                                         semantic=semantic, validValue=validValue, errorMessage=errorMessage,
+                                         keyable=keyable, keyType=keyType, group=group, advanced=advanced, 
+                                         enabled=enabled, invalidate=invalidate, semantic=semantic, 
+                                         validValue=validValue, errorMessage=errorMessage,
                                          visible=visible, exposed=exposed)
         self._valueType = float