pip_services3_container.config.ContainerConfigReader module

pip_services3_container.config.ContainerConfigReader

Container configuration reader implementation.

copyright

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

license

MIT, see LICENSE for more details.

class pip_services3_container.config.ContainerConfigReader.ContainerConfigReader

Bases: object

Helper class that reads container configuration from JSON or YAML file.

static read_from_file(correlation_id: Optional[str], path: str, parameters: pip_services3_commons.config.ConfigParams.ConfigParams) → pip_services3_container.config.ContainerConfig.ContainerConfig

Reads container configuration from JSON or YAML file. The type of the file is determined by file extension.

Parameters

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

  • path – a path to component configuration file.

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

Returns

the read container configuration

static read_from_json_file(correlation_id: Optional[str], path: str, parameters: pip_services3_commons.config.ConfigParams.ConfigParams) → pip_services3_container.config.ContainerConfig.ContainerConfig

Reads container configuration from JSON file.

Parameters

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

  • path – a path to component configuration file.

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

Returns

the read container configuration

static read_from_yaml_file(correlation_id: Optional[str], path: str, parameters: pip_services3_commons.config.ConfigParams.ConfigParams) → pip_services3_container.config.ContainerConfig.ContainerConfig

Reads container configuration from YAML file.

Parameters

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

  • path – a path to component configuration file.

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

Returns

the read container configuration