Improve schema validation error messages #140
Merged
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.
We previously decided to suppress
jsonschema.exceptions.ValidationError
messages because they provided a significant amount of context by default. By extracting the 'message' field, we can provide a helpful error message without also providing full context about the schema.Related issues
Closes #67.
Proposed changes
ValueError
raised by a validation failure.ValueError
explicitly, since catchingBaseException
may hide other failures.Before this change, any error in the .cbi/config file produced this error:
Now, it produces helpful errors: