[core] Add 'strictCompatibility' mode for loadGraph function

Provide a way to control how to handle node compatibility issues
when loading a Graph with the `strictCompatibility` parameter.
Introduce a new error type, GraphCompatibilityError, to be raised
when loading a Graph with compatibility issues with strictCompatibility enabled.

Author: yann-lty

meshroom/core/exception.py

@@ -1,5 +1,9 @@
-#!/usr/bin/env python
 # coding:utf-8
+"""
+Module defining exceptions for Meshroom.
+"""
+
+from meshroom.core.typing import PathLike
 
 
 class MeshroomException(Exception):
@@ -12,6 +16,21 @@ class GraphException(MeshroomException):
     pass
 
 
+class GraphCompatibilityError(GraphException):
+    """
+    Raised when node compatibility issues occurs when loading a graph.
+    
+    Args:
+        filepath: The path to the file that caused the error.
+        issues: A dictionnary of node names and their respective compatibility issues.
+    """
+    def __init__(self, filepath: PathLike, issues: dict[str, str]) -> None:
+        self.filepath = filepath
+        self.issues = issues
+        msg = f"Compatibility issues found when loading {self.filepath}: {self.issues}"
+        super().__init__(msg)
+
+
 class UnknownNodeTypeError(GraphException):
     """
     Raised when asked to create a unknown node type.

meshroom/core/graph.py

@@ -15,8 +15,9 @@
 from meshroom.common import BaseObject, DictModel, Slot, Signal, Property
 from meshroom.core import Version
 from meshroom.core.attribute import Attribute, ListAttribute, GroupAttribute
-from meshroom.core.exception import StopGraphVisit, StopBranchVisit
+from meshroom.core.exception import GraphCompatibilityError, StopGraphVisit, StopBranchVisit
 from meshroom.core.node import nodeFactory, Status, Node, CompatibilityNode
+from meshroom.core.typing import PathLike
 
 # Replace default encoder to support Enums
 
@@ -1633,11 +1634,27 @@ def setVerbose(self, v):
     canComputeLeaves = Property(bool, lambda self: self._canComputeLeaves, notify=canComputeLeavesChanged)
 
 
-def loadGraph(filepath):
+def loadGraph(filepath: PathLike, strictCompatibility: bool = False) -> Graph:
     """
+    Load a Graph from a Meshroom Graph (.mg) file.
+
+    Args:
+        filepath: The path to the Meshroom Graph file.
+        strictCompatibility: If True, raise a GraphCompatibilityError if the loaded Graph has node compatibility issues.
+
+    Returns:
+        Graph: The loaded Graph instance.
+
+    Raises:
+        CompatibilityError: If the Graph has node compatibility issues and `strictCompatibility` is False.
     """
     graph = Graph("")
     graph.load(filepath)
+
+    compatibilityIssues = len(graph.compatibilityNodes) > 0
+    if compatibilityIssues and strictCompatibility:
+        raise GraphCompatibilityError(filepath, {n.name: str(n.issue) for n in graph.compatibilityNodes})
+
     graph.update()
     return graph
 

meshroom/core/typing.py

@@ -0,0 +1,6 @@
+import os
+from typing import Union
+
+
+# PathLike: A type that can be used to indicate a file system path.
+PathLike = Union[os.PathLike, bytes, str]