Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

vdk-core: adjust defined type for configuration values #684

Merged
merged 2 commits into from
Jan 28, 2022
Merged

vdk-core: adjust defined type for configuration values #684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b688b66
vdk-core: adjust defined type for configuration values
antoniivanov Jan 28, 2022
9998e2f
Update projects/vdk-core/src/vdk/internal/core/config.py
antoniivanov Jan 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions projects/vdk-core/src/vdk/internal/core/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ def add(
self.__add_public(key, description, default_value)
elif description:
self.__add_public(key, description)
self.__adjust_type_if_value_set(key, default_value)
return self

def set_value(self, key: ConfigKey, value: ConfigValue) -> ConfigurationBuilder:
Expand Down Expand Up @@ -205,6 +206,16 @@ def __add_public(
description += "\nDefault value is: '%s'." % default_value
self.__config_key_to_description[key] = description

def __adjust_type_if_value_set(self, key: ConfigKey, default_value: ConfigValue):
"""
As set_value can be called before add (which defines the configuration) we may need to adjust
the type of the value if it's already set.
"""
if default_value is not None and key in self.__config_key_to_value:
self.__config_key_to_value[key] = convert_value_to_type_of_default_type(
key, self.__config_key_to_value[key], default_value
)

def build(self) -> Configuration:
"""
:return: immutable version of the Configuration
Expand Down
15 changes: 15 additions & 0 deletions projects/vdk-core/tests/vdk/internal/core/test_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,21 @@ def test_set_value_overrides_default():
assert cfg.get_value("key") == "value"


def test_set_value_overrides_default_preserve_types():
builder = ConfigurationBuilder()
builder.set_value("key", "False")
builder.add("key", True, False, "key description")
builder.set_value("float", "11.12")
builder.add("float", 1.1, False, "key description")
cfg = builder.build()
assert cfg.get_value("key") == False
assert cfg.get_value("float") == 11.12

builder.set_value("int", "bad-value")
with pytest.raises(VdkConfigurationError):
builder.add("int", 1, False, "key description")


def test_list_config_keys():
builder = ConfigurationBuilder()
builder.add("key1", 1)
Expand Down