如何在 Tornado 中为 websockets 使用 Python 3.5 风格的异步和等待？

Question

考虑一下这个简短的 sn-p：

import tornado
import tornado.websocket
import tornado.ioloop
import tornado.gen
import tornado.web

class NewWsHandler(tornado.websocket.WebSocketHandler):
    async def on_message(self, message):
        await self.write_message("echo " + message)

class OldWsHandler(tornado.websocket.WebSocketHandler):
    @tornado.gen.coroutine
    def on_message(self, message):
        yield self.write_message("echo " + message)

app = tornado.web.Application([(r'/', OldWsHandler)])
app.listen(8080)
tornado.ioloop.IOLoop.current().start()

OldWsHandler 使用 3.5 之前的方式在 Tornado 中执行异步函数，并且运行良好。但是，as the documentation states，为了可读性和速度，最好使用PEP 0492。

文档说：

只需使用async def foo() 代替带有@gen.coroutine 装饰器的函数定义，并使用await 代替yield。

所以我写了NewWsHandler。但是，在发送 websocket 消息时，会引发警告：

/usr/lib/python3.5/site-packages/tornado/websocket.py:417：RuntimeWarning：从未等待协程'on_message' 回调（*args，**kwargs）

我真的不知道如何（正确）修复它。我尝试用tornado.web.asynchronous 装饰它，但假设是HTTP verb method。所以在我覆盖finish()（不允许websockets这样做）之后，它似乎有点工作：

class NewWsHandler(tornado.websocket.WebSocketHandler):
    def finish(self):
        pass

    @tornado.web.asynchronous
    async def on_message(self, message):
        await self.write_message("echo " + message)

但这看起来仍然是骇人听闻的，并且似乎与文档相矛盾。这样做的正确方法是什么？

注意：我使用的是 Python 3.5.1 和 Tornado 4.3。

Answer 1

协程的调用方式与常规函数不同；因此，当子类化和覆盖方法时，您不能将基类中的常规方法更改为子类中的协程（除非基类明确表示可以）。 WebSocketHandler.on_message 可能不是协程（从 Tornado 4.3 开始；将来可能会改变）。

相反，如果您需要对消息进行异步响应，请将异步部分放在单独的函数中并使用IOLoop.current().spawn_callback 调用它。 （或者如果 write_message 是您正在做的唯一异步操作，只需同步调用它）

---

更新

这在 Tornado 4.5 中发生了变化，WebSocketHandler.on_message 现在可以用作协程。见http://www.tornadoweb.org/en/stable/releases/v4.5.0.html#tornado-websocket。