LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst.pex.config.history Namespace Reference

Classes

class  Color
 

Functions

 _colorize (text, category)
 
 format (config, name=None, writeSourceLine=True, prefix="", verbose=False)
 

Function Documentation

◆ _colorize()

lsst.pex.config.history._colorize ( text,
category )
protected

Definition at line 168 of file history.py.

168def _colorize(text, category):
169 text = Color(text, category)
170 return str(text)
171
172

◆ format()

lsst.pex.config.history.format ( config,
name = None,
writeSourceLine = True,
prefix = "",
verbose = False )
Format the history record for a configuration, or a specific
configuration field.

Parameters
----------
config : `lsst.pex.config.Config`
    A configuration instance.
name : `str`, optional
    The name of a configuration field to specifically format the history
    for. Otherwise the history of all configuration fields is printed.
writeSourceLine : `bool`, optional
    If `True`, prefix each printout line with the code filename and line
    number where the configuration event occurred. Default is `True`.
prefix : `str`, optional
    A prefix for to add to each printout line. This prefix occurs first,
    even before any source line. The default is an empty string.
verbose : `bool`, optional
    Default is `False`.

Definition at line 173 of file history.py.

173def format(config, name=None, writeSourceLine=True, prefix="", verbose=False):
174 """Format the history record for a configuration, or a specific
175 configuration field.
176
177 Parameters
178 ----------
179 config : `lsst.pex.config.Config`
180 A configuration instance.
181 name : `str`, optional
182 The name of a configuration field to specifically format the history
183 for. Otherwise the history of all configuration fields is printed.
184 writeSourceLine : `bool`, optional
185 If `True`, prefix each printout line with the code filename and line
186 number where the configuration event occurred. Default is `True`.
187 prefix : `str`, optional
188 A prefix for to add to each printout line. This prefix occurs first,
189 even before any source line. The default is an empty string.
190 verbose : `bool`, optional
191 Default is `False`.
192 """
193 if name is None:
194 for i, name in enumerate(config.history.keys()):
195 if i > 0:
196 print()
197 print(format(config, name))
198
199 outputs = []
200 for value, stack, _ in config.history.get(name, []):
201 output = []
202 for frame in stack:
203 if frame.function in (
204 "__new__",
205 "__set__",
206 "__setattr__",
207 "execfile",
208 "wrapper",
209 ) or os.path.split(frame.filename)[1] in ("argparse.py", "argumentParser.py"):
210 if not verbose:
211 continue
212
213 line = []
214 if writeSourceLine:
215 line.append(
216 [
217 f"{frame.filename}:{frame.lineno}",
218 "FILE",
219 ]
220 )
221
222 line.append(
223 [
224 frame.content,
225 "TEXT",
226 ]
227 )
228 if False:
229 line.append(
230 [
231 frame.function,
232 "FUNCTION_NAME",
233 ]
234 )
235
236 output.append(line)
237
238 outputs.append([value, output])
239
240 if outputs:
241 # Find the maximum widths of the value and file:lineNo fields.
242 if writeSourceLine:
243 sourceLengths = []
244 for _, output in outputs:
245 sourceLengths.append(max([len(x[0][0]) for x in output]))
246 sourceLength = max(sourceLengths)
247
248 valueLength = len(prefix) + max([len(str(value)) for value, _ in outputs])
249
250 # Generate the config history content.
251 msg = []
252 fullname = f"{config._name}.{name}" if config._name is not None else name
253 msg.append(_colorize(re.sub(r"^root\.", "", fullname), "NAME"))
254 for value, output in outputs:
255 line = prefix + _colorize(f"{value:<{valueLength}}", "VALUE") + " "
256 for i, vt in enumerate(output):
257 if writeSourceLine:
258 vt[0][0] = f"{vt[0][0]:<{sourceLength}}"
259
260 output[i] = " ".join([_colorize(v, t) for v, t in vt])
261
262 line += f"\n{'':>{valueLength + 1}}".join(output)
263 msg.append(line)
264
265 return "\n".join(msg)