BpsConfig

class lsst.ctrl.bps.BpsConfig(other, search_order=None)

Bases: lsst.daf.butler.Config

Contains the configuration for a BPS submission.

Parameters
otherstr, dict, Config, BpsConfig

Path to a yaml file or a dict/Config/BpsConfig containing configuration to copy.

search_orderlist of str, optional

Root section names in the order in which they should be searched.

Methods Summary

copy()

Makes a copy of config

search(key[, opt])

Searches for key using given opt following hierarchy rules.

Methods Documentation

copy()

Makes a copy of config

Returns
copyBpsConfig

A duplicate of itself

search(key, opt=None)

Searches for key using given opt following hierarchy rules.

Search hierarchy rules: current values, a given search object, and search order of config sections.

Parameters
keystr

Key to look for in config.

optdict, 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)

"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)

Returns
foundbool

Whether name was in config or not

valuestr, int, BpsConfig, …

Value from config if found