Draft: Fix return types of some Surreal
methods
#98
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 some return types from
List[Dict, Any]
toUnions[Dict[str, Any], List[Dict, Any]]
, or the Optional[...], variant of that.What is the motivation?
Fix the currently incomplete/wrong return type annotations of some
Surreal
(WS/RPC client) methods.Improving developer experience of users.
Type of Change
What does this change do?
Changes the return type of some methods from
List[Dict[str, Any]]
toUnion[Dict[str, Any], List[Dict[str, Any]]]
forcreate
,update
, andmerge
Optional[Union[Dict[str, Any], List[Dict[str, Any]]]]
forselect
anddelete
What is your testing strategy?
mypy
returned OKpre-commit
returned OK./scripts/run_tests.sh
returned OKIs this related to any issues?
Yes: #97
This PR is regarding the first "1." propose solution in the above referenced issue.
Have you read the Contributing Guidelines?