Merge pull request #2629 from alicevision/dev/relativePaths

Add relative paths to nodes as variables

Author: cbentejac

meshroom/core/attribute.py

@@ -276,8 +276,11 @@ def uid(self):
                 # To guarantee that each output attribute receives a unique ID, we add the attribute name to it.
                 return hashValue((self.name, self.node._uid))
             else:
-                # only dependent on the hash of its value without the cache folder
-                return hashValue(self._invalidationValue)
+                # Only dependent on the hash of its value without the cache folder.
+                # "/" at the end of the link is stripped to prevent having different UIDs depending on
+                # whether the invalidation value finishes with it or not
+                strippedInvalidationValue = self._invalidationValue.rstrip("/")
+                return hashValue(strippedInvalidationValue)
         if self.isLink:
             linkParam = self.getLinkParam(recursive=True)
             return linkParam.uid()
@@ -362,7 +365,14 @@ 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)
+            substituted = Template(self.value).safe_substitute(os.environ)
+            try:
+                varResolved = substituted.format(**self.node._cmdVars)
+                return varResolved
+            except (KeyError, IndexError):
+                # Catch KeyErrors and IndexErros to be able to open files created prior to the support of
+                # relative variables (when self.node._cmdVars was not used to evaluate expressions in the attribute)
+                return substituted
         return self.value
 
     def getValueStr(self, withQuotes=True):

meshroom/core/desc/node.py

@@ -1,3 +1,5 @@
+from inspect import getfile
+from pathlib import Path
 import os
 import psutil
 import shlex
@@ -11,7 +13,6 @@
 class Node(object):
     """
     """
-    internalFolder = '{cache}/{nodeType}/{uid}/'
     cpu = Level.NORMAL
     gpu = Level.NONE
     ram = Level.NORMAL
@@ -63,6 +64,7 @@ class Node(object):
     def __init__(self):
         super(Node, self).__init__()
         self.hasDynamicOutputAttribute = any(output.isDynamicValue for output in self.outputs)
+        self.sourceCodeFolder = Path(getfile(self.__class__)).parent.resolve().as_posix()
 
     def upgradeAttributeValues(self, attrValues, fromVersion):
         return attrValues

meshroom/core/node.py

@@ -501,6 +501,7 @@ def __init__(self, nodeType, position=None, parent=None, uid=None, **kwargs):
 
         self.packageName = self.packageVersion = ""
         self._internalFolder = ""
+        self._sourceCodeFolder = ""
 
         self._name = None
         self.graph = None
@@ -757,6 +758,8 @@ def _buildAttributeCmdVars(cmdVars, name, attr):
 
         """ Generate command variables using input attributes and resolved output attributes names and values. """
         self._cmdVars["uid"] = self._uid
+        self._cmdVars["nodeCacheFolder"] = self.internalFolder
+        self._cmdVars["nodeSourceCodeFolder"] = self.sourceCodeFolder
 
         # Evaluate input params
         for name, attr in self._attributes.objects.items():
@@ -766,7 +769,11 @@ def _buildAttributeCmdVars(cmdVars, name, attr):
 
         # For updating output attributes invalidation values
         cmdVarsNoCache = self._cmdVars.copy()
-        cmdVarsNoCache['cache'] = ''
+        cmdVarsNoCache["cache"] = ""
+
+        # Use "self._internalFolder" instead of "self.internalFolder" because we do not want it to be
+        # resolved with the {cache} information ("self.internalFolder" resolves "self._internalFolder")
+        cmdVarsNoCache["nodeCacheFolder"] = self._internalFolder.format(**cmdVarsNoCache)
 
         # Evaluate output params
         for name, attr in self._attributes.objects.items():
@@ -1021,8 +1028,10 @@ def updateInternals(self, cacheDir=None):
 
         # Update command variables / output attributes
         self._cmdVars = {
-            'cache': cacheDir or self.graph.cacheDir,
-            'nodeType': self.nodeType,
+            "cache": cacheDir or self.graph.cacheDir,
+            "nodeType": self.nodeType,
+            "nodeCacheFolder": self._internalFolder,
+            "nodeSourceCodeFolder": self.sourceCodeFolder
         }
         self._computeUid()
         self._buildCmdVars()
@@ -1039,6 +1048,10 @@ def updateInternalAttributes(self):
     def internalFolder(self):
         return self._internalFolder.format(**self._cmdVars)
 
+    @property
+    def sourceCodeFolder(self):
+        return self._sourceCodeFolder
+
     def updateStatusFromCache(self):
         """
         Update node status based on status file content/existence.
@@ -1440,7 +1453,8 @@ def __init__(self, nodeType, position=None, parent=None, uid=None, **kwargs):
 
         self.packageName = self.nodeDesc.packageName
         self.packageVersion = self.nodeDesc.packageVersion
-        self._internalFolder = self.nodeDesc.internalFolder
+        self._internalFolder = "{cache}/{nodeType}/{uid}"
+        self._sourceCodeFolder = self.nodeDesc.sourceCodeFolder
 
         for attrDesc in self.nodeDesc.inputs:
             self._attributes.add(attributeFactory(attrDesc, kwargs.get(attrDesc.name, None), isOutput=False, node=self))

meshroom/nodes/aliceVision/ApplyCalibration.py

@@ -44,6 +44,6 @@ class ApplyCalibration(desc.AVCommandLineNode):
             name="output",
             label="SMData",
             description="Path to the output SfMData file.",
-            value=desc.Node.internalFolder + "sfmData.sfm",
+            value="{nodeCacheFolder}/sfmData.sfm",
         ),
     ]

meshroom/nodes/aliceVision/CameraCalibration.py

@@ -124,6 +124,6 @@ class CameraCalibration(desc.AVCommandLineNode):
             name="output",
             label="Output",
             description="Output filename for intrinsic [and extrinsic] parameters.",
-            value=desc.Node.internalFolder + "/cameraCalibration.cal",
+            value="{nodeCacheFolder}/cameraCalibration.cal",
         ),
     ]

meshroom/nodes/aliceVision/CameraInit.py

@@ -487,7 +487,7 @@ class CameraInit(desc.AVCommandLineNode, desc.InitNode):
             name="output",
             label="SfMData",
             description="Output SfMData.",
-            value=desc.Node.internalFolder + "cameraInit.sfm",
+            value="{nodeCacheFolder}/cameraInit.sfm",
         ),
     ]
 
@@ -671,7 +671,7 @@ def createViewpointsFile(self, node, additionalViews=()):
                 "featureFolder": "",
                 "matchingFolder": "",
             }
-            node.viewpointsFile = os.path.join(node.nodeDesc.internalFolder, 'viewpoints.sfm').format(**node._cmdVars)
+            node.viewpointsFile = os.path.join(node.internalFolder, 'viewpoints.sfm').format(**node._cmdVars)
             with open(node.viewpointsFile, 'w') as f:
                 json.dump(sfmData, f, indent=4)
 

meshroom/nodes/aliceVision/CameraLocalization.py

@@ -191,12 +191,12 @@ class CameraLocalization(desc.AVCommandLineNode):
             name="outputAlembic",
             label="Alembic",
             description="Filename for the SfMData export file (where camera poses will be stored).",
-            value=desc.Node.internalFolder + "trackedCameras.abc",
+            value="{nodeCacheFolder}/trackedCameras.abc",
         ),
         desc.File(
             name="outputJSON",
             label="JSON File",
             description="Filename for the localization results as .json.",
-            value=desc.Node.internalFolder + "trackedCameras.json",
+            value="{nodeCacheFolder}/trackedCameras.json",
         ),
     ]

meshroom/nodes/aliceVision/CameraRigCalibration.py

@@ -156,6 +156,6 @@ class CameraRigCalibration(desc.AVCommandLineNode):
             name="outfile",
             label="Output File",
             description="The name of the file to store the calibration data in.",
-            value=desc.Node.internalFolder + "cameraRigCalibration.rigCal",
+            value="{nodeCacheFolder}/cameraRigCalibration.rigCal",
         ),
     ]

meshroom/nodes/aliceVision/CameraRigLocalization.py

@@ -162,6 +162,6 @@ class CameraRigLocalization(desc.AVCommandLineNode):
             name="outputAlembic",
             label="Alembic",
             description="Filename for the SfMData export file (where camera poses will be stored).",
-            value=desc.Node.internalFolder + "trackedcameras.abc",
+            value="{nodeCacheFolder}/trackedcameras.abc",
         ),
     ]

meshroom/nodes/aliceVision/CheckerboardCalibration.py

@@ -47,6 +47,6 @@ class CheckerboardCalibration(desc.AVCommandLineNode):
             name="output",
             label="SfMData File",
             description="Path to the output SfMData file.",
-            value=desc.Node.internalFolder + "sfmData.sfm",
+            value="{nodeCacheFolder}/sfmData.sfm",
         )
     ]