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

Introduce a sentinel value _NO_VALUE to improve Global resolvers to support defaults 0 or None #2976

Merged
merged 20 commits into from
Aug 30, 2023
Merged

Introduce a sentinel value _NO_VALUE to improve Global resolvers to support defaults 0 or None #2976

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
5422c60
Add None support to globals
ankatiyar Aug 25, 2023
4046fc8
Add warning when default value is used
ankatiyar Aug 25, 2023
0812057
Check keys
ankatiyar Aug 29, 2023
76a8259
Merge branch 'main' into fix-globals
ankatiyar Aug 29, 2023
e43e3ab
Nok's suggestions
ankatiyar Aug 29, 2023
c80437f
Create the test to check the non-existing keys
noklam Aug 29, 2023
b36ffbd
add more tests to catch case when global key is not a dict
noklam Aug 29, 2023
0c845f5
Fix the null test
noklam Aug 29, 2023
7334077
Introduce sentinel value _NO_VALUE
noklam Aug 29, 2023
a6df46a
rename test
noklam Aug 29, 2023
5485361
Improve error mesasge and raise InterpolationResolutionError when key…
noklam Aug 29, 2023
320a391
Fix non exist default test
noklam Aug 29, 2023
93abb1c
Fix test
noklam Aug 29, 2023
5ac78a0
Use omegaconf to replace the custom resolving logic
noklam Aug 29, 2023
03b121b
uncommented some tests
noklam Aug 29, 2023
75fc408
Remove dead code
ankatiyar Aug 30, 2023
eb797cc
Merge branch 'main' into fix-globals
ankatiyar Aug 30, 2023
1917f29
Update error message
ankatiyar Aug 30, 2023
b297277
Merge branch 'fix-globals' of https://github.com/kedro-org/kedro into…
ankatiyar Aug 30, 2023
bf0d38c
Merge branch 'main' into fix-globals
ankatiyar Aug 30, 2023
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
10 changes: 6 additions & 4 deletions kedro/config/omegaconf_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,14 +331,16 @@ def _get_globals_value(self, variable, default_value):
value = self["globals"]
for k in keys:
value = value.get(k)
if not value:
if value is None:
if default_value:
_config_logger.debug(
f"Using the default value for the global variable {variable}."
)
return default_value
msg = f"Globals key '{variable}' not found and no default value provided. "
raise InterpolationResolutionError(msg)
else:
_config_logger.warning(
f"Globals key '{variable}' might be undefined. Using the default 'None' value."
)
return default_value
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we care about the value here? It could be anything included None or 0. Shouldn't we check where the key is a valid key instead of the value?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made some changes!

return value

@staticmethod
Expand Down
11 changes: 4 additions & 7 deletions tests/config/test_omegaconf_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,7 @@ def test_custom_resolvers(self, tmp_path):
def test_globals(self, tmp_path):
globals_params = tmp_path / _BASE_ENV / "globals.yml"
globals_config = {
"x": 34,
"x": 0,
}
_write_yaml(globals_params, globals_config)
conf = OmegaConfigLoader(tmp_path, default_run_env="")
Expand Down Expand Up @@ -760,7 +760,7 @@ def test_globals_across_env(self, tmp_path):
# Base global value is accessible to local params
assert conf["parameters"]["param2"] == base_globals_config["x"]

def test_bad_globals(self, tmp_path):
def test_globals_default_none(self, tmp_path):
base_params = tmp_path / _BASE_ENV / "parameters.yml"
base_globals = tmp_path / _BASE_ENV / "globals.yml"
base_param_config = {
Expand All @@ -774,11 +774,8 @@ def test_bad_globals(self, tmp_path):
_write_yaml(base_params, base_param_config)
_write_yaml(base_globals, base_globals_config)
conf = OmegaConfigLoader(tmp_path, default_run_env="")
with pytest.raises(
InterpolationResolutionError,
match=r"Globals key 'x.y' not found and no default value provided.",
):
conf["parameters"]["param1"]
# Default value None is being used
assert conf["parameters"]["param1"] is None

def test_bad_globals_underscore(self, tmp_path):
base_params = tmp_path / _BASE_ENV / "parameters.yml"
Expand Down