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

# This file is part of pipe_base. 

# 

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

 

"""Module which defines ConfigOverrides class and related methods. 

""" 

 

__all__ = ["ConfigOverrides"] 

 

import ast 

 

from lsst.pipe.base import PipelineTaskConfig 

import lsst.pex.exceptions as pexExceptions 

 

 

class ConfigOverrides: 

"""Defines a set of overrides to be applied to a task config. 

 

Overrides for task configuration need to be applied by activator when 

creating task instances. This class represents an ordered set of such 

overrides which activator receives from some source (e.g. command line 

or some other configuration). 

 

Methods 

---------- 

addFileOverride(filename) 

Add overrides from a specified file. 

addValueOverride(field, value) 

Add override for a specific field. 

applyTo(config) 

Apply all overrides to a `config` instance. 

 

Notes 

----- 

Serialization support for this class may be needed, will add later if 

necessary. 

""" 

 

def __init__(self): 

self._overrides = [] 

 

def addFileOverride(self, filename): 

"""Add overrides from a specified file. 

 

Parameters 

---------- 

filename : str 

Path to the override file. 

""" 

self._overrides += [('file', filename)] 

 

def addValueOverride(self, field, value): 

"""Add override for a specific field. 

 

This method is not very type-safe as it is designed to support 

use cases where input is given as string, e.g. command line 

activators. If `value` has a string type and setting of the field 

fails with `TypeError` the we'll attempt `eval()` the value and 

set the field with that value instead. 

 

Parameters 

---------- 

field : str 

Fully-qualified field name. 

value : 

Value to be given to a filed. 

""" 

self._overrides += [('value', (field, value))] 

 

def addDatasetNameSubstitution(self, nameDict): 

"""Add keys and values to be used in formatting config nameTemplates 

 

This method takes in a dictionary in the format of key:value which 

will be used to format fields in all of the nameTemplates found in 

a config object. I.E. a nameDictString = {'input': 'deep'} would be 

used to format a nameTemplate of "{input}CoaddDatasetProduct". 

 

Parameters 

---------- 

nameDict : `dict` 

a python dict used in formatting nameTemplates 

""" 

self._overrides += [('namesDict', nameDict)] 

 

def applyTo(self, config): 

"""Apply all overrides to a task configuration object. 

 

Parameters 

---------- 

config : `pex.Config` 

 

Raises 

------ 

`Exception` is raised if operations on configuration object fail. 

""" 

for otype, override in self._overrides: 

if otype == 'file': 

config.load(override) 

elif otype == 'value': 

field, value = override 

field = field.split('.') 

# find object with attribute to set, throws if we name is wrong 

obj = config 

for attr in field[:-1]: 

obj = getattr(obj, attr) 

# If input is a string and field type is not a string then we 

# have to convert string to an expected type. Implementing 

# full string parser is non-trivial so we take a shortcut here 

# and `eval` the string and assign the resulting value to a 

# field. Type erroes can happen during both `eval` and field 

# assignment. 

if isinstance(value, str) and obj._fields[field[-1]].dtype is not str: 

try: 

# use safer ast.literal_eval, it only supports literals 

value = ast.literal_eval(value) 

except Exception: 

# eval failed, wrap exception with more user-friendly message 

raise pexExceptions.RuntimeError(f"Unable to parse `{value}' into a Python object") 

 

# this can throw in case of type mismatch 

setattr(obj, field[-1], value) 

elif otype == 'namesDict': 

if not isinstance(config, PipelineTaskConfig): 

raise pexExceptions.RuntimeError("Dataset name substitution can only be used on Tasks " 

"with a ConfigClass that is a subclass of " 

"PipelineTaskConfig") 

config.formatTemplateNames(override)