lsst.pipe.base  20.0.0+3
Public Member Functions | List of all members
lsst.pipe.base.configOverrides.ConfigOverrides Class Reference

Public Member Functions

def __init__ (self)
 
def addFileOverride (self, filename)
 
def addValueOverride (self, field, value)
 
def addPythonOverride (self, str python_snippet)
 
def addInstrumentOverride (self, str instrument, str task_name)
 
def applyTo (self, config)
 

Detailed Description

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.

Definition at line 37 of file configOverrides.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.configOverrides.ConfigOverrides.__init__ (   self)

Definition at line 60 of file configOverrides.py.

Member Function Documentation

◆ addFileOverride()

def lsst.pipe.base.configOverrides.ConfigOverrides.addFileOverride (   self,
  filename 
)
Add overrides from a specified file.

Parameters
----------
filename : str
    Path to the override file.

Definition at line 63 of file configOverrides.py.

◆ addInstrumentOverride()

def lsst.pipe.base.configOverrides.ConfigOverrides.addInstrumentOverride (   self,
str  instrument,
str  task_name 
)
Apply any overrides that an instrument has for a task

Parameters
----------
instrument: str
    A string containing the fully qualified name of an instrument from
    which configs should be loaded and applied
task_name: str
    The _DefaultName of a task associated with a config, used to look
    up overrides from the instrument.

Definition at line 102 of file configOverrides.py.

◆ addPythonOverride()

def lsst.pipe.base.configOverrides.ConfigOverrides.addPythonOverride (   self,
str  python_snippet 
)
Add Overrides by running a snippit of python code against a config.

Parameters
----------
python_snippet: str
    A string which is valid python code to be executed. This is done with
    config as the only local accessible value.

Definition at line 91 of file configOverrides.py.

◆ addValueOverride()

def lsst.pipe.base.configOverrides.ConfigOverrides.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.

Definition at line 73 of file configOverrides.py.

◆ applyTo()

def lsst.pipe.base.configOverrides.ConfigOverrides.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.

Definition at line 117 of file configOverrides.py.


The documentation for this class was generated from the following file: