docs: improve ChunkedEncodingError docstring with retry guidance#7347
Open
docs: improve ChunkedEncodingError docstring with retry guidance#7347
Conversation
The existing docstring only mentions invalid chunks from the server, but ChunkedEncodingError is also commonly caused by transient network issues that corrupt the chunked transfer encoding mid-stream. Users should know that retrying may succeed. Fixes psf#7341 Signed-off-by: bahtya <bahtyar153@qq.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.
Problem
ChunkedEncodingErroris commonly caused by transient network issues (connection drops mid-stream) that corrupt chunked transfer encoding, not just server-side bugs. The current docstring only mentions "invalid chunk" which is misleading.Solution
Expanded the docstring to mention transient network issues and that retrying may succeed. This addresses the confusion documented in #4771 and #7341.
Fixes #7341