Problem
The AsyncOAuth2Client class in stubs/Authlib/authlib/integrations/httpx_client/oauth2_client.pyi is missing type annotations for the async context manager protocol (__aenter__ and __aexit__), causing type checkers to incorrectly flag valid async with usage as errors.
Expected Behavior
AsyncOAuth2Client should be usable as an async context manager since it inherits from httpx.AsyncClient at runtime:
from authlib.integrations.httpx_client import AsyncOAuth2Client
async with AsyncOAuth2Client(client_id="...", client_secret="...") as client:
response = await client.get("https://api.example.com/data")
Actual Behavior
Pyright reports errors:
error: Object of type "AsyncOAuth2Client" cannot be used with "async with" because it does not correctly implement __aenter__
Attribute "__aenter__" is unknown (reportGeneralTypeIssues)
error: Object of type "AsyncOAuth2Client" cannot be used with "with" because it does not correctly implement __aexit__
Attribute "__aexit__" is unknown (reportGeneralTypeIssues)
Root Cause
The stub file at line 26-27 shows:
# Inherits from httpx.AsyncClient
class AsyncOAuth2Client(_OAuth2Client):
The comment is correct but the type stub is incomplete. The class should expose the async context manager protocol from httpx.AsyncClient, but it's not properly modeled in the stubs.
Runtime Verification
At runtime, AsyncOAuth2Client does have these methods:
from authlib.integrations.httpx_client import AsyncOAuth2Client
print(hasattr(AsyncOAuth2Client, '__aenter__')) # True
print(hasattr(AsyncOAuth2Client, '__aexit__')) # True
Proposed Fix
Update stubs/Authlib/authlib/integrations/httpx_client/oauth2_client.pyi to explicitly declare the async context manager protocol:
from typing_extensions import Self
class AsyncOAuth2Client(_OAuth2Client):
SESSION_REQUEST_PARAMS: list[str]
client_auth_class = OAuth2ClientAuth
token_auth_class = OAuth2Auth
oauth_error_class = OAuthError
def __init__(
self,
client_id=None,
client_secret=None,
token_endpoint_auth_method=None,
revocation_endpoint_auth_method=None,
scope=None,
redirect_uri=None,
token=None,
token_placement="header",
update_token=None,
leeway=60,
**kwargs,
) -> None: ...
async def __aenter__(self) -> Self: ...
async def __aexit__(self, exc_type, exc_val, exc_tb) -> None: ...
async def request(self, method, url, withhold_token: bool = False, auth=..., **kwargs): ...
async def stream(self, method, url, withhold_token: bool = False, auth=..., **kwargs) -> Generator[Incomplete]: ...
async def ensure_active_token(self, token): ...
Similarly, OAuth2Client (the sync version) may need __enter__ and __exit__ methods.
Affected Versions
Related Files
stubs/Authlib/authlib/integrations/httpx_client/oauth2_client.pyi (line 26-48)
Labels to add: stubs: incomplete
Issue URL: https://github.com/python/typeshed/issues/new
Problem
The
AsyncOAuth2Clientclass instubs/Authlib/authlib/integrations/httpx_client/oauth2_client.pyiis missing type annotations for the async context manager protocol (__aenter__and__aexit__), causing type checkers to incorrectly flag validasync withusage as errors.Expected Behavior
AsyncOAuth2Clientshould be usable as an async context manager since it inherits fromhttpx.AsyncClientat runtime:Actual Behavior
Pyright reports errors:
Root Cause
The stub file at line 26-27 shows:
The comment is correct but the type stub is incomplete. The class should expose the async context manager protocol from
httpx.AsyncClient, but it's not properly modeled in the stubs.Runtime Verification
At runtime,
AsyncOAuth2Clientdoes have these methods:Proposed Fix
Update
stubs/Authlib/authlib/integrations/httpx_client/oauth2_client.pyito explicitly declare the async context manager protocol:Similarly,
OAuth2Client(the sync version) may need__enter__and__exit__methods.Affected Versions
types-Authlib>=1.4.0(when httpx_client stubs were added in PR [Authlib] Add integrations dirs #15147)types-Authlib==1.3.0.20241229(no httpx_client stubs existed)Related Files
stubs/Authlib/authlib/integrations/httpx_client/oauth2_client.pyi(line 26-48)Labels to add:
stubs: incompleteIssue URL: https://github.com/python/typeshed/issues/new