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.

def _colorize(text, category):
    text = Color(text, category)
    return str(text)
 
 

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.

def 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`.
    """
    if name is None:
        for i, name in enumerate(config.history.keys()):
            if i > 0:
                print()
            print(format(config, name))
 
    outputs = []
    for value, stack, _ in config.history.get(name, []):
        output = []
        for frame in stack:
            if frame.function in (
                "__new__",
                "__set__",
                "__setattr__",
                "execfile",
                "wrapper",
            ) or os.path.split(frame.filename)[1] in ("argparse.py", "argumentParser.py"):
                if not verbose:
                    continue
 
            line = []
            if writeSourceLine:
                line.append(
                    [
                        f"{frame.filename}:{frame.lineno}",
                        "FILE",
                    ]
                )
 
            line.append(
                [
                    frame.content,
                    "TEXT",
                ]
            )
            if False:
                line.append(
                    [
                        frame.function,
                        "FUNCTION_NAME",
                    ]
                )
 
            output.append(line)
 
        outputs.append([value, output])
 
    if outputs:
        # Find the maximum widths of the value and file:lineNo fields.
        if writeSourceLine:
            sourceLengths = []
            for _, output in outputs:
                sourceLengths.append(max([len(x[0][0]) for x in output]))
            sourceLength = max(sourceLengths)
 
        valueLength = len(prefix) + max([len(str(value)) for value, _ in outputs])
 
    # Generate the config history content.
    msg = []
    fullname = f"{config._name}.{name}" if config._name is not None else name
    msg.append(_colorize(re.sub(r"^root\.", "", fullname), "NAME"))
    for value, output in outputs:
        if value is not None:
            line = prefix + _colorize(f"{value:<{valueLength}}", "VALUE") + " "
        else:
            line = prefix + _colorize("None", "VALUE") + " "
        for i, vt in enumerate(output):
            if writeSourceLine:
                vt[0][0] = f"{vt[0][0]:<{sourceLength}}"
 
            output[i] = " ".join([_colorize(v, t) for v, t in vt])
 
        line += f"\n{'':>{valueLength + 1}}".join(output)
        msg.append(line)
 
    return "\n".join(msg)