From fd91e36799b3ba66c0f5ff22504f54b50951833f Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Fri, 26 Apr 2019 16:00:13 +0100 Subject: [PATCH] remove unused wait and timeout arguments from send method --- socketio/asyncio_client.py | 14 ++------------ socketio/client.py | 14 ++------------ socketio/server.py | 2 +- tests/asyncio/test_asyncio_client.py | 5 ++--- tests/common/test_client.py | 5 ++--- 5 files changed, 9 insertions(+), 31 deletions(-) diff --git a/socketio/asyncio_client.py b/socketio/asyncio_client.py index eb20faf..db79b33 100644 --- a/socketio/asyncio_client.py +++ b/socketio/asyncio_client.py @@ -162,8 +162,7 @@ class AsyncClient(client.Client): packet.EVENT, namespace=namespace, data=[event] + data, id=id, binary=binary)) - async def send(self, data, namespace=None, callback=None, wait=False, - timeout=60): + async def send(self, data, namespace=None, callback=None): """Send a message to one or more connected clients. This function emits an event with the name ``'message'``. Use @@ -180,20 +179,11 @@ class AsyncClient(client.Client): that will be passed to the function are those provided by the client. Callback functions can only be used when addressing an individual client. - :param wait: If set to ``True``, this function will wait for the - server to handle the event and acknowledge it via its - callback function. The value(s) passed by the server to - its callback will be returned. If set to ``False``, - this function emits the event and returns immediately. - :param timeout: If ``wait`` is set to ``True``, this parameter - specifies a waiting timeout. If the timeout is reached - before the server acknowledges the event, then a - ``TimeoutError`` exception is raised. Note: this method is a coroutine. """ await self.emit('message', data=data, namespace=namespace, - callback=callback, wait=wait, timeout=timeout) + callback=callback) async def call(self, event, data=None, namespace=None, timeout=60): """Emit a custom event to a client and wait for the response. diff --git a/socketio/client.py b/socketio/client.py index b8cf1b9..0c49bbc 100644 --- a/socketio/client.py +++ b/socketio/client.py @@ -264,8 +264,7 @@ class Client(object): data=[event] + data, id=id, binary=binary)) - def send(self, data, namespace=None, callback=None, wait=False, - timeout=60): + def send(self, data, namespace=None, callback=None): """Send a message to one or more connected clients. This function emits an event with the name ``'message'``. Use @@ -282,18 +281,9 @@ class Client(object): that will be passed to the function are those provided by the client. Callback functions can only be used when addressing an individual client. - :param wait: If set to ``True``, this function will wait for the - server to handle the event and acknowledge it via its - callback function. The value(s) passed by the server to - its callback will be returned. If set to ``False``, - this function emits the event and returns immediately. - :param timeout: If ``wait`` is set to ``True``, this parameter - specifies a waiting timeout. If the timeout is reached - before the server acknowledges the event, then a - ``TimeoutError`` exception is raised. """ self.emit('message', data=data, namespace=namespace, - callback=callback, wait=wait, timeout=timeout) + callback=callback) def call(self, event, data=None, namespace=None, timeout=60): """Emit a custom event to a client and wait for the response. diff --git a/socketio/server.py b/socketio/server.py index 87cc826..60247ba 100644 --- a/socketio/server.py +++ b/socketio/server.py @@ -242,7 +242,7 @@ class Server(object): skip_sid=skip_sid, callback=callback, **kwargs) def send(self, data, room=None, skip_sid=None, namespace=None, - callback=None, wait=False, timeout=60, **kwargs): + callback=None, **kwargs): """Send a message to one or more connected clients. This function emits an event with the name ``'message'``. Use diff --git a/tests/asyncio/test_asyncio_client.py b/tests/asyncio/test_asyncio_client.py index 79556f5..7602882 100644 --- a/tests/asyncio/test_asyncio_client.py +++ b/tests/asyncio/test_asyncio_client.py @@ -240,15 +240,14 @@ class TestAsyncClient(unittest.TestCase): _run(c.send('data', 'namespace', 'callback')) c.emit.mock.assert_called_once_with( 'message', data='data', namespace='namespace', - callback='callback', wait=False, timeout=60) + callback='callback') def test_send_with_defaults(self): c = asyncio_client.AsyncClient() c.emit = AsyncMock() _run(c.send('data')) c.emit.mock.assert_called_once_with( - 'message', data='data', namespace=None, callback=None, wait=False, - timeout=60) + 'message', data='data', namespace=None, callback=None) def test_call(self): c = asyncio_client.AsyncClient() diff --git a/tests/common/test_client.py b/tests/common/test_client.py index b23b7d7..0d588c9 100644 --- a/tests/common/test_client.py +++ b/tests/common/test_client.py @@ -323,15 +323,14 @@ class TestClient(unittest.TestCase): c.send('data', 'namespace', 'callback') c.emit.assert_called_once_with( 'message', data='data', namespace='namespace', - callback='callback', wait=False, timeout=60) + callback='callback') def test_send_with_defaults(self): c = client.Client() c.emit = mock.MagicMock() c.send('data') c.emit.assert_called_once_with( - 'message', data='data', namespace=None, callback=None, wait=False, - timeout=60) + 'message', data='data', namespace=None, callback=None) def test_call(self): c = client.Client()