Add sole_config function for enforced one-time configuring #1661
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
hnyu
reviewed
Jun 21, 2024
alf/config_util.py
Outdated
| previous or future calls will raise a ValueError. This is helpful | ||
| in enforcing a singular point of initialization, thus eliminating | ||
| any potential side effects from possible prior or future overrides. | ||
| This flag overrides the mutable flag. |
There was a problem hiding this comment.
This flag only overwrites the mutable flag if it's True?
There was a problem hiding this comment.
Right. Good catch. I've clarified this.
hnyu
approved these changes
Jun 21, 2024
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 PR adds a new
sole_initflag in the originalalf.configalong with a simple wrapper function,alf.sole_config.If the flag is set to true, the config value can only be set once, with any previous or future calls raising a
ValueError. This is helpful in enforcing a singular point of initialization, thus eliminating any potential side effects from possible prior or future overrides. This is especially a problem when working deeply nestedalf.configcalls.Before, a somewhat similar behavior could be achieved through the
mutableflag, but this flag would only raise a warning, which can easily get drowned out in logs.