Rename skip-defaults, and add ability to exclude actual defaults #915
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
dmontagu
commented
Oct 21, 2019
Codecov Report
@@ Coverage Diff @@
## master #915 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 16 16
Lines 2799 2799
Branches 543 543
=====================================
Hits 2799 2799Continue to review full report at Codecov.
|
pydantic/main.py
Outdated
| @@ -345,8 +358,20 @@ def json( | |||
|
|
|||
| `encoder` is an optional function to supply as `default` to json.dumps(), other arguments as per `json.dumps()`. | |||
| """ | |||
| if skip_defaults is not None: | |||
| warnings.warn( | |||
| f'{type(self).__name__}.dict: "skip_defaults" is deprecated and replaced by "exclude_unset"', | |||
There was a problem hiding this comment.
Suggested change
| f'{type(self).__name__}.dict: "skip_defaults" is deprecated and replaced by "exclude_unset"', | |
| f'{type(self).__name__}.json: "skip_defaults" is deprecated and replaced by "exclude_unset"', |
?
dmontagu
commented
Oct 21, 2019
4 tasks
dmontagu
commented
Oct 21, 2019
|
need tests for the warning raise by |
|
also need a change file. |
|
I think this is the only thing v1 is waiting for. If possible it would be great if this could get finished. Otherwise hope you don't if I push to this PR to finish it tomorrow. |
dmontagu
force-pushed
the
rename-skip-defaults
branch
from
263f9af
to
1c64181
Compare
|
awesome, thank you. |
andreshndz
pushed a commit
to cuenca-mx/pydantic
that referenced
this pull request
Jan 17, 2020
…antic#915) * Rename skip-defaults, and add ability to exclude actual defaults * Add __defaults__ and deprecation warnings * Add note about `skip_defaults` to docs * Incorporate feedback * Add tests and changes * Fix reference to .json()
alexdrydew
pushed a commit
to alexdrydew/pydantic
that referenced
this pull request
Dec 23, 2023
4 tasks
elliotgunton
added a commit
to argoproj-labs/hera
that referenced
this pull request
Sep 27, 2024
**Description of PR** Currently, we are setting both `skip_defaults` and `exclude_unset` when we call Pydantic's `json` method. The former was made a (deprecated) alias for the latter in pydantic/pydantic#915, released [as part of v1.0](https://github.com/pydantic/pydantic/blob/main/HISTORY.md#v10-2019-10-23); we have a minimum requirement of v1.7. This PR removes the redundant `skip_defaults` parameter. Signed-off-by: Alice Purcell <[email protected]> Co-authored-by: Elliot Gunton <[email protected]>
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
Rename
skip_defaultstoexclude_unset, and addexclude_defaultsargument.Still need to add tests and docs, but I wanted to get some feedback on the approach first.
Related issue number
fix #523
Checklist
changes/<pull request or issue id>-<github username>.mdfile added describing change(see changes/README.md for details)