fix(python): remove warnings for HighlightResult and SnippetResult #5284
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.
|
millotp
approved these changes
Sep 1, 2025
algolia-bot
added a commit
that referenced
this pull request
Sep 1, 2025
…5284) (generated) [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 1, 2025
…enerated) algolia/api-clients-automation#5284 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/CR-8953 https://algolia.atlassian.net/browse/DI-4020
Changes included:
closes algolia/algoliasearch-client-python#569
When calling
to_dicton a search response, pydantic yells about recursion issue and incorrect typings of our HighlightResult and SnippetResults models.I tried many ways to solve this, and sadly the only other solution that would work (except the one proposed in this PR) is to implement a custom serializer for every models, which would be a much harder work to put in place.
In the meantime, I propose using a custom serializer (with the
field_serializerfeature from Pydantic), that allows us to simply remove warnings for those two models.