Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add relative paths to nodes as variables #2629

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open

Conversation

cbentejac
Copy link
Contributor

@cbentejac cbentejac commented Dec 26, 2024

Description

This PR will invalidate all pre-existing graphs.

Failures of the CI will be solved when the following PR will be merged: alicevision/meshroomNodes#12.

This PR adds new variables that can be used in the description of nodes to write relative paths. For each Node object, there are currently two variables that are available by default:

  • {nodeCacheFolder}, which points towards the cache folder for this node (and is effectively the same as desc.Node.internalFolder);
  • {nodeSourceCodeFolder}, which points towards the folder containing the node's description.

These variables are resolved with the cmdVars dictionary, which contains essentially the {"key": "value"} mapping for all the attributes in a node's command line. desc.Node.internalFolder is removed as its purpose is fully replaced by {nodeCacheFolder}, and {nodeSourceCodeFolder} replaces the absolute path for the Blender script in the ScenePreview node.

Features

  • Add {nodeCacheFolder} and {nodeSourceCodeFolder} to the list of command-line variables
  • Fix "Open File" links in the Node Editor

Implementation remarks

For output attributes, we implement a change that will invalidate almost all pre-existing graphs: when computing an output attribute, we want "/path/to/something" to evaluate to the same thing as "/path/to/something/". right-handed "/" are thus stripped from invalidation values when evaluating the UID for an output attribute. This causes all the nodes which had outputs finishing with a "/" to evaluate to a new UID.

@cbentejac cbentejac added this to the Meshroom 2024.1.0 milestone Dec 26, 2024
@cbentejac cbentejac self-assigned this Dec 26, 2024
@cbentejac cbentejac force-pushed the dev/relativePaths branch 2 times, most recently from 53206f9 to 34e1495 Compare December 27, 2024 08:52
Copy link

codecov bot commented Dec 27, 2024

Codecov Report

Attention: Patch coverage is 94.66667% with 8 lines in your changes missing coverage. Please review.

Project coverage is 70.47%. Comparing base (e43cd62) to head (11d9b40).
Report is 23 commits behind head on develop.

Files with missing lines Patch % Lines
meshroom/nodes/aliceVision/ImageProcessing.py 25.00% 3 Missing ⚠️
tests/test_nodeDynamicEnvVars.py 97.56% 3 Missing ⚠️
meshroom/core/desc/attribute.py 0.00% 1 Missing ⚠️
tests/nodes/test/RelativePaths.py 85.71% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2629      +/-   ##
===========================================
+ Coverage    69.93%   70.47%   +0.53%     
===========================================
  Files          121      123       +2     
  Lines         7088     7231     +143     
===========================================
+ Hits          4957     5096     +139     
- Misses        2131     2135       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cbentejac cbentejac force-pushed the dev/relativePaths branch 8 times, most recently from 8c37fd0 to 3042f94 Compare December 27, 2024 13:42
@cbentejac cbentejac marked this pull request as ready for review December 27, 2024 14:31
meshroom/nodes/aliceVision/CameraCalibration.py Outdated Show resolved Hide resolved
meshroom/core/node.py Outdated Show resolved Hide resolved
meshroom/core/node.py Outdated Show resolved Hide resolved
meshroom/core/node.py Outdated Show resolved Hide resolved
Copy link
Member

@fabiencastan fabiencastan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I should have seen that in the first review...

meshroom/core/desc/node.py Outdated Show resolved Hide resolved
meshroom/core/node.py Outdated Show resolved Hide resolved
This property stores the location of the source code for a given node
and is not exposed to the QML side.
@cbentejac cbentejac marked this pull request as draft January 8, 2025 16:41
@cbentejac cbentejac added the invalidate:graph Invalidates the cache of the entire computation graph. label Jan 14, 2025
Add 2 default entries to the command line variables:
- `nodeCacheFolder`, which contains the location of the cache folder
- `nodeSourceCodeFolder`, which contains the location of the file
describing the node
This is fully replaced with `{nodeCacheFolder}`.
By doing so, invalidation values will evaluate to the same UID
independently from whether the attribute's value has been written
with an extra "/" or not.
Otherwise, input attributes with variables (either environment ones
or local ones) cannot be opened through "Open File", even though "Open
Containing Folder" works fine.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalidate:graph Invalidates the cache of the entire computation graph.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants