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

# 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/>. 

 

"""Tests related to the formatter infrastructure. 

""" 

 

import os.path 

import unittest 

 

from datasetsHelper import DatasetTestHelper 

from lsst.daf.butler import Formatter, FormatterFactory, StorageClass, DatasetType, Config 

 

TESTDIR = os.path.abspath(os.path.dirname(__file__)) 

 

 

class FormatterFactoryTestCase(unittest.TestCase, DatasetTestHelper): 

"""Tests of the formatter factory infrastructure. 

""" 

 

def setUp(self): 

self.id = 0 

self.factory = FormatterFactory() 

 

def testRegistry(self): 

"""Check that formatters can be stored in the registry. 

""" 

formatterTypeName = "lsst.daf.butler.formatters.fitsCatalogFormatter.FitsCatalogFormatter" 

storageClassName = "Image" 

self.factory.registerFormatter(storageClassName, formatterTypeName) 

f = self.factory.getFormatter(storageClassName) 

self.assertIsInstance(f, Formatter) 

# Defer the import so that we ensure that the infrastructure loaded 

# it on demand previously 

from lsst.daf.butler.formatters.fitsCatalogFormatter import FitsCatalogFormatter 

self.assertEqual(type(f), FitsCatalogFormatter) 

 

with self.assertRaises(KeyError): 

f = self.factory.getFormatter("Missing") 

 

def testRegistryWithStorageClass(self): 

"""Test that the registry can be given a StorageClass object. 

""" 

formatterTypeName = "lsst.daf.butler.formatters.yamlFormatter.YamlFormatter" 

storageClassName = "TestClass" 

sc = StorageClass(storageClassName, dict, None) 

 

datasetType = DatasetType("calexp", {}, sc) 

 

# Store using an instance 

self.factory.registerFormatter(sc, formatterTypeName) 

 

# Retrieve using the class 

f = self.factory.getFormatter(sc) 

self.assertIsInstance(f, Formatter) 

 

# Retrieve using the DatasetType 

f2 = self.factory.getFormatter(datasetType) 

self.assertIsInstance(f, Formatter) 

self.assertEqual(f.name(), f2.name()) 

 

# This might defer the import, pytest may have already loaded it 

from lsst.daf.butler.formatters.yamlFormatter import YamlFormatter 

self.assertEqual(type(f), YamlFormatter) 

 

with self.assertRaises(KeyError): 

# Attempt to overwrite using a different value 

self.factory.registerFormatter(storageClassName, 

"lsst.daf.butler.formatters.jsonFormatter.JsonFormatter") 

 

def testRegistryConfig(self): 

configFile = os.path.join(TESTDIR, "config", "basic", "posixDatastore.yaml") 

config = Config(configFile) 

self.factory.registerFormatters(config["datastore", "formatters"]) 

 

# Create a DatasetRef with and without instrument matching the 

# one in the config file. 

dimensions = frozenset(("Visit", "PhysicalFilter", "Instrument")) 

sc = StorageClass("DummySC", dict, None) 

refPviHsc = self.makeDatasetRef("pvi", dimensions, sc, {"instrument": "DummyHSC", 

"physical_filter": "v"}) 

refPviHscFmt = self.factory.getFormatter(refPviHsc) 

self.assertIsInstance(refPviHscFmt, Formatter) 

self.assertIn("JsonFormatter", refPviHscFmt.name()) 

 

refPviNotHsc = self.makeDatasetRef("pvi", dimensions, sc, {"instrument": "DummyNotHSC", 

"physical_filter": "v"}) 

refPviNotHscFmt = self.factory.getFormatter(refPviNotHsc) 

self.assertIsInstance(refPviNotHscFmt, Formatter) 

self.assertIn("PickleFormatter", refPviNotHscFmt.name()) 

 

# Create a DatasetRef that should fall back to using Dimensions 

refPvixHsc = self.makeDatasetRef("pvix", dimensions, sc, {"instrument": "DummyHSC", 

"physical_filter": "v"}) 

refPvixNotHscFmt = self.factory.getFormatter(refPvixHsc) 

self.assertIsInstance(refPvixNotHscFmt, Formatter) 

self.assertIn("PickleFormatter", refPvixNotHscFmt.name()) 

 

# Create a DatasetRef that should fall back to using StorageClass 

dimensionsNoV = frozenset(("PhysicalFilter", "Instrument")) 

refPvixNotHscDims = self.makeDatasetRef("pvix", dimensionsNoV, sc, {"instrument": "DummyHSC", 

"physical_filter": "v"}) 

refPvixNotHscDims_fmt = self.factory.getFormatter(refPvixNotHscDims) 

self.assertIsInstance(refPvixNotHscDims_fmt, Formatter) 

self.assertIn("YamlFormatter", refPvixNotHscDims_fmt.name()) 

 

 

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

unittest.main()