Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1"""
2_exceptions.py
3websocket - WebSocket client library for Python
5Copyright 2025 engn33r
7Licensed under the Apache License, Version 2.0 (the "License");
8you may not use this file except in compliance with the License.
9You may obtain a copy of the License at
11 http://www.apache.org/licenses/LICENSE-2.0
13Unless required by applicable law or agreed to in writing, software
14distributed under the License is distributed on an "AS IS" BASIS,
15WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16See the License for the specific language governing permissions and
17limitations under the License.
18"""
21class WebSocketException(Exception):
22 """
23 WebSocket exception class.
24 """
26 pass
29class WebSocketProtocolException(WebSocketException):
30 """
31 If the WebSocket protocol is invalid, this exception will be raised.
32 """
34 pass
37class WebSocketPayloadException(WebSocketException):
38 """
39 If the WebSocket payload is invalid, this exception will be raised.
40 """
42 pass
45class WebSocketConnectionClosedException(WebSocketException):
46 """
47 If remote host closed the connection or some network error happened,
48 this exception will be raised.
49 """
51 pass
54class WebSocketTimeoutException(WebSocketException):
55 """
56 WebSocketTimeoutException will be raised at socket timeout during read/write data.
57 """
59 pass
62class WebSocketProxyException(WebSocketException):
63 """
64 WebSocketProxyException will be raised when proxy error occurred.
65 """
67 pass
70class WebSocketBadStatusException(WebSocketException):
71 """
72 WebSocketBadStatusException will be raised when we get bad handshake status code.
73 """
75 def __init__(
76 self,
77 message: str,
78 status_code: int,
79 status_message=None,
80 resp_headers=None,
81 resp_body=None,
82 ):
83 super().__init__(message)
84 self.status_code = status_code
85 self.resp_headers = resp_headers
86 self.resp_body = resp_body
89class WebSocketAddressException(WebSocketException):
90 """
91 If the websocket address info cannot be found, this exception will be raised.
92 """
94 pass