在 python 中使用 websocket 客户端作为类

Question

我正在尝试使用 websockets 访问一些数据，但我无法真正绕过 websockets 文档中给出的示例。

我有这个代码（ https://pypi.org/project/websocket_client/ ）并想将它转换成一个类。

import websocket
import 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_message = on_message,
                                on_error = on_error,
                                on_close = on_close)
    ws.on_open = on_open

    ws.run_forever()

这个想法是在一个类中拥有所有这些 websocket 功能，这样我就可以创建该类的一个对象。

我试图开始这样做，但我什至无法通过这个：

class MySocket(object):
    def __init__(self):
        websocket.enableTrace(True)
        self.ws = websocket.WebSocketApp("ws://echo.websocket.org:12300/foo",
                                    on_message = on_message,
                                    on_error = on_error,
                                    on_close = on_close)

    def on_message(ws, message):
        print message

    def on_error(ws, error):
        print error

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

    def on_open(ws):
    ws.send("Hello %d" % i)

错误立即在on_message开始，说这是一个“未解析的引用”。

Answer 1

将调用打包在匿名lambda函数中，以使用正确的self实现正确调用：

class Client:
    def __init__(self, db, symbols):
        self.ws = websocket.WebSocketApp("wss://the.server.com/api",
                    on_message = lambda ws,msg: self.on_message(ws, msg),
                    on_error   = lambda ws,msg: self.on_error(ws, msg),
                    on_close   = lambda ws:     self.on_close(ws),
                    on_open    = lambda ws:     self.on_open(ws))

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

Answer 2

WebSocketApp的回调需要可调用对象（您在构造函数中传递的对象，如on_message ，以及事后设置的对象， on_open ）。

普通函数是可调用对象，因此您的非 OO 版本可以正常工作，因为您正在传递普通函数。

绑定方法也是可调用对象。 但是您的 OO 版本没有传递绑定方法。 绑定方法，顾名思义，绑定到一个对象。 您可以使用obj.method表示法来完成此操作。 在你的情况下，那是self.on_message ：

self.ws = websocket.WebSocketApp("ws://echo.websocket.org/",
                                 on_message = self.on_message,
                                 on_error = self.on_error,
                                 on_close = self.on_close)
self.ws.on_open = self.on_open

但是，您还有另一个问题。 虽然这会使您的错误消失，但不会使您的代码真正工作。 一个普通的方法必须将self作为它的第一个参数：

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

另外值得一提的是，你没有真正使用类的东西。 如果您从不访问self任何内容，则该类就像一个命名空间。 并不是说这总是一件坏事，但这通常表明您至少需要仔细考虑您的设计。 真的有任何需要维护的状态吗？ 如果没有，你为什么首先要上课？

您可能需要重新阅读有关类的教程部分以了解方法、 self等。

Answer 3

import websocket

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


class OnyxGenericClient:
    """
    Onyx Client Interface

    """

    def __init__(self, ):
        websocket.enableTrace(True)
        ws = websocket.WebSocketApp("ws://localhost:3000/",
                                         on_message=self.on_message,
                                         on_error=self.on_error,
                                         on_close=self.on_close)
        self.ws = ws
        self.ws.on_open = self.on_open
        self.ws.run_forever()

    # def initiate(self):

    def on_message(self, message):
        print(message)
        return message

    def on_error(self, error):
        return error

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

    def run(self, *args):
        global driver
        driver = True
        while driver:
            try:
                time.sleep(1)
                print("Say something nice")
                p = input()
                self.ws.send(p)
            except KeyboardInterrupt:
                driver = False
        time.sleep(1)
        self.ws.close()
        print("thread terminating...")

    def on_open(self):
        thread.start_new_thread(self.run, ())


if __name__ == "__main__":
    websocket.enableTrace(True)
    onyx_client = OnyxGenericClient()

不知道为什么大家还在放ws参数。

阅读错误日志。

文件“venv/lib/python3.7/site-packages/websocket/_app.py”，第 343 行，在 _callback 回调（*args）中

    def _callback(self, callback, *args):
    if callback:
        try:
            if inspect.ismethod(callback):
                callback(*args)
            else:
                callback(self, *args)

        except Exception as e:
            _logging.error("error from callback {}: {}".format(callback, e))
            if _logging.isEnabledForDebug():
                _, _, tb = sys.exc_info()
                traceback.print_tb(tb)

查看我们的回调， on_open(self, ws)

当try块执行时，它会检查我们的回调是一个方法还是一个函数。 如果它是一个方法，它将执行callback(*args)已经我们的自定义客户端中的CustomClient已经作为参数传递给 (*args)。 请注意，它已经在def _callback(self, callback, *args)拥有自己的self 。 因此，作为CustomClient实例的每个回调CustomClient应该有 ws 参数。

Answer 4

您需要在类方法中添加“self”：

class MySocket(object):
    def __init__(self):
        websocket.enableTrace(True)
        self.ws = websocket.WebSocketApp("ws://echo.websocket.org:12300/foo",
                                on_message = self.on_message,
                                on_error = self.on_error,
                                on_close = self.on_close)

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

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

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

    def on_open(self, ws):
        ws.send("Hello %d" % i)

Answer 5

Self 将这些方法作为类方法，得到这个作为 on_error/message/close 方法签名将得到满足，如果由 self 调用将引用类本身。

 class MySocket(object):
   def __init__(self,x):
     websocket.enableTrace(True)
     ## Only Keep the object Initialisation here  
     self.x=x
     self.ws=None

     # call This method from a Object and it will create and run the websocket 
    def ws_comm(self):
        self.ws = websocket.WebSocketApp(self.WS_URL,on_message = 
        self.on_message,on_error =self.on_error,on_close = self.on_close)
        self.ws.on_open = self.on_open
        self.ws.run_forever()

    def on_error(self,ws, error):
        print "onError", error

    def on_close(self,ws):
       print "onClosed"

    #Send some message on open 
    def on_open(self,ws):
       self.ws.send(json.dumps(register_msg))

    def on_message(self,ws, msg):
       self.ws.send(json.dumps(msg))


 user1=Userapp('x')
 user1.ws_comm()

Answer 6

只需更新此页面上其他作者编写的代码，这对我有用。 问题是在像 on_message 这样的事件回调函数定义中，我们不应该使用 ws 作为参数。 self 负责它，在这些事件处理函数的主体中，我们应该使用 self.ws

class MySocket(object):
    def __init__(self):
        websocket.enableTrace(True)
        self.ws = websocket.WebSocketApp("ws://echo.websocket.org:12300/foo",
                                on_message = self.on_message,
                                on_error = self.on_error,
                                on_close = self.on_close)

    
    def on_message(self, message):
        # if you want to send something use like this
        # self.ws.send()
        print message

    def on_error(self, error):
        print error

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

    def on_open(self):
        self.ws.send("Hello Message")

Answer 7

我想试试这种方式：

class FooClient(object):
    def __init__(self):
        def on_message(ws, message):
            print message
            # use 'self' variable to access other resource
            # handle message from websocket server like this
            self.handler.handle(message)

        def on_error(ws, error):
            print error

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

        def on_open(ws):
            ws.send("Hello %d" % i)

        # assign to 'self.handler'
        self.handler = FooHandler()
        # maybe there are another module should be initiated
        # ...

        websocket.enableTrace(True)
        self.ws = websocket.WebSocketApp("ws://echo.websocket.org:12300/foo",
                                         on_message = on_message,
                                         on_error = on_error,
                                         on_close = on_close)

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

    def close(self):
        """clean other resources"""
        pass

在方法__init__(self)使用内部函数可以避免on_message(self, ws, message)方法的参数数量与WebSocketApp提供给其参数on_message的数量不匹配的on_message （类方法多了一个参数self ）。

我上面有一个handler来处理消息，如果有的话，方法close(self)来清理一些资源， run_forever(self)来运行 websocket。

Answer 8

这是有效的：

class MySocket(object):
    def __init__(self):
        websocket.enableTrace(True)
        self.ws = websocket.WebSocketApp("ws://echo.websocket.org:12300/foo",
                                on_message = self.on_message,
                                on_error = self.on_error,
                                on_close = self.on_close)

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

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

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

    @staticmethod
    def on_open(ws):
        ws.send("Hello %d" % i)

但你无权访问 self