Internal code restructure (no functional changes)

src/engineio/client.py

@@ -22,15 +22,14 @@
 from . import payload
 
 default_logger = logging.getLogger('engineio.client')
-connected_clients = []
 
 
 def signal_handler(sig, frame):
     """SIGINT handler.
 
     Disconnect all active clients and then invoke the original signal handler.
     """
-    for client in connected_clients[:]:
+    for client in base_client.connected_clients[:]:
         if not client.is_asyncio_based():
             client.disconnect()
     if callable(original_signal_handler):
@@ -163,7 +162,7 @@ def disconnect(self, abort=False):
                 self.read_loop_task.join()
             self.state = 'disconnected'
             try:
-                connected_clients.remove(self)
+                base_client.connected_clients.remove(self)
             except ValueError:  # pragma: no cover
                 pass
         self._reset()
@@ -245,7 +244,7 @@ def _connect_polling(self, url, headers, engineio_path):
         self.base_url += '&sid=' + self.sid
 
         self.state = 'connected'
-        connected_clients.append(self)
+        base_client.connected_clients.append(self)
         self._trigger_event('connect', run_async=False)
 
         for pkt in p.packets[1:]:
@@ -414,7 +413,7 @@ def _connect_websocket(self, url, headers, engineio_path):
             self.current_transport = 'websocket'
 
             self.state = 'connected'
-            connected_clients.append(self)
+            base_client.connected_clients.append(self)
             self._trigger_event('connect', run_async=False)
         self.ws = ws
         self.ws.settimeout(self.ping_interval + self.ping_timeout)
@@ -514,7 +513,7 @@ def _read_loop_polling(self):
         if self.state == 'connected':
             self._trigger_event('disconnect', run_async=False)
             try:
-                connected_clients.remove(self)
+                base_client.connected_clients.remove(self)
             except ValueError:  # pragma: no cover
                 pass
             self._reset()
@@ -556,7 +555,7 @@ def _read_loop_websocket(self):
         if self.state == 'connected':
             self._trigger_event('disconnect', run_async=False)
             try:
-                connected_clients.remove(self)
+                base_client.connected_clients.remove(self)
             except ValueError:  # pragma: no cover
                 pass
             self._reset()

tests/common/test_client.py

@@ -7,6 +7,7 @@
 import pytest
 import websocket
 
+from engineio import base_client
 from engineio import client
 from engineio import exceptions
 from engineio import json
@@ -197,7 +198,7 @@ def test_disconnect_not_connected(self):
 
     def test_disconnect_polling(self):
         c = client.Client()
-        client.connected_clients.append(c)
+        base_client.connected_clients.append(c)
         c.state = 'connected'
         c.current_transport = 'polling'
         c.queue = mock.MagicMock()
@@ -207,12 +208,12 @@ def test_disconnect_polling(self):
         c.disconnect()
         c.read_loop_task.join.assert_called_once_with()
         c.ws.mock.assert_not_called()
-        assert c not in client.connected_clients
+        assert c not in base_client.connected_clients
         c._trigger_event.assert_called_once_with('disconnect', run_async=False)
 
     def test_disconnect_websocket(self):
         c = client.Client()
-        client.connected_clients.append(c)
+        base_client.connected_clients.append(c)
         c.state = 'connected'
         c.current_transport = 'websocket'
         c.queue = mock.MagicMock()
@@ -222,12 +223,12 @@ def test_disconnect_websocket(self):
         c.disconnect()
         c.read_loop_task.join.assert_called_once_with()
         c.ws.close.assert_called_once_with()
-        assert c not in client.connected_clients
+        assert c not in base_client.connected_clients
         c._trigger_event.assert_called_once_with('disconnect', run_async=False)
 
     def test_disconnect_polling_abort(self):
         c = client.Client()
-        client.connected_clients.append(c)
+        base_client.connected_clients.append(c)
         c.state = 'connected'
         c.current_transport = 'polling'
         c.queue = mock.MagicMock()
@@ -237,11 +238,11 @@ def test_disconnect_polling_abort(self):
         c.queue.join.assert_not_called()
         c.read_loop_task.join.assert_not_called()
         c.ws.mock.assert_not_called()
-        assert c not in client.connected_clients
+        assert c not in base_client.connected_clients
 
     def test_disconnect_websocket_abort(self):
         c = client.Client()
-        client.connected_clients.append(c)
+        base_client.connected_clients.append(c)
         c.state = 'connected'
         c.current_transport = 'websocket'
         c.queue = mock.MagicMock()
@@ -251,7 +252,7 @@ def test_disconnect_websocket_abort(self):
         c.queue.join.assert_not_called()
         c.read_loop_task.join.assert_not_called()
         c.ws.mock.assert_not_called()
-        assert c not in client.connected_clients
+        assert c not in base_client.connected_clients
 
     def test_current_transport(self):
         c = client.Client()
@@ -388,7 +389,7 @@ def test_polling_connection_successful(self, _send_request):
         c._read_loop_websocket.assert_not_called()
         c._write_loop.assert_called_once_with()
         on_connect.assert_called_once_with()
-        assert c in client.connected_clients
+        assert c in base_client.connected_clients
         assert (
             c.base_url
             == 'http://foo/engine.io/?transport=polling&EIO=4&sid=123'
@@ -428,7 +429,7 @@ def test_polling_https_noverify_connection_successful(self, _send_request):
         c._read_loop_websocket.assert_not_called()
         c._write_loop.assert_called_once_with()
         on_connect.assert_called_once_with()
-        assert c in client.connected_clients
+        assert c in base_client.connected_clients
         assert (
             c.base_url
             == 'https://foo/engine.io/?transport=polling&EIO=4&sid=123'
@@ -497,7 +498,7 @@ def test_polling_connection_upgraded(self, _send_request):
             'http://foo', {}, 'engine.io'
         )
         on_connect.assert_called_once_with()
-        assert c in client.connected_clients
+        assert c in base_client.connected_clients
         assert (
             c.base_url
             == 'http://foo/engine.io/?transport=polling&EIO=4&sid=123'
@@ -540,7 +541,7 @@ def test_polling_connection_not_upgraded(self, _send_request):
         c._read_loop_websocket.assert_not_called()
         c._write_loop.assert_called_once_with()
         on_connect.assert_called_once_with()
-        assert c in client.connected_clients
+        assert c in base_client.connected_clients
 
     @mock.patch('engineio.client.time.time', return_value=123.456)
     @mock.patch(
@@ -654,7 +655,7 @@ def test_websocket_connection_successful(self, create_connection):
         c._read_loop_websocket.assert_called_once_with()
         c._write_loop.assert_called_once_with()
         on_connect.assert_called_once_with()
-        assert c in client.connected_clients
+        assert c in base_client.connected_clients
         assert c.base_url == 'ws://foo/engine.io/?transport=websocket&EIO=4'
         assert c.sid == '123'
         assert c.ping_interval == 1
@@ -696,7 +697,7 @@ def test_websocket_https_noverify_connection_successful(
         c._read_loop_websocket.assert_called_once_with()
         c._write_loop.assert_called_once_with()
         on_connect.assert_called_once_with()
-        assert c in client.connected_clients
+        assert c in base_client.connected_clients
         assert c.base_url == 'wss://foo/engine.io/?transport=websocket&EIO=4'
         assert c.sid == '123'
         assert c.ping_interval == 1
@@ -1152,7 +1153,7 @@ def test_websocket_upgrade_successful(self, create_connection):
         c._read_loop_websocket.assert_called_once_with()
         c._write_loop.assert_called_once_with()
         on_connect.assert_not_called()  # was called by polling
-        assert c not in client.connected_clients  # was added by polling
+        assert c not in base_client.connected_clients  # was added by polling
         assert c.base_url == 'http://foo'  # not changed
         assert c.sid == '123'  # not changed
         assert c.transport() == 'websocket'
@@ -1717,9 +1718,9 @@ def test_write_loop_websocket_bad_connection(self):
     @mock.patch('engineio.client.original_signal_handler')
     def test_signal_handler(self, original_handler):
         clients = [mock.MagicMock(), mock.MagicMock()]
-        client.connected_clients = clients[:]
-        client.connected_clients[0].is_asyncio_based.return_value = False
-        client.connected_clients[1].is_asyncio_based.return_value = True
+        base_client.connected_clients = clients[:]
+        base_client.connected_clients[0].is_asyncio_based.return_value = False
+        base_client.connected_clients[1].is_asyncio_based.return_value = True
         client.signal_handler('sig', 'frame')
         clients[0].disconnect.assert_called_once_with()
         clients[1].disconnect.assert_not_called()