mirror
/
miguelgrinberg.python-socketio
mirror of https://github.com/miguelgrinberg/python-socketio
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Document the user of tuples when emitting

pull/1118/head
Miguel Grinberg 5 years ago
parent
1fffa8ce7a
commit
3ac3437af7
No known key found for this signature in database GPG Key ID: 36848B262DF5F06C
4 changed files with 50 additions and 42 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 31
      socketio/asyncio_client.py
  2. 15
      socketio/asyncio_server.py
  3. 31
      socketio/client.py
  4. 15
      socketio/server.py

31
socketio/asyncio_client.py
View File

@ -139,17 +139,17 @@ class AsyncClient(client.Client):
:param event: The event name. It can be any string. The event names :param event: The event name. It can be any string. The event names
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the server. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this
argument is omitted the event is emitted to the argument is omitted the event is emitted to the
default namespace. default namespace.
:param callback: If given, this function will be called to acknowledge :param callback: If given, this function will be called to acknowledge
the the client has received the message. The arguments the the server has received the message. The arguments
that will be passed to the function are those provided that will be passed to the function are those provided
by the client. Callback functions can only be used by the server.
when addressing an individual client.
Note: this method is not designed to be used concurrently. If multiple Note: this method is not designed to be used concurrently. If multiple
tasks are emitting at the same time on the same client connection, then tasks are emitting at the same time on the same client connection, then
@ -190,17 +190,17 @@ class AsyncClient(client.Client):
This function emits an event with the name ``'message'``. Use This function emits an event with the name ``'message'``. Use
:func:`emit` to issue custom event names. :func:`emit` to issue custom event names.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the server. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this
argument is omitted the event is emitted to the argument is omitted the event is emitted to the
default namespace. default namespace.
:param callback: If given, this function will be called to acknowledge :param callback: If given, this function will be called to acknowledge
the the client has received the message. The arguments the the server has received the message. The arguments
that will be passed to the function are those provided that will be passed to the function are those provided
by the client. Callback functions can only be used by the server.
when addressing an individual client.
Note: this method is a coroutine. Note: this method is a coroutine.
""" """
@ -213,9 +213,10 @@ class AsyncClient(client.Client):
:param event: The event name. It can be any string. The event names :param event: The event name. It can be any string. The event names
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the server. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this
argument is omitted the event is emitted to the argument is omitted the event is emitted to the
default namespace. default namespace.

15
socketio/asyncio_server.py
View File

@ -91,8 +91,9 @@ class AsyncServer(server.Server):
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the client or clients. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param to: The recipient of the message. This can be set to the :param to: The recipient of the message. This can be set to the
session ID of a client to address only that client, or to session ID of a client to address only that client, or to
to any custom room created by the application to address all to any custom room created by the application to address all
@ -142,8 +143,9 @@ class AsyncServer(server.Server):
:func:`emit` to issue custom event names. :func:`emit` to issue custom event names.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the client or clients. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param to: The recipient of the message. This can be set to the :param to: The recipient of the message. This can be set to the
session ID of a client to address only that client, or to session ID of a client to address only that client, or to
to any custom room created by the application to address all to any custom room created by the application to address all
@ -183,8 +185,9 @@ class AsyncServer(server.Server):
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the client or clients. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param to: The session ID of the recipient client. :param to: The session ID of the recipient client.
:param sid: Alias for the ``to`` parameter. :param sid: Alias for the ``to`` parameter.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this

31
socketio/client.py
View File

@ -307,17 +307,17 @@ class Client(object):
:param event: The event name. It can be any string. The event names :param event: The event name. It can be any string. The event names
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the server. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this
argument is omitted the event is emitted to the argument is omitted the event is emitted to the
default namespace. default namespace.
:param callback: If given, this function will be called to acknowledge :param callback: If given, this function will be called to acknowledge
the the client has received the message. The arguments the the server has received the message. The arguments
that will be passed to the function are those provided that will be passed to the function are those provided
by the client. Callback functions can only be used by the server.
when addressing an individual client.
Note: this method is not thread safe. If multiple threads are emitting Note: this method is not thread safe. If multiple threads are emitting
at the same time on the same client connection, messages composed of at the same time on the same client connection, messages composed of
@ -356,17 +356,17 @@ class Client(object):
This function emits an event with the name ``'message'``. Use This function emits an event with the name ``'message'``. Use
:func:`emit` to issue custom event names. :func:`emit` to issue custom event names.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the server. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this
argument is omitted the event is emitted to the argument is omitted the event is emitted to the
default namespace. default namespace.
:param callback: If given, this function will be called to acknowledge :param callback: If given, this function will be called to acknowledge
the the client has received the message. The arguments the the server has received the message. The arguments
that will be passed to the function are those provided that will be passed to the function are those provided
by the client. Callback functions can only be used by the server.
when addressing an individual client.
""" """
self.emit('message', data=data, namespace=namespace, self.emit('message', data=data, namespace=namespace,
callback=callback) callback=callback)
@ -377,9 +377,10 @@ class Client(object):
:param event: The event name. It can be any string. The event names :param event: The event name. It can be any string. The event names
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the server. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this
argument is omitted the event is emitted to the argument is omitted the event is emitted to the
default namespace. default namespace.

15
socketio/server.py
View File

@ -253,8 +253,9 @@ class Server(object):
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the client or clients. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param to: The recipient of the message. This can be set to the :param to: The recipient of the message. This can be set to the
session ID of a client to address only that client, or to session ID of a client to address only that client, or to
to any custom room created by the application to address all to any custom room created by the application to address all
@ -302,8 +303,9 @@ class Server(object):
:func:`emit` to issue custom event names. :func:`emit` to issue custom event names.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the client or clients. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param to: The recipient of the message. This can be set to the :param to: The recipient of the message. This can be set to the
session ID of a client to address only that client, or to session ID of a client to address only that client, or to
to any custom room created by the application to address all to any custom room created by the application to address all
@ -341,8 +343,9 @@ class Server(object):
``'connect'``, ``'message'`` and ``'disconnect'`` are ``'connect'``, ``'message'`` and ``'disconnect'`` are
reserved and should not be used. reserved and should not be used.
:param data: The data to send to the client or clients. Data can be of :param data: The data to send to the client or clients. Data can be of
type ``str``, ``bytes``, ``list`` or ``dict``. If a type ``str``, ``bytes``, ``list`` or ``dict``. To send
``list`` or ``dict``, the data will be serialized as JSON. multiple arguments, use a tuple where each element is of
one of the types indicated above.
:param to: The session ID of the recipient client. :param to: The session ID of the recipient client.
:param sid: Alias for the ``to`` parameter. :param sid: Alias for the ``to`` parameter.
:param namespace: The Socket.IO namespace for the event. If this :param namespace: The Socket.IO namespace for the event. If this

Write Preview
Loading…
Cancel
Save