pip_services3_components.config.YamlConfigReader module

pip_services3_components.config.YamlConfigReader

YAML config reader implementation

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_components.config.YamlConfigReader.YamlConfigReader(path: str = None)

Bases: pip_services3_components.config.FileConfigReader.FileConfigReader

Config reader that reads configuration from YAML file.

### Configuration parameters ###

  • path: path to configuration file

  • parameters: this entire section is used as template parameters

  • …

Example:

======== config.yml ======
key1: "{{KEY1_VALUE}}"
key2: "{{KEY2_VALUE}}"
===========================

configReader = YamlConfigReader("config.yml")
parameters = ConfigParams.from_tuples("KEY1_VALUE", 123, "KEY2_VALUE", "ABC")
configReader.read_config_("123", parameters)
static read_config(correlation_id: Optional[str], path: str, parameters: pip_services3_commons.config.ConfigParams.ConfigParams) → pip_services3_commons.config.ConfigParams.ConfigParams

Reads configuration from a file, parameterize it with given values and returns a new ConfigParams object.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • path – a path to configuration file.

  • parameters – values to parameters the configuration.

Returns

ConfigParams configuration.

read_config_(correlation_id: Optional[str], parameters: pip_services3_commons.config.ConfigParams.ConfigParams) → pip_services3_commons.config.ConfigParams.ConfigParams

Reads configuration and parameterize it with given values.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • parameters – values to parameters the configuration or null to skip parameterization.

Returns

ConfigParams configuration.

static read_object(correlation_id: Optional[str], path: str, parameters: pip_services3_commons.config.ConfigParams.ConfigParams) → Any

Reads configuration file, parameterizes its content and converts it into YAML object.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • path – a path to configuration file.

  • parameters – values to parameters the configuration.

Returns

a YAML object with configuration.