[oauthlib] Fix type on body argument of oauthlib.oauth1.Client.sign() #14295
Conversation
From the oauthlib documentation: "The body argument may be a dict, a list of 2-tuples, or a formencoded string."
liffiton
changed the title
This comment has been minimized.
This comment has been minimized.
One mypy type error remains, caused by an issue in the typeshed type stubs. python/typeshed#14295
| def sign( | ||
| self, | ||
| uri, | ||
| http_method: str = "GET", | ||
| body: str | dict[str, str] | list[tuple[str, str]] | None = None, | ||
| headers: dict[str, str] | None = None, | ||
| realm=None, | ||
| ): ... |
There was a problem hiding this comment.
Many of these arguments are forwarded to oauthlib.common.Request: https://github.com/oauthlib/oauthlib/blob/v3.3.0/oauthlib/oauth1/rfc5849/__init__.py#L295-L296. If you're feeling ambitious, you could align some of the other parameter hints with its signature:
typeshed/stubs/oauthlib/oauthlib/common.pyi
Lines 67 to 74 in ca543bf
There was a problem hiding this comment.
Sure! Thanks for the suggestion.
| def sign( | ||
| self, | ||
| uri, | ||
| http_method: str = "GET", |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Ah, thanks. I don't have experience with type stubs, so I appreciate you providing the import statement.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
From the function docstring: "The body argument may be a dict, a list of 2-tuples, or a formencoded string."