OptionsResolver

Description

The OptionsResolver class can be use to obtain all the parameters under the section “options” from a CongifParams object. It has a single method called “resolve”.

Static methods

resolve

Returns a ConfigParams object containing all the parameters under the section “option”.

static resolve(config: ConfigParams, config_as_default: bool = False): ConfigParams

• config: ConfigParams - configuration parameters
• config_as_default: bool - (optional) When set true the method returns the entire parameter set when “options” section is not found. Default: false
• returns: ConfigParams - configuration parameters from “options” section

Examples

config = ConfigParams.from_tuples(
  "abc.param1", "ABC",
  "options.param1", "ABC",
  "options.param2", 123)

options = OptionsResolver.resolve(config)           # Returns {'param1': 'ABC', 'param2': '123'}

# If the configuration doesn't contain an "options" section, it returns an empty ConfigParams object.
config = ConfigParams.from_tuples(
          "section1.key1", "AAA",
          "section1.key2", 123,
          )
options = OptionsResolver.resolve(config)            # Returns {}