skip_sid parameter can also be a list (fixes miguelgrinberg#202)

miguelgrinberg · miguelgrinberg · commit 00d39ca6985e · 2019-05-19T18:31:29.000+01:00
diff --git a/socketio/asyncio_manager.py b/socketio/asyncio_manager.py
@@ -15,8 +15,10 @@ async def emit(self, event, data, namespace, room=None, skip_sid=None,
         if namespace not in self.rooms or room not in self.rooms[namespace]:
             return
         tasks = []
+        if not isinstance(skip_sid, list):
+            skip_sid = [skip_sid]
         for sid in self.get_participants(namespace, room):
-            if sid != skip_sid:
+            if sid not in skip_sid:
                 if callback is not None:
                     id = self._generate_ack_id(sid, namespace, callback)
                 else:
diff --git a/socketio/base_manager.py b/socketio/base_manager.py
@@ -130,8 +130,10 @@ def emit(self, event, data, namespace, room=None, skip_sid=None,
         connected to the namespace."""
         if namespace not in self.rooms or room not in self.rooms[namespace]:
             return
+        if not isinstance(skip_sid, list):
+            skip_sid = [skip_sid]
         for sid in self.get_participants(namespace, room):
-            if sid != skip_sid:
+            if sid not in skip_sid:
                 if callback is not None:
                     id = self._generate_ack_id(sid, namespace, callback)
                 else:
diff --git a/socketio/server.py b/socketio/server.py
@@ -218,7 +218,8 @@ def emit(self, event, data=None, room=None, skip_sid=None, namespace=None,
                      connected clients.
         :param skip_sid: The session ID of a client to skip when broadcasting
                          to a room or to all clients. This can be used to
-                         prevent a message from being sent to the sender.
+                         prevent a message from being sent to the sender. To
+                         skip multiple sids, pass a list.
         :param namespace: The Socket.IO namespace for the event. If this
                           argument is omitted the event is emitted to the
                           default namespace.
@@ -258,7 +259,8 @@ def send(self, data, room=None, skip_sid=None, namespace=None,
                      connected clients.
         :param skip_sid: The session ID of a client to skip when broadcasting
                          to a room or to all clients. This can be used to
-                         prevent a message from being sent to the sender.
+                         prevent a message from being sent to the sender. To
+                         skip multiple sids, pass a list.
         :param namespace: The Socket.IO namespace for the event. If this
                           argument is omitted the event is emitted to the
                           default namespace.
diff --git a/tests/asyncio/test_asyncio_manager.py b/tests/asyncio/test_asyncio_manager.py
@@ -255,6 +255,19 @@ def test_emit_to_all_skip_one(self):
         self.bm.server._emit_internal.mock.assert_any_call(
             '789', 'my event', {'foo': 'bar'}, '/foo', None)
 
+    def test_emit_to_all_skip_two(self):
+        self.bm.connect('123', '/foo')
+        self.bm.enter_room('123', '/foo', 'bar')
+        self.bm.connect('456', '/foo')
+        self.bm.enter_room('456', '/foo', 'bar')
+        self.bm.connect('789', '/foo')
+        self.bm.connect('abc', '/bar')
+        _run(self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo',
+                          skip_sid=['123', '789']))
+        self.assertEqual(self.bm.server._emit_internal.mock.call_count, 1)
+        self.bm.server._emit_internal.mock.assert_any_call(
+            '456', 'my event', {'foo': 'bar'}, '/foo', None)
+
     def test_emit_with_callback(self):
         self.bm.connect('123', '/foo')
         self.bm._generate_ack_id = mock.MagicMock()
diff --git a/tests/common/test_base_manager.py b/tests/common/test_base_manager.py
@@ -237,6 +237,20 @@ def test_emit_to_all_skip_one(self):
                                                       {'foo': 'bar'}, '/foo',
                                                       None)
 
+    def test_emit_to_all_skip_two(self):
+        self.bm.connect('123', '/foo')
+        self.bm.enter_room('123', '/foo', 'bar')
+        self.bm.connect('456', '/foo')
+        self.bm.enter_room('456', '/foo', 'bar')
+        self.bm.connect('789', '/foo')
+        self.bm.connect('abc', '/bar')
+        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo',
+                     skip_sid=['123', '789'])
+        self.assertEqual(self.bm.server._emit_internal.call_count, 1)
+        self.bm.server._emit_internal.assert_any_call('456', 'my event',
+                                                      {'foo': 'bar'}, '/foo',
+                                                      None)
+
     def test_emit_with_callback(self):
         self.bm.connect('123', '/foo')
         self.bm._generate_ack_id = mock.MagicMock()
