util/yaml: warn on duplicate keys in mappings #1451
Merged
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
Bastian-Krause
force-pushed
the
bst/yaml-duplicate-keys
branch
2 times, most recently
from
b7e3dee
to
1890cb1
Compare
When adding drivers/resources to an environment config or resources to an exporter config, users can stumble upon redundant keys. The resulting errors are not obvious, the last key simply overrides any previous entries with the same key. In order to make these config errors more obvious, emit a warning when duplicate keys are detected in mappings. Signed-off-by: Bastian Krause <[email protected]>
Bastian-Krause
force-pushed
the
bst/yaml-duplicate-keys
branch
from
1890cb1
to
0bf0141
Compare
Bastian-Krause
changed the title
SmithChart
approved these changes
Jul 29, 2024
There was a problem hiding this comment.
Tested on the setup where I ran into this issue recently.
I guess this warning would have made my problem really obvious:
/(...)/labgrid-lxatac/venv/lib/python3.11/site-packages/labgrid/util/yaml.py:26: UserWarning: lxatac-ptx.yaml: previous entry with duplicate YAML dictionary key 'LXAIOBusPIODriver' overwritten
pyyaml seems to had a discussion on if they want to solve this at least back tot 2018: yaml/pyyaml#165
But it does not look like the project is willing to provide an upstream solution for this situation.
LGTM
Emantor
approved these changes
Jul 29, 2024
|
Before merging, let me check if this also works with templated exporter configs. |
|
Works also with templated configs. |
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.
Description
When adding drivers/resources to an environment config or resources to an exporter config, users can stumble upon redundant keys. The resulting errors are not obvious, the last key simply overrides any previous entries with the same key.
In order to make these config errors more obvious, emit a warning when duplicate keys are detected in mappings.
Checklist