Clarify that only required=True conflicts with default in field docs - #10030
Merged
Merged
Conversation
browniebroke
approved these changes
Sep 1, 2026
required=True conflicts with default in field docs
Collaborator
|
Thanks |
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.
The fields docs say that "including both the
defaultandrequiredkeyword arguments is invalid and will raise an error". The assertion inField.__init__isassert not (required and default is not empty), so onlyrequired=Truecombined with a default raises. An explicitrequired=Falsepasses silently. Reword the note to match the implemented behavior.