Add custom validator to blueprint variables #218
Merged
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
- Now all blueprint variables must provide a `type`, otherwise an exception is thrown. Before it wasn't required, and the type was ignored if it wasn't provided. That didn't seem right to me, but I realize I may just not have understood the implications. Other changes: - variable resolution now done in a function not a class method - moved variable type validation to a function - instead of passing the whole blueprint just to use it's name, I just pass the blueprints name into the exceptions that use them (that was all the blueprint was used for it appeared) I'll add docs in the next checkin.
|
Fixes #217 |
|
|
||
| # If no validator, return the value as is, otherwise apply validator | ||
| validator = var_def.get("validator", lambda v: v) | ||
| value = validator(value) |
There was a problem hiding this comment.
I think we should have a preferred exception that validators raise that gets caught here. Then we can include more details about which variable was invalid etc.
Right now if you raise an exception within the validator, you can't tell which variable was being validated.
There was a problem hiding this comment.
or maybe just any exception that is raised by the validator we wrap with some other info?
There was a problem hiding this comment.
Good call - I'll think about it and come up with something that makes it easy to tell which variable failed it's validator, and why.
Makes it a bit more explicit when there is an issue with a validator.
| try: | ||
| value = validator(value) | ||
| except Exception as exc: | ||
| raise ValidatorError(var_name, validator.__name__, value, exc) |
There was a problem hiding this comment.
add this to docstring above
|
👍 |
|
|
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.
type, otherwise anexception is thrown.
Before it wasn't required, and the type was ignored if it wasn't
provided. That didn't seem right to me, but I realize I may just not
have understood the implications.
Other changes:
pass the blueprints name into the exceptions that use them (that was
all the blueprint was used for it appeared)
I'll add docs in the next checkin.