Fix typing - :type kwargs: dict is not correct#7422
Closed
retnikt wants to merge 1 commit intogoogleapis:masterfrom
Closed
Fix typing - :type kwargs: dict is not correct#7422retnikt wants to merge 1 commit intogoogleapis:masterfrom
:type kwargs: dict is not correct#7422retnikt wants to merge 1 commit intogoogleapis:masterfrom
Conversation
When typing Python code, the special `*args` and `**kwargs` params are typed based on their contents, e.g.
```python
def foo(thing: int, *args: str):
...
def bar(thing: int, *args: str, **kwargs: Union[int, float]):
...
bar(-3, "G", spam=80, eggs=4.4)
foo(44, "abc", "xyz")```
And in this case, the types are passed to a different func (`Query.__init__`) which has specific arguments, so it is best to not give **kwargs a type, or, better, copy the parameters of that function (but I haven't done this here).
This also applies to `Transaction`.
PS I know this is a stupidly minor change but it annoys me, having to write `noinspection PyTypeChecker` before every datastore query.
:smile:
Contributor
|
@crwilcox I'm -1 on this change myself, but will leave it to you to decide: if we are going to change how we document |
Contributor
|
I spent some time researching. This is also how mypy interprets types. I agree though @tseaver, we likely need to do this more broadly. |
Contributor
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
When typing Python code, the special
*argsand**kwargsparams are typed based on their contents, not what they actually are (a tuple, and a dict) e.g.And in this case, the types are passed to a different func (
Query.__init__) which has specific arguments, so it is best to not give **kwargs a type, or, better, copy the parameters of that function (but I haven't done this here).This also applies to
Transaction.PS I know this is a stupidly minor change but it annoys me, having to write
noinspection PyTypeCheckerbefore every datastore query.😄