Coverage for tests/test_taskmetadata.py: 7%
160 statements
« prev ^ index » next coverage.py v7.3.0, created at 2023-08-31 09:39 +0000
« prev ^ index » next coverage.py v7.3.0, created at 2023-08-31 09:39 +0000
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# (https://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 <https://www.gnu.org/licenses/>.
22import json
23import unittest
25try:
26 import numpy
27except ImportError:
28 numpy = None
30from lsst.pipe.base import TaskMetadata
33class TaskMetadataTestCase(unittest.TestCase):
34 """Test task metadata."""
36 def testTaskMetadata(self):
37 """Full test of TaskMetadata API."""
38 meta = TaskMetadata()
39 meta["test"] = 42
40 self.assertEqual(meta["test"], 42)
41 meta.add("test", 55)
42 self.assertEqual(meta["test"], 55)
43 meta.add("test", [1, 2])
44 self.assertEqual(meta.getScalar("test"), 2)
45 self.assertEqual(meta.getArray("test"), [42, 55, 1, 2])
46 self.assertEqual(meta.get("test"), 2)
47 meta["new.int"] = 30
48 self.assertEqual(meta["new.int"], 30)
49 self.assertEqual(meta.get("new.int", 20), 30)
50 self.assertEqual(meta.get("not.present.at.all", 20), 20)
51 self.assertEqual(meta["new"]["int"], 30)
52 self.assertEqual(meta.get("new").get("int"), 30)
53 self.assertEqual(meta.getArray("new.int"), [30])
54 self.assertEqual(meta.getScalar("new.int"), 30)
55 self.assertIsInstance(meta["new"], TaskMetadata)
56 self.assertIsInstance(meta.getScalar("new"), TaskMetadata)
57 self.assertIsInstance(meta.getArray("new")[0], TaskMetadata)
58 self.assertIsInstance(meta.get("new"), TaskMetadata)
59 meta.add("new.int", 24)
60 self.assertEqual(meta["new.int"], 24)
61 meta["new.str"] = "str"
62 self.assertEqual(meta["new.str"], "str")
64 meta["test"] = "string"
65 self.assertEqual(meta["test"], "string")
67 self.assertIn("test", meta)
68 self.assertIn("new", meta)
69 self.assertIn("new.int", meta)
70 self.assertNotIn("new2.int", meta)
71 self.assertNotIn("test2", meta)
73 self.assertEqual(meta.paramNames(topLevelOnly=False), {"test", "new.int", "new.str"})
74 self.assertEqual(meta.paramNames(topLevelOnly=True), {"test"})
75 self.assertEqual(meta.names(), {"test", "new", "new.int", "new.str"})
76 self.assertEqual(meta.keys(), ("test", "new"))
77 self.assertEqual(len(meta), 2)
78 self.assertEqual(len(meta["new"]), 2)
80 meta["new_array"] = ("a", "b")
81 self.assertEqual(meta["new_array"], "b")
82 self.assertEqual(meta.getArray("new_array"), ["a", "b"])
83 meta.add("new_array", "c")
84 self.assertEqual(meta["new_array"], "c")
85 self.assertEqual(meta.getArray("new_array"), ["a", "b", "c"])
86 meta["new_array"] = [1, 2, 3]
87 self.assertEqual(meta.getArray("new_array"), [1, 2, 3])
89 meta["meta"] = 5
90 meta["meta"] = TaskMetadata()
91 self.assertIsInstance(meta["meta"], TaskMetadata)
92 meta["meta.a.b"] = "deep"
93 self.assertEqual(meta["meta.a.b"], "deep")
94 self.assertIsInstance(meta["meta.a"], TaskMetadata)
96 meta.add("via_scalar", 22)
97 self.assertEqual(meta["via_scalar"], 22)
99 del meta["test"]
100 self.assertNotIn("test", meta)
101 del meta["new.int"]
102 self.assertNotIn("new.int", meta)
103 self.assertIn("new", meta)
104 with self.assertRaises(KeyError):
105 del meta["test2"]
106 with self.assertRaises(KeyError) as cm:
107 # Check that deleting a hierarchy that is not present also
108 # reports the correct key.
109 del meta["new.a.b.c"]
110 self.assertIn("new.a.b.c", str(cm.exception))
112 with self.assertRaises(KeyError) as cm:
113 # Something that doesn't exist at all.
114 meta["something.a.b"]
115 # Ensure that the full key hierarchy is reported in the error message.
116 self.assertIn("something.a.b", str(cm.exception))
118 with self.assertRaises(KeyError) as cm:
119 # Something that does exist at level 2 but not further down.
120 meta["new.str.a"]
121 # Ensure that the full key hierarchy is reported in the error message.
122 self.assertIn("new.str.a", str(cm.exception))
124 with self.assertRaises(KeyError) as cm:
125 # Something that only exists at level 1.
126 meta["new.str3"]
127 # Ensure that the full key hierarchy is reported in the error message.
128 self.assertIn("new.str3", str(cm.exception))
130 with self.assertRaises(KeyError) as cm:
131 # Something that only exists at level 1 but as an array.
132 meta.getArray("new.str3")
133 # Ensure that the full key hierarchy is reported in the error message.
134 self.assertIn("new.str3", str(cm.exception))
136 with self.assertRaises(ValueError):
137 meta.add("new", 1)
139 with self.assertRaises(KeyError):
140 meta[42]
142 with self.assertRaises(KeyError):
143 meta["not.present"]
145 with self.assertRaises(KeyError):
146 meta["not_present"]
148 with self.assertRaises(KeyError):
149 meta.getScalar("not_present")
151 with self.assertRaises(KeyError):
152 meta.getArray("not_present")
154 def testValidation(self):
155 """Test that validation works."""
156 meta = TaskMetadata()
158 class BadThing:
159 pass
161 with self.assertRaises(ValueError):
162 meta["bad"] = BadThing()
164 with self.assertRaises(ValueError):
165 meta["bad_list"] = [BadThing()]
167 meta.add("int", 4)
168 with self.assertRaises(ValueError):
169 meta.add("int", "string")
171 with self.assertRaises(ValueError):
172 meta.add("mapping", {})
174 with self.assertRaises(ValueError):
175 meta.add("int", ["string", "array"])
177 with self.assertRaises(ValueError):
178 meta["mixed"] = [1, "one"]
180 def testDict(self):
181 """Construct a TaskMetadata from a dictionary."""
182 d = {"a": "b", "c": 1, "d": [1, 2], "e": {"f": "g", "h": {"i": [3, 4]}}}
184 meta = TaskMetadata.from_dict(d)
185 self.assertEqual(meta["a"], "b")
186 self.assertEqual(meta["e.f"], "g")
187 self.assertEqual(meta.getArray("d"), [1, 2])
188 self.assertEqual(meta["e.h.i"], 4)
190 d2 = meta.to_dict()
191 self.assertEqual(d2, d)
193 j = meta.json()
194 meta2 = TaskMetadata.parse_obj(json.loads(j))
195 self.assertEqual(meta2, meta)
197 # Round trip.
198 meta3 = TaskMetadata.from_metadata(meta)
199 self.assertEqual(meta3, meta)
201 # Add a new element that would be a single-element array.
202 # This will not equate as equal because from_metadata will move
203 # the item to the scalar part of the model and pydantic does not
204 # see them as equal.
205 meta3.add("e.new", 5)
206 meta4 = TaskMetadata.from_metadata(meta3)
207 self.assertNotEqual(meta4, meta3)
208 self.assertEqual(meta4["e.new"], meta3["e.new"])
209 del meta4["e.new"]
210 del meta3["e.new"]
211 self.assertEqual(meta4, meta3)
213 @unittest.skipIf(not numpy, "Numpy is required for this test.")
214 def testNumpy(self):
215 meta = TaskMetadata()
216 meta["int"] = numpy.int64(42)
217 self.assertEqual(meta["int"], 42)
218 self.assertEqual(type(meta["int"]), int)
220 meta["float"] = numpy.float64(3.14)
221 self.assertEqual(meta["float"], 3.14)
222 self.assertEqual(type(meta["float"]), float)
224 meta.add("floatArray", [numpy.float64(1.5), numpy.float64(3.0)])
225 self.assertEqual(meta.getArray("floatArray"), [1.5, 3.0])
226 self.assertEqual(type(meta["floatArray"]), float)
228 meta.add("intArray", [numpy.int64(1), numpy.int64(3)])
229 self.assertEqual(meta.getArray("intArray"), [1, 3])
230 self.assertEqual(type(meta["intArray"]), int)
232 with self.assertRaises(ValueError):
233 meta.add("mixed", [1.5, numpy.float64(4.5)])
235 with self.assertRaises(ValueError):
236 meta["numpy"] = numpy.zeros(5)
238 def test_deprecated(self):
239 meta = TaskMetadata()
240 with self.assertRaises(RuntimeError):
241 meta.names(topLevelOnly=True)
243 with self.assertWarns(FutureWarning):
244 meta.names(topLevelOnly=False)
247if __name__ == "__main__":
248 unittest.main()