Deprecate Field.include
#6852
Merged
Deprecate Field.include
#6852
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
Deploying with
|
| Latest commit: |
510f961
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://24ca2a59.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://deprecate-field-include.pydantic-docs2.pages.dev |
|
please review |
Kludex
reviewed
Jul 26, 2023
docs/usage/serialization.md
Outdated
| id: int = Field(..., include=True) | ||
| username: str = Field(..., include=True) # overridden by explicit include | ||
| id: int | ||
| username: str # overridden by explicit include |
There was a problem hiding this comment.
No, I've just removed it.
| @@ -793,6 +785,10 @@ def Field( # noqa: C901 | |||
| if validation_alias in (_Unset, None): | |||
| validation_alias = alias | |||
|
|
|||
| include = extra.pop('include', None) # type: ignore | |||
| if include is not None: | |||
| warn('`include` is deprecated and does nothing. It will be removed, use `exclude` instead', DeprecationWarning) | |||
There was a problem hiding this comment.
AFAIU, this is not a deprecation... If the functionality is removed, it's a removal. The parameter itself is deprecated.
Also, how is exclude a replacement for include? 🤔
There was a problem hiding this comment.
AFAIU, this is not a deprecation... If the functionality is removed, it's a removal. The parameter itself is deprecated.
I think it is a deprecation as it did nothing before and still does nothing. So, no change in functionality. just warning the user.
Also, how is
excludea replacement forinclude? 🤔
include=False can be replaced with exclude=True. That's why I suggested using exclude.
hramezani
force-pushed
the
deprecate-field-include
branch
from
42a0f88 to
510f961
Compare
Kludex
approved these changes
Jul 26, 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.
Selected Reviewer: @Kludex