.. image:: https://travis-ci.org/invisibleroads/socketIO-client.svg?branch=master
:target: https://travis-ci.org/invisibleroads/socketIO-client
socketIO-client
===============
Here is a `socket.io <http://socket.io>`_ client library for Python. You can use it to write test code for your socket.io server.
Please note that this version implements `socket.io protocol 1.x <https://github.com/automattic/socket.io-protocol>`_, which is not backwards compatible. If you want to communicate using `socket.io protocol 0.9 <https://github.com/learnboost/socket.io-spec>`_ (which is compatible with `gevent-socketio <https://github.com/abourget/gevent-socketio>`_), please use `socketIO-client 0.5.7.2 <https://pypi.python.org/pypi/socketIO-client/0.5.7.2>`_.
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. ::
cd $(python -c "import os, socketIO_client;\
print(os.path.dirname(socketIO_client.__file__))")
DEBUG=* node tests/serve.js # Start socket.io server in terminal one
DEBUG=* node tests/proxy.js # Start proxy server in terminal two
nosetests # Run tests in terminal three
For debugging information, run these commands first. ::
import logging
logging.getLogger('socketIO-client').setLevel(logging.DEBUG)
logging.basicConfig()
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_connect():
print('connect')
def on_disconnect():
print('disconnect')
def on_reconnect():
print('reconnect')
def on_aaa_response(*args):
print('on_aaa_response', args)
socketIO = SocketIO('localhost', 8000, LoggingNamespace)
socketIO.on('connect', on_connect)
socketIO.on('disconnect', on_disconnect)
socketIO.on('reconnect', on_reconnect)
# Listen
socketIO.on('aaa_response', on_aaa_response)
socketIO.emit('aaa')
socketIO.emit('aaa')
socketIO.wait(seconds=1)
# Stop listening
socketIO.off('aaa_response')
socketIO.emit('aaa')
socketIO.wait(seconds=1)
# Listen only once
socketIO.once('aaa_response', on_aaa_response)
socketIO.emit('aaa') # Activate aaa_response
socketIO.emit('aaa') # Ignore
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]')
def on_reconnect(self):
print('[Reconnected]')
def on_disconnect(self):
print('[Disconnected]')
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 (https://github.com/invisibleroads/socketIO-client/issues/54). ::
from socketIO_client import SocketIO
# Skip server certificate verification
SocketIO('https://localhost', verify=False)
# Verify the server certificate
SocketIO('https://localhost', verify='server.crt')
# Verify the server certificate and encrypt using client certificate
socketIO = SocketIO('https://localhost', verify='server.crt', cert=(
'client.crt', 'client.key'))
Specify params, headers, cookies, proxies thanks to the `requests <http://python-requests.org>`_ 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 <https://github.com/rauchg>`_ wrote the `socket.io specification <https://github.com/automattic/socket.io-protocol>`_.
- `Hiroki Ohtani <https://github.com/liris>`_ wrote `websocket-client <https://github.com/liris/websocket-client>`_.
- `rod <http://stackoverflow.com/users/370115/rod>`_ wrote a `prototype for a Python client to a socket.io server <http://stackoverflow.com/questions/6692908/formatting-messages-to-send-to-socket-io-node-js-server-from-python-client>`_.
- `Alexandre Bourget <https://github.com/abourget>`_ wrote `gevent-socketio <https://github.com/abourget/gevent-socketio>`_, which is a socket.io server written in Python.
- `Paul Kienzle <https://github.com/pkienzle>`_, `Zac Lee <https://github.com/zratic>`_, `Josh VanderLinden <https://github.com/codekoala>`_, `Ian Fitzpatrick <https://github.com/ifitzpatrick>`_, `Lucas Klein <https://github.com/lukasklein>`_, `Rui Chicoria <https://github.com/rchicoria>`_, `Travis Odom <https://github.com/burstaholic>`_, `Patrick Huber <https://github.com/stackmagic>`_, `Brad Campbell <https://github.com/bradjc>`_, `Daniel <https://github.com/dabidan>`_, `Sean Arietta <https://github.com/sarietta>`_, `Sacha Stafyniak <https://github.com/stafyniaksacha>`_ submitted code to expand support of the socket.io protocol.
- `Bernard Pratz <https://github.com/guyzmo>`_, `Francis Bull <https://github.com/franbull>`_ wrote prototypes to support xhr-polling and jsonp-polling.
- `Joe Palmer <https://github.com/softforge>`_ sponsored development.
- `Eric Chen <https://github.com/taiyangc>`_, `Denis Zinevich <https://github.com/dzinevich>`_, `Thiago Hersan <https://github.com/thiagohersan>`_, `Nayef Copty <https://github.com/nayefc>`_, `Jörgen Karlsson <https://github.com/jorgen-k>`_, `Branden Ghena <https://github.com/brghena>`_, `Tim Landscheidt <https://github.com/scfc>`_, `Matt Porritt <https://github.com/mattporritt>`_, `Matt Dainty <https://github.com/bodgit>`_, `Thomaz de Oliveira dos Reis <https://github.com/thor27>`_, `Felix König <https://github.com/Felk>`_, `George Wilson <https://github.com/wilsonge>`_, `Andreas Strikos <https://github.com/astrikos>`_, `Alessio Sergi <https://github.com/asergi>`_ `Claudio Yacarini <https://github.com/cyacarinic>`_, `Khairi Hafsham <https://github.com/khairihafsham>`_, `Robbie Clarken <https://github.com/RobbieClarken>`_ suggested ways to make the connection more robust.
- `Merlijn van Deen <https://github.com/valhallasw>`_, `Frederic Sureau <https://github.com/fredericsureau>`_, `Marcus Cobden <https://github.com/leth>`_, `Drew Hutchison <https://github.com/drewhutchison>`_, `wuurrd <https://github.com/wuurrd>`_, `Adam Kecer <https://github.com/amfg>`_, `Alex Monk <https://github.com/Krenair>`_, `Vishal P R <https://github.com/vishalwy>`_, `John Vandenberg <https://github.com/jayvdb>`_, `Thomas Grainger <https://github.com/graingert>`_, `Daniel Quinn <https://github.com/danielquinn>`_, `Adric Worley <https://github.com/AdricEpic>`_, `Adam Roses Wight <https://github.com/adamwight>`_, `Jan Včelák <https://github.com/fcelda>`_ proposed changes that make the library more friendly and practical for you!
0.7
---
- Fixed thread cleanup
- Fixed disconnect detection if defined directly thanks to Andreas Strikos
0.6
---
- Upgraded to socket.io protocol 1.x thanks to Sean Arietta and Joe Palmer
- Fixed support for Python 3
- Fixed SSL support
- Added locks to fix concurrency issues with polling transport
- Added SocketIO.off() and SocketIO.once()
0.5
---
- Added support for Python 3
- Added support for jsonp-polling thanks to Bernard Pratz
- Added support for xhr-polling thanks to Francis Bull
- Added support for query params and cookies
- Fixed sending acknowledgments in custom namespaces thanks to Travis Odom
- Rewrote library to use coroutines instead of threads to save memory
0.4
---
- Added support for custom headers and proxies thanks to Rui and Sajal
- Added support for server-side callbacks thanks to Zac Lee
- 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 <http://stackoverflow.com/questions/6692908/formatting-messages-to-send-to-socket-io-node-js-server-from-python-client>`_
- Added exception handling to destructor in case of connection failure
Raw data
{
"_id": null,
"home_page": "https://github.com/invisibleroads/socketIO-client",
"name": "socketIO-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "socket.io node.js",
"author": "Roy Hyunjin Han",
"author_email": "rhh@crosscompute.com",
"download_url": "https://files.pythonhosted.org/packages/12/d4/abeb2596c2f16276c66910362b27d04b8d2cf12a746dcccf1d00de3f691b/socketIO-client-0.7.2.tar.gz",
"platform": "",
"description": ".. image:: https://travis-ci.org/invisibleroads/socketIO-client.svg?branch=master\n :target: https://travis-ci.org/invisibleroads/socketIO-client\n\n\nsocketIO-client\n===============\nHere is a `socket.io <http://socket.io>`_ client library for Python. You can use it to write test code for your socket.io server.\n\nPlease note that this version implements `socket.io protocol 1.x <https://github.com/automattic/socket.io-protocol>`_, which is not backwards compatible. If you want to communicate using `socket.io protocol 0.9 <https://github.com/learnboost/socket.io-spec>`_ (which is compatible with `gevent-socketio <https://github.com/abourget/gevent-socketio>`_), please use `socketIO-client 0.5.7.2 <https://pypi.python.org/pypi/socketIO-client/0.5.7.2>`_.\n\n\nInstallation\n------------\nInstall the package in an isolated environment. ::\n\n VIRTUAL_ENV=$HOME/.virtualenv\n\n # Prepare isolated environment\n virtualenv $VIRTUAL_ENV\n\n # Activate isolated environment\n source $VIRTUAL_ENV/bin/activate\n\n # Install package\n pip install -U socketIO-client\n\n\nUsage\n-----\nActivate isolated environment. ::\n\n VIRTUAL_ENV=$HOME/.virtualenv\n source $VIRTUAL_ENV/bin/activate\n\nLaunch your socket.io server. ::\n\n cd $(python -c \"import os, socketIO_client;\\\n print(os.path.dirname(socketIO_client.__file__))\")\n\n DEBUG=* node tests/serve.js # Start socket.io server in terminal one\n DEBUG=* node tests/proxy.js # Start proxy server in terminal two\n nosetests # Run tests in terminal three\n\nFor debugging information, run these commands first. ::\n\n import logging\n logging.getLogger('socketIO-client').setLevel(logging.DEBUG)\n logging.basicConfig()\n\nEmit. ::\n\n from socketIO_client import SocketIO, LoggingNamespace\n\n with SocketIO('localhost', 8000, LoggingNamespace) as socketIO:\n socketIO.emit('aaa')\n socketIO.wait(seconds=1)\n\nEmit with callback. ::\n\n from socketIO_client import SocketIO, LoggingNamespace\n\n def on_bbb_response(*args):\n print('on_bbb_response', args)\n\n with SocketIO('localhost', 8000, LoggingNamespace) as socketIO:\n socketIO.emit('bbb', {'xxx': 'yyy'}, on_bbb_response)\n socketIO.wait_for_callbacks(seconds=1)\n\nDefine events. ::\n\n from socketIO_client import SocketIO, LoggingNamespace\n\n def on_connect():\n print('connect')\n\n def on_disconnect():\n print('disconnect')\n\n def on_reconnect():\n print('reconnect')\n\n def on_aaa_response(*args):\n print('on_aaa_response', args)\n\n socketIO = SocketIO('localhost', 8000, LoggingNamespace)\n socketIO.on('connect', on_connect)\n socketIO.on('disconnect', on_disconnect)\n socketIO.on('reconnect', on_reconnect)\n\n # Listen\n socketIO.on('aaa_response', on_aaa_response)\n socketIO.emit('aaa')\n socketIO.emit('aaa')\n socketIO.wait(seconds=1)\n\n # Stop listening\n socketIO.off('aaa_response')\n socketIO.emit('aaa')\n socketIO.wait(seconds=1)\n\n # Listen only once\n socketIO.once('aaa_response', on_aaa_response)\n socketIO.emit('aaa') # Activate aaa_response\n socketIO.emit('aaa') # Ignore\n socketIO.wait(seconds=1)\n\nDefine events in a namespace. ::\n\n from socketIO_client import SocketIO, BaseNamespace\n\n class Namespace(BaseNamespace):\n\n def on_aaa_response(self, *args):\n print('on_aaa_response', args)\n self.emit('bbb')\n\n socketIO = SocketIO('localhost', 8000, Namespace)\n socketIO.emit('aaa')\n socketIO.wait(seconds=1)\n\nDefine standard events. ::\n\n from socketIO_client import SocketIO, BaseNamespace\n\n class Namespace(BaseNamespace):\n\n def on_connect(self):\n print('[Connected]')\n\n def on_reconnect(self):\n print('[Reconnected]')\n\n def on_disconnect(self):\n print('[Disconnected]')\n\n socketIO = SocketIO('localhost', 8000, Namespace)\n socketIO.wait(seconds=1)\n\nDefine different namespaces on a single socket. ::\n\n from socketIO_client import SocketIO, BaseNamespace\n\n class ChatNamespace(BaseNamespace):\n\n def on_aaa_response(self, *args):\n print('on_aaa_response', args)\n\n class NewsNamespace(BaseNamespace):\n\n def on_aaa_response(self, *args):\n print('on_aaa_response', args)\n\n socketIO = SocketIO('localhost', 8000)\n chat_namespace = socketIO.define(ChatNamespace, '/chat')\n news_namespace = socketIO.define(NewsNamespace, '/news')\n\n chat_namespace.emit('aaa')\n news_namespace.emit('aaa')\n socketIO.wait(seconds=1)\n\nConnect via SSL (https://github.com/invisibleroads/socketIO-client/issues/54). ::\n\n from socketIO_client import SocketIO\n\n # Skip server certificate verification\n SocketIO('https://localhost', verify=False)\n # Verify the server certificate\n SocketIO('https://localhost', verify='server.crt')\n # Verify the server certificate and encrypt using client certificate\n socketIO = SocketIO('https://localhost', verify='server.crt', cert=(\n 'client.crt', 'client.key'))\n\nSpecify params, headers, cookies, proxies thanks to the `requests <http://python-requests.org>`_ library. ::\n\n from socketIO_client import SocketIO\n from base64 import b64encode\n\n SocketIO(\n localhost', 8000,\n params={'q': 'qqq'},\n headers={'Authorization': 'Basic ' + b64encode('username:password')},\n cookies={'a': 'aaa'},\n proxies={'https': 'https://proxy.example.com:8080'})\n\nWait forever. ::\n\n from socketIO_client import SocketIO\n\n socketIO = SocketIO('localhost', 8000)\n socketIO.wait()\n\n\nLicense\n-------\nThis software is available under the MIT License.\n\n\nCredits\n-------\n- `Guillermo Rauch <https://github.com/rauchg>`_ wrote the `socket.io specification <https://github.com/automattic/socket.io-protocol>`_.\n- `Hiroki Ohtani <https://github.com/liris>`_ wrote `websocket-client <https://github.com/liris/websocket-client>`_.\n- `rod <http://stackoverflow.com/users/370115/rod>`_ wrote a `prototype for a Python client to a socket.io server <http://stackoverflow.com/questions/6692908/formatting-messages-to-send-to-socket-io-node-js-server-from-python-client>`_.\n- `Alexandre Bourget <https://github.com/abourget>`_ wrote `gevent-socketio <https://github.com/abourget/gevent-socketio>`_, which is a socket.io server written in Python.\n- `Paul Kienzle <https://github.com/pkienzle>`_, `Zac Lee <https://github.com/zratic>`_, `Josh VanderLinden <https://github.com/codekoala>`_, `Ian Fitzpatrick <https://github.com/ifitzpatrick>`_, `Lucas Klein <https://github.com/lukasklein>`_, `Rui Chicoria <https://github.com/rchicoria>`_, `Travis Odom <https://github.com/burstaholic>`_, `Patrick Huber <https://github.com/stackmagic>`_, `Brad Campbell <https://github.com/bradjc>`_, `Daniel <https://github.com/dabidan>`_, `Sean Arietta <https://github.com/sarietta>`_, `Sacha Stafyniak <https://github.com/stafyniaksacha>`_ submitted code to expand support of the socket.io protocol.\n- `Bernard Pratz <https://github.com/guyzmo>`_, `Francis Bull <https://github.com/franbull>`_ wrote prototypes to support xhr-polling and jsonp-polling.\n- `Joe Palmer <https://github.com/softforge>`_ sponsored development.\n- `Eric Chen <https://github.com/taiyangc>`_, `Denis Zinevich <https://github.com/dzinevich>`_, `Thiago Hersan <https://github.com/thiagohersan>`_, `Nayef Copty <https://github.com/nayefc>`_, `J\u00f6rgen Karlsson <https://github.com/jorgen-k>`_, `Branden Ghena <https://github.com/brghena>`_, `Tim Landscheidt <https://github.com/scfc>`_, `Matt Porritt <https://github.com/mattporritt>`_, `Matt Dainty <https://github.com/bodgit>`_, `Thomaz de Oliveira dos Reis <https://github.com/thor27>`_, `Felix K\u00f6nig <https://github.com/Felk>`_, `George Wilson <https://github.com/wilsonge>`_, `Andreas Strikos <https://github.com/astrikos>`_, `Alessio Sergi <https://github.com/asergi>`_ `Claudio Yacarini <https://github.com/cyacarinic>`_, `Khairi Hafsham <https://github.com/khairihafsham>`_, `Robbie Clarken <https://github.com/RobbieClarken>`_ suggested ways to make the connection more robust.\n- `Merlijn van Deen <https://github.com/valhallasw>`_, `Frederic Sureau <https://github.com/fredericsureau>`_, `Marcus Cobden <https://github.com/leth>`_, `Drew Hutchison <https://github.com/drewhutchison>`_, `wuurrd <https://github.com/wuurrd>`_, `Adam Kecer <https://github.com/amfg>`_, `Alex Monk <https://github.com/Krenair>`_, `Vishal P R <https://github.com/vishalwy>`_, `John Vandenberg <https://github.com/jayvdb>`_, `Thomas Grainger <https://github.com/graingert>`_, `Daniel Quinn <https://github.com/danielquinn>`_, `Adric Worley <https://github.com/AdricEpic>`_, `Adam Roses Wight <https://github.com/adamwight>`_, `Jan V\u010del\u00e1k <https://github.com/fcelda>`_ proposed changes that make the library more friendly and practical for you!\n\n\n0.7\n---\n- Fixed thread cleanup\n- Fixed disconnect detection if defined directly thanks to Andreas Strikos\n\n0.6\n---\n- Upgraded to socket.io protocol 1.x thanks to Sean Arietta and Joe Palmer\n- Fixed support for Python 3\n- Fixed SSL support\n- Added locks to fix concurrency issues with polling transport\n- Added SocketIO.off() and SocketIO.once()\n\n0.5\n---\n- Added support for Python 3\n- Added support for jsonp-polling thanks to Bernard Pratz\n- Added support for xhr-polling thanks to Francis Bull\n- Added support for query params and cookies\n- Fixed sending acknowledgments in custom namespaces thanks to Travis Odom\n- Rewrote library to use coroutines instead of threads to save memory\n\n0.4\n---\n- Added support for custom headers and proxies thanks to Rui and Sajal\n- Added support for server-side callbacks thanks to Zac Lee\n- Merged Channel functionality into BaseNamespace thanks to Alexandre Bourget\n\n0.3\n---\n- Added support for secure connections\n- Added SocketIO.wait()\n- Improved exception handling in _RhythmicThread and _ListenerThread\n\n0.2\n---\n- Added support for callbacks and channels thanks to Paul Kienzle\n- Incorporated suggestions from Josh VanderLinden and Ian Fitzpatrick\n\n0.1\n---\n- Wrapped `code from StackOverflow <http://stackoverflow.com/questions/6692908/formatting-messages-to-send-to-socket-io-node-js-server-from-python-client>`_\n- Added exception handling to destructor in case of connection failure",
"bugtrack_url": null,
"license": "MIT",
"summary": "A socket.io client library",
"version": "0.7.2",
"split_keywords": [
"socket.io",
"node.js"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ecdbfa4cc00118d2948632cd50b10735",
"sha256": "64cd84fba79cf97f28c11e64d1fc42a2221f2d7a4fada05ab381e2d73d74d2c1"
},
"downloads": -1,
"filename": "socketIO-client-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "ecdbfa4cc00118d2948632cd50b10735",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23488,
"upload_time": "2016-12-11T03:24:59",
"upload_time_iso_8601": "2016-12-11T03:24:59.633156Z",
"url": "https://files.pythonhosted.org/packages/12/d4/abeb2596c2f16276c66910362b27d04b8d2cf12a746dcccf1d00de3f691b/socketIO-client-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2016-12-11 03:24:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "invisibleroads",
"github_project": "socketIO-client",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "socketio-client"
}
JSON
