Error if an invalid field name is used with Field #6797
Merged
Conversation
This file contains 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
Deploying with
|
| Latest commit: |
f203806
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://436da25d.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://error-for-invalid-field-name.pydantic-docs2.pages.dev |
hramezani
reviewed
Jul 21, 2023
hramezani
reviewed
Jul 21, 2023
| elif isinstance(value, FieldInfo) and not is_valid_field_name(var_name): | ||
| suggested_name = var_name.lstrip('_') or 'my_field' # don't suggest '' for all-underscore name | ||
| raise NameError( | ||
| f'Fields must not use names with leading underscores;' |
There was a problem hiding this comment.
Suggested change
| f'Fields must not use names with leading underscores;' | |
| f'Field() must not use names with leading underscores;' |
There was a problem hiding this comment.
We say Private attributes above, which I was trying to mirror here with the description of what it was, rather than the function used to create it. I actually think it's less confusing like this because people might not realize that calling Field() signals to pydantic that that thing should be a field, which is what I want to emphasize.
There was a problem hiding this comment.
Agree, I've edited my suggestion
hramezani
approved these changes
Jul 21, 2023
hramezani
approved these changes
Jul 21, 2023
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.
Closes #6745