fix(python): exclude unset API values on model dump #3777
Merged
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
✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
shortcuts
changed the title
shortcuts
force-pushed
the
fix/python-default-values
branch
from
3ad5b24 to
2a89472
Compare
shortcuts
changed the title
millotp
reviewed
Sep 19, 2024
| @@ -2,5 +2,5 @@ argcomplete==3.5.0 | |||
| click==8.1.7 | |||
| packaging==24.1 | |||
| pipx==1.7.1 | |||
| platformdirs==4.3.3 | |||
| platformdirs==4.2.2 | |||
There was a problem hiding this comment.
why the downgrade ? I think this file should be excluded from PR
There was a problem hiding this comment.
idk I've let the tooling do its thing, it was after this change
algolia-bot
added a commit
that referenced
this pull request
Sep 19, 2024
…d) [skip ci] Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-python
that referenced
this pull request
Sep 19, 2024
algolia/api-clients-automation#3777 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clément Vannicatte <[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.
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-2951
Changes included:
see https://algolia.slack.com/archives/C336MP4UA/p1726487274846109 for context
Pydantic requires default values on optional fields (which is an other problem I should tackle), but those default values are also added to the dict when dumping the model, which we don't want because we only want to rely on what the API returns, in case there's a change there before it is reflected on the client.
We now tell Pydantic to only rely on values that are set, and ignore the defaults.
You can try it by running the playground as-is, and see that the default searchParams are not provided, only the one explicit defined