Check Universe compatibility with Graph

If a DimensionUniverse is supplied, check that it is compatible with the one saved in the graph.
lsst · Jul 12, 2022 · d915d8a · d915d8a
1 parent 0b6582a
commit d915d8a
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 7 deletions.
diff --git a/python/lsst/pipe/base/graph/_loadHelpers.py b/python/lsst/pipe/base/graph/_loadHelpers.py
@@ -219,8 +219,9 @@ def load(
         universe: `~lsst.daf.butler.DimensionUniverse` or None
             DimensionUniverse instance, not used by the method itself but
             needed to ensure that registry data structures are initialized.
-            If None the universe saved with the graph is used if possible,
-            otherwise the global universe is used.
+            The universe saved with the graph is used, but if one is passed
+            it will be used to validate the compatibility with the loaded
+            graph universe.
         nodes : `Iterable` of `UUID` or `str`; or `None`
             The nodes to load from the graph, loads all if value is None
             (the default)
@@ -240,6 +241,9 @@ def load(
             Raised if one or more of the nodes requested is not in the
             `QuantumGraph` or if graphID parameter does not match the graph
             being loaded.
+        RuntimeError
+            Raise if Supplied DimensionUniverse is not compatible with the
+            DimensionUniverse saved in the graph
         """
         # verify this is the expected graph
         if graphID is not None and self.headerInfo._buildId != graphID:

diff --git a/python/lsst/pipe/base/graph/_versionDeserializers.py b/python/lsst/pipe/base/graph/_versionDeserializers.py
@@ -519,7 +519,12 @@ def constructGraph(
         taskToQuantumNode: DefaultDict[TaskDef, Set[QuantumNode]] = defaultdict(set)
         recontitutedDimensions: Dict[int, Tuple[str, DimensionRecord]] = {}
 
-        if universe is None:
+        if universe is not None:
+            if not universe.checkCompatibility(self.infoMappings.universe):
+                raise RuntimeError(
+                    "The saved dimension universe is not compatible with the supplied universe"
+                )
+        else:
             universe = self.infoMappings.universe
 
         for node in nodes:

diff --git a/python/lsst/pipe/base/graph/graph.py b/python/lsst/pipe/base/graph/graph.py
@@ -759,8 +759,9 @@ def loadUri(
         universe: `~lsst.daf.butler.DimensionUniverse` optional
             DimensionUniverse instance, not used by the method itself but
             needed to ensure that registry data structures are initialized.
-            If None it is loaded from the QuantumGraph saved structure. Only
-            pass this argument to overload explicitly.
+            If None it is loaded from the QuantumGraph saved structure. If
+            supplied, the DimensionUniverse from the loaded `QuantumGraph`
+            will be validated against the supplied argument for compatibility.
         nodes: iterable of `int` or None
             Numbers that correspond to nodes in the graph. If specified, only
             these nodes will be loaded. Defaults to None, in which case all
@@ -790,6 +791,9 @@ def loadUri(
             `QuantumGraph` or if graphID parameter does not match the graph
             being loaded or if the supplied uri does not point at a valid
             `QuantumGraph` save file.
+        RuntimeError
+            Raise if Supplied DimensionUniverse is not compatible with the
+            DimensionUniverse saved in the graph
 
 
         Notes
@@ -1036,8 +1040,9 @@ def load(
         universe: `~lsst.daf.butler.DimensionUniverse`, optional
             DimensionUniverse instance, not used by the method itself but
             needed to ensure that registry data structures are initialized.
-            If None it is loaded from the QuantumGraph saved structure. Only
-            pass this argument to overload explicitly.
+            If None it is loaded from the QuantumGraph saved structure. If
+            supplied, the DimensionUniverse from the loaded `QuantumGraph`
+            will be validated against the supplied argument for compatibility.
         nodes: iterable of `int` or None
             Numbers that correspond to nodes in the graph. If specified, only
             these nodes will be loaded. Defaults to None, in which case all