Improve warning message when a field name shadows a field in a parent model#9105
Merged
sydney-runkle merged 3 commits intopydantic:mainfrom Mar 26, 2024
chan-vince:improve-user-warning-message
Merged
Improve warning message when a field name shadows a field in a parent model#9105sydney-runkle merged 3 commits intopydantic:mainfrom chan-vince:improve-user-warning-message
sydney-runkle merged 3 commits intopydantic:mainfrom
chan-vince:improve-user-warning-message
Conversation
Contributor
Author
|
please review |
CodSpeed Performance ReportMerging #9105 will not alter performanceComparing Summary
|
sydney-runkle
approved these changes
Mar 26, 2024
Contributor
sydney-runkle
left a comment
There was a problem hiding this comment.
Great work, thank you!
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.
Change Summary
Added in #7193, a helpful warning message is displayed when a subclass contains a field with the same name as the parent class.
If you have many models that inherit from a parent class, it would be helpful to be able to see in the warning message which child model contains the duplicate field name - not just the parent class.
So I've simply tweaked the warning message text to allow the user to easily see which model they should inspect.
Before:
After:
I think this is clearer for cases where you have tens or hundreds of ChildModels.
I also removed the semi-colon because I'm not sure why it's there, but happy to put that back, I may have missed a convention or other warning message or code style rule.
Related issue number
None
Checklist
Selected Reviewer: @Kludex