Avoid duplicate warnings if an unset env variable is used multiple times

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
This commit is contained in:
Aanand Prasad 2015-08-07 15:04:30 +01:00
commit 4c65891db1
3 changed files with 62 additions and 31 deletions

View file

@ -10,13 +10,15 @@ log = logging.getLogger(__name__)
def interpolate_environment_variables(config):
mapping = BlankDefaultDict(os.environ)
return dict(
(service_name, process_service(service_name, service_dict))
(service_name, process_service(service_name, service_dict, mapping))
for (service_name, service_dict) in config.items()
)
def process_service(service_name, service_dict):
def process_service(service_name, service_dict, mapping):
if not isinstance(service_dict, dict):
raise ConfigurationError(
'Service "%s" doesn\'t have any configuration options. '
@ -25,14 +27,14 @@ def process_service(service_name, service_dict):
)
return dict(
(key, interpolate_value(service_name, key, val))
(key, interpolate_value(service_name, key, val, mapping))
for (key, val) in service_dict.items()
)
def interpolate_value(service_name, config_key, value):
def interpolate_value(service_name, config_key, value, mapping):
try:
return recursive_interpolate(value)
return recursive_interpolate(value, mapping)
except InvalidInterpolation as e:
raise ConfigurationError(
'Invalid interpolation format for "{config_key}" option '
@ -45,39 +47,43 @@ def interpolate_value(service_name, config_key, value):
)
def recursive_interpolate(obj):
def recursive_interpolate(obj, mapping):
if isinstance(obj, six.string_types):
return interpolate(obj, os.environ)
return interpolate(obj, mapping)
elif isinstance(obj, dict):
return dict(
(key, recursive_interpolate(val))
(key, recursive_interpolate(val, mapping))
for (key, val) in obj.items()
)
elif isinstance(obj, list):
return map(recursive_interpolate, obj)
return [recursive_interpolate(val, mapping) for val in obj]
else:
return obj
def interpolate(string, mapping):
try:
return Template(string).substitute(BlankDefaultDict(mapping))
return Template(string).substitute(mapping)
except ValueError:
raise InvalidInterpolation(string)
class BlankDefaultDict(dict):
def __init__(self, mapping):
super(BlankDefaultDict, self).__init__(mapping)
def __init__(self, *args, **kwargs):
super(BlankDefaultDict, self).__init__(*args, **kwargs)
self.missing_keys = []
def __getitem__(self, key):
try:
return super(BlankDefaultDict, self).__getitem__(key)
except KeyError:
log.warn(
"The {} variable is not set. Substituting a blank string."
.format(key)
)
if key not in self.missing_keys:
log.warn(
"The {} variable is not set. Substituting a blank string."
.format(key)
)
self.missing_keys.append(key)
return ""