JSON: Selectively suppress unknown key warnings#1700
Merged
ax3l merged 5 commits intoopenPMD:devfrom Feb 18, 2025
Merged
Conversation
franzpoeschel
force-pushed
the
json-suppress-warnings
branch
2 times, most recently
from
f0ef1f2 to
1130041
Compare
franzpoeschel
force-pushed
the
json-suppress-warnings
branch
2 times, most recently
from
e91e724 to
5db738e
Compare
ax3l
reviewed
Jan 28, 2025
| bool trace); | ||
|
|
||
| void init(); | ||
| static void init(nlohmann::json &original, nlohmann::json &shadow); |
Member
There was a problem hiding this comment.
- Are both original and shadow modified or is one
const &? - Please add a doxygen
Contributor
Author
There was a problem hiding this comment.
original is now const, docstring is now there.
For unknown keys.
{
"dont_warn_unused_keys": [
"key1",
"key3"
],
"key1": 5,
"key2": {
"dont_warn_unused_keys": [
"key1"
],
"key1": 5,
"key2": 6
},
"key3": {
"dont_warn_unused_keys": [
"key1"
],
"key1": 5,
"key2": 6
}
}
Will yield the warning:
[Series] The following parts of the global JSON config remains unused:
{
"key2": {
"dont_warn_unused_keys": [
"key1"
],
"key1": 5,
"key2": 6
},
"key3": {
"key2": 6
}
}
TODO: Better errors when parsing, documentation
franzpoeschel
force-pushed
the
json-suppress-warnings
branch
from
25c9cb0 to
0de9f15
Compare
ax3l
approved these changes
Feb 18, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Example use case: This came up when in the last release we added the key
adios2.engine.attribute_writing_ranks. When adding this key in downstream codes (came up in PIConGPU), then that code might either be compiled against the recent version which knows that key or against the older version which knows it not.In the latter case, a runtime warning about an unknown key will be printed. To avoid that issue, this PR adds a flag to opt-out keys from warnings:
{ "dont_warn_unused_keys": [ "key1", "key3" ], "key1": 5, "key2": { "dont_warn_unused_keys": [ "key1" ], "key1": 5, "key2": 6 }, "key3": { "dont_warn_unused_keys": [ "key1" ], "key1": 5, "key2": 6 } }Will yield the warning:
[Series] The following parts of the global JSON config remains unused:
{ "key2": { "dont_warn_unused_keys": [ "key1" ], "key1": 5, "key2": 6 }, "key3": { "key2": 6 } }TODO: