Fix StreamingResponse docs: warn about blocking operations in async generators#14991
Closed
thakoreh wants to merge 1 commit into
Closed
Fix StreamingResponse docs: warn about blocking operations in async generators#14991thakoreh wants to merge 1 commit into
thakoreh wants to merge 1 commit into
Conversation
…ngResponse Async generators need to use asyncio.sleep() instead of time.sleep() to avoid blocking the event loop and prevent proper streaming. Fixes: fastapi#14680
Contributor
📝 Docs previewLast commit 03ca680 at: https://3cd4c3a9.fastapitiangolo.pages.dev Modified Pages |
Member
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
2 participants
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.
Description
Fixes issue #14680 - StreamingResponse doc example needs correction
Problem
The documentation states that StreamingResponse "Takes an async generator or a normal generator/iterator" but doesn't explain that async generators need to actually await something to work properly.
Users might use in an async generator, which blocks the event loop and prevents proper streaming.
Solution
Added a warning admonition explaining that:
Changes