python-engineio 4.8.2__tar.gz → 4.9.1__tar.gz

{python-engineio-4.8.2/src/python_engineio.egg-info → python_engineio-4.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-engineio
-Version: 4.8.2
+Version: 4.9.1
 Summary: Engine.IO server and client for Python
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 Project-URL: Homepage, https://github.com/miguelgrinberg/python-engineio

{python-engineio-4.8.2 → python_engineio-4.9.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-engineio"
-version = "4.8.2"
+version = "4.9.1"
 authors = [{name = "Miguel Grinberg", email = "miguel.grinberg@gmail.com"}]
 description = "Engine.IO server and client for Python"
 classifiers = [

{python-engineio-4.8.2 → python_engineio-4.9.1}/src/engineio/async_client.py

@@ -493,7 +493,7 @@ class AsyncClient(base_client.BaseClient):
 
     async def _read_loop_polling(self):
         """Read packets by polling the Engine.IO server."""
-        while self.state == 'connected':
+        while self.state == 'connected' and self.write_loop_task:
             self.logger.info(
                 'Sending polling GET request to ' + self.base_url)
             r = await self._send_request(
@@ -520,8 +520,9 @@ class AsyncClient(base_client.BaseClient):
             for pkt in p.packets:
                 await self._receive_packet(pkt)
 
-        self.logger.info('Waiting for write loop task to end')
-        await self.write_loop_task
+        if self.write_loop_task:  # pragma: no branch
+            self.logger.info('Waiting for write loop task to end')
+            await self.write_loop_task
         if self.state == 'connected':
             await self._trigger_event('disconnect', run_async=False)
             try:
@@ -541,8 +542,10 @@ class AsyncClient(base_client.BaseClient):
                     timeout=self.ping_interval + self.ping_timeout)
                 if not isinstance(p.data, (str, bytes)):  # pragma: no cover
                     self.logger.warning(
-                        'Server sent unexpected packet %s data %s, aborting',
-                        str(p.type), str(p.data))
+                        'Server sent %s packet data %s, aborting',
+                        'close' if p.type in [aiohttp.WSMsgType.CLOSE,
+                                              aiohttp.WSMsgType.CLOSING]
+                        else str(p.type), str(p.data))
                     await self.queue.put(None)
                     break  # the connection is broken
                 p = p.data
@@ -571,8 +574,9 @@ class AsyncClient(base_client.BaseClient):
                 break
             await self._receive_packet(pkt)
 
-        self.logger.info('Waiting for write loop task to end')
-        await self.write_loop_task
+        if self.write_loop_task:  # pragma: no branch
+            self.logger.info('Waiting for write loop task to end')
+            await self.write_loop_task
         if self.state == 'connected':
             await self._trigger_event('disconnect', run_async=False)
             try:
@@ -630,7 +634,7 @@ class AsyncClient(base_client.BaseClient):
                 if r.status < 200 or r.status >= 300:
                     self.logger.warning('Unexpected status code %s in server '
                                         'response, aborting', r.status)
-                    await self._reset()
+                    self.write_loop_task = None
                     break
             else:
                 # websocket

{python-engineio-4.8.2 → python_engineio-4.9.1}/src/engineio/async_drivers/asgi.py

@@ -19,7 +19,12 @@ class ASGIApp:
     :param other_asgi_app: A separate ASGI app that receives all other traffic.
     :param engineio_path: The endpoint where the Engine.IO application should
                           be installed. The default value is appropriate for
-                          most cases.
+                          most cases. With a value of ``None``, all incoming
+                          traffic is directed to the Engine.IO server, with the
+                          assumption that routing, if necessary, is handled by
+                          a different layer. When this option is set to
+                          ``None``, ``static_files`` and ``other_asgi_app`` are
+                          ignored.
     :param on_startup: function to be called on application startup; can be
                        coroutine
     :param on_shutdown: function to be called on application shutdown; can be
@@ -44,24 +49,26 @@ class ASGIApp:
         self.engineio_server = engineio_server
         self.other_asgi_app = other_asgi_app
         self.engineio_path = engineio_path
-        if not self.engineio_path.startswith('/'):
-            self.engineio_path = '/' + self.engineio_path
-        if not self.engineio_path.endswith('/'):
-            self.engineio_path += '/'
+        if self.engineio_path is not None:
+            if not self.engineio_path.startswith('/'):
+                self.engineio_path = '/' + self.engineio_path
+            if not self.engineio_path.endswith('/'):
+                self.engineio_path += '/'
         self.static_files = static_files or {}
         self.on_startup = on_startup
         self.on_shutdown = on_shutdown
 
     async def __call__(self, scope, receive, send):
-        if scope['type'] in ['http', 'websocket'] and \
-                scope['path'].startswith(self.engineio_path):
+        if scope['type'] == 'lifespan':
+            await self.lifespan(scope, receive, send)
+        elif scope['type'] in ['http', 'websocket'] and (
+                self.engineio_path is None
+                or scope['path'].startswith(self.engineio_path)):
             await self.engineio_server.handle_request(scope, receive, send)
         else:
             static_file = get_static_file(scope['path'], self.static_files) \
                 if scope['type'] == 'http' and self.static_files else None
-            if scope['type'] == 'lifespan':
-                await self.lifespan(scope, receive, send)
-            elif static_file and os.path.exists(static_file['filename']):
+            if static_file and os.path.exists(static_file['filename']):
                 await self.serve_static_file(static_file, receive, send)
             elif self.other_asgi_app is not None:
                 await self.other_asgi_app(scope, receive, send)

{python-engineio-4.8.2 → python_engineio-4.9.1}/src/engineio/async_server.py

@@ -524,9 +524,9 @@ class AsyncServer(base_server.BaseServer):
                 try:
                     await asyncio.wait_for(self.service_task_event.wait(),
                                            timeout=self.ping_timeout)
-                except asyncio.TimeoutError:
                     break
-                continue
+                except asyncio.TimeoutError:
+                    continue
 
             # go through the entire client list in a ping interval cycle
             sleep_interval = self.ping_timeout / len(self.sockets)
@@ -546,8 +546,9 @@ class AsyncServer(base_server.BaseServer):
                     try:
                         await asyncio.wait_for(self.service_task_event.wait(),
                                                timeout=sleep_interval)
-                    except asyncio.TimeoutError:
                         raise KeyboardInterrupt()
+                    except asyncio.TimeoutError:
+                        continue
             except (
                 SystemExit,
                 KeyboardInterrupt,

{python-engineio-4.8.2 → python_engineio-4.9.1}/src/engineio/client.py

@@ -450,7 +450,7 @@ class Client(base_client.BaseClient):
 
     def _read_loop_polling(self):
         """Read packets by polling the Engine.IO server."""
-        while self.state == 'connected':
+        while self.state == 'connected' and self.write_loop_task:
             self.logger.info(
                 'Sending polling GET request to ' + self.base_url)
             r = self._send_request(
@@ -476,8 +476,9 @@ class Client(base_client.BaseClient):
             for pkt in p.packets:
                 self._receive_packet(pkt)
 
-        self.logger.info('Waiting for write loop task to end')
-        self.write_loop_task.join()
+        if self.write_loop_task:  # pragma: no branch
+            self.logger.info('Waiting for write loop task to end')
+            self.write_loop_task.join()
         if self.state == 'connected':
             self._trigger_event('disconnect', run_async=False)
             try:
@@ -493,6 +494,9 @@ class Client(base_client.BaseClient):
             p = None
             try:
                 p = self.ws.recv()
+                if len(p) == 0 and not self.ws.connected:  # pragma: no cover
+                    # websocket client can return an empty string after close
+                    raise websocket.WebSocketConnectionClosedException()
             except websocket.WebSocketTimeoutException:
                 self.logger.warning(
                     'Server has stopped communicating, aborting')
@@ -503,10 +507,15 @@ class Client(base_client.BaseClient):
                     'WebSocket connection was closed, aborting')
                 self.queue.put(None)
                 break
-            except Exception as e:
-                self.logger.info(
-                    'Unexpected error receiving packet: "%s", aborting',
-                    str(e))
+            except Exception as e:  # pragma: no cover
+                if type(e) is OSError and e.errno == 9:
+                    self.logger.info(
+                        'WebSocket connection is closing, aborting',
+                        str(e))
+                else:
+                    self.logger.info(
+                        'Unexpected error receiving packet: "%s", aborting',
+                        str(e))
                 self.queue.put(None)
                 break
             try:
@@ -518,8 +527,9 @@ class Client(base_client.BaseClient):
                 break
             self._receive_packet(pkt)
 
-        self.logger.info('Waiting for write loop task to end')
-        self.write_loop_task.join()
+        if self.write_loop_task:  # pragma: no branch
+            self.logger.info('Waiting for write loop task to end')
+            self.write_loop_task.join()
         if self.state == 'connected':
             self._trigger_event('disconnect', run_async=False)
             try:
@@ -575,7 +585,7 @@ class Client(base_client.BaseClient):
                 if r.status_code < 200 or r.status_code >= 300:
                     self.logger.warning('Unexpected status code %s in server '
                                         'response, aborting', r.status_code)
-                    self._reset()
+                    self.write_loop_task = None
                     break
             else:
                 # websocket

{python-engineio-4.8.2 → python_engineio-4.9.1/src/python_engineio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-engineio
-Version: 4.8.2
+Version: 4.9.1
 Summary: Engine.IO server and client for Python
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 Project-URL: Homepage, https://github.com/miguelgrinberg/python-engineio

{python-engineio-4.8.2 → python_engineio-4.9.1}/tests/async/test_asgi.py

@@ -514,3 +514,30 @@ class AsgiTests(unittest.TestCase):
         environ['asgi.send'].mock.assert_called_with(
             {'type': 'websocket.close'}
         )
+
+    def test_sub_app_routing(self):
+
+        class ASGIDispatcher:
+            def __init__(self, routes):
+                self.routes = routes
+
+            async def __call__(self, scope, receive, send):
+                path = scope['path']
+                for prefix, app in self.routes.items():
+                    if path.startswith(prefix):
+                        await app(scope, receive, send)
+                        return
+                assert False, 'No route found'
+
+        other_app = AsyncMock()
+        mock_server = mock.MagicMock()
+        mock_server.handle_request = AsyncMock()
+        eio_app = async_asgi.ASGIApp(mock_server, engineio_path=None)
+        root_app = ASGIDispatcher({'/foo': other_app, '/eio': eio_app})
+        scope = {'type': 'http', 'path': '/foo/bar'}
+        _run(root_app(scope, 'receive', 'send'))
+        other_app.mock.assert_called_once_with(scope, 'receive', 'send')
+        scope = {'type': 'http', 'path': '/eio/'}
+        _run(root_app(scope, 'receive', 'send'))
+        eio_app.engineio_server.handle_request.mock.assert_called_once_with(
+            scope, 'receive', 'send')

{python-engineio-4.8.2 → python_engineio-4.9.1}/tests/async/test_client.py

@@ -1378,7 +1378,8 @@ class TestAsyncClient(unittest.TestCase):
             headers={'Content-Type': 'text/plain'},
             timeout=5,
         )
-        assert c.state == 'disconnected'
+        assert c.state == 'connected'
+        assert c.write_loop_task is None
 
     def test_write_loop_websocket_one_packet(self):
         c = async_client.AsyncClient()

{python-engineio-4.8.2 → python_engineio-4.9.1}/tests/common/test_client.py

@@ -1631,7 +1631,8 @@ class TestClient(unittest.TestCase):
             headers={'Content-Type': 'text/plain'},
             timeout=5,
         )
-        assert c.state == 'disconnected'
+        assert c.state == 'connected'
+        assert c.write_loop_task is None
 
     def test_write_loop_websocket_one_packet(self):
         c = client.Client()