【python】bitFlyerのWebSocketを使用した通信が接続されない

Question

##分からない事
bitFlyerのRelTimeApi をwebsocketを使用した際の書き方が分かりません。

##困っている点
なぜ接続ができないのかが分からず、何をとっかかりに調べればよいのかがわかりません。

###調べた事
以下のようなミニマムコードのプログラムを作成しました。

import websocket
import json
import pprint
import time

class RealtimeAPI(object):

    def __init__(self,url,channel):
        self.url = url
        self.channel = channel
        self.ws = websocket.WebSocketApp(self.url,header=None,on_message=self.on_message,\
                                        on_open=self.on_open,on_close=self.on_close,on_error=self.on_error)
        # websocket.enableTrace(True)

    def run(self):
        self.ws.run_forever()

    def on_message(self,message):
        message = json.loads(message)
        print(message)

    def on_error(self,error):
        print(error)

    def on_open(self):
        print("websocket connection started.")
        ws.send(json.dumps({"method": "subscribe","params": {"channel": self.channel}}))

    def on_close(self):
        print("###websocket connection closed.###")

if __name__ == "__main__":
    url = "wss://ws.lightstream.bitflyer.com/json-rpc"
    channel = "lightning_executions_FX_BTC_JPY"
    json_rpc = RealtimeAPI(url=url,channel=channel)
    json_rpc.run()

実行したところ、以下のようなエラーが発生しました。

[WinError 10060] 接続済みの呼び出し先が一定の時間を過ぎても正しく応答しなかったため、接続できませんでした。または接続済みのホストが応答しなかったため、確立された接続は失敗しました。

理由はわかりませんが、on_openメソッドを通っていないようです。

次に、
https://github.com/websocket-client/websocket-client にある以下のサンプルコードを実行してみました。

import websocket
try:
    import thread
except ImportError:
    import _thread as thread
import time

def on_message(ws, message):
    print(message)

def on_error(ws, error):
    print(error)

def on_close(ws):
    print("### closed ###")

def on_open(ws):
    def run(*args):
        for i in range(3):
            time.sleep(1)
            ws.send("Hello %d" % i)
        time.sleep(1)
        ws.close()
        print("thread terminating...")
    thread.start_new_thread(run, ())

if __name__ == "__main__":
    websocket.enableTrace(True)
    ws = websocket.WebSocketApp("ws://echo.websocket.org/",
                              on_open = on_open,
                              on_message = on_message,
                              on_error = on_error,
                              on_close = on_close)

    ws.run_forever()

このプログラムを実行したところ、

Hello 0
send: b'\x81\x87Tm\x8fm\x1c\x08\xe3\x01;M\xbe'
Hello 1
send: b'\x81\x87\n\xce\x06\xa7B\xabj\xcbe\xee4'
Hello 2
send: b'\x88\x82\xb1\x9f)\xc4\xb2w'
closed ###
thread terminating...

と出力されうまく通信が出来ているようでした。

そこで、
https://bf-lightning-api.readme.io/docs/endpoint-json-rpc に記載されているエンドポイント（wss://ws.lightstream.bitflyer.com/json-rpc）に書き換えて実行してみました。

if __name__ == "__main__":
    websocket.enableTrace(True)
    ws = websocket.WebSocketApp("wss://ws.lightstream.bitflyer.com/json-rpc",
                              on_open = on_open,
                              on_message = on_message,
                              on_error = on_error,
                              on_close = on_close)

    ws.run_forever()

先ほどと同じく、以下のエラーが出力されるかつ、on_openメソッドすら実行されません。

[WinError 10060] 接続済みの呼び出し先が一定の時間を過ぎても正しく応答しなかったため、接続できませんでした。または接続済みのホストが応答しなかったため、確立された接続は失敗しました。

これは何が問題なのでしょうか。

Answer 1

[投稿 2021/03/10 13:23時点の内容に対する回答]
「調べた事」に記載してあるコードに関してのみですが、下記のように、__init__で生成したWebSocketApp　（＝self.ws）に対してmessageを送る必要があると思います。

    def on_open(self):
        print("websocket connection started.")
-       ws.send(json.dumps({"method": "subscribe","params": {"channel": self.channel}}))
+       self.ws.send(json.dumps({"method": "subscribe","params": {"channel": self.channel}}))

なお、手元の環境では、修正前のコードでは「websocket connection started.」と表示されて止まるだけで、[Winerror 10060]は再現できませんでした。
上記のように修正しても同じエラーが発生する場合は、環境固有の問題である可能性があります。

自分の環境:
Windows10
python 3.8.6
websockets-client 0.57.0

Comments

[OXamarin]

ありがとうございます！

on_openメソッド自体を通らないので、その記述に到達できていないですね…。
仰ることはその通りだと思いますので、self は付与しました！