python / python/typeshed

AsyncOAuth2Client missing async context manager protocol (__aenter__, __aexit__)

Open
#15,246 1 comment 0 reactions 0 assignees View on GitHub

@robertuss12 is already working on this.

Since Dec 29, 2025.

  • #15190 by @robertuss12 — open
Dominant language
Python
Stars
5.1k
Forks
2.1k
Avg merge
1d 19h
Merged PRs (30d)
82

Description

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

  • types-Authlib>=1.4.0 (when httpx_client stubs were added in PR #15147)
  • Works correctly in 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: incomplete

Issue URL: https://github.com/python/typeshed/issues/new

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with stubs/Authlib/authlib/integrations/httpx_client/oauth2_client.pyi, especially the AsyncOAuth2Client declaration around lines 26–48, and review linked pull request #15190. Check the async with example using Pyright; done means the stub exposes the runtime context-manager behavior without those protocol errors, with the possible sync OAuth2Client concern addressed if in scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.