BpsConfig¶
- class lsst.ctrl.bps.BpsConfig(other, search_order=None)¶
Bases:
Config
Contains the configuration for a BPS submission.
- Parameters:
Methods Summary
copy
()Make a copy of config.
get
(key[, default])Return the value for key if key is in the config, else default.
search
(key[, opt])Search for key using given opt following hierarchy rules.
Methods Documentation
- copy()¶
Make a copy of config.
- Returns:
- copy
lsst.ctrl.bps.BpsConfig
A duplicate of itself.
- copy
- get(key, default='')¶
Return the value for key if key is in the config, else default.
If default is not given, it defaults to an empty string.
- Parameters:
- key
str
Key to look for in config.
- defaultAny, optional
Default value to return if the key is not in the config.
- key
- Returns:
- valAny
Value from config if found, default otherwise.
Notes
The provided default value (an empty string) was chosen to maintain the internal consistency with other methods of the class.
- search(key, opt=None)¶
Search for key using given opt following hierarchy rules.
Search hierarchy rules: current values, a given search object, and search order of config sections.
- Parameters:
- key
str
Key to look for in config.
- opt
dict
[str
,Any
], optional Options dictionary to use while searching. All are optional.
"curvals"
Means to pass in values for search order key (curr_<sectname>) or variable replacements. (
dict
, optional)"default"
Value to return if not found. (
Any
, optional)"replaceEnvVars"
If search result is string, whether to replace environment variables inside it with special placeholder (<ENV:name>). By default set to False. (
bool
)"expandEnvVars"
If search result is string, whether to replace environment variables inside it with current environment value. By default set to False. (
bool
)"replaceVars"
If search result is string, whether to replace variables inside it. By default set to True. (
bool
)"required"
If replacing variables, whether to raise exception if variable is undefined. By default set to False. (
bool
)
- key
- Returns:
- found
bool
Whether name was in config or not.
- value
str
,int
,lsst.ctrl.bps.BpsConfig
, … Value from config if found.
- found