Skip to content

websockets 16.0

Version history | Download JSON

  • PyPI https://pypi.org/project/websockets/
    Repository https://github.com/python-websockets/websockets

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 862
    "Any" : 23
    "Untyped" : 121
    • 88.0% coverage
    • 85.7% coverage (strict)
    • 1006 typable
      • 862 typed
      • 121 untyped
      • 23 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 190
    "classes" : 643
    "other" : 2
    • 50 functions (+0 overloads)
      • 140 parameters
    • 73 classes
      • 249 methods (+16 overloads)
        • 370 parameters
      • 23 properties
    • 40 modules
      • 2 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
websockets.asyncio.async_timeout 100.0% 100.0% 30 0
websockets.asyncio.client 84.7% 81.4% 59 0
websockets.asyncio.compatibility 0.0% 0.0% 0 0
websockets.asyncio.connection 100.0% 100.0% 4 0
websockets.asyncio.messages 75.0% 75.0% 20 0
websockets.asyncio.router 90.3% 80.6% 31 0
websockets.asyncio.server 90.7% 88.9% 108 0
websockets.cli 100.0% 100.0% 2 0
websockets.client 0.0% 0.0% 0 0
websockets.datastructures 100.0% 96.4% 28 0
websockets.exceptions 77.9% 77.9% 68 0
websockets.extensions.base 100.0% 100.0% 15 0
websockets.extensions.permessage_deflate 62.1% 62.1% 58 0
websockets.frames 93.8% 93.8% 16 0
websockets.headers 100.0% 100.0% 26 0
websockets.http11 84.6% 84.6% 13 0
websockets.imports 100.0% 100.0% 4 0
websockets.legacy.auth 100.0% 88.9% 18 0
websockets.legacy.client 84.8% 78.8% 33 0
websockets.legacy.exceptions 66.7% 66.7% 18 0
websockets.legacy.framing 100.0% 100.0% 21 0
websockets.legacy.handshake 100.0% 100.0% 10 0
websockets.legacy.http 100.0% 100.0% 4 0
websockets.legacy.protocol 100.0% 100.0% 4 0
websockets.legacy.server 88.8% 86.2% 80 0
websockets.protocol 88.7% 88.7% 62 0
websockets.proxy 100.0% 100.0% 5 0
websockets.server 0.0% 0.0% 0 0
websockets.speedups 100.0% 100.0% 3 0
websockets.streams 85.7% 85.7% 14 0
websockets.sync.client 97.7% 93.0% 43 0
websockets.sync.connection 84.1% 81.2% 69 0
websockets.sync.messages 76.9% 76.9% 26 0
websockets.sync.router 90.3% 80.6% 31 0
websockets.sync.server 94.2% 91.3% 69 0
websockets.sync.utils 100.0% 100.0% 5 0
websockets.typing 0.0% 0.0% 0 0
websockets.uri 100.0% 100.0% 4 0
websockets.utils 100.0% 100.0% 5 0
websockets.version 0.0% 0.0% 0 0

Incomplete Annotations

websockets.asyncio.client (9 missing, 2 any)

Symbol Typable Typed Any
func unix_connect 4 4 1
meth connect.init 20 20 1
attr connect.uri 1 0 0
attr connect.proxy 1 0 0
attr connect.protocol_factory 1 0 0
attr connect.additional_headers 1 0 0
attr connect.user_agent_header 1 0 0
attr connect.process_exception 1 0 0
attr connect.open_timeout 1 0 0
attr connect.logger 1 0 0
attr connect.connection_kwargs 1 0 0

websockets.asyncio.messages (5 missing, 0 any)

Symbol Typable Typed Any
attr Assembler.pause 1 0 0
attr Assembler.resume 1 0 0
attr Assembler.paused 1 0 0
attr Assembler.get_in_progress 1 0 0
attr Assembler.closed 1 0 0

websockets.asyncio.router (3 missing, 3 any)

Symbol Typable Typed Any
func unix_route 4 4 1
func route 7 7 2
attr Router.url_map 1 0 0
attr Router.server_name 1 0 0
attr Router.url_scheme 1 0 0

websockets.asyncio.server (10 missing, 2 any)

Symbol Typable Typed Any
meth serve.init 22 22 1
attr serve.server 1 0 0
attr serve.create_server 1 0 0
func unix_serve 4 4 1
attr ServerConnection.server 1 0 0
attr Server.loop 1 0 0
attr Server.handler 1 0 0
attr Server.process_request 1 0 0
attr Server.process_response 1 0 0
attr Server.server_header 1 0 0
attr Server.open_timeout 1 0 0
attr Server.logger 1 0 0

websockets.datastructures (0 missing, 1 any)

Symbol Typable Typed Any
meth Headers.eq 2 2 1

websockets.exceptions (15 missing, 0 any)

Symbol Typable Typed Any
attr InvalidProxy.proxy 1 0 0
attr InvalidProxy.msg 1 0 0
attr InvalidHeader.name 1 0 0
attr InvalidHeader.value 1 0 0
attr InvalidStatus.response 1 0 0
attr InvalidProxyStatus.response 1 0 0
attr InvalidParameterValue.name 1 0 0
attr InvalidParameterValue.value 1 0 0
attr InvalidURI.uri 1 0 0
attr InvalidURI.msg 1 0 0
attr DuplicateParameter.name 1 0 0
attr InvalidParameterName.name 1 0 0
attr ConnectionClosed.rcvd 1 0 0
attr ConnectionClosed.sent 1 0 0
attr ConnectionClosed.rcvd_then_sent 1 0 0

websockets.extensions.permessage_deflate (22 missing, 0 any)

Symbol Typable Typed Any
attr PerMessageDeflate.name 1 0 0
attr PerMessageDeflate.remote_no_context_takeover 1 0 0
attr PerMessageDeflate.local_no_context_takeover 1 0 0
attr PerMessageDeflate.remote_max_window_bits 1 0 0
attr PerMessageDeflate.local_max_window_bits 1 0 0
attr PerMessageDeflate.compress_settings 1 0 0
attr PerMessageDeflate.decode_cont_data 1 0 0
attr PerMessageDeflate.decoder 1 0 0
attr PerMessageDeflate.encoder 1 0 0
attr ServerPerMessageDeflateFactory.name 1 0 0
attr ServerPerMessageDeflateFactory.server_no_context_takeover 1 0 0
attr ServerPerMessageDeflateFactory.client_no_context_takeover 1 0 0
attr ServerPerMessageDeflateFactory.server_max_window_bits 1 0 0
attr ServerPerMessageDeflateFactory.client_max_window_bits 1 0 0
attr ServerPerMessageDeflateFactory.compress_settings 1 0 0
attr ServerPerMessageDeflateFactory.require_client_max_window_bits 1 0 0
attr ClientPerMessageDeflateFactory.name 1 0 0
attr ClientPerMessageDeflateFactory.server_no_context_takeover 1 0 0
attr ClientPerMessageDeflateFactory.client_no_context_takeover 1 0 0
attr ClientPerMessageDeflateFactory.server_max_window_bits 1 0 0
attr ClientPerMessageDeflateFactory.client_max_window_bits 1 0 0
attr ClientPerMessageDeflateFactory.compress_settings 1 0 0

websockets.frames (1 missing, 0 any)

Symbol Typable Typed Any
attr Frame.MAX_LOG_SIZE 1 0 0

websockets.http11 (2 missing, 0 any)

Symbol Typable Typed Any
attr SERVER 1 0 0
attr USER_AGENT 1 0 0

websockets.legacy.auth (0 missing, 2 any)

Symbol Typable Typed Any
meth BasicAuthWebSocketServerProtocol.init 5 5 2

websockets.legacy.client (5 missing, 2 any)

Symbol Typable Typed Any
meth WebSocketClientProtocol.init 8 8 1
attr WebSocketClientProtocol.origin 1 0 0
attr WebSocketClientProtocol.available_extensions 1 0 0
attr WebSocketClientProtocol.available_subprotocols 1 0 0
attr WebSocketClientProtocol.extra_headers 1 0 0
attr WebSocketClientProtocol.user_agent_header 1 0 0
func unix_connect 4 4 1

websockets.legacy.exceptions (6 missing, 0 any)

Symbol Typable Typed Any
attr AbortHandshake.status 1 0 0
attr AbortHandshake.headers 1 0 0
attr AbortHandshake.body 1 0 0
attr InvalidStatusCode.status_code 1 0 0
attr InvalidStatusCode.headers 1 0 0
attr RedirectHandshake.uri 1 0 0

websockets.legacy.server (9 missing, 2 any)

Symbol Typable Typed Any
attr WebSocketServer.logger 1 0 0
meth WebSocketServerProtocol.init 13 13 1
attr WebSocketServerProtocol.ws_handler 1 0 0
attr WebSocketServerProtocol.ws_server 1 0 0
attr WebSocketServerProtocol.origins 1 0 0
attr WebSocketServerProtocol.available_extensions 1 0 0
attr WebSocketServerProtocol.available_subprotocols 1 0 0
attr WebSocketServerProtocol.extra_headers 1 0 0
attr WebSocketServerProtocol.server_header 1 0 0
attr WebSocketServerProtocol.open_timeout 1 0 0
func unix_serve 4 4 1

websockets.protocol (7 missing, 0 any)

Symbol Typable Typed Any
attr Protocol.debug 1 0 0
attr Protocol.side 1 0 0
attr Protocol.state 1 0 0
attr Protocol.expect_continuation_frame 1 0 0
attr Protocol.eof_sent 1 0 0
attr Protocol.reader 1 0 0
attr Protocol.parser 1 0 0

websockets.streams (2 missing, 0 any)

Symbol Typable Typed Any
attr StreamReader.buffer 1 0 0
attr StreamReader.eof 1 0 0

websockets.sync.client (1 missing, 2 any)

Symbol Typable Typed Any
func connect 23 23 1
attr ClientConnection.response_rcvd 1 0 0
func unix_connect 4 4 1

websockets.sync.connection (11 missing, 2 any)

Symbol Typable Typed Any
prop Connection.local_address 1 1 1
prop Connection.remote_address 1 1 1
attr Connection.socket 1 0 0
attr Connection.protocol 1 0 0
attr Connection.ping_interval 1 0 0
attr Connection.ping_timeout 1 0 0
attr Connection.close_timeout 1 0 0
attr Connection.debug 1 0 0
attr Connection.protocol_mutex 1 0 0
attr Connection.recv_flow_control 1 0 0
attr Connection.recv_messages 1 0 0
attr Connection.send_in_progress 1 0 0
attr Connection.recv_events_thread 1 0 0

websockets.sync.messages (6 missing, 0 any)

Symbol Typable Typed Any
attr Assembler.mutex 1 0 0
attr Assembler.pause 1 0 0
attr Assembler.resume 1 0 0
attr Assembler.paused 1 0 0
attr Assembler.get_in_progress 1 0 0
attr Assembler.closed 1 0 0

websockets.sync.router (3 missing, 3 any)

Symbol Typable Typed Any
func route 7 7 2
attr Router.url_map 1 0 0
attr Router.server_name 1 0 0
attr Router.url_scheme 1 0 0
func unix_route 4 4 1

websockets.sync.server (4 missing, 2 any)

Symbol Typable Typed Any
attr ServerConnection.request_rcvd 1 0 0
attr Server.socket 1 0 0
attr Server.handler 1 0 0
attr Server.logger 1 0 0
func serve 23 23 1
func unix_serve 4 4 1

Type-Ignore Comments

No type-ignore comments.