需要在配置文件内定义

    1. [vip.ws]
    2. host = "ws.ebonex.vip"
    3. agreement = "wss"
    4. api = [['api', 'wss']]

    api

    1. {
    2.     "id": "quote",
    3.     "path": "/ws/quote/v1?lang=zh-cn",
    4.     "title": "行情"
    5. }

    case

    1. class TestCase(TestBase):
    3.     def test_01(self, data_conversion, data):
    4.         topic, outs = data_conversion.get('topic', 'outs')
    5.         client = self.settings.ws.get_client("quote", *topic, on_pong=self.on_pong)
    6.         client.run_forever(ping_interval=2, ping_payload=json.dumps({"ping": int(time.time() * 1000)}))
    8.     def on_pong(self, ws: websocket.WebSocketApp, message):
    9.         self.logger.debug("收到pong消息:{}".format(message))
    10.         if time.time() - ws.open_start_time > 20:
    11.             ws.close()

    data（topic）

    1. [
    2.     {
    3.         "__file": "test_quote",
    4.         "__func": "test_01",
    5.         "__dependent_class": null
    6.     },
    7.     {
    8.         "title": "行情",
    9.         "tags": ["au", "debug"],
    10.         "topic": [
    11.             {"id":"BTCAUD","topic":"klineV2_5m","symbol":"BTCAUD","params":{"org":9001,"binary":false},"event":"sub"}
    12.         ],
    13.         "outs": {
    15.         }
    16.     }
    17. ]

    get_client入参

    1.     def get_client(self, api_id, *topics, header=None, **kwargs) -> websocket.WebSocketApp:
    2.         """
    3.         获取客户端
    4.         api_id: 
    5.         topics： topics列表
    6.         header
    7.         """

    websocket采用的是websocket.WebSocketApp，相关方法及代码

    2. class WebSocketApp:
    3.     """
    4.     Higher level of APIs are provided. The interface is like JavaScript WebSocket object.
    5.     """
    7.     def __init__(self, url, header=None,
    8.                  on_open=None, on_message=None, on_error=None,
    9.                  on_close=None, on_ping=None, on_pong=None,
    10.                  on_cont_message=None,
    11.                  keep_running=True, get_mask_key=None, cookie=None,
    12.                  subprotocols=None,
    13.                  on_data=None):
    14.         """
    15.         WebSocketApp initialization
    17.         Parameters
    18.         ----------
    19.         url: str
    20.             Websocket url.
    21.         header: list or dict
    22.             Custom header for websocket handshake.
    23.         on_open: function
    24.             Callback object which is called at opening websocket.
    25.             on_open has one argument.
    26.             The 1st argument is this class object.
    27.         on_message: function
    28.             Callback object which is called when received data.
    29.             on_message has 2 arguments.
    30.             The 1st argument is this class object.
    31.             The 2nd argument is utf-8 data received from the server.
    32.         on_error: function
    33.             Callback object which is called when we get error.
    34.             on_error has 2 arguments.
    35.             The 1st argument is this class object.
    36.             The 2nd argument is exception object.
    37.         on_close: function
    38.             Callback object which is called when connection is closed.
    39.             on_close has 3 arguments.
    40.             The 1st argument is this class object.
    41.             The 2nd argument is close_status_code.
    42.             The 3rd argument is close_msg.
    43.         on_cont_message: function
    44.             Callback object which is called when a continuation
    45.             frame is received.
    46.             on_cont_message has 3 arguments.
    47.             The 1st argument is this class object.
    48.             The 2nd argument is utf-8 string which we get from the server.
    49.             The 3rd argument is continue flag. if 0, the data continue
    50.             to next frame data
    51.         on_data: function
    52.             Callback object which is called when a message received.
    53.             This is called before on_message or on_cont_message,
    54.             and then on_message or on_cont_message is called.
    55.             on_data has 4 argument.
    56.             The 1st argument is this class object.
    57.             The 2nd argument is utf-8 string which we get from the server.
    58.             The 3rd argument is data type. ABNF.OPCODE_TEXT or ABNF.OPCODE_BINARY will be came.
    59.             The 4th argument is continue flag. If 0, the data continue
    60.         keep_running: bool
    61.             This parameter is obsolete and ignored.
    62.         get_mask_key: function
    63.             A callable function to get new mask keys, see the
    64.             WebSocket.set_mask_key's docstring for more information.
    65.         cookie: str
    66.             Cookie value.
    67.         subprotocols: list
    68.             List of available sub protocols. Default is None.
    69.         """
    71.     def send(self, data, opcode=ABNF.OPCODE_TEXT):
    72.         """
    73.         send message
    75.         Parameters
    76.         ----------
    77.         data: str
    78.             Message to send. If you set opcode to OPCODE_TEXT,
    79.             data must be utf-8 string or unicode.
    80.         opcode: int
    81.             Operation code of data. Default is OPCODE_TEXT.
    82.         """
    84.     def close(self, **kwargs):
    85.         """
    86.         Close websocket connection.
    87.         """
    89.     def run_forever(self, sockopt=None, sslopt=None,
    90.                     ping_interval=0, ping_timeout=None,
    91.                     ping_payload="",
    92.                     http_proxy_host=None, http_proxy_port=None,
    93.                     http_no_proxy=None, http_proxy_auth=None,
    94.                     skip_utf8_validation=False,
    95.                     host=None, origin=None, dispatcher=None,
    96.                     suppress_origin=False, proxy_type=None):
    97.         """
    98.         Run event loop for WebSocket framework.
    100.         This loop is an infinite loop and is alive while websocket is available.
    102.         Parameters
    103.         ----------
    104.         sockopt: tuple
    105.             Values for socket.setsockopt.
    106.             sockopt must be tuple
    107.             and each element is argument of sock.setsockopt.
    108.         sslopt: dict
    109.             Optional dict object for ssl socket option.
    110.         ping_interval: int or float
    111.             Automatically send "ping" command
    112.             every specified period (in seconds).
    113.             If set to 0, no ping is sent periodically.
    114.         ping_timeout: int or float
    115.             Timeout (in seconds) if the pong message is not received.
    116.         ping_payload: str
    117.             Payload message to send with each ping.
    118.         http_proxy_host: str
    119.             HTTP proxy host name.
    120.         http_proxy_port: int or str
    121.             HTTP proxy port. If not set, set to 80.
    122.         http_no_proxy: list
    123.             Whitelisted host names that don't use the proxy.
    124.         skip_utf8_validation: bool
    125.             skip utf8 validation.
    126.         host: str
    127.             update host header.
    128.         origin: str
    129.             update origin header.
    130.         dispatcher: Dispatcher object
    131.             customize reading data from socket.
    132.         suppress_origin: bool
    133.             suppress outputting origin header.
    135.         Returns
    136.         -------
    137.         teardown: bool
    138.             False if caught KeyboardInterrupt, True if other exception was raised during a loop
    139.         """

    附上send的opcode类型

    1.     # 导入方式
    2.     import websocket
    3.     websocket.ABNF.OPCODE_PONG
    5.     # 类型
    6.     OPCODE_CONT = 0x0
    7.     OPCODE_TEXT = 0x1
    8.     OPCODE_BINARY = 0x2
    9.     OPCODE_CLOSE = 0x8
    10.     OPCODE_PING = 0x9
    11.     OPCODE_PONG = 0xa
    13.     # available operation code value tuple
    14.     OPCODES = (OPCODE_CONT, OPCODE_TEXT, OPCODE_BINARY, OPCODE_CLOSE,
    15.                OPCODE_PING, OPCODE_PONG)
    17.     # opcode human readable string
    18.     OPCODE_MAP = {
    19.         OPCODE_CONT: "cont",
    20.         OPCODE_TEXT: "text",
    21.         OPCODE_BINARY: "binary",
    22.         OPCODE_CLOSE: "close",
    23.         OPCODE_PING: "ping",
    24.         OPCODE_PONG: "pong"
    25.     }
    27.     # data length threshold.
    28.     LENGTH_7 = 0x7e
    29.     LENGTH_16 = 1 << 16
    30.     LENGTH_63 = 1 << 63

    监听示例

    3.     def on_data(self, ws:websocket.WebSocketApp, message, data_type, flag):
    4.         logger.debug("{}内容：{}，类型：{}，flage：{}".format(ws.title, message, data_type, flag))
    6.     def on_close(self, ws:websocket.WebSocketApp, close_status_code, close_msg):
    7.         logger.debug("{}关闭连接,状态码:{}, 关闭消息:{}.....".format(ws.title, close_status_code, close_msg))
    9.     def on_error(self, ws:websocket.WebSocketApp, exception):
    10.         if getattr(a, 'format_exc', None) is not None:
    11.             logger.debug("异常():{}".format(ws.title, exception.format_exc()))
    12.         else:
    13.             logger.exception("异常({})".format(ws.title))
    15.     def on_open(self, ws:websocket.WebSocketApp):
    16.         logger.debug("websocket()连接成功.....".format(ws.title))
    17.         ws.open_start_time = time.time()
    18.         for topic in ws.topics:
    19.             ws.send(json.dumps(topic))
    21.     def on_pong(self, ws:websocket.WebSocketApp, message):
    22.         logger.debug("{}收到pong消息:{}".format(ws.title, message))
    24.     def on_ping(self, ws:websocket.WebSocketApp, message):
    25.         ws.send(json.dumps({"pong": int(time.time() * 1000)}), websocket.ABNF.OPCODE_PONG)
    26.         logger.debug("{}收到ping消息:{}".format(ws.title, message))
    28.     def on_message(self, ws:websocket.WebSocketApp, message):
    29.         logger.debug("{}收到消息:{}".format(ws.title, message))