From 723a24a6ee9adca59756d6abb12c92594bfc94d7 Mon Sep 17 00:00:00 2001 From: donBarbos Date: Fri, 4 Apr 2025 19:54:25 +0400 Subject: [PATCH] Define log var in `oauthlib` --- .../oauthlib/oauth1/rfc5849/__init__.pyi | 44 +++++++++-------- .../oauth1/rfc5849/endpoints/access_token.pyi | 4 +- .../rfc5849/endpoints/request_token.pyi | 4 +- .../oauth1/rfc5849/endpoints/resource.pyi | 4 +- .../rfc5849/endpoints/signature_only.pyi | 4 +- .../oauthlib/oauth1/rfc5849/signature.pyi | 49 +++++++++++-------- .../oauthlib/oauth1/rfc5849/utils.pyi | 25 +++++++--- .../connect/core/endpoints/userinfo.pyi | 3 +- .../core/grant_types/authorization_code.pyi | 3 +- .../openid/connect/core/grant_types/base.pyi | 4 +- .../connect/core/grant_types/dispatchers.pyi | 3 +- .../connect/core/grant_types/hybrid.pyi | 3 +- .../connect/core/grant_types/implicit.pyi | 3 +- .../core/grant_types/refresh_token.pyi | 3 +- .../openid/connect/core/request_validator.pyi | 4 +- 15 files changed, 92 insertions(+), 68 deletions(-) diff --git a/stubs/oauthlib/oauthlib/oauth1/rfc5849/__init__.pyi b/stubs/oauthlib/oauthlib/oauth1/rfc5849/__init__.pyi index 6058e9d7f1a3..a98b62b667fb 100644 --- a/stubs/oauthlib/oauthlib/oauth1/rfc5849/__init__.pyi +++ b/stubs/oauthlib/oauthlib/oauth1/rfc5849/__init__.pyi @@ -1,24 +1,26 @@ from _typeshed import Incomplete -from typing import Any +from collections.abc import Callable +from logging import Logger +from typing import Any, Final -log: Any -SIGNATURE_HMAC_SHA1: str -SIGNATURE_HMAC_SHA256: str -SIGNATURE_HMAC_SHA512: str -SIGNATURE_HMAC: str -SIGNATURE_RSA_SHA1: str -SIGNATURE_RSA_SHA256: str -SIGNATURE_RSA_SHA512: str -SIGNATURE_RSA: str -SIGNATURE_PLAINTEXT: str -SIGNATURE_METHODS: Any -SIGNATURE_TYPE_AUTH_HEADER: str -SIGNATURE_TYPE_QUERY: str -SIGNATURE_TYPE_BODY: str -CONTENT_TYPE_FORM_URLENCODED: str +log: Logger +SIGNATURE_HMAC_SHA1: Final[str] +SIGNATURE_HMAC_SHA256: Final[str] +SIGNATURE_HMAC_SHA512: Final[str] +SIGNATURE_HMAC: Final[str] +SIGNATURE_RSA_SHA1: Final[str] +SIGNATURE_RSA_SHA256: Final[str] +SIGNATURE_RSA_SHA512: Final[str] +SIGNATURE_RSA: Final[str] +SIGNATURE_PLAINTEXT: Final[str] +SIGNATURE_METHODS: Final[tuple[str, str, str, str, str, str, str]] +SIGNATURE_TYPE_AUTH_HEADER: Final[str] +SIGNATURE_TYPE_QUERY: Final[str] +SIGNATURE_TYPE_BODY: Final[str] +CONTENT_TYPE_FORM_URLENCODED: Final[str] class Client: - SIGNATURE_METHODS: Any + SIGNATURE_METHODS: dict[str, Callable[[str, Incomplete], str]] @classmethod def register_signature_method(cls, method_name, method_callback) -> None: ... client_key: Any @@ -37,8 +39,8 @@ class Client: timestamp: Any def __init__( self, - client_key, - client_secret: Incomplete | None = None, + client_key: str, + client_secret: str | None = None, resource_owner_key: Incomplete | None = None, resource_owner_secret: Incomplete | None = None, callback_uri: Incomplete | None = None, @@ -58,7 +60,7 @@ class Client: self, uri, http_method: str = "GET", - body: Incomplete | None = None, - headers: Incomplete | None = None, + body: str | None = None, + headers: dict[str, str] | None = None, realm: Incomplete | None = None, ): ... diff --git a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/access_token.pyi b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/access_token.pyi index b924cc7cc7f0..a9f541a2b282 100644 --- a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/access_token.pyi +++ b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/access_token.pyi @@ -1,9 +1,9 @@ from _typeshed import Incomplete -from typing import Any +from logging import Logger from .base import BaseEndpoint as BaseEndpoint -log: Any +log: Logger class AccessTokenEndpoint(BaseEndpoint): def create_access_token(self, request, credentials): ... diff --git a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/request_token.pyi b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/request_token.pyi index 940486b28a02..dcdd497ec614 100644 --- a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/request_token.pyi +++ b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/request_token.pyi @@ -1,9 +1,9 @@ from _typeshed import Incomplete -from typing import Any +from logging import Logger from .base import BaseEndpoint as BaseEndpoint -log: Any +log: Logger class RequestTokenEndpoint(BaseEndpoint): def create_request_token(self, request, credentials): ... diff --git a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/resource.pyi b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/resource.pyi index a7219c670789..c59cab3e82f8 100644 --- a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/resource.pyi +++ b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/resource.pyi @@ -1,9 +1,9 @@ from _typeshed import Incomplete -from typing import Any +from logging import Logger from .base import BaseEndpoint as BaseEndpoint -log: Any +log: Logger class ResourceEndpoint(BaseEndpoint): def validate_protected_resource_request( diff --git a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/signature_only.pyi b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/signature_only.pyi index 0b0994158455..38ac0d31be9d 100644 --- a/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/signature_only.pyi +++ b/stubs/oauthlib/oauthlib/oauth1/rfc5849/endpoints/signature_only.pyi @@ -1,9 +1,9 @@ from _typeshed import Incomplete -from typing import Any +from logging import Logger from .base import BaseEndpoint as BaseEndpoint -log: Any +log: Logger class SignatureOnlyEndpoint(BaseEndpoint): def validate_request( diff --git a/stubs/oauthlib/oauthlib/oauth1/rfc5849/signature.pyi b/stubs/oauthlib/oauthlib/oauth1/rfc5849/signature.pyi index e37b9be48439..9da09f5d07e3 100644 --- a/stubs/oauthlib/oauthlib/oauth1/rfc5849/signature.pyi +++ b/stubs/oauthlib/oauthlib/oauth1/rfc5849/signature.pyi @@ -1,33 +1,40 @@ -from _typeshed import Incomplete -from typing import Any +from _typeshed import Incomplete, Unused +from collections.abc import Iterable +from logging import Logger -log: Any +from oauthlib.common import Request, _HTTPMethod -def signature_base_string(http_method: str, base_str_uri: str, normalized_encoded_request_parameters: str) -> str: ... +log: Logger + +def signature_base_string(http_method: _HTTPMethod, base_str_uri: str, normalized_encoded_request_parameters: str) -> str: ... def base_string_uri(uri: str, host: str | None = None) -> str: ... def collect_parameters( uri_query: str = "", - body: Incomplete | None = None, - headers: Incomplete | None = None, + body: str | bytes | dict[str, str] | Iterable[tuple[str, str]] | None = None, + headers: dict[str, str] | None = None, exclude_oauth_signature: bool = True, with_realm: bool = False, -): ... -def normalize_parameters(params) -> str: ... -def sign_hmac_sha1_with_client(sig_base_str, client): ... -def verify_hmac_sha1(request, client_secret: Incomplete | None = None, resource_owner_secret: Incomplete | None = None): ... -def sign_hmac_sha1(base_string, client_secret, resource_owner_secret): ... +) -> list[tuple[str, str]]: ... +def normalize_parameters(params: dict[str, str]) -> str: ... +def sign_hmac_sha1_with_client(sig_base_str: str, client): ... +def verify_hmac_sha1( + request: Request, client_secret: Incomplete | None = None, resource_owner_secret: Incomplete | None = None +) -> bool: ... +def sign_hmac_sha1(base_string: str | bytes, client_secret, resource_owner_secret): ... def sign_hmac_sha256_with_client(sig_base_str, client): ... -def verify_hmac_sha256(request, client_secret: Incomplete | None = None, resource_owner_secret: Incomplete | None = None): ... -def sign_hmac_sha256(base_string, client_secret, resource_owner_secret): ... +def verify_hmac_sha256( + request, client_secret: Incomplete | None = None, resource_owner_secret: Incomplete | None = None +) -> bool: ... +def sign_hmac_sha256(base_string: str | bytes, client_secret, resource_owner_secret): ... def sign_hmac_sha512_with_client(sig_base_str: str, client): ... -def verify_hmac_sha512(request, client_secret: str | None = None, resource_owner_secret: str | None = None): ... -def sign_rsa_sha1_with_client(sig_base_str, client): ... -def verify_rsa_sha1(request, rsa_public_key: str): ... +def verify_hmac_sha512(request, client_secret: str | None = None, resource_owner_secret: str | None = None) -> bool: ... +def sign_rsa_sha1_with_client(sig_base_str: str | bytes, client): ... +def verify_rsa_sha1(request, rsa_public_key: str) -> bool: ... def sign_rsa_sha1(base_string, rsa_private_key): ... def sign_rsa_sha256_with_client(sig_base_str: str, client): ... -def verify_rsa_sha256(request, rsa_public_key: str): ... +def verify_rsa_sha256(request, rsa_public_key: str) -> bool: ... def sign_rsa_sha512_with_client(sig_base_str: str, client): ... -def verify_rsa_sha512(request, rsa_public_key: str): ... -def sign_plaintext_with_client(_signature_base_string, client): ... -def sign_plaintext(client_secret, resource_owner_secret): ... -def verify_plaintext(request, client_secret: Incomplete | None = None, resource_owner_secret: Incomplete | None = None): ... +def verify_rsa_sha512(request, rsa_public_key: str) -> bool: ... +def sign_plaintext_with_client(_signature_base_string: Unused, client) -> str: ... +def sign_plaintext(client_secret: str | None, resource_owner_secret: str | None) -> str: ... +def verify_plaintext(request, client_secret: str | None = None, resource_owner_secret: str | None = None) -> bool: ... diff --git a/stubs/oauthlib/oauthlib/oauth1/rfc5849/utils.pyi b/stubs/oauthlib/oauthlib/oauth1/rfc5849/utils.pyi index cce8ec232e67..14f91fd1434c 100644 --- a/stubs/oauthlib/oauthlib/oauth1/rfc5849/utils.pyi +++ b/stubs/oauthlib/oauthlib/oauth1/rfc5849/utils.pyi @@ -1,9 +1,18 @@ -UNICODE_ASCII_CHARACTER_SET: str +from collections.abc import Callable, Iterable +from typing import Any, Final, TypeVar -def filter_params(target): ... -def filter_oauth_params(params): ... -def escape(u): ... -def unescape(u): ... -def parse_keqv_list(l): ... -def parse_http_list(u): ... -def parse_authorization_header(authorization_header): ... +_T = TypeVar("_T") + +UNICODE_ASCII_CHARACTER_SET: Final[str] + +def filter_params( + target: Callable[[dict[str, Any] | Iterable[tuple[str, Any]], _T], object], +) -> Callable[[list[str], _T], object]: ... +def filter_oauth_params( + params: dict[str, Any] | Iterable[tuple[str, Any]], +) -> list[str]: ... # we don't care about second (Any) part +def escape(u: str) -> str: ... +def unescape(u: str) -> str: ... +def parse_keqv_list(l: list[str]) -> dict[str, str]: ... +def parse_http_list(u: str) -> list[str]: ... +def parse_authorization_header(authorization_header: str) -> list[tuple[str, str]]: ... diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/endpoints/userinfo.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/endpoints/userinfo.pyi index 4e6239a084cb..1b22e896f817 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/endpoints/userinfo.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/endpoints/userinfo.pyi @@ -1,9 +1,10 @@ from _typeshed import Incomplete +from logging import Logger from typing import Any from oauthlib.oauth2.rfc6749.endpoints.base import BaseEndpoint as BaseEndpoint -log: Any +log: Logger class UserInfoEndpoint(BaseEndpoint): bearer: Any diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/authorization_code.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/authorization_code.pyi index c977ff3928cb..a244bccd5eb4 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/authorization_code.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/authorization_code.pyi @@ -1,9 +1,10 @@ from _typeshed import Incomplete +from logging import Logger from typing import Any from .base import GrantTypeBase as GrantTypeBase -log: Any +log: Logger class AuthorizationCodeGrant(GrantTypeBase): proxy_target: Any diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/base.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/base.pyi index be05e3f78c57..0e049a5bcb0a 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/base.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/base.pyi @@ -1,7 +1,7 @@ from _typeshed import Incomplete -from typing import Any +from logging import Logger -log: Any +log: Logger class GrantTypeBase: def __getattr__(self, attr: str): ... diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/dispatchers.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/dispatchers.pyi index f33ed52817fb..bfc918c0b74b 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/dispatchers.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/dispatchers.pyi @@ -1,7 +1,8 @@ from _typeshed import Incomplete +from logging import Logger from typing import Any -log: Any +log: Logger class Dispatcher: default_grant: Any diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/hybrid.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/hybrid.pyi index 042510bacdec..9c909a884835 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/hybrid.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/hybrid.pyi @@ -1,4 +1,5 @@ from _typeshed import Incomplete +from logging import Logger from typing import Any from oauthlib.oauth2.rfc6749.errors import InvalidRequestError as InvalidRequestError @@ -6,7 +7,7 @@ from oauthlib.oauth2.rfc6749.errors import InvalidRequestError as InvalidRequest from ..request_validator import RequestValidator as RequestValidator from .base import GrantTypeBase as GrantTypeBase -log: Any +log: Logger class HybridGrant(GrantTypeBase): request_validator: Any diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/implicit.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/implicit.pyi index 136f25661891..138ab6e228ee 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/implicit.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/implicit.pyi @@ -1,9 +1,10 @@ from _typeshed import Incomplete +from logging import Logger from typing import Any from .base import GrantTypeBase as GrantTypeBase -log: Any +log: Logger class ImplicitGrant(GrantTypeBase): proxy_target: Any diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/refresh_token.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/refresh_token.pyi index 810e4f8dbfc6..cf126c21c85e 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/refresh_token.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/grant_types/refresh_token.pyi @@ -1,8 +1,9 @@ from _typeshed import Incomplete +from logging import Logger from .base import GrantTypeBase -log: Incomplete +log: Logger class RefreshTokenGrant(GrantTypeBase): proxy_target: Incomplete diff --git a/stubs/oauthlib/oauthlib/openid/connect/core/request_validator.pyi b/stubs/oauthlib/oauthlib/openid/connect/core/request_validator.pyi index 6790cf455374..4e29f272031d 100644 --- a/stubs/oauthlib/oauthlib/openid/connect/core/request_validator.pyi +++ b/stubs/oauthlib/oauthlib/openid/connect/core/request_validator.pyi @@ -1,8 +1,8 @@ -from typing import Any +from logging import Logger from oauthlib.oauth2.rfc6749.request_validator import RequestValidator as OAuth2RequestValidator -log: Any +log: Logger class RequestValidator(OAuth2RequestValidator): def get_authorization_code_scopes(self, client_id, code, redirect_uri, request) -> None: ...