Report errors when loading YAML files with duplicate keys #257
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a custom constructor to the YAML loader created in get_yaml_loader() so that duplicate keys in the YAML file result in a PyYAML ConstructorError. Duplicate keys are not allowed as per the YAML spec but are silently ignored by PyYAML. This is a potential source of hard-to-detect errors due to misconfigurations. It has been reported several times in the PyYAML issues, e.g. yaml/pyyaml#165. The specific fix here was proposed at https://gist.github.com/pypt/94d747fe5180851196eb.
jgehring
force-pushed
the
yaml-check-duplicate-keys
branch
from
d4c262a to
1c8dbbb
Compare
omry
requested changes
May 26, 2020
tests/test_serialization.py
Outdated
|
|
||
| try: | ||
| with tempfile.NamedTemporaryFile(delete=False) as fp: | ||
| fp.write("a:\n b: 1\na:\n b: 2\n".encode("utf-8")) |
There was a problem hiding this comment.
Switch tests to use """ strings to to make them easier to understand.
"""
Suggested change
| fp.write("a:\n b: 1\na:\n b: 2\n".encode("utf-8")) | |
| content = """ | |
| a: | |
| b: 1 | |
| a: | |
| b: 2 | |
| """ | |
| fp.write(content.encode("utf-8")) |
|
I guess "bugfix" is the most appropriate label for this PR? |
omry
reviewed
May 27, 2020
Comment on lines
+122
to
+123
| with pytest.raises(ConstructorError): | ||
| OmegaConf.load(fp.name) |
There was a problem hiding this comment.
this becomes:
with pytest.warns(...)
|
Alright, error it is! |
omry
pushed a commit
that referenced
this pull request
May 28, 2020
* Report errors when loading YAML files with duplicate keys This adds a custom constructor to the YAML loader created in get_yaml_loader() so that duplicate keys in the YAML file result in a PyYAML ConstructorError. Duplicate keys are not allowed as per the YAML spec but are silently ignored by PyYAML. This is a potential source of hard-to-detect errors due to misconfigurations. It has been reported several times in the PyYAML issues, e.g. yaml/pyyaml#165. The specific fix here was proposed at https://gist.github.com/pypt/94d747fe5180851196eb.
This was referenced Dec 30, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a custom constructor to the YAML loader created in
get_yaml_loader() so that duplicate keys in the YAML file result in a
PyYAML ConstructorError.
Duplicate keys are not allowed as per the YAML spec but are silently
ignored by PyYAML. This is a potential source of hard-to-detect errors
due to misconfigurations. It has been reported several times in the
PyYAML issues, e.g. yaml/pyyaml#165. The
specific fix here was proposed at https://gist.github.com/pypt/94d747fe5180851196eb.