Hide keyboard shortcuts

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 

22 

23__all__ = ("QuantumNode", "NodeId", "BuildId") 

24 

25from dataclasses import dataclass 

26from typing import NewType 

27 

28from ..pipeline import TaskDef 

29from lsst.daf.butler import Quantum, DatasetRef 

30 

31BuildId = NewType("BuildId", str) 

32 

33 

34def _hashDsRef(ref: DatasetRef) -> int: 

35 return hash((ref.datasetType, ref.dataId)) 

36 

37 

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 through 

42 a pickle, and any `QuantumGraph` methods that return a new `QuantumGraph`. 

43 

44 A `NodeId` will not be the same if a new graph is built containing the same 

45 information in a `QuantumNode`, or even built from exactly the same inputs. 

46 

47 `NodeId`s do not play any role in deciding the equality or identity (hash) 

48 of a `QuantumNode`, and are mainly useful in debugging or working with 

49 various subsets of the same graph. 

50 

51 This interface is a convenance only, and no guarantees on long term 

52 stability are made. New implementations might change the `NodeId`, or 

53 provide more or less guarantees. 

54 """ 

55 number: int 

56 """The unique position of the node within the graph assigned at graph 

57 creation. 

58 """ 

59 buildId: BuildId 

60 """Unique identifier created at the time the originating graph was created 

61 """ 

62 

63 

64@dataclass(frozen=True) 

65class QuantumNode: 

66 """This class represents a node in the quantum graph. 

67 

68 The quantum attribute represents the data that is to be processed at this 

69 node. 

70 """ 

71 quantum: Quantum 

72 """The unit of data that is to be processed by this graph node""" 

73 taskDef: TaskDef 

74 """Definition of the task that will process the `Quantum` associated with 

75 this node. 

76 """ 

77 nodeId: NodeId 

78 """The unique position of the node within the graph assigned at graph 

79 creation. 

80 """ 

81 

82 def __eq__(self, other: object) -> bool: 

83 if not isinstance(other, QuantumNode): 

84 return False 

85 if self.quantum != other.quantum: 

86 return False 

87 return self.taskDef == other.taskDef 

88 

89 def __hash__(self) -> int: 

90 """For graphs it is useful to have a more robust hash than provided 

91 by the default quantum id based hashing 

92 """ 

93 return hash((self.taskDef, self.quantum))