Improve JsonType type definition #3667
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR improves type definitions and annotations in the Redis commands modules. Key changes include:
- Updating type annotations for query parameters and methods in the Query class.
- Changing the _ids attribute from a List to a Tuple to promote immutability.
- Enhancing the JsonType definition to a recursive and Mapping-based type.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| redis/commands/search/query.py | Refined type annotations for method arguments and attributes to better reflect their intended usage. |
| redis/commands/json/_util.py | Updated the JsonType definition to a recursive structure using Mapping, aligning with JSON standards. |
Comments suppressed due to low confidence (1)
redis/commands/search/query.py:34
- Consider updating the _ids type annotation to Tuple[str, ...] if multiple string IDs are expected, to clarify that it may contain more than one element.
self._ids: Optional[Tuple[str]] = None
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.
Pull Request check-list
Please make sure to review and check all of these items:
NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.
Description of change
Fixes #3519
Related discussion in python source repo: python/typing#182