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

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

 

"""Test file name templating.""" 

 

import os.path 

import unittest 

 

from lsst.daf.butler import DatasetType, DatasetRef, FileTemplates, \ 

FileTemplate, FileTemplatesConfig, StorageClass, Run 

 

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

 

 

class TestFileTemplates(unittest.TestCase): 

"""Test creation of paths from templates.""" 

 

def makeDatasetRef(self, datasetTypeName, dataId=None): 

"""Make a simple DatasetRef""" 

if dataId is None: 

dataId = self.dataId 

if datasetTypeName not in self.datasetTypes: 

self.datasetTypes[datasetTypeName] = DatasetType(datasetTypeName, list(dataId.keys()), 

StorageClass(None)) 

datasetType = self.datasetTypes[datasetTypeName] 

return DatasetRef(datasetType, dataId, run=Run(id=2, collection="run2")) 

 

def setUp(self): 

self.dataId = {"visit": 52, "filter": "U"} 

self.datasetTypes = {} 

 

def assertTemplate(self, template, answer, ref): 

fileTmpl = FileTemplate(template) 

path = fileTmpl.format(ref) 

self.assertEqual(path, answer) 

 

def testBasic(self): 

tmplstr = "{run:02d}/{datasetType}/{visit:05d}/{filter}" 

self.assertTemplate(tmplstr, 

"02/calexp/00052/U", 

self.makeDatasetRef("calexp")) 

tmplstr = "{collection}/{datasetType}/{visit:05d}/{filter}-trail" 

self.assertTemplate(tmplstr, 

"run2/calexp/00052/U-trail", 

self.makeDatasetRef("calexp")) 

 

def testRunOrCollectionNeeded(self): 

tmplstr = "{datasetType}/{visit:05d}/{filter}" 

with self.assertRaises(KeyError): 

self.assertTemplate(tmplstr, 

"02/calexp/00052/U", 

self.makeDatasetRef("calexp")) 

 

def testOptional(self): 

"""Optional units in templates.""" 

ref = self.makeDatasetRef("calexp") 

tmplstr = "{run:02d}/{datasetType}/v{visit:05d}_f{filter:?}" 

self.assertTemplate(tmplstr, "02/calexp/v00052_fU", 

self.makeDatasetRef("calexp")) 

 

du = {"visit": 48, "tract": 265} 

self.assertTemplate(tmplstr, "02/calexpT/v00048", 

self.makeDatasetRef("calexpT", du)) 

 

# Ensure that this returns a relative path even if the first field 

# is optional 

tmplstr = "{run:02d}/{tract:?}/{visit:?}/f{filter}" 

self.assertTemplate(tmplstr, "02/52/fU", ref) 

 

# Ensure that // from optionals are converted to singles 

tmplstr = "{run:02d}/{datasetType}/{patch:?}/{tract:?}/f{filter}" 

self.assertTemplate(tmplstr, "02/calexp/fU", ref) 

 

# Optionals with some text between fields 

tmplstr = "{run:02d}/{datasetType}/p{patch:?}_t{tract:?}/f{filter}" 

self.assertTemplate(tmplstr, "02/calexp/p/fU", ref) 

tmplstr = "{run:02d}/{datasetType}/p{patch:?}_t{visit:04d?}/f{filter}" 

self.assertTemplate(tmplstr, "02/calexp/p_t0052/fU", ref) 

 

def testComponent(self): 

"""Test handling of components in templates.""" 

refMetricOutput = self.makeDatasetRef("metric.output") 

refMetric = self.makeDatasetRef("metric") 

refMaskedImage = self.makeDatasetRef("calexp.maskedimage.variance") 

refWcs = self.makeDatasetRef("calexp.wcs") 

 

tmplstr = "{run:02d}_c_{component}_v{visit}" 

self.assertTemplate(tmplstr, "02_c_output_v52", refMetricOutput) 

 

tmplstr = "{run:02d}_{component:?}_{visit}" 

self.assertTemplate(tmplstr, "02_52", refMetric) 

self.assertTemplate(tmplstr, "02_output_52", refMetricOutput) 

self.assertTemplate(tmplstr, "02_maskedimage.variance_52", refMaskedImage) 

self.assertTemplate(tmplstr, "02_output_52", refMetricOutput) 

 

# Providing a component but not using it 

tmplstr = "{collection}/{datasetType}/v{visit:05d}" 

with self.assertRaises(KeyError): 

self.assertTemplate(tmplstr, "", refWcs) 

 

def testSimpleConfig(self): 

"""Test reading from config file""" 

configRoot = os.path.join(TESTDIR, "config", "templates") 

config1 = FileTemplatesConfig(os.path.join(configRoot, "templates-nodefault.yaml")) 

templates = FileTemplates(config1) 

ref = self.makeDatasetRef("calexp") 

tmpl = templates.getTemplate(ref.datasetType.name) 

self.assertIsInstance(tmpl, FileTemplate) 

 

# This config file should not allow defaulting 

ref2 = self.makeDatasetRef("unknown") 

with self.assertRaises(KeyError): 

templates.getTemplate(ref2.datasetType.name) 

 

# Format config file with defaulting 

config2 = FileTemplatesConfig(os.path.join(configRoot, "templates-withdefault.yaml")) 

templates = FileTemplates(config2) 

tmpl = templates.getTemplate(ref2.datasetType.name) 

self.assertIsInstance(tmpl, FileTemplate) 

 

# Format config file with bad format string 

with self.assertRaises(ValueError): 

FileTemplates(os.path.join(configRoot, "templates-bad.yaml")) 

 

# Config file with no defaulting mentioned 

config3 = os.path.join(configRoot, "templates-nodefault2.yaml") 

templates = FileTemplates(config3) 

with self.assertRaises(KeyError): 

templates.getTemplate(ref2.datasetType.name) 

 

# Try again but specify a default in the constructor 

default = "{datasetType}/{filter}" 

templates = FileTemplates(config3, default=default) 

tmpl = templates.getTemplate(ref2.datasetType.name) 

self.assertEqual(tmpl.template, default) 

 

 

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

unittest.main()