Add is_disconnected property to WebSocket#3200
Open
r266-tech wants to merge 1 commit intoKludex:mainfrom
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds a synchronous
is_disconnectedproperty to theWebSocketclass that returnsTruewhen either the client or application state isDISCONNECTED.Closes #2766
Motivation
When handling WebSocket connections with multiple coroutines, it's common for more than one coroutine to attempt closing the connection. Without a way to check the connection state synchronously, this leads to
RuntimeErrorexceptions.This property enables clean, exception-free state checking:
Implementation
The property simply checks whether either
client_stateorapplication_stateequalsWebSocketState.DISCONNECTED— both of which are already tracked by the existing state machine instarlette/websockets.py.Changes
is_disconnectedproperty toWebSocketclasstest_is_disconnected_property