fix: improve error messages in deep_iterable and deep_mapping validators#1533
Closed
JasonOA888 wants to merge 2 commits intopython-attrs:mainfrom
Closed
fix: improve error messages in deep_iterable and deep_mapping validators#1533JasonOA888 wants to merge 2 commits intopython-attrs:mainfrom
JasonOA888 wants to merge 2 commits intopython-attrs:mainfrom
Conversation
When inner validators fail, the error message now includes the index/key of the failing element instead of just the parent attribute name. Before: "Length of 'x' must be >= 1: 0" After: "Length of 'x[1]' must be >= 1: 0" This makes it clear which element in the iterable/mapping failed validation. Fixes python-attrs#1245
for more information, see https://pre-commit.ci
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
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.
Summary
Fixes #1245 (also referenced in #1206)
When inner validators fail in
deep_iterableordeep_mapping, the error message now includes the index/key of the failing element instead of just the parent attribute name.Problem
Before this fix:
The error says
'x'but it's notxthat is too short - it's one of its items.Solution
After this fix:
Now the error clearly indicates which element failed validation.
Changes
_DeepIterable.__call__to catch exceptions and rewrite the attribute name to include the index_DeepMapping.__call__to catch exceptions and rewrite the attribute name to include the keyTesting