[oauthlib] Fix type on body argument of oauthlib.oauth1.Client.sign() #14295
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
From the oauthlib documentation: "The body argument may be a dict, a list of 2-tuples, or a formencoded string."
liffiton
changed the title
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
liffiton
added a commit
to liffiton/Gen-Ed
that referenced
this pull request
Jun 17, 2025
One mypy type error remains, caused by an issue in the typeshed type stubs. python/typeshed#14295
brianschubert
approved these changes
Jun 18, 2025
Comment on lines
+59
to
+66
| 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
donBarbos
reviewed
Jun 18, 2025
| def sign( | ||
| self, | ||
| uri, | ||
| http_method: str = "GET", |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
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.
From the function docstring: "The body argument may be a dict, a list of 2-tuples, or a formencoded string."