pip_services3_commons.config.NameResolver module

pip_services3_commons.config.NameResolver

Name resolver implementation

copyright: Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.
license: MIT, see LICENSE for more details.

class pip_services3_commons.config.NameResolver.NameResolver

Bases: object

A helper class that allows to extract component name from configuration parameters. The name can be defined in “id”, “name” parameters or inside a component descriptor.

Examples:

config = ConfigParams.fromTuples("descriptor", "myservice:connector:aws:connector1:1.0",
                                 "param1", "ABC",
                                 "param2", 123)

name = NameResolver.resolve(config)

static resolve(config: pip_services3_commons.config.ConfigParams.ConfigParams, default_name: str = None) → str 

Resolves a component name from configuration parameters. The name can be stored in “id”, “name” fields or inside a component descriptor. If name cannot be determined it returns a defaultName.

Parameters

config – configuration parameters that may contain a component name.
default_name – (optional) a default component name.

Returns

resolved name or default name if the name cannot be determined.