Coverage for python/lsst/pipe/base/graph/quantumNode.py : 67%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# This file is part of pipe_base.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <http://www.gnu.org/licenses/>.
21from __future__ import annotations
23__all__ = ("QuantumNode", "NodeId", "BuildId")
25from dataclasses import dataclass
26from typing import NewType
28from ..pipeline import TaskDef
29from lsst.daf.butler import Quantum, DatasetRef
31BuildId = NewType("BuildId", str)
34def _hashDsRef(ref: DatasetRef) -> int:
35 return hash((ref.datasetType, ref.dataId))
38@dataclass(frozen=True, eq=True)
39class NodeId:
40 """This represents an unique identifier of a node within an individual
41 construction of a `QuantumGraph`. This identifier will stay constant
42 through a pickle, and any `QuantumGraph` methods that return a new
43 `QuantumGraph`.
45 A `NodeId` will not be the same if a new graph is built containing the same
46 information in a `QuantumNode`, or even built from exactly the same inputs.
48 `NodeId`s do not play any role in deciding the equality or identity (hash)
49 of a `QuantumNode`, and are mainly useful in debugging or working with
50 various subsets of the same graph.
52 This interface is a convenance only, and no guarantees on long term
53 stability are made. New implementations might change the `NodeId`, or
54 provide more or less guarantees.
55 """
56 number: int
57 """The unique position of the node within the graph assigned at graph
58 creation.
59 """
60 buildId: BuildId
61 """Unique identifier created at the time the originating graph was created
62 """
65@dataclass(frozen=True)
66class QuantumNode:
67 """This class represents a node in the quantum graph.
69 The quantum attribute represents the data that is to be processed at this
70 node.
71 """
72 quantum: Quantum
73 """The unit of data that is to be processed by this graph node"""
74 taskDef: TaskDef
75 """Definition of the task that will process the `Quantum` associated with
76 this node.
77 """
78 nodeId: NodeId
79 """The unique position of the node within the graph assigned at graph
80 creation.
81 """
83 def __eq__(self, other: object) -> bool:
84 if not isinstance(other, QuantumNode):
85 return False
86 if self.quantum != other.quantum:
87 return False
88 return self.taskDef == other.taskDef
90 def __hash__(self) -> int:
91 """For graphs it is useful to have a more robust hash than provided
92 by the default quantum id based hashing
93 """
94 return hash((self.taskDef, self.quantum))