blob: cd042fe8ac038b3e7da6bbce70a7d1e1620f5bbe [file] [log] [blame]
websocket-client module is WebSocket client for python. This provide the low level APIs for WebSocket. All APIs are the synchronous functions.
websocket-client supports only hybi-13.
This module is tested on Python 2.7 and Python 3.4+.
Type "python install" or "pip install websocket-client" to install.
from v0.16.0, we can install by "pip install websocket-client" for Python 3.
This module depends on
- six
- backports.ssl_match_hostname for Python 2.x
The "send" and "validate_utf8" methods are too slow on pure python. If you want to get better performace, please install both numpy and wsaccel.
How about Python 3
Now, we support Python 3 on single source code from version 0.14.0. Thanks, @battlemidget and @ralphbean.
HTTP Proxy
Support websocket access via http proxy.
The proxy server must allow "CONNECT" method to websocket port.
Default squid setting is "ALLOWED TO CONNECT ONLY HTTPS PORT".
Current implementation of websocket-client is using "CONNECT" method via proxy.
.. code:: python
import websocket
ws = websocket.WebSocket()
ws.connect("ws://", http_proxy_host="proxy_host_name", http_proxy_port=3128)
Long-lived connection
This example is similar to how WebSocket code looks in browsers using JavaScript.
.. code:: python
import websocket
import thread
except ImportError:
import _thread as thread
import time
def on_message(ws, message):
def on_error(ws, error):
def on_close(ws):
print("### closed ###")
def on_open(ws):
def run(*args):
for i in range(3):
ws.send("Hello %d" % i)
print("thread terminating...")
thread.start_new_thread(run, ())
if __name__ == "__main__":
ws = websocket.WebSocketApp("ws://",
on_message = on_message,
on_error = on_error,
on_close = on_close)
ws.on_open = on_open
Short-lived one-off send-receive
This is if you want to communicate a short message and disconnect immediately when done.
.. code:: python
from websocket import create_connection
ws = create_connection("ws://")
print("Sending 'Hello, World'...")
ws.send("Hello, World")
result = ws.recv()
print("Received '%s'" % result)
If you want to customize socket options, set sockopt.
sockopt example
.. code:: python
from websocket import create_connection
ws = create_connection("ws://",
sockopt=((socket.IPPROTO_TCP, socket.TCP_NODELAY),))
More advanced: Custom class
You can also write your own class for the connection, if you want to handle the nitty-gritty details yourself.
.. code:: python
import socket
from websocket import create_connection, WebSocket
class MyWebSocket(WebSocket):
def recv_frame(self):
frame = super().recv_frame()
print('yay! I got this frame: ', frame)
return frame
ws = create_connection("ws://",
sockopt=((socket.IPPROTO_TCP, socket.TCP_NODELAY, 1),), class_=MyWebSocket)
How to disable ssl cert verification?
Please set sslopt to {"cert_reqs": ssl.CERT_NONE}.
WebSocketApp sample
.. code:: python
ws = websocket.WebSocketApp("wss://")
ws.run_forever(sslopt={"cert_reqs": ssl.CERT_NONE})
create_connection sample
.. code:: python
ws = websocket.create_connection("wss://",
sslopt={"cert_reqs": ssl.CERT_NONE})
WebSocket sample
.. code:: python
ws = websocket.WebSocket(sslopt={"cert_reqs": ssl.CERT_NONE})
How to disable hostname verification?
Please set sslopt to {"check_hostname": False}.
(since v0.18.0)
WebSocketApp sample
.. code:: python
ws = websocket.WebSocketApp("wss://")
ws.run_forever(sslopt={"check_hostname": False})
create_connection sample
.. code:: python
ws = websocket.create_connection("wss://",
sslopt={"check_hostname": False})
WebSocket sample
.. code:: python
ws = websocket.WebSocket(sslopt={"check_hostname": False})
How to enable `SNI <>`_?
SNI support is available for Python 2.7.9+ and 3.2+. It will be enabled automatically whenever possible.
Sub Protocols.
The server needs to support sub protocols, please set the subprotocol like this.
Subprotocol sample
.. code:: python
ws = websocket.create_connection("ws://", subprotocols=["binary", "base64"])
========= is simple WebSocket test(debug) tool.
sample for
$ ws://
Press Ctrl+C to quit
> Hello, WebSocket
< Hello, WebSocket
> How are you?
< How are you?
usage:: [-h] [-v [VERBOSE]] ws_url
WebSocket Simple Dump Tool
positional arguments:
ws_url websocket url. ex. ws://
optional arguments:
-h, --help show this help message and exit
-v VERBOSE, --verbose VERBOSE set verbose mode. If set to 1, show opcode. If set to 2, enable to trace websocket module
$ ws://
$ ws:// -v
$ ws:// -vv