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

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

# This file is part of daf_butler. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

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

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

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

# (at your option) any later version. 

# 

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

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

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

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

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

 

import pickle 

import unittest 

import lsst.utils.tests 

 

from lsst.daf.butler import StorageClass, StorageClassFactory, StorageClassConfig, CompositeAssembler 

 

"""Tests related to the StorageClass infrastructure. 

""" 

 

 

class PythonType: 

"""A dummy class to test the registry of Python types.""" 

pass 

 

 

class StorageClassFactoryTestCase(lsst.utils.tests.TestCase): 

"""Tests of the storage class infrastructure. 

""" 

 

def testCreation(self): 

"""Test that we can dynamically create storage class subclasses. 

 

This is critical for testing the factory functions.""" 

className = "TestImage" 

sc = StorageClass(className, pytype=dict) 

self.assertIsInstance(sc, StorageClass) 

self.assertEqual(sc.name, className) 

self.assertFalse(sc.components) 

self.assertTrue(sc.validateInstance({})) 

self.assertFalse(sc.validateInstance("")) 

 

# Ensure we do not have an assembler 

with self.assertRaises(TypeError): 

sc.assembler() 

 

# Allow no definition of python type 

scn = StorageClass(className) 

self.assertIs(scn.pytype, object) 

 

# Include some components 

scc = StorageClass(className, pytype=PythonType, components={"comp1": sc}) 

self.assertIn("comp1", scc.components) 

self.assertIn("comp1", repr(scc)) 

 

# Ensure that we have an assembler 

self.assertIsInstance(scc.assembler(), CompositeAssembler) 

 

# Check we can create a storageClass using the name of an importable 

# type. 

sc2 = StorageClass("TestImage2", 

"lsst.daf.butler.core.storageClass.StorageClassFactory") 

self.assertIsInstance(sc2.pytype(), StorageClassFactory) 

self.assertIn("butler.core", repr(sc2)) 

 

def testEquality(self): 

"""Test that StorageClass equality works""" 

className = "TestImage" 

sc1 = StorageClass(className, pytype=dict) 

sc2 = StorageClass(className, pytype=dict) 

self.assertEqual(sc1, sc2) 

sc3 = StorageClass(className + "2", pytype=str) 

self.assertNotEqual(sc1, sc3) 

 

# Same StorageClass name but different python type 

sc4 = StorageClass(className, pytype=str) 

self.assertNotEqual(sc1, sc4) 

 

# Now with components 

sc5 = StorageClass("Composite", pytype=PythonType, 

components={"comp1": sc1, "comp2": sc3}) 

sc6 = StorageClass("Composite", pytype=PythonType, 

components={"comp1": sc1, "comp2": sc3}) 

self.assertEqual(sc5, sc6) 

self.assertNotEqual(sc5, sc3) 

sc7 = StorageClass("Composite", pytype=PythonType, 

components={"comp1": sc4, "comp2": sc3}) 

self.assertNotEqual(sc5, sc7) 

sc8 = StorageClass("Composite", pytype=PythonType, 

components={"comp2": sc3}) 

self.assertNotEqual(sc5, sc8) 

sc9 = StorageClass("Composite", pytype=PythonType, 

components={"comp2": sc3}, assembler="lsst.daf.butler.Butler") 

self.assertNotEqual(sc5, sc9) 

 

def testRegistry(self): 

"""Check that storage classes can be created on the fly and stored 

in a registry.""" 

className = "TestImage" 

factory = StorageClassFactory() 

newclass = StorageClass(className, pytype=PythonType) 

factory.registerStorageClass(newclass) 

sc = factory.getStorageClass(className) 

self.assertIsInstance(sc, StorageClass) 

self.assertEqual(sc.name, className) 

self.assertFalse(sc.components) 

self.assertEqual(sc.pytype, PythonType) 

self.assertIn(sc, factory) 

newclass2 = StorageClass("Temporary2", pytype=str) 

self.assertNotIn(newclass2, factory) 

factory.registerStorageClass(newclass2) 

self.assertIn(newclass2, factory) 

self.assertIn("Temporary2", factory) 

self.assertNotIn("Temporary3", factory) 

self.assertNotIn({}, factory) 

 

# Make sure we can't register a storage class with the same name 

# but different values 

newclass3 = StorageClass("Temporary2", pytype=dict) 

with self.assertRaises(ValueError): 

factory.registerStorageClass(newclass3) 

 

factory._unregisterStorageClass(newclass3.name) 

self.assertNotIn(newclass3, factory) 

self.assertNotIn(newclass3.name, factory) 

factory.registerStorageClass(newclass3) 

self.assertIn(newclass3, factory) 

self.assertIn(newclass3.name, factory) 

 

# Check you can silently insert something that is already there 

factory.registerStorageClass(newclass3) 

 

def testFactoryConfig(self): 

factory = StorageClassFactory() 

factory.addFromConfig(StorageClassConfig()) 

image = factory.getStorageClass("Image") 

imageF = factory.getStorageClass("ImageF") 

self.assertIsInstance(imageF, type(image)) 

self.assertNotEqual(imageF, image) 

 

# Check component inheritance 

exposure = factory.getStorageClass("Exposure") 

exposureF = factory.getStorageClass("ExposureF") 

self.assertIsInstance(exposureF, type(exposure)) 

self.assertIsInstance(exposure.components["image"], type(image)) 

self.assertNotIsInstance(exposure.components["image"], type(imageF)) 

self.assertIsInstance(exposureF.components["image"], type(image)) 

self.assertIsInstance(exposureF.components["image"], type(imageF)) 

self.assertIn("wcs", exposure.components) 

self.assertIn("wcs", exposureF.components) 

 

# Check that we can't have a new StorageClass that does not 

# inherit from StorageClass 

with self.assertRaises(ValueError): 

factory.makeNewStorageClass("ClassName", baseClass=StorageClassFactory) 

 

sc = factory.makeNewStorageClass("ClassName") 

self.assertIsInstance(sc(), StorageClass) 

 

def testPickle(self): 

"""Test that we can pickle storageclasses. 

""" 

className = "TestImage" 

sc = StorageClass(className, pytype=dict) 

self.assertIsInstance(sc, StorageClass) 

self.assertEqual(sc.name, className) 

self.assertFalse(sc.components) 

sc2 = pickle.loads(pickle.dumps(sc)) 

self.assertEqual(sc2, sc) 

 

 

class MemoryTester(lsst.utils.tests.MemoryTestCase): 

pass 

 

 

def setup_module(module): 

lsst.utils.tests.init() 

 

 

190 ↛ 191line 190 didn't jump to line 191, because the condition on line 190 was never trueif __name__ == "__main__": 

lsst.utils.tests.init() 

unittest.main()