CLI: Validate strict in verdi config set caching.disabled_for
#6197
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
sphuber
force-pushed
the
fix/verdi-config-set-caching-strict
branch
2 times, most recently
from
864180e to
d183b93
Compare
|
@unkcpz shall we try to get this in the release? |
|
Sorry, I missed this PR. I'll give it a look now. |
unkcpz
approved these changes
Dec 14, 2023
There was a problem hiding this comment.
Thanks! @sphuber
The downside of this approach is that it is no longer possible to disable or enable caching for an entry point or import path that cannot be loaded in the current environment. But then again, the question is what the use would be of such a use-case.
I think it is not a downside but even an upside to giving strict validation. Plus you add nice documentation for this case, it will be all fine I assume.
Values provided for `verdi config set caching.disabled_for` and `verdi config set caching.enabled_for` were validated, but without setting `strict=True` for the `_validate_identifier_pattern` validator. This keyword was recently added and when set to `True` would actually attempt to load the entry point or import path. Without this strict validation, a user could accidentally set an incorrect value to enable or disable caching for. Most common example is where a correct entry point was provided but without the entry point group, e.g., `core.arithmetic.add`. The validator would interpret this as an import path and not as an entry point, and since strict validation was turned off, it didn't attempt to actually import it. The `strict` validation is now turned on causing the example above to return a validation error. The downside of this approach is that it is no longer possible to disable or enable caching for an entry point or import path that cannot be loaded in the current environment. But then again, the question is what the use would be of such a use-case.
sphuber
force-pushed
the
fix/verdi-config-set-caching-strict
branch
from
d183b93 to
8a7dd66
Compare
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.
Values provided for
verdi config set caching.disabled_forandverdi config set caching.enabled_forwere validated, but without settingstrict=Truefor the_validate_identifier_patternvalidator. This keyword was recently added (b9144bb) and when set toTruewould actually attempt to load the entry point or import path.Without this strict validation, a user could accidentally set an incorrect value to enable or disable caching for. Most common example is where a correct entry point was provided but without the entry point group, e.g.,
core.arithmetic.add. The validator would interpret this as an import path and not as an entry point, and since strict validation was turned off, it didn't attempt to actually import it.The
strictvalidation is now turned on causing the example above to return a validation error. The downside of this approach is that it is no longer possible to disable or enable caching for an entry point or import path that cannot be loaded in the current environment. But then again, the question is what the use would be of such a use-case.