LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
configOverrides.py
Go to the documentation of this file.
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 # (http://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 <http://www.gnu.org/licenses/>.
21 
22 """Module which defines ConfigOverrides class and related methods.
23 """
24 
25 __all__ = ["ConfigOverrides"]
26 
27 import ast
28 
29 from lsst.pipe.base import PipelineTaskConfig
30 import lsst.pex.exceptions as pexExceptions
31 
32 
34  """Defines a set of overrides to be applied to a task config.
35 
36  Overrides for task configuration need to be applied by activator when
37  creating task instances. This class represents an ordered set of such
38  overrides which activator receives from some source (e.g. command line
39  or some other configuration).
40 
41  Methods
42  ----------
43  addFileOverride(filename)
44  Add overrides from a specified file.
45  addValueOverride(field, value)
46  Add override for a specific field.
47  applyTo(config)
48  Apply all overrides to a `config` instance.
49 
50  Notes
51  -----
52  Serialization support for this class may be needed, will add later if
53  necessary.
54  """
55 
56  def __init__(self):
57  self._overrides = []
58 
59  def addFileOverride(self, filename):
60  """Add overrides from a specified file.
61 
62  Parameters
63  ----------
64  filename : str
65  Path to the override file.
66  """
67  self._overrides += [('file', filename)]
68 
69  def addValueOverride(self, field, value):
70  """Add override for a specific field.
71 
72  This method is not very type-safe as it is designed to support
73  use cases where input is given as string, e.g. command line
74  activators. If `value` has a string type and setting of the field
75  fails with `TypeError` the we'll attempt `eval()` the value and
76  set the field with that value instead.
77 
78  Parameters
79  ----------
80  field : str
81  Fully-qualified field name.
82  value :
83  Value to be given to a filed.
84  """
85  self._overrides += [('value', (field, value))]
86 
87  def addDatasetNameSubstitution(self, nameDict):
88  """Add keys and values to be used in formatting config nameTemplates
89 
90  This method takes in a dictionary in the format of key:value which
91  will be used to format fields in all of the nameTemplates found in
92  a config object. I.E. a nameDictString = {'input': 'deep'} would be
93  used to format a nameTemplate of "{input}CoaddDatasetProduct".
94 
95  Parameters
96  ----------
97  nameDict : `dict`
98  a python dict used in formatting nameTemplates
99  """
100  self._overrides += [('namesDict', nameDict)]
101 
102  def applyTo(self, config):
103  """Apply all overrides to a task configuration object.
104 
105  Parameters
106  ----------
107  config : `pex.Config`
108 
109  Raises
110  ------
111  `Exception` is raised if operations on configuration object fail.
112  """
113  for otype, override in self._overrides:
114  if otype == 'file':
115  config.load(override)
116  elif otype == 'value':
117  field, value = override
118  field = field.split('.')
119  # find object with attribute to set, throws if we name is wrong
120  obj = config
121  for attr in field[:-1]:
122  obj = getattr(obj, attr)
123  # If input is a string and field type is not a string then we
124  # have to convert string to an expected type. Implementing
125  # full string parser is non-trivial so we take a shortcut here
126  # and `eval` the string and assign the resulting value to a
127  # field. Type erroes can happen during both `eval` and field
128  # assignment.
129  if isinstance(value, str) and obj._fields[field[-1]].dtype is not str:
130  try:
131  # use safer ast.literal_eval, it only supports literals
132  value = ast.literal_eval(value)
133  except Exception:
134  # eval failed, wrap exception with more user-friendly message
135  raise pexExceptions.RuntimeError(f"Unable to parse `{value}' into a Python object")
136 
137  # this can throw in case of type mismatch
138  setattr(obj, field[-1], value)
139  elif otype == 'namesDict':
140  if not isinstance(config, PipelineTaskConfig):
141  raise pexExceptions.RuntimeError("Dataset name substitution can only be used on Tasks "
142  "with a ConfigClass that is a subclass of "
143  "PipelineTaskConfig")
144  config.formatTemplateNames(override)
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104