Adding parameter warn_when_defaulting_parameters to control default parameter warnings (backport #5189) #5210
+54
−19
Conversation
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
…arameter warnings (#5189) * Adding a parameter warn_when_defaulting_parameters to control default parameter warnings instead of using a flag Signed-off-by: Marco Bassa <marco.bassa@idealworks.com> * Adding parameter strict_param_loading for optionally throwing an exception if parameter overrides are missing Signed-off-by: Marco Bassa <marco.bassa@idealworks.com> * Using default false declaration instead of declare_or_get in param util Signed-off-by: Marco Bassa <marco.bassa@idealworks.com> --------- Signed-off-by: Marco Bassa <marco.bassa@idealworks.com> (cherry picked from commit 7b5e7e0)
Contributor
Author
SteveMacenski
approved these changes
May 29, 2025
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.
Basic Info
Description of contribution in a few bullet points
As previously discussed in #5154, as most of the parameters in the stack are associated to default values, it is currently difficult for code maintainers to spot parameters that are not loaded because of typos, wrong namespaces, or because of code changes.
The problem can be solved associating a full definition of the parameters in the yaml configuration files with a mechanism that warns when an association fails.
As this would likely result in a lot of spam for users without a full yaml definition, the current change proposes optionally enabling the feature for a node through a parameter.
This would leave the default policy to not-warning while allowing the user to enable it without modifying source-code.
Description of how this change was tested
Unit tests
Future work that may be required in bullet points
For Maintainers:
This is an automatic backport of pull request #5189 done by [Mergify](https://mergify.com).