gevent-websocket

0.10.1 · maintenance · verified Sun Apr 12

gevent-websocket is a WebSocket library designed for the gevent networking library, integrating with its `pywsgi` server. It provides features like integration at the socket level or through an abstract interface, and supports RPC and PubSub using WAMP (WebSocket Application Messaging Protocol). The current version is 0.10.1, last released in March 2017, suggesting it is in maintenance mode with infrequent updates.

Warnings

deprecated The library's last release was in March 2017, indicating a low maintenance or potentially abandoned status. Users seeking actively developed WebSocket solutions with gevent might consider alternatives like `gevent-ws` which explicitly states itself as an MIT-licensed alternative to the 'abandoned' gevent-websocket.
Fix: Evaluate newer alternatives for active development and support, or be aware of the limited maintenance for this library.
breaking The `wait()` method was renamed to `receive()` in earlier versions (pre-0.10.1). If upgrading from very old versions or referencing outdated documentation, this change can cause `AttributeError`s.
Fix: Always use `ws.receive()` to get messages from the WebSocket connection.
gotcha When integrating with WSGI applications (especially with `WebSocketHandler`), the WebSocket object is exposed via `environ['wsgi.websocket']`. Applications must explicitly check for the presence of this key to determine if a request is a WebSocket upgrade or a standard HTTP request.
Fix: Always check `if 'wsgi.websocket' in environ:` before attempting to access the WebSocket object and handle standard HTTP requests accordingly.
gotcha When combining `gevent-websocket` with `Flask-SocketIO`, installing `gevent-websocket` can unexpectedly break `Flask-SocketIO`'s WebSocket server functionality, leading to connections immediately closing, even though `Flask-SocketIO` itself might recommend installing it for performance.
Fix: Carefully test integration with other WebSocket-dependent libraries. If issues arise, consider removing `gevent-websocket` if `Flask-SocketIO` handles its own WebSocket transport effectively, or explore the specific `Flask-SocketIO` worker classes that might conflict.

Install

pip install gevent-websocket Install stable version

Imports

WebSocketServer

from geventwebsocket import WebSocketServer

WebSocketApplication

from geventwebsocket import WebSocketApplication

Resource
```
from geventwebsocket import Resource
```

WebSocketHandler

from geventwebsocket.handler import WebSocketHandler

WebSocketError
```
from geventwebsocket import WebSocketError
```
Used for catching WebSocket-specific exceptions.

Quickstart

This quickstart sets up a basic WebSocket echo server using the `WebSocketApplication` and `WebSocketServer` classes. It listens on `ws://localhost:8000/` and echoes any received message back to the client. This is the higher-level API for defining WebSocket applications.

from gevent import pywsgi
from geventwebsocket import WebSocketServer, WebSocketApplication, Resource
from collections import OrderedDict

class EchoApplication(WebSocketApplication):
    def on_open(self):
        print("Connection opened")

    def on_message(self, message):
        # Echo the received message back to the client
        print(f"Received: {message}")
        self.ws.send(message)

    def on_close(self, reason):
        print(f"Connection closed: {reason}")

if __name__ == '__main__':
    print("Starting WebSocket echo server on ws://localhost:8000/")
    server = WebSocketServer(
        ('', 8000),
        Resource(OrderedDict([('/', EchoApplication)]))
    )
    try:
        server.serve_forever()
    except KeyboardInterrupt:
        print("Server stopped.")

view raw JSON →