replace JSONType with Any #1856
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
pquentin
approved these changes
Jul 4, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Jul 4, 2024
(cherry picked from commit d045a99)
miguelgrinberg
added a commit
that referenced
this pull request
Jul 4, 2024
(cherry picked from commit d045a99) Co-authored-by: Miguel Grinberg <[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.
One of the issues I'm facing when trying to type the examples is that JSONType was used in many places to represent responses from the API. Because this is an imperfect type hint, it requires adding casts all over the place.
With this change I'm removing
JSONTypeand replacing it withAny. This matches the commonly usedObjectApiResponse[Any]from the low-level client, and lets mypy digest attribute accesses without generating warnings, in things likeself.meta.inner_hits.answer.hits. Just by making this change a few type ignores can be removed, and no new typing errors appeared.I think in the future I will revisit this and create proper types for the response structure, but for now I think
Anyis the best choice.