#!/usr/bin/env python # coding:utf-8 import copy import os import re import weakref import types import logging from collections.abc import Iterable, Sequence from string import Template from meshroom.common import BaseObject, Property, Variant, Signal, ListModel, DictModel, Slot from meshroom.core import desc, hashValue def attributeFactory(description, value, isOutput, node, root=None, parent=None): """ Create an Attribute based on description type. Args: description: the Attribute description value: value of the Attribute. Will be set if not None. isOutput: whether is Attribute is an output attribute. node (Node): node owning the Attribute. Note that the created Attribute is not added to Node's attributes root: (optional) parent Attribute (must be ListAttribute or GroupAttribute) parent (BaseObject): (optional) the parent BaseObject if any """ if isinstance(description, desc.GroupAttribute): cls = GroupAttribute elif isinstance(description, desc.ListAttribute): cls = ListAttribute elif isinstance(description, desc.ChoiceParam): cls = ChoiceParam elif isinstance(description, desc.PushButtonParam): cls = PushButtonParam else: cls = Attribute attr = cls(node, description, isOutput, root, parent) if value is not None: attr.value = value return attr class Attribute(BaseObject): """ """ stringIsLinkRe = re.compile(r'^\{[A-Za-z]+[A-Za-z0-9_.]*\}$') def __init__(self, node, attributeDesc, isOutput, root=None, parent=None): """ Attribute constructor Args: node (Node): the Node hosting this Attribute attributeDesc (desc.Attribute): the description of this Attribute isOutput (bool): whether this Attribute is an output of the Node root (Attribute): (optional) the root Attribute (List or Group) containing this one parent (BaseObject): (optional) the parent BaseObject """ super(Attribute, self).__init__(parent) self._name = attributeDesc.name self._root = None if root is None else weakref.ref(root) self._node = weakref.ref(node) self.attributeDesc = attributeDesc self._isOutput = isOutput self._value = copy.copy(attributeDesc.value) self._label = attributeDesc.label self._enabled = True self._validValue = True self._description = attributeDesc.description # invalidation value for output attributes self._invalidationValue = "" @property def node(self): return self._node() @property def root(self): return self._root() if self._root else None def getName(self): """ Attribute name """ return self._name def getFullName(self): """ Name inside the Graph: groupName.name """ if isinstance(self.root, ListAttribute): return '{}[{}]'.format(self.root.getFullName(), self.root.index(self)) elif isinstance(self.root, GroupAttribute): return '{}.{}'.format(self.root.getFullName(), self.getName()) return self.getName() def getFullNameToNode(self): """ Name inside the Graph: nodeName.groupName.name """ return '{}.{}'.format(self.node.name, self.getFullName()) def getFullNameToGraph(self): """ Name inside the Graph: graphName.nodeName.groupName.name """ graphName = self.node.graph.name if self.node.graph else "UNDEFINED" return '{}.{}'.format(graphName, self.getFullNameToNode()) def asLinkExpr(self): """ Return link expression for this Attribute """ return "{" + self.getFullNameToNode() + "}" def getType(self): return self.attributeDesc.__class__.__name__ def _isReadOnly(self): return not self._isOutput and self.node.isCompatibilityNode def getBaseType(self): return self.getType() def getLabel(self): return self._label @Slot(str, result=bool) def matchText(self, text): return self.fullLabel.lower().find(text.lower()) > -1 def getFullLabel(self): """ Full Label includes the name of all parent groups, e.g. 'groupLabel subGroupLabel Label' """ if isinstance(self.root, ListAttribute): return self.root.getFullLabel() elif isinstance(self.root, GroupAttribute): return '{} {}'.format(self.root.getFullLabel(), self.getLabel()) return self.getLabel() def getFullLabelToNode(self): """ Label inside the Graph: nodeLabel groupLabel Label """ return '{} {}'.format(self.node.label, self.getFullLabel()) def getFullLabelToGraph(self): """ Label inside the Graph: graphName nodeLabel groupLabel Label """ graphName = self.node.graph.name if self.node.graph else "UNDEFINED" return '{} {}'.format(graphName, self.getFullLabelToNode()) def getEnabled(self): if isinstance(self.desc.enabled, types.FunctionType): try: return self.desc.enabled(self.node) except: # Node implementation may fail due to version mismatch return True return self.attributeDesc.enabled def setEnabled(self, v): if self._enabled == v: return self._enabled = v self.enabledChanged.emit() def getUidIgnoreValue(self): """ Value for which the attribute should be ignored during the UID computation. """ return self.attributeDesc.uidIgnoreValue def getValidValue(self): """ Get the status of _validValue: - If it is a function, execute it and return the result - Otherwise, simply return its value """ if isinstance(self.desc.validValue, types.FunctionType): try: return self.desc.validValue(self.node) except Exception: return True return self._validValue def setValidValue(self, value): if self._validValue == value: return self._validValue = value def validateValue(self, value): return self.desc.validateValue(value) def _get_value(self): if self.isLink: return self.getLinkParam().value return self._value def _set_value(self, value): if self._value == value: return if isinstance(value, Attribute) or Attribute.isLinkExpression(value): # if we set a link to another attribute self._value = value else: # if we set a new value, we use the attribute descriptor validator to check the validity of the value # and apply some conversion if needed convertedValue = self.validateValue(value) self._value = convertedValue self.node.onAttributeChanged(self) # Request graph update when input parameter value is set # and parent node belongs to a graph # Output attributes value are set internally during the update process, # which is why we don't trigger any update in this case # TODO: update only the nodes impacted by this change # TODO: only update the graph if this attribute participates to a UID if self.isInput: self.requestGraphUpdate() # TODO: only call update of the node if the attribute is internal # Internal attributes are set as inputs self.requestNodeUpdate() self.valueChanged.emit() self.validValueChanged.emit() def _set_label(self, label): if self._label == label: return self._label = label self.labelChanged.emit() def _get_description(self): return self._description def _set_description(self, desc): if self._description == desc: return self._description = desc self.descriptionChanged.emit() def upgradeValue(self, exportedValue): self._set_value(exportedValue) def resetValue(self): self._value = self.attributeDesc.value def requestGraphUpdate(self): if self.node.graph: self.node.graph.markNodesDirty(self.node) self.node.graph.update() def requestNodeUpdate(self): # Update specific node information that do not affect the rest of the graph # (like internal attributes) if self.node: self.node.updateInternalAttributes() @property def isOutput(self): return self._isOutput @property def isInput(self): return not self._isOutput def uid(self, uidIndex=-1): """ """ # 'uidIndex' should be in 'self.desc.uid' but in the case of linked attribute # it will not be the case (so we cannot have an assert). if self.isOutput: # only dependent on the hash of its value without the cache folder return hashValue(self._invalidationValue) if self.isLink: return self.getLinkParam().uid(uidIndex) if isinstance(self._value, (list, tuple, set,)): # hash of sorted values hashed return hashValue([hashValue(v) for v in sorted(self._value)]) return hashValue(self._value) @property def isLink(self): """ Whether the input attribute is a link to another attribute. """ # note: directly use self.node.graph._edges to avoid using the property that may become invalid at some point return self.node.graph and self.isInput and self.node.graph._edges and self in self.node.graph._edges.keys() @staticmethod def isLinkExpression(value): """ Return whether the given argument is a link expression. A link expression is a string matching the {nodeName.attrName} pattern. """ return isinstance(value, str) and Attribute.stringIsLinkRe.match(value) def getLinkParam(self, recursive=False): if not self.isLink: return None linkParam = self.node.graph.edge(self).src if not recursive: return linkParam if linkParam.isLink: return linkParam.getLinkParam(recursive) return linkParam @property def hasOutputConnections(self): """ Whether the attribute has output connections, i.e is the source of at least one edge. """ # safety check to avoid evaluation errors if not self.node.graph or not self.node.graph.edges: return False return next((edge for edge in self.node.graph.edges.values() if edge.src == self), None) is not None def _applyExpr(self): """ For string parameters with an expression (when loaded from file), this function convert the expression into a real edge in the graph and clear the string value. """ v = self._value g = self.node.graph if not g: return if isinstance(v, Attribute): g.addEdge(v, self) self.resetValue() elif self.isInput and Attribute.isLinkExpression(v): # value is a link to another attribute link = v[1:-1] linkNode, linkAttr = link.split('.') try: g.addEdge(g.node(linkNode).attribute(linkAttr), self) except KeyError as err: logging.warning('Connect Attribute from Expression failed.\nExpression: "{exp}"\nError: "{err}".'.format(exp=v, err=err)) self.resetValue() def getExportValue(self): if self.isLink: return self.getLinkParam().asLinkExpr() if self.isOutput: return self.defaultValue() return self._value def getEvalValue(self): ''' Return the value. If it is a string, expressions will be evaluated. ''' if isinstance(self.value, str): return Template(self.value).safe_substitute(os.environ) return self.value def getValueStr(self, withQuotes=True): ''' Return the value formatted as a string with quotes to deal with spaces. If it is a string, expressions will be evaluated. If it is an empty string, it will returns 2 quotes. 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. ''' # ChoiceParam with multiple values should be combined if isinstance(self.attributeDesc, desc.ChoiceParam) and not self.attributeDesc.exclusive: # ensure value is a list as expected assert(isinstance(self.value, Sequence) and not isinstance(self.value, str)) v = self.attributeDesc.joinChar.join(self.getEvalValue()) if withQuotes and v: return '"{}"'.format(v) return v # String, File, single value Choice are based on strings and should includes quotes to deal with spaces if withQuotes and isinstance(self.attributeDesc, (desc.StringParam, desc.File, desc.ChoiceParam)): return '"{}"'.format(self.getEvalValue()) return str(self.getEvalValue()) def defaultValue(self): if isinstance(self.desc.value, types.FunctionType): return self.desc.value(self) # 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) def _isDefault(self): return self.value == self.defaultValue() def getPrimitiveValue(self, exportDefault=True): return self._value def updateInternals(self): # Emit if the enable status has changed self.setEnabled(self.getEnabled()) name = Property(str, getName, constant=True) fullName = Property(str, getFullName, constant=True) fullNameToNode = Property(str, getFullNameToNode, constant=True) fullNameToGraph = Property(str, getFullNameToGraph, constant=True) labelChanged = Signal() label = Property(str, getLabel, _set_label, notify=labelChanged) fullLabel = Property(str, getFullLabel, constant=True) fullLabelToNode = Property(str, getFullLabelToNode, constant=True) fullLabelToGraph = Property(str, getFullLabelToGraph, constant=True) type = Property(str, getType, constant=True) baseType = Property(str, getType, constant=True) isReadOnly = Property(bool, _isReadOnly, constant=True) # description of the attribute descriptionChanged = Signal() description = Property(str, _get_description, _set_description, notify=descriptionChanged) # definition of the attribute desc = Property(desc.Attribute, lambda self: self.attributeDesc, constant=True) valueChanged = Signal() value = Property(Variant, _get_value, _set_value, notify=valueChanged) valueStr = Property(Variant, getValueStr, notify=valueChanged) evalValue = Property(Variant, getEvalValue, notify=valueChanged) isOutput = Property(bool, isOutput.fget, constant=True) isLinkChanged = Signal() isLink = Property(bool, isLink.fget, notify=isLinkChanged) isLinkNested = isLink hasOutputConnectionsChanged = Signal() hasOutputConnections = Property(bool, hasOutputConnections.fget, notify=hasOutputConnectionsChanged) isDefault = Property(bool, _isDefault, notify=valueChanged) linkParam = Property(BaseObject, getLinkParam, notify=isLinkChanged) rootLinkParam = Property(BaseObject, lambda self: self.getLinkParam(recursive=True), notify=isLinkChanged) node = Property(BaseObject, node.fget, constant=True) enabledChanged = Signal() enabled = Property(bool, getEnabled, setEnabled, notify=enabledChanged) uidIgnoreValue = Property(Variant, getUidIgnoreValue, constant=True) validValueChanged = Signal() validValue = Property(bool, getValidValue, setValidValue, notify=validValueChanged) def raiseIfLink(func): """ If Attribute instance is a link, raise a RuntimeError.""" def wrapper(attr, *args, **kwargs): if attr.isLink: raise RuntimeError("Can't modify connected Attribute") return func(attr, *args, **kwargs) return wrapper class PushButtonParam(Attribute): def __init__(self, node, attributeDesc, isOutput, root=None, parent=None): super(PushButtonParam, self).__init__(node, attributeDesc, isOutput, root, parent) @Slot() def clicked(self): self.node.onAttributeClicked(self) class ChoiceParam(Attribute): def __init__(self, node, attributeDesc, isOutput, root=None, parent=None): super(ChoiceParam, self).__init__(node, attributeDesc, isOutput, root, parent) self._values = None def getValues(self): return self._values if self._values is not None else self.desc._values def conformValue(self, val): """ Conform 'val' to the correct type and check for its validity """ return self.desc.conformValue(val) def validateValue(self, value): if self.desc.exclusive: return self.conformValue(value) if isinstance(value, str): value = value.split(',') if not isinstance(value, Iterable): raise ValueError('Non exclusive ChoiceParam value should be iterable (param:{}, value:{}, type:{})'.format(self.name, value, type(value))) return [self.conformValue(v) for v in value] def setValues(self, values): if values == self._values: return self._values = values self.valuesChanged.emit() def __len__(self): return len(self.getValues()) valuesChanged = Signal() values = Property(Variant, getValues, setValues, notify=valuesChanged) class ListAttribute(Attribute): def __init__(self, node, attributeDesc, isOutput, root=None, parent=None): super(ListAttribute, self).__init__(node, attributeDesc, isOutput, root, parent) self._value = ListModel(parent=self) def __len__(self): return len(self._value) def getBaseType(self): return self.attributeDesc.elementDesc.__class__.__name__ def at(self, idx): """ Returns child attribute at index 'idx' """ # implement 'at' rather than '__getitem__' # since the later is called spuriously when object is used in QML return self._value.at(idx) def index(self, item): return self._value.indexOf(item) def resetValue(self): self._value = ListModel(parent=self) def _set_value(self, value): if self.node.graph: self.remove(0, len(self)) # Link to another attribute if isinstance(value, ListAttribute) or Attribute.isLinkExpression(value): self._value = value # New value else: newValue = self.desc.validateValue(value) self.extend(newValue) self.requestGraphUpdate() def upgradeValue(self, exportedValues): if not isinstance(exportedValues, list): if isinstance(exportedValues, ListAttribute) or Attribute.isLinkExpression(exportedValues): self._set_value(exportedValues) return raise RuntimeError("ListAttribute.upgradeValue: the given value is of type " + str(type(exportedValues)) + " but a 'list' is expected.") attrs = [] for v in exportedValues: a = attributeFactory(self.attributeDesc.elementDesc, None, self.isOutput, self.node, self) a.upgradeValue(v) attrs.append(a) index = len(self._value) self._value.insert(index, attrs) self.valueChanged.emit() self._applyExpr() self.requestGraphUpdate() @raiseIfLink def append(self, value): self.extend([value]) @raiseIfLink def insert(self, index, value): values = value if isinstance(value, list) else [value] attrs = [attributeFactory(self.attributeDesc.elementDesc, v, self.isOutput, self.node, self) for v in values] self._value.insert(index, attrs) self.valueChanged.emit() self._applyExpr() self.requestGraphUpdate() @raiseIfLink def extend(self, values): self.insert(len(self._value), values) @raiseIfLink def remove(self, index, count=1): if self.node.graph: from meshroom.core.graph import GraphModification with GraphModification(self.node.graph): # remove potential links for i in range(index, index + count): attr = self._value.at(i) if attr.isLink: # delete edge if the attribute is linked self.node.graph.removeEdge(attr) self._value.removeAt(index, count) self.requestGraphUpdate() self.valueChanged.emit() def uid(self, uidIndex): if isinstance(self.value, ListModel): uids = [] for value in self.value: if uidIndex in value.desc.uid: uids.append(value.uid(uidIndex)) return hashValue(uids) return super(ListAttribute, self).uid(uidIndex) def _applyExpr(self): if not self.node.graph: return if isinstance(self._value, ListAttribute) or Attribute.isLinkExpression(self._value): super(ListAttribute, self)._applyExpr() else: for value in self._value: value._applyExpr() def getExportValue(self): if self.isLink: return self.getLinkParam().asLinkExpr() return [attr.getExportValue() for attr in self._value] def defaultValue(self): return [] def _isDefault(self): return len(self._value) == 0 def getPrimitiveValue(self, exportDefault=True): if exportDefault: return [attr.getPrimitiveValue(exportDefault=exportDefault) for attr in self._value] else: return [attr.getPrimitiveValue(exportDefault=exportDefault) for attr in self._value if not attr.isDefault] def getValueStr(self, withQuotes=True): assert(isinstance(self.value, ListModel)) if self.attributeDesc.joinChar == ' ': return self.attributeDesc.joinChar.join([v.getValueStr(withQuotes=withQuotes) for v in self.value]) else: v = self.attributeDesc.joinChar.join([v.getValueStr(withQuotes=False) for v in self.value]) if withQuotes and v: return '"{}"'.format(v) return v def updateInternals(self): super(ListAttribute, self).updateInternals() for attr in self._value: attr.updateInternals() @property def isLinkNested(self): """ Whether the attribute or any of its elements is a link to another attribute. """ # note: directly use self.node.graph._edges to avoid using the property that may become invalid at some point return self.isLink \ or self.node.graph and self.isInput and self.node.graph._edges \ and any(v in self.node.graph._edges.keys() for v in self._value) # Override value property setter value = Property(Variant, Attribute._get_value, _set_value, notify=Attribute.valueChanged) isDefault = Property(bool, _isDefault, notify=Attribute.valueChanged) baseType = Property(str, getBaseType, constant=True) isLinkNested = Property(bool, isLinkNested.fget) class GroupAttribute(Attribute): def __init__(self, node, attributeDesc, isOutput, root=None, parent=None): super(GroupAttribute, self).__init__(node, attributeDesc, isOutput, root, parent) self._value = DictModel(keyAttrName='name', parent=self) subAttributes = [] for subAttrDesc in self.attributeDesc.groupDesc: childAttr = attributeFactory(subAttrDesc, None, self.isOutput, self.node, self) subAttributes.append(childAttr) childAttr.valueChanged.connect(self.valueChanged) self._value.reset(subAttributes) def __getattr__(self, key): try: return super(GroupAttribute, self).__getattr__(key) except AttributeError: try: return self._value.get(key) except KeyError: raise AttributeError(key) def _set_value(self, exportedValue): value = self.validateValue(exportedValue) if isinstance(value, dict): # set individual child attribute values for key, v in value.items(): self._value.get(key).value = v elif isinstance(value, (list, tuple)): if len(self.desc._groupDesc) != len(value): raise AttributeError("Incorrect number of values on GroupAttribute: {}".format(str(value))) for attrDesc, v in zip(self.desc._groupDesc, value): self._value.get(attrDesc.name).value = v else: raise AttributeError("Failed to set on GroupAttribute: {}".format(str(value))) def upgradeValue(self, exportedValue): value = self.validateValue(exportedValue) if isinstance(value, dict): # set individual child attribute values for key, v in value.items(): if key in self._value.keys(): self._value.get(key).upgradeValue(v) elif isinstance(value, (list, tuple)): if len(self.desc._groupDesc) != len(value): raise AttributeError("Incorrect number of values on GroupAttribute: {}".format(str(value))) for attrDesc, v in zip(self.desc._groupDesc, value): self._value.get(attrDesc.name).upgradeValue(v) else: raise AttributeError("Failed to set on GroupAttribute: {}".format(str(value))) @Slot(str, result=Attribute) def childAttribute(self, key): """ Get child attribute by name or None if none was found. Args: key (str): the name of the child attribute Returns: Attribute: the child attribute or None """ try: return self._value.get(key) except KeyError: return None def uid(self, uidIndex): uids = [] for k, v in self._value.items(): if v.enabled and uidIndex in v.desc.uid: uids.append(v.uid(uidIndex)) return hashValue(uids) def _applyExpr(self): for value in self._value: value._applyExpr() def getExportValue(self): return {key: attr.getExportValue() for key, attr in self._value.objects.items()} def _isDefault(self): return all(v.isDefault for v in self._value) def defaultValue(self): return {key: attr.defaultValue() for key, attr in self._value.items()} def getPrimitiveValue(self, exportDefault=True): if exportDefault: return {name: attr.getPrimitiveValue(exportDefault=exportDefault) for name, attr in self._value.items()} else: return {name: attr.getPrimitiveValue(exportDefault=exportDefault) for name, attr in self._value.items() if not attr.isDefault} def getValueStr(self, withQuotes=True): # add brackets if requested strBegin = '' strEnd = '' if self.attributeDesc.brackets is not None: if len(self.attributeDesc.brackets) == 2: strBegin = self.attributeDesc.brackets[0] strEnd = self.attributeDesc.brackets[1] else: raise AttributeError("Incorrect brackets on GroupAttribute: {}".format(self.attributeDesc.brackets)) # particular case when using space separator spaceSep = self.attributeDesc.joinChar == ' ' # sort values based on child attributes group description order sortedSubValues = [self._value.get(attr.name).getValueStr(withQuotes=spaceSep) for attr in self.attributeDesc.groupDesc] s = self.attributeDesc.joinChar.join(sortedSubValues) if withQuotes and not spaceSep: return '"{}{}{}"'.format(strBegin, s, strEnd) return '{}{}{}'.format(strBegin, s, strEnd) def updateInternals(self): super(GroupAttribute, self).updateInternals() for attr in self._value: attr.updateInternals() @Slot(str, result=bool) def matchText(self, text): return super().matchText(text) or any(c.matchText(text) for c in self._value) # Override value property value = Property(Variant, Attribute._get_value, _set_value, notify=Attribute.valueChanged) isDefault = Property(bool, _isDefault, notify=Attribute.valueChanged)