From 4822d8125df11bbf2ef3061c0622164f37a261c9 Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Sun, 16 Dec 2018 23:18:06 +0000 Subject: [PATCH] reorganization of examples, plus some new ones for the client --- examples/README.rst | 25 ++----------- examples/client/README.rst | 15 ++++++++ examples/client/asyncio/README.rst | 24 ++++++++++++ examples/client/asyncio/latency_client.py | 37 +++++++++++++++++++ examples/client/threads/README.rst | 24 ++++++++++++ examples/client/threads/latency_client.py | 31 ++++++++++++++++ examples/server/README.rst | 30 +++++++++++++++ examples/{ => server}/aiohttp/README.rst | 0 examples/{ => server}/aiohttp/app.html | 0 examples/{ => server}/aiohttp/app.py | 0 examples/{ => server}/aiohttp/latency.html | 0 examples/{ => server}/aiohttp/latency.py | 0 .../{ => server}/aiohttp/requirements.txt | 0 .../{ => server}/aiohttp/static/style.css | 0 examples/{ => server}/asgi/README.rst | 0 examples/{ => server}/asgi/app.html | 0 examples/{ => server}/asgi/app.py | 0 examples/{ => server}/asgi/latency.html | 0 examples/{ => server}/asgi/latency.py | 0 examples/{ => server}/asgi/requirements.txt | 0 examples/{ => server}/asgi/static/style.css | 0 examples/{ => server}/sanic/README.rst | 0 examples/{ => server}/sanic/app.html | 0 examples/{ => server}/sanic/app.py | 0 examples/{ => server}/sanic/latency.html | 0 examples/{ => server}/sanic/latency.py | 0 examples/{ => server}/sanic/requirements.txt | 0 examples/{ => server}/sanic/static/style.css | 0 examples/{ => server}/tornado/README.rst | 0 examples/{ => server}/tornado/app.py | 0 examples/{ => server}/tornado/latency.py | 0 .../{ => server}/tornado/requirements.txt | 0 .../{ => server}/tornado/static/style.css | 0 .../{ => server}/tornado/templates/app.html | 0 .../tornado/templates/latency.html | 0 examples/{ => server}/wsgi/README.rst | 0 examples/{ => server}/wsgi/app.py | 0 .../django_example/django_example/__init__.py | 0 .../django_example/django_example/settings.py | 0 .../django_example/django_example/urls.py | 0 .../django_example/django_example/wsgi.py | 0 .../wsgi/django_example/manage.py | 0 .../wsgi/django_example/requirements.txt | 0 .../django_example/socketio_app/__init__.py | 0 .../wsgi/django_example/socketio_app/admin.py | 0 .../wsgi/django_example/socketio_app/apps.py | 0 .../socketio_app/management/__init__.py | 0 .../management/commands/__init__.py | 0 .../management/commands/runserver.py | 0 .../socketio_app/migrations/__init__.py | 0 .../django_example/socketio_app/models.py | 0 .../socketio_app/static/index.html | 0 .../wsgi/django_example/socketio_app/tests.py | 0 .../wsgi/django_example/socketio_app/urls.py | 0 .../wsgi/django_example/socketio_app/views.py | 0 examples/{ => server}/wsgi/latency.py | 0 examples/{ => server}/wsgi/requirements.txt | 0 examples/{ => server}/wsgi/static/style.css | 0 .../{ => server}/wsgi/templates/index.html | 0 .../{ => server}/wsgi/templates/latency.html | 0 socketio/asyncio_client.py | 4 +- socketio/client.py | 4 +- 62 files changed, 170 insertions(+), 24 deletions(-) create mode 100644 examples/client/README.rst create mode 100644 examples/client/asyncio/README.rst create mode 100644 examples/client/asyncio/latency_client.py create mode 100644 examples/client/threads/README.rst create mode 100644 examples/client/threads/latency_client.py create mode 100644 examples/server/README.rst rename examples/{ => server}/aiohttp/README.rst (100%) rename examples/{ => server}/aiohttp/app.html (100%) rename examples/{ => server}/aiohttp/app.py (100%) rename examples/{ => server}/aiohttp/latency.html (100%) rename examples/{ => server}/aiohttp/latency.py (100%) rename examples/{ => server}/aiohttp/requirements.txt (100%) rename examples/{ => server}/aiohttp/static/style.css (100%) rename examples/{ => server}/asgi/README.rst (100%) rename examples/{ => server}/asgi/app.html (100%) rename examples/{ => server}/asgi/app.py (100%) rename examples/{ => server}/asgi/latency.html (100%) rename examples/{ => server}/asgi/latency.py (100%) rename examples/{ => server}/asgi/requirements.txt (100%) rename examples/{ => server}/asgi/static/style.css (100%) rename examples/{ => server}/sanic/README.rst (100%) rename examples/{ => server}/sanic/app.html (100%) rename examples/{ => server}/sanic/app.py (100%) rename examples/{ => server}/sanic/latency.html (100%) rename examples/{ => server}/sanic/latency.py (100%) rename examples/{ => server}/sanic/requirements.txt (100%) rename examples/{ => server}/sanic/static/style.css (100%) rename examples/{ => server}/tornado/README.rst (100%) rename examples/{ => server}/tornado/app.py (100%) rename examples/{ => server}/tornado/latency.py (100%) rename examples/{ => server}/tornado/requirements.txt (100%) rename examples/{ => server}/tornado/static/style.css (100%) rename examples/{ => server}/tornado/templates/app.html (100%) rename examples/{ => server}/tornado/templates/latency.html (100%) rename examples/{ => server}/wsgi/README.rst (100%) rename examples/{ => server}/wsgi/app.py (100%) rename examples/{ => server}/wsgi/django_example/django_example/__init__.py (100%) rename examples/{ => server}/wsgi/django_example/django_example/settings.py (100%) rename examples/{ => server}/wsgi/django_example/django_example/urls.py (100%) rename examples/{ => server}/wsgi/django_example/django_example/wsgi.py (100%) rename examples/{ => server}/wsgi/django_example/manage.py (100%) rename examples/{ => server}/wsgi/django_example/requirements.txt (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/__init__.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/admin.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/apps.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/management/__init__.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/management/commands/__init__.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/management/commands/runserver.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/migrations/__init__.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/models.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/static/index.html (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/tests.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/urls.py (100%) rename examples/{ => server}/wsgi/django_example/socketio_app/views.py (100%) rename examples/{ => server}/wsgi/latency.py (100%) rename examples/{ => server}/wsgi/requirements.txt (100%) rename examples/{ => server}/wsgi/static/style.css (100%) rename examples/{ => server}/wsgi/templates/index.html (100%) rename examples/{ => server}/wsgi/templates/latency.html (100%) diff --git a/examples/README.rst b/examples/README.rst index 19b6b53..8651bba 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -1,25 +1,6 @@ Socket.IO Examples ================== -This directory contains several example Socket.IO applications, organized by -directory: - -wsgi ----- - -Examples that are compatible with the WSGI protocol and frameworks. - -aiohttp -------- - -Examples that are compatible with the aiohttp framework for asyncio. - -sanic ------ - -Examples that are compatible with the sanic framework for asyncio. - -tornado -------- - -Examples that are compatible with the tornado framework. +This directory contains several example Socket.IO applications. Look in the +`server` directory for Socket.IO servers, and in the `client` directory for +Socket.IO clients. \ No newline at end of file diff --git a/examples/client/README.rst b/examples/client/README.rst new file mode 100644 index 0000000..d8a17ec --- /dev/null +++ b/examples/client/README.rst @@ -0,0 +1,15 @@ +Socket.IO Client Examples +========================= + +This directory contains several example Socket.IO client applications, +organized by directory: + +threads +------- + +Examples that use standard Python thread concurrency. + +asyncio +------- + +Examples that use Python's `asyncio` package for concurrency. diff --git a/examples/client/asyncio/README.rst b/examples/client/asyncio/README.rst new file mode 100644 index 0000000..e7fcd7b --- /dev/null +++ b/examples/client/asyncio/README.rst @@ -0,0 +1,24 @@ +Socket.IO Threading Examples +============================ + +This directory contains example Socket.IO clients that work with the +`threading` package of the Python standard library. + +latency_client.py +----------------- + +In this application the client sends *ping* messages to the server, which are +responded by the server with a *pong*. The client measures the time it takes +for each of these exchanges. + +This is an ideal application to measure the performance of the different +asynchronous modes supported by the Socket.IO server. + +Running the Examples +-------------------- + +These examples work with the server examples of the same name. First run one +of the `latency.py` versions from the `examples/server/wsgi` directory. On +another terminal, then start the corresponding client:: + + $ python latency_client.py diff --git a/examples/client/asyncio/latency_client.py b/examples/client/asyncio/latency_client.py new file mode 100644 index 0000000..e8923de --- /dev/null +++ b/examples/client/asyncio/latency_client.py @@ -0,0 +1,37 @@ +import asyncio +import time +import socketio + +loop = asyncio.get_event_loop() +sio = socketio.AsyncClient() +start_timer = None + + +async def send_ping(): + global start_timer + start_timer = time.time() + await sio.emit('ping_from_client') + + +@sio.on('connect') +async def on_connect(): + print('connected to server') + await send_ping() + + +@sio.on('pong_from_server') +async def on_pong(data): + global start_timer + latency = time.time() - start_timer + print('latency is {0:.2f} ms'.format(latency * 1000)) + await sio.sleep(1) + await send_ping() + + +async def start_server(): + await sio.connect('http://localhost:5000') + await sio.wait() + + +if __name__ == '__main__': + loop.run_until_complete(start_server()) diff --git a/examples/client/threads/README.rst b/examples/client/threads/README.rst new file mode 100644 index 0000000..5333375 --- /dev/null +++ b/examples/client/threads/README.rst @@ -0,0 +1,24 @@ +Socket.IO Threading Examples +============================ + +This directory contains example Socket.IO clients that work with the +`threading` package of the Python standard library. + +latency_client.py +----------------- + +In this application the client sends *ping* messages to the server, which are +responded by the server with a *pong*. The client measures the time it takes +for each of these exchanges. + +This is an ideal application to measure the performance of the different +asynchronous modes supported by the Socket.IO server. + +Running the Examples +-------------------- + +These examples work with the server examples of the same name. First run one +of the `latency.py` versions from the `examples/server/wsgi` directory. On +another terminal, then start the corresponding client:: + + $ python latency_client.py diff --git a/examples/client/threads/latency_client.py b/examples/client/threads/latency_client.py new file mode 100644 index 0000000..c08b359 --- /dev/null +++ b/examples/client/threads/latency_client.py @@ -0,0 +1,31 @@ +import time +import socketio + +sio = socketio.Client() +start_timer = None + + +def send_ping(): + global start_timer + start_timer = time.time() + sio.emit('ping_from_client') + + +@sio.on('connect') +def on_connect(): + print('connected to server') + send_ping() + + +@sio.on('pong_from_server') +def on_pong(data): + global start_timer + latency = time.time() - start_timer + print('latency is {0:.2f} ms'.format(latency * 1000)) + sio.sleep(1) + send_ping() + + +if __name__ == '__main__': + sio.connect('http://localhost:5000') + sio.wait() diff --git a/examples/server/README.rst b/examples/server/README.rst new file mode 100644 index 0000000..94bacb4 --- /dev/null +++ b/examples/server/README.rst @@ -0,0 +1,30 @@ +Socket.IO Server Examples +========================= + +This directory contains several example Socket.IO applications, organized by +directory: + +wsgi +---- + +Examples that are compatible with the WSGI protocol and frameworks. + +asgi +---- + +Examples that are compatible with the ASGI specification. + +aiohttp +------- + +Examples that are compatible with the aiohttp framework for asyncio. + +sanic +----- + +Examples that are compatible with the sanic framework for asyncio. + +tornado +------- + +Examples that are compatible with the tornado framework. diff --git a/examples/aiohttp/README.rst b/examples/server/aiohttp/README.rst similarity index 100% rename from examples/aiohttp/README.rst rename to examples/server/aiohttp/README.rst diff --git a/examples/aiohttp/app.html b/examples/server/aiohttp/app.html similarity index 100% rename from examples/aiohttp/app.html rename to examples/server/aiohttp/app.html diff --git a/examples/aiohttp/app.py b/examples/server/aiohttp/app.py similarity index 100% rename from examples/aiohttp/app.py rename to examples/server/aiohttp/app.py diff --git a/examples/aiohttp/latency.html b/examples/server/aiohttp/latency.html similarity index 100% rename from examples/aiohttp/latency.html rename to examples/server/aiohttp/latency.html diff --git a/examples/aiohttp/latency.py b/examples/server/aiohttp/latency.py similarity index 100% rename from examples/aiohttp/latency.py rename to examples/server/aiohttp/latency.py diff --git a/examples/aiohttp/requirements.txt b/examples/server/aiohttp/requirements.txt similarity index 100% rename from examples/aiohttp/requirements.txt rename to examples/server/aiohttp/requirements.txt diff --git a/examples/aiohttp/static/style.css b/examples/server/aiohttp/static/style.css similarity index 100% rename from examples/aiohttp/static/style.css rename to examples/server/aiohttp/static/style.css diff --git a/examples/asgi/README.rst b/examples/server/asgi/README.rst similarity index 100% rename from examples/asgi/README.rst rename to examples/server/asgi/README.rst diff --git a/examples/asgi/app.html b/examples/server/asgi/app.html similarity index 100% rename from examples/asgi/app.html rename to examples/server/asgi/app.html diff --git a/examples/asgi/app.py b/examples/server/asgi/app.py similarity index 100% rename from examples/asgi/app.py rename to examples/server/asgi/app.py diff --git a/examples/asgi/latency.html b/examples/server/asgi/latency.html similarity index 100% rename from examples/asgi/latency.html rename to examples/server/asgi/latency.html diff --git a/examples/asgi/latency.py b/examples/server/asgi/latency.py similarity index 100% rename from examples/asgi/latency.py rename to examples/server/asgi/latency.py diff --git a/examples/asgi/requirements.txt b/examples/server/asgi/requirements.txt similarity index 100% rename from examples/asgi/requirements.txt rename to examples/server/asgi/requirements.txt diff --git a/examples/asgi/static/style.css b/examples/server/asgi/static/style.css similarity index 100% rename from examples/asgi/static/style.css rename to examples/server/asgi/static/style.css diff --git a/examples/sanic/README.rst b/examples/server/sanic/README.rst similarity index 100% rename from examples/sanic/README.rst rename to examples/server/sanic/README.rst diff --git a/examples/sanic/app.html b/examples/server/sanic/app.html similarity index 100% rename from examples/sanic/app.html rename to examples/server/sanic/app.html diff --git a/examples/sanic/app.py b/examples/server/sanic/app.py similarity index 100% rename from examples/sanic/app.py rename to examples/server/sanic/app.py diff --git a/examples/sanic/latency.html b/examples/server/sanic/latency.html similarity index 100% rename from examples/sanic/latency.html rename to examples/server/sanic/latency.html diff --git a/examples/sanic/latency.py b/examples/server/sanic/latency.py similarity index 100% rename from examples/sanic/latency.py rename to examples/server/sanic/latency.py diff --git a/examples/sanic/requirements.txt b/examples/server/sanic/requirements.txt similarity index 100% rename from examples/sanic/requirements.txt rename to examples/server/sanic/requirements.txt diff --git a/examples/sanic/static/style.css b/examples/server/sanic/static/style.css similarity index 100% rename from examples/sanic/static/style.css rename to examples/server/sanic/static/style.css diff --git a/examples/tornado/README.rst b/examples/server/tornado/README.rst similarity index 100% rename from examples/tornado/README.rst rename to examples/server/tornado/README.rst diff --git a/examples/tornado/app.py b/examples/server/tornado/app.py similarity index 100% rename from examples/tornado/app.py rename to examples/server/tornado/app.py diff --git a/examples/tornado/latency.py b/examples/server/tornado/latency.py similarity index 100% rename from examples/tornado/latency.py rename to examples/server/tornado/latency.py diff --git a/examples/tornado/requirements.txt b/examples/server/tornado/requirements.txt similarity index 100% rename from examples/tornado/requirements.txt rename to examples/server/tornado/requirements.txt diff --git a/examples/tornado/static/style.css b/examples/server/tornado/static/style.css similarity index 100% rename from examples/tornado/static/style.css rename to examples/server/tornado/static/style.css diff --git a/examples/tornado/templates/app.html b/examples/server/tornado/templates/app.html similarity index 100% rename from examples/tornado/templates/app.html rename to examples/server/tornado/templates/app.html diff --git a/examples/tornado/templates/latency.html b/examples/server/tornado/templates/latency.html similarity index 100% rename from examples/tornado/templates/latency.html rename to examples/server/tornado/templates/latency.html diff --git a/examples/wsgi/README.rst b/examples/server/wsgi/README.rst similarity index 100% rename from examples/wsgi/README.rst rename to examples/server/wsgi/README.rst diff --git a/examples/wsgi/app.py b/examples/server/wsgi/app.py similarity index 100% rename from examples/wsgi/app.py rename to examples/server/wsgi/app.py diff --git a/examples/wsgi/django_example/django_example/__init__.py b/examples/server/wsgi/django_example/django_example/__init__.py similarity index 100% rename from examples/wsgi/django_example/django_example/__init__.py rename to examples/server/wsgi/django_example/django_example/__init__.py diff --git a/examples/wsgi/django_example/django_example/settings.py b/examples/server/wsgi/django_example/django_example/settings.py similarity index 100% rename from examples/wsgi/django_example/django_example/settings.py rename to examples/server/wsgi/django_example/django_example/settings.py diff --git a/examples/wsgi/django_example/django_example/urls.py b/examples/server/wsgi/django_example/django_example/urls.py similarity index 100% rename from examples/wsgi/django_example/django_example/urls.py rename to examples/server/wsgi/django_example/django_example/urls.py diff --git a/examples/wsgi/django_example/django_example/wsgi.py b/examples/server/wsgi/django_example/django_example/wsgi.py similarity index 100% rename from examples/wsgi/django_example/django_example/wsgi.py rename to examples/server/wsgi/django_example/django_example/wsgi.py diff --git a/examples/wsgi/django_example/manage.py b/examples/server/wsgi/django_example/manage.py similarity index 100% rename from examples/wsgi/django_example/manage.py rename to examples/server/wsgi/django_example/manage.py diff --git a/examples/wsgi/django_example/requirements.txt b/examples/server/wsgi/django_example/requirements.txt similarity index 100% rename from examples/wsgi/django_example/requirements.txt rename to examples/server/wsgi/django_example/requirements.txt diff --git a/examples/wsgi/django_example/socketio_app/__init__.py b/examples/server/wsgi/django_example/socketio_app/__init__.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/__init__.py rename to examples/server/wsgi/django_example/socketio_app/__init__.py diff --git a/examples/wsgi/django_example/socketio_app/admin.py b/examples/server/wsgi/django_example/socketio_app/admin.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/admin.py rename to examples/server/wsgi/django_example/socketio_app/admin.py diff --git a/examples/wsgi/django_example/socketio_app/apps.py b/examples/server/wsgi/django_example/socketio_app/apps.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/apps.py rename to examples/server/wsgi/django_example/socketio_app/apps.py diff --git a/examples/wsgi/django_example/socketio_app/management/__init__.py b/examples/server/wsgi/django_example/socketio_app/management/__init__.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/management/__init__.py rename to examples/server/wsgi/django_example/socketio_app/management/__init__.py diff --git a/examples/wsgi/django_example/socketio_app/management/commands/__init__.py b/examples/server/wsgi/django_example/socketio_app/management/commands/__init__.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/management/commands/__init__.py rename to examples/server/wsgi/django_example/socketio_app/management/commands/__init__.py diff --git a/examples/wsgi/django_example/socketio_app/management/commands/runserver.py b/examples/server/wsgi/django_example/socketio_app/management/commands/runserver.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/management/commands/runserver.py rename to examples/server/wsgi/django_example/socketio_app/management/commands/runserver.py diff --git a/examples/wsgi/django_example/socketio_app/migrations/__init__.py b/examples/server/wsgi/django_example/socketio_app/migrations/__init__.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/migrations/__init__.py rename to examples/server/wsgi/django_example/socketio_app/migrations/__init__.py diff --git a/examples/wsgi/django_example/socketio_app/models.py b/examples/server/wsgi/django_example/socketio_app/models.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/models.py rename to examples/server/wsgi/django_example/socketio_app/models.py diff --git a/examples/wsgi/django_example/socketio_app/static/index.html b/examples/server/wsgi/django_example/socketio_app/static/index.html similarity index 100% rename from examples/wsgi/django_example/socketio_app/static/index.html rename to examples/server/wsgi/django_example/socketio_app/static/index.html diff --git a/examples/wsgi/django_example/socketio_app/tests.py b/examples/server/wsgi/django_example/socketio_app/tests.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/tests.py rename to examples/server/wsgi/django_example/socketio_app/tests.py diff --git a/examples/wsgi/django_example/socketio_app/urls.py b/examples/server/wsgi/django_example/socketio_app/urls.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/urls.py rename to examples/server/wsgi/django_example/socketio_app/urls.py diff --git a/examples/wsgi/django_example/socketio_app/views.py b/examples/server/wsgi/django_example/socketio_app/views.py similarity index 100% rename from examples/wsgi/django_example/socketio_app/views.py rename to examples/server/wsgi/django_example/socketio_app/views.py diff --git a/examples/wsgi/latency.py b/examples/server/wsgi/latency.py similarity index 100% rename from examples/wsgi/latency.py rename to examples/server/wsgi/latency.py diff --git a/examples/wsgi/requirements.txt b/examples/server/wsgi/requirements.txt similarity index 100% rename from examples/wsgi/requirements.txt rename to examples/server/wsgi/requirements.txt diff --git a/examples/wsgi/static/style.css b/examples/server/wsgi/static/style.css similarity index 100% rename from examples/wsgi/static/style.css rename to examples/server/wsgi/static/style.css diff --git a/examples/wsgi/templates/index.html b/examples/server/wsgi/templates/index.html similarity index 100% rename from examples/wsgi/templates/index.html rename to examples/server/wsgi/templates/index.html diff --git a/examples/wsgi/templates/latency.html b/examples/server/wsgi/templates/latency.html similarity index 100% rename from examples/wsgi/templates/latency.html rename to examples/server/wsgi/templates/latency.html diff --git a/socketio/asyncio_client.py b/socketio/asyncio_client.py index fff17a3..b48515f 100644 --- a/socketio/asyncio_client.py +++ b/socketio/asyncio_client.py @@ -218,8 +218,10 @@ class AsyncClient(client.Client): # as a single argument if isinstance(data, tuple): data = list(data) - else: + elif data is not None: data = [data] + else: + data = [] await self._send_packet(packet.Packet( packet.EVENT, namespace=namespace, data=[event] + data, id=id, binary=binary)) diff --git a/socketio/client.py b/socketio/client.py index 50d500c..a33f86d 100644 --- a/socketio/client.py +++ b/socketio/client.py @@ -320,8 +320,10 @@ class Client(object): # as a single argument if isinstance(data, tuple): data = list(data) - else: + elif data is not None: data = [data] + else: + data = [] self._send_packet(packet.Packet(packet.EVENT, namespace=namespace, data=[event] + data, id=id, binary=binary))