socketIO-client 0.6.3

A socket.io client library

socketIO-client

Here is a socket.io client library for Python. You can use it to write test code for your socket.io server.

Installation

Install the package in an isolated environment.

VIRTUAL_ENV=$HOME/.virtualenv

# Prepare isolated environment
virtualenv $VIRTUAL_ENV

# Activate isolated environment
source $VIRTUAL_ENV/bin/activate

# Install package
pip install -U socketIO-client

Usage

Activate isolated environment.

VIRTUAL_ENV=$HOME/.virtualenv
source $VIRTUAL_ENV/bin/activate

Launch your socket.io server.

# Get package folder
PACKAGE_FOLDER=`python -c "import os, socketIO_client;\
    print(os.path.dirname(socketIO_client.__file__))"`
# Start socket.io server
DEBUG=* node $PACKAGE_FOLDER/tests/serve.js
# Start proxy server in a separate terminal on the same machine
DEBUG=* node $PACKAGE_FOLDER/tests/proxy.js

For debugging information, run these commands first.

import logging
logging.getLogger('requests').setLevel(logging.WARNING)
logging.basicConfig(level=logging.DEBUG)

Emit.

from socketIO_client import SocketIO, LoggingNamespace

with SocketIO('localhost', 8000, LoggingNamespace) as socketIO:
    socketIO.emit('aaa')
    socketIO.wait(seconds=1)

Emit with callback.

from socketIO_client import SocketIO, LoggingNamespace

def on_bbb_response(*args):
    print('on_bbb_response', args)

with SocketIO('localhost', 8000, LoggingNamespace) as socketIO:
    socketIO.emit('bbb', {'xxx': 'yyy'}, on_bbb_response)
    socketIO.wait_for_callbacks(seconds=1)

Define events.

from socketIO_client import SocketIO, LoggingNamespace

def on_aaa_response(*args):
    print('on_aaa_response', args)

socketIO = SocketIO('localhost', 8000, LoggingNamespace)
socketIO.on('aaa_response', on_aaa_response)
socketIO.emit('aaa')
socketIO.wait(seconds=1)

Define events in a namespace.

from socketIO_client import SocketIO, BaseNamespace

class Namespace(BaseNamespace):

    def on_aaa_response(self, *args):
        print('on_aaa_response', args)
        self.emit('bbb')

socketIO = SocketIO('localhost', 8000, Namespace)
socketIO.emit('aaa')
socketIO.wait(seconds=1)

Define standard events.

from socketIO_client import SocketIO, BaseNamespace

class Namespace(BaseNamespace):

    def on_connect(self):
        print('[Connected]')

socketIO = SocketIO('localhost', 8000, Namespace)
socketIO.wait(seconds=1)

Define different namespaces on a single socket.

from socketIO_client import SocketIO, BaseNamespace

class ChatNamespace(BaseNamespace):

    def on_aaa_response(self, *args):
        print('on_aaa_response', args)

class NewsNamespace(BaseNamespace):

    def on_aaa_response(self, *args):
        print('on_aaa_response', args)

socketIO = SocketIO('localhost', 8000)
chat_namespace = socketIO.define(ChatNamespace, '/chat')
news_namespace = socketIO.define(NewsNamespace, '/news')

chat_namespace.emit('aaa')
news_namespace.emit('aaa')
socketIO.wait(seconds=1)

Connect via SSL.

from socketIO_client import SocketIO

SocketIO('https://localhost', verify=False)

Specify params, headers, cookies, proxies thanks to the requests library.

from socketIO_client import SocketIO
from base64 import b64encode

SocketIO(
    localhost', 8000,
    params={'q': 'qqq'},
    headers={'Authorization': 'Basic ' + b64encode('username:password')},
    cookies={'a': 'aaa'},
    proxies={'https': 'https://proxy.example.com:8080'})

Wait forever.

from socketIO_client import SocketIO

socketIO = SocketIO('localhost', 8000)
socketIO.wait()

License

This software is available under the MIT License.

Credits

• Guillermo Rauch wrote the socket.io specification.

• Hiroki Ohtani wrote websocket-client.

• rod wrote a prototype for a Python client to a socket.io server.

• Alexandre Bourget wrote gevent-socketio, which is a socket.io server written in Python.

• Paul Kienzle, Zac Lee, Josh VanderLinden, Ian Fitzpatrick, Lucas Klein, Rui Chicoria, Travis Odom, Patrick Huber, Brad Campbell, Daniel, Sean Arietta submitted code to expand support of the socket.io protocol.

• Bernard Pratz, Francis Bull wrote prototypes to support xhr-polling and jsonp-polling.

• Eric Chen, Denis Zinevich, Thiago Hersan, Nayef Copty, Jörgen Karlsson, Branden Ghena suggested ways to make the connection more robust.

• Merlijn van Deen, Frederic Sureau, Marcus Cobden, Drew Hutchison, wuurrd, Adam Kecer, Alex Monk, Vishal P R, John Vandenberg, Thomas Grainger proposed changes that make the library more friendly and practical for you!

0.6.3

• Upgraded to socket.io protocol 1.x for websocket transport

• Added locks to fix concurrency issues with polling transport

• Fixed SSL support

0.6.1

• Upgraded to socket.io protocol 1.x thanks to Sean Arietta and Joe Palmer

0.5.5

• Fixed reconnection in the event of server restart

• Fixed calling on_reconnect() so that it is actually called

• Set default Namespace=None

• Added support for Python 3.4

0.5.3

• Updated wait loop to exit if the client wants to disconnect

• Fixed calling on_connect() so that it is called only once

• Set heartbeat_interval to be half of the heartbeat_timeout

0.5.2

• Replaced secure=True with host=’https://example.com’

• Fixed sending heartbeats thanks to Travis Odom

0.5.1

• Added error handling in the event of websocket timeout

• Fixed sending acknowledgments in custom namespaces thanks to Travis Odom

0.5

• Rewrote library to use coroutines instead of threads to save memory

• Improved connection resilience

• Added support for xhr-polling thanks to Francis Bull

• Added support for jsonp-polling thanks to Bernard Pratz

• Added support for query params and cookies

0.4

• Added support for custom headers and proxies thanks to Rui and Sajal

• Added support for server-side callbacks thanks to Zac Lee

• Added low-level _SocketIO to remove cyclic references

• Merged Channel functionality into BaseNamespace thanks to Alexandre Bourget

0.3

• Added support for secure connections

• Added socketIO.wait()

• Improved exception handling in _RhythmicThread and _ListenerThread

0.2

• Added support for callbacks and channels thanks to Paul Kienzle

• Incorporated suggestions from Josh VanderLinden and Ian Fitzpatrick

0.1

• Wrapped code from StackOverflow

• Added exception handling to destructor in case of connection failure