Helpful TypeError when user forgets to return values in root valida…
#2209
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
Codecov Report
@@ Coverage Diff @@
## master #2209 +/- ##
===========================================
- Coverage 100.00% 99.93% -0.07%
===========================================
Files 21 22 +1
Lines 4121 4351 +230
Branches 829 875 +46
===========================================
+ Hits 4121 4348 +227
- Misses 0 3 +3
Continue to review full report at Codecov.
|
PrettyWood
reviewed
Dec 18, 2020
samuelcolvin
reviewed
Jan 1, 2021
pydantic/main.py
Outdated
| object_setattr(__pydantic_self__, '__fields_set__', fields_set) | ||
| __pydantic_self__._init_private_attributes() | ||
|
|
||
| @no_type_check | ||
| @no_type_check # noqa: C901 (ignore complexity) |
There was a problem hiding this comment.
It's because of #2198 (review)
PrettyWood
reviewed
Jan 19, 2021
PrettyWood
added
the
awaiting author revision
PrettyWood
reviewed
Jan 19, 2021
changes/2209-masalim2.md
Outdated
| @@ -0,0 +1 @@ | |||
| User-friendly TypeError when a `root_validator` returns `None`. | |||
There was a problem hiding this comment.
Better add a verb at the beginning like
Raise a user-friendly
TypeErrorwhen aroot_validatordoes not return a dict (e.g.None).
Otherwise LGTM 👍
PrettyWood
approved these changes
Jan 19, 2021
PrettyWood
added
ready for review
and removed
awaiting author revision
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.
Change Summary
If a user forgot to return the
valuesdict in a root validator, they'd see a somewhat opaque exception:Added a quick check in
BaseModel.__init__to raise a more user-friendly hint in the TypeError:Related issue number
Checklist
changes/<pull request or issue id>-<github username>.mdfile added describing change(see changes/README.md for details)