Skip to main content

High-performance WebSockets for your Flask apps powered by uWSGI.

Project description

High-performance WebSockets for your Flask apps powered by uWSGI. Inspired by Flask-Sockets.

from flask import Flask
from flask.ext.uwsgi_websocket import WebSocket

app = Flask(__name__)
ws = WebSocket(app)

def echo(ws):
    while True:
        msg = ws.receive()

if __name__ == '__main__':, threads=16)


To install Flask-uWSGI-WebSocket, simply:

$ pip install Flask-uWSGI-WebSocket


You can use uWSGI’s built-in HTTP router to get up and running quickly:

$ uwsgi --master --http :8080 --http-websockets --wsgi-file

…or call, passing uwsgi any arguments you like:, host='localhost', port=8080, master=true, processes=8)

uWSGI supports several concurrency models, in particular it has nice support for Gevent. If you want to use Gevent, import flask.ext.uwsgi_websocket.GeventWebSocket and configure uWSGI to use the gevent loop engine:

$ uwsgi –master –http :8080 –http-websockets –gevent 100 –wsgi-file

…or:, gevent=100)

For production you’ll probably want to run uWSGI behind Haproxy or nginx of course, instead of using the built-int HTTP router. Explore the uWSGI documentation for more detail.


It’s possible to take advantage of Flask’s interactive debugger by installing werkzeug’s DebuggedApplication middleware:

from werkzeug.debug import DebuggedApplication
app.wsgi_app = DebuggedApplication(app.wsgi_app, True)

…and running uWSGI with only a single worker:

$ uwsgi --master --http :8080 --http-websockets --wsgi-file --workers 1 --threads 8

If you use, Flask-uWSGI-Websocket will do this automatically for you.


Flask-uWSGI-Websocket automatically performs the WebSocket handshake for you and passes your route handler a websocket client exposing uWSGI’s WebSocket API.





websocket.send_from_sharedarea(id, pos)

websocket.send_binary_from_sharedarea(id, pos)

In addition there is a special websocket.receive() method which tries to make non-blocking calls simpler. When using the WebSocket plugin, it blocks making it appropriate for threaded or multiprocess concurrency models. When using GeventWebSocket it’ll take advantage of gevent and make a non-blocking recv call. AsyncWebsocket should do roughly the same thing, but currently plain --async concurrency model is a bit buggy in uWSGI 2.0.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-uWSGI-WebSocket-0.1.5.tar.gz (4.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page