gh-109532: fix socket HOWTO inaccuracy about send() on broken connection #144747
+6
−3
Conversation
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
…onnection Correct the claim that send() returns 0 bytes on a broken connection. In practice, send() on a broken connection raises OSError (EPIPE) rather than returning 0. Only recv() returns 0 bytes to indicate disconnection. Add a clarifying comment to the mysend example noting this distinction.
bedevere-app
bot
added
awaiting review
docs
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.
socket.sendbehavior #109532Summary
Corrects an inaccuracy in the Socket Programming HOWTO (
Doc/howto/sockets.rst) aboutsend()behavior when the remote end has disconnected.The existing text stated "if a socket
sendorrecvreturns after handling 0 bytes, the connection has been broken." In practice,send()on a broken connection raisesOSError(specificallyBrokenPipeError/EPIPE) rather than returning 0. Onlyrecv()returns 0 bytes to indicate disconnection.Changes
send()(raisesOSError) andrecv()(returns 0 bytes)mysendcode exampleTesting
send()raisesBrokenPipeErrorandrecv()returnsb''📚 Documentation preview 📚: https://cpython-previews--144747.org.readthedocs.build/