fix: add aclose() to AsyncStream for standard async cleanup#2854
Open
landim wants to merge 2 commits intoopenai:mainfrom
Open
fix: add aclose() to AsyncStream for standard async cleanup#2854landim wants to merge 2 commits intoopenai:mainfrom
landim wants to merge 2 commits intoopenai:mainfrom
Conversation
`AsyncStream` exposes `close()` but not `aclose()`, which is the standard Python async cleanup method name (used by contextlib, asyncio, and the language spec for async generators). This causes `AttributeError` when callers use the conventional `aclose()` pattern. Two concrete callers in this repo are affected: - `AsyncChatCompletionStream.close()` stores `raw_stream.response` in `self._response` and calls `self._response.aclose()`. When instrumentation libraries (e.g. Langfuse) wrap the raw stream, the `.response` attribute can resolve to the `AsyncStream` itself rather than the underlying `httpx.Response`, hitting the missing method. - Third-party instrumentation (Langfuse `LangfuseResponseGeneratorAsync`) calls `.aclose()` on the response generator which delegates to the wrapped `AsyncStream`. The fix adds `aclose()` as a thin async alias for `close()`, matching the pattern already used by `httpx.Response`, `asyncio.StreamWriter`, and Python async generators.
Replace the smoke test with a mock-based assertion that aclose() actually calls close(), validating the behavioral contract. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
aclose()method toAsyncStreamas a thin async alias forclose()test_async_stream_acloseto verify the method exists and worksFixes #2853
Problem
AsyncStreamexposesclose()but notaclose(). This causesAttributeErrorwhen:AsyncChatCompletionStream.close()callsself._response.aclose()and the response is anAsyncStream(happens when instrumentation libraries wrap the raw stream)LangfuseResponseGeneratorAsync) callsaclose()on the wrapped streamFix
Add
aclose()as an alias forclose()onAsyncStream, matching the standard Python async cleanup convention used byhttpx.Response,asyncio.StreamWriter, and async generators (PEP 525).Test plan
test_async_stream_aclose— assertsaclose()exists and can be called