[auth0-python] Add auth0-python stubs (#13716)

Author: David-Gilman

pyrightconfig.stricter.json

@@ -24,6 +24,7 @@
         "stdlib/tkinter/ttk.pyi",
         "stubs/aiofiles/aiofiles/tempfile/temptypes.pyi",
         "stubs/antlr4-python3-runtime",
+        "stubs/auth0-python",
         "stubs/Authlib",
         "stubs/aws-xray-sdk",
         "stubs/beautifulsoup4",

stubs/auth0-python/@tests/stubtest_allowlist.txt

@@ -0,0 +1,17 @@
+# Omit tests
+auth0\.test.*
+
+# Omit _async functions because they aren't present in the code
+auth0\..*_async
+
+# Inconsistently implemented, ommitted
+auth0.asyncify.AsyncRestClient.file_post
+auth0.authentication.async_token_verifier.AsyncRestClient.file_post
+auth0.management.Auth0\..*
+auth0.rest_async.AsyncRestClient.file_post
+auth0.authentication.async_token_verifier.AsyncTokenVerifier.verify
+
+# TYPE_CHECKING override makes these show up wrong
+auth0.management.async_auth0.RestClientOptions
+auth0.management.auth0.RestClientOptions
+auth0.rest.RequestsResponse

stubs/auth0-python/METADATA.toml

@@ -0,0 +1,3 @@
+version = "4.8.*"
+upstream_repository = "https://github.com/auth0/auth0-python"
+requires = ["cryptography", "types-requests"]

stubs/auth0-python/auth0/__init__.pyi

@@ -0,0 +1,7 @@
+from auth0.exceptions import (
+    Auth0Error as Auth0Error,
+    RateLimitError as RateLimitError,
+    TokenValidationError as TokenValidationError,
+)
+
+__all__ = ("Auth0Error", "RateLimitError", "TokenValidationError")

stubs/auth0-python/auth0/asyncify.pyi

@@ -0,0 +1,6 @@
+from auth0.authentication import Users as Users
+from auth0.authentication.base import AuthenticationBase as AuthenticationBase
+from auth0.rest import RestClientOptions as RestClientOptions
+from auth0.rest_async import AsyncRestClient as AsyncRestClient
+
+def asyncify(cls): ...

stubs/auth0-python/auth0/authentication/__init__.pyi

@@ -0,0 +1,10 @@
+from .database import Database as Database
+from .delegated import Delegated as Delegated
+from .enterprise import Enterprise as Enterprise
+from .get_token import GetToken as GetToken
+from .passwordless import Passwordless as Passwordless
+from .revoke_token import RevokeToken as RevokeToken
+from .social import Social as Social
+from .users import Users as Users
+
+__all__ = ("Database", "Delegated", "Enterprise", "GetToken", "Passwordless", "RevokeToken", "Social", "Users")

stubs/auth0-python/auth0/authentication/async_token_verifier.pyi

@@ -0,0 +1,27 @@
+from _typeshed import Incomplete
+
+from .. import TokenValidationError as TokenValidationError
+from ..rest_async import AsyncRestClient as AsyncRestClient
+from .token_verifier import (
+    AsymmetricSignatureVerifier as AsymmetricSignatureVerifier,
+    JwksFetcher as JwksFetcher,
+    TokenVerifier as TokenVerifier,
+)
+
+class AsyncAsymmetricSignatureVerifier(AsymmetricSignatureVerifier):
+    def __init__(self, jwks_url: str, algorithm: str = "RS256") -> None: ...
+    def set_session(self, session) -> None: ...
+
+class AsyncJwksFetcher(JwksFetcher):
+    def __init__(self, *args, **kwargs) -> None: ...
+    def set_session(self, session) -> None: ...
+    async def get_key(self, key_id: str): ...
+
+class AsyncTokenVerifier(TokenVerifier):
+    iss: Incomplete
+    aud: Incomplete
+    leeway: Incomplete
+    def __init__(
+        self, signature_verifier: AsyncAsymmetricSignatureVerifier, issuer: str, audience: str, leeway: int = 0
+    ) -> None: ...
+    def set_session(self, session) -> None: ...

stubs/auth0-python/auth0/authentication/back_channel_login.pyi

@@ -0,0 +1,4 @@
+from .base import AuthenticationBase as AuthenticationBase
+
+class BackChannelLogin(AuthenticationBase):
+    def back_channel_login(self, binding_message: str, login_hint: str, scope: str, **kwargs): ...

stubs/auth0-python/auth0/authentication/base.pyi

@@ -0,0 +1,31 @@
+from _typeshed import Incomplete
+
+from auth0.rest import RestClient as RestClient, RestClientOptions as RestClientOptions
+from auth0.types import RequestData as RequestData
+
+from .client_authentication import add_client_authentication as add_client_authentication
+
+UNKNOWN_ERROR: str
+
+class AuthenticationBase:
+    domain: Incomplete
+    client_id: Incomplete
+    client_secret: Incomplete
+    client_assertion_signing_key: Incomplete
+    client_assertion_signing_alg: Incomplete
+    protocol: Incomplete
+    client: Incomplete
+    def __init__(
+        self,
+        domain: str,
+        client_id: str,
+        client_secret: str | None = None,
+        client_assertion_signing_key: str | None = None,
+        client_assertion_signing_alg: str | None = None,
+        telemetry: bool = True,
+        timeout: float | tuple[float, float] = 5.0,
+        protocol: str = "https",
+    ) -> None: ...
+    def post(self, url: str, data: RequestData | None = None, headers: dict[str, str] | None = None): ...
+    def authenticated_post(self, url: str, data: dict[str, Incomplete], headers: dict[str, str] | None = None): ...
+    def get(self, url: str, params: dict[str, Incomplete] | None = None, headers: dict[str, str] | None = None): ...

stubs/auth0-python/auth0/authentication/client_authentication.pyi

@@ -0,0 +1,13 @@
+from _typeshed import Incomplete
+
+def create_client_assertion_jwt(
+    domain: str, client_id: str, client_assertion_signing_key: str, client_assertion_signing_alg: str | None
+) -> str: ...
+def add_client_authentication(
+    payload: dict[str, Incomplete],
+    domain: str,
+    client_id: str,
+    client_secret: str | None,
+    client_assertion_signing_key: str | None,
+    client_assertion_signing_alg: str | None,
+) -> dict[str, Incomplete]: ...