Coverage for tests/test_dataset_handle.py: 19%

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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28import unittest 

29 

30from lsst.daf.butler import DataCoordinate, DimensionUniverse, StorageClassConfig, StorageClassFactory 

31from lsst.daf.butler.tests import MetricsExample 

32from lsst.pipe.base import InMemoryDatasetHandle 

33 

34storageClasses = """ 

35Integer: 

36 pytype: int 

37StructuredDataTestDict: 

38 pytype: dict 

39StructuredDataTestList: 

40 pytype: list 

41 delegate: lsst.daf.butler.tests.ListDelegate 

42 parameters: 

43 - slice 

44 derivedComponents: 

45 counter: Integer 

46StructuredDataTest: 

47 # Data from a simple Python class 

48 pytype: lsst.daf.butler.tests.MetricsExample 

49 delegate: lsst.daf.butler.tests.MetricsDelegate 

50 # Use YAML formatter by default 

51 components: 

52 # Components are those supported by get. 

53 summary: StructuredDataTestDict 

54 output: StructuredDataTestDict 

55 data: StructuredDataTestList 

56 parameters: 

57 - slice 

58 derivedComponents: 

59 counter: Integer 

60MetricsConversion: 

61 # Special storage class to test conversions. 

62 pytype: lsst.daf.butler.tests.MetricsExampleModel 

63 delegate: lsst.daf.butler.tests.MetricsDelegate 

64 converters: 

65 lsst.daf.butler.tests.MetricsExample: lsst.daf.butler.tests.MetricsExampleModel.from_metrics 

66StructuredDataTestListSet: 

67 pytype: set 

68 converters: 

69 list: builtins.set 

70""" 

71 

72 

73class SpecialThing: 

74 """Class known not to have associated StorageClass""" 

75 

76 

77class NotCopyable(MetricsExample): 

78 """Subclass of metrics that can't be copied.""" 

79 

80 def __deepcopy__(self, memo=None): 

81 raise RuntimeError("Can not be copied") 

82 

83 

84class TestDatasetHandle(unittest.TestCase): 

85 """Test in-memory dataset handle.""" 

86 

87 @classmethod 

88 def setUpClass(cls): 

89 config = StorageClassConfig.fromYaml(storageClasses) 

90 cls.factory = StorageClassFactory() 

91 cls.factory.addFromConfig(config) 

92 

93 def test_dataset_handle_basic(self): 

94 inMemoryDataset = 42 

95 hdl = InMemoryDatasetHandle(inMemoryDataset) 

96 

97 self.assertEqual(hdl.get(), inMemoryDataset) 

98 

99 def test_dataset_handle_copy(self): 

100 inMemoryDataset = [1, 2] 

101 hdl = InMemoryDatasetHandle(inMemoryDataset, copy=False) 

102 

103 retrieved = hdl.get() 

104 self.assertEqual(retrieved, inMemoryDataset) 

105 retrieved.append(3) 

106 self.assertEqual(retrieved, inMemoryDataset) 

107 

108 hdl = InMemoryDatasetHandle(inMemoryDataset, copy=True) 

109 retrieved = hdl.get() 

110 self.assertEqual(retrieved, inMemoryDataset) 

111 retrieved.append(3) 

112 self.assertNotEqual(retrieved, inMemoryDataset) 

113 

114 inMemoryDataset = NotCopyable(summary={"a": 1, "b": 2}, output={"c": {"d": 5}}, data=[1, 2, 3, 4]) 

115 hdl = InMemoryDatasetHandle(inMemoryDataset) 

116 self.assertIs(hdl.get(), inMemoryDataset) 

117 

118 hdl = InMemoryDatasetHandle(inMemoryDataset, copy=True, storageClass="MetricsConversion") 

119 with self.assertRaises(NotImplementedError): 

120 hdl.get() 

121 

122 def test_dataset_handle_unknown(self): 

123 inMemoryDataset = SpecialThing() 

124 hdl = InMemoryDatasetHandle(inMemoryDataset) 

125 

126 self.assertEqual(hdl.get(), inMemoryDataset) 

127 

128 with self.assertRaises(KeyError): 

129 # Will not be able to find a matching StorageClass. 

130 hdl.get(parameters={"key": "value"}) 

131 

132 def test_dataset_handle_none(self): 

133 hdl = InMemoryDatasetHandle(None) 

134 self.assertIsNone(hdl.get()) 

135 self.assertIsNone(hdl.get(component="comp")) 

136 self.assertIsNone(hdl.get(parameters={"something": 42})) 

137 

138 def test_dataset_handle_dataid(self): 

139 hdl = InMemoryDatasetHandle(42) 

140 self.assertEqual(dict(hdl.dataId), {}) 

141 

142 dataId = DataCoordinate.makeEmpty(DimensionUniverse()) 

143 hdl = InMemoryDatasetHandle(42, dataId=dataId) 

144 self.assertIs(hdl.dataId, dataId) 

145 

146 dataId = {"tract": 5, "patch": 2, "instrument": "TestCam"} 

147 hdl = InMemoryDatasetHandle(42, **dataId) 

148 self.assertEqual(hdl.dataId, dataId) 

149 

150 hdl = InMemoryDatasetHandle(42, dataId=dataId, tract=6) 

151 self.assertEqual(hdl.dataId["tract"], 6) 

152 

153 dataId = DataCoordinate.standardize({}, universe=DimensionUniverse(), instrument="DummyCam") 

154 hdl = InMemoryDatasetHandle(42, dataId=dataId, physical_filter="g") 

155 self.assertIsInstance(hdl.dataId, DataCoordinate) 

156 self.assertEqual(hdl.dataId["physical_filter"], "g") 

157 

158 def test_dataset_handle_metric(self): 

159 metric = MetricsExample(summary={"a": 1, "b": 2}, output={"c": {"d": 5}}, data=[1, 2, 3, 4]) 

160 

161 # First with explicit storage class. 

162 hdl = InMemoryDatasetHandle(metric, storageClass="StructuredDataTest") 

163 retrieved = hdl.get() 

164 self.assertEqual(retrieved, metric) 

165 

166 data = hdl.get(component="data") 

167 self.assertEqual(data, metric.data) 

168 

169 # Now with implicit storage class. 

170 hdl = InMemoryDatasetHandle(metric) 

171 data = hdl.get(component="data") 

172 self.assertEqual(data, metric.data) 

173 

174 # Parameters. 

175 data = hdl.get(parameters={"slice": slice(2)}) 

176 self.assertEqual(data.summary, metric.summary) 

177 self.assertEqual(data.data, [1, 2]) 

178 

179 data = hdl.get(parameters={"slice": slice(2)}, component="data") 

180 self.assertEqual(data, [1, 2]) 

181 

182 # Use parameters in constructor and also override. 

183 hdl = InMemoryDatasetHandle(metric, storageClass="StructuredDataTest", parameters={"slice": slice(3)}) 

184 self.assertEqual(hdl.get(component="data"), [1, 2, 3]) 

185 self.assertEqual(hdl.get(component="counter"), 3) 

186 self.assertEqual(hdl.get(component="data", parameters={"slice": slice(1, 3)}), [2, 3]) 

187 self.assertEqual(hdl.get(component="counter", parameters={"slice": slice(1, 3)}), 2) 

188 

189 # Ensure the original has not been modified. 

190 self.assertEqual(len(metric.data), 4) 

191 

192 def test_handle_conversion(self): 

193 metric = MetricsExample(summary={"a": 1, "b": 2}, output={"c": {"d": 5}}, data=[1, 2, 3, 4]) 

194 

195 # Test conversion with no components or parameters. 

196 hdl = InMemoryDatasetHandle(metric) 

197 retrieved = hdl.get() # Reset the reference. 

198 converted = hdl.get(storageClass="MetricsConversion") 

199 self.assertIsNot(type(converted), type(retrieved)) 

200 self.assertEqual(retrieved, converted) 

201 

202 # Again with a full storage class. 

203 sc = self.factory.getStorageClass("MetricsConversion") 

204 converted2 = hdl.get(storageClass=sc) 

205 self.assertEqual(converted2, converted) 

206 

207 # Conversion of component. 

208 data = hdl.get(component="data", storageClass="StructuredDataTestListSet") 

209 self.assertIsInstance(data, set) 

210 self.assertEqual(data, set(converted.data)) 

211 

212 

213if __name__ == "__main__": 

214 unittest.main()