Skip to content

Commit ed08a01

Browse files
Add missing to argument to namespace emit() and send() calls (Fixes #810)
1 parent 8c15b77 commit ed08a01

File tree

4 files changed

+28
-18
lines changed

4 files changed

+28
-18
lines changed

src/socketio/asyncio_namespace.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ async def trigger_event(self, event, *args):
4141
ret = handler(*args)
4242
return ret
4343

44-
async def emit(self, event, data=None, room=None, skip_sid=None,
44+
async def emit(self, event, data=None, to=None, room=None, skip_sid=None,
4545
namespace=None, callback=None):
4646
"""Emit a custom event to one or more connected clients.
4747
@@ -51,13 +51,13 @@ async def emit(self, event, data=None, room=None, skip_sid=None,
5151
5252
Note: this method is a coroutine.
5353
"""
54-
return await self.server.emit(event, data=data, room=room,
54+
return await self.server.emit(event, data=data, to=to, room=room,
5555
skip_sid=skip_sid,
5656
namespace=namespace or self.namespace,
5757
callback=callback)
5858

59-
async def send(self, data, room=None, skip_sid=None, namespace=None,
60-
callback=None):
59+
async def send(self, data, to=None, room=None, skip_sid=None,
60+
namespace=None, callback=None):
6161
"""Send a message to one or more connected clients.
6262
6363
The only difference with the :func:`socketio.Server.send` method is
@@ -66,7 +66,8 @@ async def send(self, data, room=None, skip_sid=None, namespace=None,
6666
6767
Note: this method is a coroutine.
6868
"""
69-
return await self.server.send(data, room=room, skip_sid=skip_sid,
69+
return await self.server.send(data, to=to, room=room,
70+
skip_sid=skip_sid,
7071
namespace=namespace or self.namespace,
7172
callback=callback)
7273

src/socketio/namespace.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,28 @@ def __init__(self, namespace=None):
3737
def _set_server(self, server):
3838
self.server = server
3939

40-
def emit(self, event, data=None, room=None, skip_sid=None, namespace=None,
41-
callback=None):
40+
def emit(self, event, data=None, to=None, room=None, skip_sid=None,
41+
namespace=None, callback=None):
4242
"""Emit a custom event to one or more connected clients.
4343
4444
The only difference with the :func:`socketio.Server.emit` method is
4545
that when the ``namespace`` argument is not given the namespace
4646
associated with the class is used.
4747
"""
48-
return self.server.emit(event, data=data, room=room, skip_sid=skip_sid,
48+
return self.server.emit(event, data=data, to=to, room=room,
49+
skip_sid=skip_sid,
4950
namespace=namespace or self.namespace,
5051
callback=callback)
5152

52-
def send(self, data, room=None, skip_sid=None, namespace=None,
53+
def send(self, data, to=None, room=None, skip_sid=None, namespace=None,
5354
callback=None):
5455
"""Send a message to one or more connected clients.
5556
5657
The only difference with the :func:`socketio.Server.send` method is
5758
that when the ``namespace`` argument is not given the namespace
5859
associated with the class is used.
5960
"""
60-
return self.server.send(data, room=room, skip_sid=skip_sid,
61+
return self.server.send(data, to=to, room=room, skip_sid=skip_sid,
6162
namespace=namespace or self.namespace,
6263
callback=callback)
6364

tests/asyncio/test_asyncio_namespace.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,14 @@ def test_emit(self):
9393
ns._set_server(mock_server)
9494
_run(
9595
ns.emit(
96-
'ev', data='data', room='room', skip_sid='skip', callback='cb'
96+
'ev', data='data', to='room', skip_sid='skip', callback='cb'
9797
)
9898
)
9999
ns.server.emit.mock.assert_called_with(
100100
'ev',
101101
data='data',
102-
room='room',
102+
to='room',
103+
room=None,
103104
skip_sid='skip',
104105
namespace='/foo',
105106
callback='cb',
@@ -117,6 +118,7 @@ def test_emit(self):
117118
ns.server.emit.mock.assert_called_with(
118119
'ev',
119120
data='data',
121+
to=None,
120122
room='room',
121123
skip_sid='skip',
122124
namespace='/bar',
@@ -128,10 +130,11 @@ def test_send(self):
128130
mock_server = mock.MagicMock()
129131
mock_server.send = AsyncMock()
130132
ns._set_server(mock_server)
131-
_run(ns.send(data='data', room='room', skip_sid='skip', callback='cb'))
133+
_run(ns.send(data='data', to='room', skip_sid='skip', callback='cb'))
132134
ns.server.send.mock.assert_called_with(
133135
'data',
134-
room='room',
136+
to='room',
137+
room=None,
135138
skip_sid='skip',
136139
namespace='/foo',
137140
callback='cb',
@@ -147,6 +150,7 @@ def test_send(self):
147150
)
148151
ns.server.send.mock.assert_called_with(
149152
'data',
153+
to=None,
150154
room='room',
151155
skip_sid='skip',
152156
namespace='/bar',

tests/common/test_namespace.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,12 @@ def on_custom_message(self, sid, data):
5656
def test_emit(self):
5757
ns = namespace.Namespace('/foo')
5858
ns._set_server(mock.MagicMock())
59-
ns.emit('ev', data='data', room='room', skip_sid='skip', callback='cb')
59+
ns.emit('ev', data='data', to='room', skip_sid='skip', callback='cb')
6060
ns.server.emit.assert_called_with(
6161
'ev',
6262
data='data',
63-
room='room',
63+
to='room',
64+
room=None,
6465
skip_sid='skip',
6566
namespace='/foo',
6667
callback='cb',
@@ -76,6 +77,7 @@ def test_emit(self):
7677
ns.server.emit.assert_called_with(
7778
'ev',
7879
data='data',
80+
to=None,
7981
room='room',
8082
skip_sid='skip',
8183
namespace='/bar',
@@ -85,10 +87,11 @@ def test_emit(self):
8587
def test_send(self):
8688
ns = namespace.Namespace('/foo')
8789
ns._set_server(mock.MagicMock())
88-
ns.send(data='data', room='room', skip_sid='skip', callback='cb')
90+
ns.send(data='data', to='room', skip_sid='skip', callback='cb')
8991
ns.server.send.assert_called_with(
9092
'data',
91-
room='room',
93+
to='room',
94+
room=None,
9295
skip_sid='skip',
9396
namespace='/foo',
9497
callback='cb',
@@ -102,6 +105,7 @@ def test_send(self):
102105
)
103106
ns.server.send.assert_called_with(
104107
'data',
108+
to=None,
105109
room='room',
106110
skip_sid='skip',
107111
namespace='/bar',

0 commit comments

Comments
 (0)