Skip to content

[oauthlib] Fix type on body argument of oauthlib.oauth1.Client.sign() #14295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 7, 2025
Merged

[oauthlib] Fix type on body argument of oauthlib.oauth1.Client.sign() #14295

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94ae98f
Fix type on body argument of oauth1.Client.sign()
liffiton Jun 17, 2025
a6e8e23
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 17, 2025
98c0eba
Add further types as suggested in PR review comments.
liffiton Jun 20, 2025
57d152d
Add missing import
liffiton Jun 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion stubs/oauthlib/oauthlib/oauth1/rfc5849/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,11 @@ class Client:
): ...
def get_oauth_signature(self, request): ...
def get_oauth_params(self, request): ...
def sign(self, uri, http_method: str = "GET", body: str | None = None, headers: dict[str, str] | None = None, realm=None): ...
def sign(
self,
uri,
http_method: str = "GET",

This comment was marked as outdated.

Sign in to view

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thanks. I don't have experience with type stubs, so I appreciate you providing the import statement.

body: str | dict[str, str] | list[tuple[str, str]] | None = None,
headers: dict[str, str] | None = None,
realm=None,
): ...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

def __init__(
self,
uri: str,
http_method: _HTTPMethod = "GET",
body: str | dict[str, str] | list[tuple[str, str]] | None = None,
headers: Mapping[str, str] | None = None,
encoding: str = "utf-8",
): ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! Thanks for the suggestion.