python-engineio 4.13.1__tar.gz → 4.13.3__tar.gz

{python_engineio-4.13.1/src/python_engineio.egg-info → python_engineio-4.13.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-engineio
-Version: 4.13.1
+Version: 4.13.3
 Summary: Engine.IO server and client for Python
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 License: MIT

{python_engineio-4.13.1 → python_engineio-4.13.3}/pyproject.toml

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

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/async_client.py

@@ -571,7 +571,7 @@ class AsyncClient(base_client.BaseClient):
 
     async def _read_loop_websocket(self):
         """Read packets from the Engine.IO WebSocket connection."""
-        while self.state == 'connected':
+        while self.state == 'connected' and self.write_loop_task:
             p = None
             try:
                 p = await asyncio.wait_for(
@@ -672,7 +672,6 @@ 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)
-                    self.write_loop_task = None
                     break
             else:
                 # websocket
@@ -690,3 +689,4 @@ class AsyncClient(base_client.BaseClient):
                         'aborting')
                     break
         self.logger.info('Exiting write loop task')
+        self.write_loop_task = None

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/async_drivers/aiohttp.py

@@ -79,11 +79,13 @@ class WebSocket:  # pragma: no cover
     """
     def __init__(self, handler, server):
         self.handler = handler
+        self.server = server
         self._sock = None
 
     async def __call__(self, environ):
         request = environ['aiohttp.request']
-        self._sock = WebSocketResponse(max_msg_size=0)
+        self._sock = WebSocketResponse(
+            max_msg_size=self.server.max_http_buffer_size)
         await self._sock.prepare(request)
 
         self.environ = environ

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/async_drivers/asgi.py

@@ -136,10 +136,18 @@ class ASGIApp:
 
 async def translate_request(scope, receive, send):
     class AwaitablePayload:  # pragma: no cover
-        def __init__(self, payload):
-            self.payload = payload or b''
+        def __init__(self, event):
+            self.event = event
+            self.payload = None
 
         async def read(self, length=None):
+            if self.payload is None and event['type'] == 'http.request':
+                # read payload from http request
+                self.payload = self.event.get('body') or b''
+                while self.event.get('more_body'):
+                    self.event = await receive()
+                    if self.event['type'] == 'http.request':
+                        self.payload += self.event.get('body') or b''
             if length is None:
                 r = self.payload
                 self.payload = b''
@@ -149,16 +157,7 @@ async def translate_request(scope, receive, send):
             return r
 
     event = await receive()
-    payload = b''
-    if event['type'] == 'http.request':
-        payload += event.get('body') or b''
-        while event.get('more_body'):
-            event = await receive()
-            if event['type'] == 'http.request':
-                payload += event.get('body') or b''
-    elif event['type'] == 'websocket.connect':
-        pass
-    else:
+    if event['type'] not in ['http.request', 'websocket.connect']:
         return {}
 
     raw_uri = scope['path']
@@ -171,7 +170,7 @@ async def translate_request(scope, receive, send):
         else:
             raw_uri += '?' + query_string
     environ = {
-        'wsgi.input': AwaitablePayload(payload),
+        'wsgi.input': AwaitablePayload(event),
         'wsgi.errors': sys.stderr,
         'wsgi.version': (1, 0),
         'wsgi.async': True,

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/async_server.py

@@ -462,7 +462,6 @@ class AsyncServer(base_server.BaseServer):
             'maxPayload': self.max_http_buffer_size,
         })
         await s.send(pkt)
-        s.schedule_ping()
 
         ret = await self._trigger_event('connect', sid, environ,
                                         run_async=False)
@@ -471,6 +470,8 @@ class AsyncServer(base_server.BaseServer):
             self.logger.warning('Application rejected connection')
             return self._unauthorized(ret or None)
 
+        s.schedule_ping()
+
         if transport == 'websocket':
             ret = await s.handle_get_request(environ)
             if s.closed and sid in self.sockets:

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/async_socket.py

@@ -128,10 +128,12 @@ class AsyncSocket(base_socket.BaseSocket):
                 await self.queue.join()
 
     def schedule_ping(self):
-        self.server.start_background_task(self._send_ping)
+        # only schedule a new ping if the previous ping wait cycle completed
+        if self.last_ping:
+            self.last_ping = None
+            self.server.start_background_task(self._send_ping)
 
     async def _send_ping(self):
-        self.last_ping = None
         await asyncio.sleep(self.server.ping_interval)
         if not self.closing and not self.closed:
             self.last_ping = time.time()

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/base_socket.py

@@ -1,3 +1,6 @@
+import time
+
+
 class BaseSocket:
     upgrade_protocols = ['websocket']
 
@@ -5,7 +8,7 @@ class BaseSocket:
         self.server = server
         self.sid = sid
         self.queue = self.server.create_queue()
-        self.last_ping = None
+        self.last_ping = time.time()
         self.connected = False
         self.upgrading = False
         self.upgraded = False

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/client.py

@@ -521,7 +521,7 @@ class Client(base_client.BaseClient):
 
     def _read_loop_websocket(self):
         """Read packets from the Engine.IO WebSocket connection."""
-        while self.state == 'connected':
+        while self.state == 'connected' and self.write_loop_task:
             p = None
             try:
                 p = self.ws.recv()
@@ -616,7 +616,6 @@ 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.write_loop_task = None
                     break
             else:
                 # websocket
@@ -634,3 +633,4 @@ class Client(base_client.BaseClient):
                         'WebSocket connection was closed, aborting')
                     break
         self.logger.info('Exiting write loop task')
+        self.write_loop_task = None

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/server.py

@@ -401,7 +401,6 @@ class Server(base_server.BaseServer):
             'maxPayload': self.max_http_buffer_size,
         })
         s.send(pkt)
-        s.schedule_ping()
 
         # NOTE: some sections below are marked as "no cover" to workaround
         # what seems to be a bug in the coverage package. All the lines below
@@ -413,6 +412,8 @@ class Server(base_server.BaseServer):
             self.logger.warning('Application rejected connection')
             return self._unauthorized(ret or None)
 
+        s.schedule_ping()
+
         if transport == 'websocket':  # pragma: no cover
             ret = s.handle_get_request(environ, start_response)
             if s.closed and sid in self.sockets:

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/engineio/socket.py

@@ -130,10 +130,12 @@ class Socket(base_socket.BaseSocket):
                 self.queue.join()
 
     def schedule_ping(self):
-        self.server.start_background_task(self._send_ping)
+        # only schedule a new ping if the previous ping wait cycle completed
+        if self.last_ping:
+            self.last_ping = None
+            self.server.start_background_task(self._send_ping)
 
     def _send_ping(self):
-        self.last_ping = None
         self.server.sleep(self.server.ping_interval)
         if not self.closing and not self.closed:
             self.last_ping = time.time()

{python_engineio-4.13.1 → python_engineio-4.13.3/src/python_engineio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-engineio
-Version: 4.13.1
+Version: 4.13.3
 Summary: Engine.IO server and client for Python
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 License: MIT

{python_engineio-4.13.1 → python_engineio-4.13.3}/src/python_engineio.egg-info/SOURCES.txt

@@ -3,14 +3,6 @@ MANIFEST.in
 README.md
 pyproject.toml
 tox.ini
-docs/Makefile
-docs/api.rst
-docs/client.rst
-docs/conf.py
-docs/index.rst
-docs/intro.rst
-docs/make.bat
-docs/server.rst
 docs/_static/README.md
 src/engineio/__init__.py
 src/engineio/async_client.py
@@ -44,7 +36,6 @@ src/python_engineio.egg-info/dependency_links.txt
 src/python_engineio.egg-info/not-zip-safe
 src/python_engineio.egg-info/requires.txt
 src/python_engineio.egg-info/top_level.txt
-tests/__init__.py
 tests/async/__init__.py
 tests/async/index.html
 tests/async/test_aiohttp.py

{python_engineio-4.13.1 → python_engineio-4.13.3}/tests/async/test_socket.py

@@ -95,14 +95,30 @@ class TestSocket:
         s = async_socket.AsyncSocket(mock_server, 'sid')
         s.send = mock.AsyncMock()
 
-        async def schedule_ping():
+        async def schedule_ping_and_sleep():
             s.schedule_ping()
             await asyncio.sleep(0.05)
 
-        await schedule_ping()
+        await schedule_ping_and_sleep()
         assert s.last_ping is not None
         assert s.send.await_args_list[0][0][0].encode() == '2'
 
+    async def test_schedule_ping_twice(self):
+        mock_server = self._get_mock_server()
+        mock_server.ping_interval = 0.1
+        s = async_socket.AsyncSocket(mock_server, 'sid')
+        s.send = mock.AsyncMock()
+
+        async def schedule_ping_and_sleep():
+            s.schedule_ping()
+            await asyncio.sleep(0.2)
+
+        s.schedule_ping()
+        assert s.last_ping is None
+        await schedule_ping_and_sleep()
+        assert s.last_ping is not None
+        assert s.send.await_count == 1
+
     async def test_schedule_ping_closed_socket(self):
         mock_server = self._get_mock_server()
         mock_server.ping_interval = 0.01

{python_engineio-4.13.1 → python_engineio-4.13.3}/tests/common/test_socket.py

@@ -21,6 +21,7 @@ class TestSocket:
         mock_server.ping_interval_grace_period = 0.001
         mock_server.async_handlers = True
         mock_server.max_http_buffer_size = 128
+        mock_server.sleep = time.sleep
 
         try:
             import queue
@@ -100,10 +101,26 @@ class TestSocket:
         s = socket.Socket(mock_server, 'sid')
         s.send = mock.MagicMock()
         s.schedule_ping()
-        time.sleep(0.05)
+        for _ in range(10):
+            time.sleep(0.05)
+            if s.last_ping is not None:
+                break
         assert s.last_ping is not None
         assert s.send.call_args_list[0][0][0].encode() == '2'
 
+    def test_schedule_ping_twice(self):
+        mock_server = self._get_mock_server()
+        mock_server.ping_interval = 0.1
+        s = socket.Socket(mock_server, 'sid')
+        s.send = mock.MagicMock()
+        s.schedule_ping()
+        assert s.last_ping is None
+        time.sleep(0.01)
+        s.schedule_ping()
+        time.sleep(0.2)
+        assert s.last_ping is not None
+        assert s.send.call_count == 1
+
     def test_schedule_ping_closed_socket(self):
         mock_server = self._get_mock_server()
         mock_server.ping_interval = 0.01

{python_engineio-4.13.1 → python_engineio-4.13.3}/tox.ini

@@ -1,16 +1,3 @@
-[tox]
-envlist=flake8,py310,py311,py312,py313,py314,pypy3,docs
-skip_missing_interpreters=True
-
-[gh-actions]
-python =
-    3.10: py310
-    3.11: py311
-    3.12: py312
-    3.13: py313
-    3.14: py314
-    pypy-3: pypy3
-
 [testenv]
 commands=
     pip install -e .
@@ -24,8 +11,6 @@ deps=
     requests
     websocket-client
 
-[testenv:pypy3]
-
 [testenv:flake8]
 deps=
     flake8

python_engineio-4.13.1/docs/Makefile

@@ -1,19 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

python_engineio-4.13.1/docs/api.rst

@@ -1,14 +0,0 @@
-API Reference
-=============
-
-.. toctree::
-   :maxdepth: 2
-
-   api_client
-   api_async_client
-   api_server
-   api_async_server
-   api_wsgiapp
-   api_asgiapp
-   api_middleware
-

python_engineio-4.13.1/docs/client.rst

@@ -1,211 +0,0 @@
-The Engine.IO Client
-====================
-
-This package contains two Engine.IO clients:
-
-- The :func:`engineio.Client` class creates a client compatible with the
-  standard Python library.
-- The :func:`engineio.AsyncClient` class creates a client compatible with
-  the ``asyncio`` package.
-
-The methods in the two clients are the same, with the only difference that in
-the ``asyncio`` client most methods are implemented as coroutines.
-
-Installation
-------------
-
-To install the standard Python client along with its dependencies, use the
-following command::
-
-    pip install "python-engineio[client]"
-
-If instead you plan on using the ``asyncio`` client, then use this::
-
-    pip install "python-engineio[asyncio_client]"
-
-Creating a Client Instance
---------------------------
-
-To instantiate an Engine.IO client, simply create an instance of the
-appropriate client class::
-
-    import engineio
-
-    # standard Python
-    eio = engineio.Client()
-
-    # asyncio
-    eio = engineio.AsyncClient()
-
-Defining Event Handlers
------------------------
-
-To responds to events triggered by the connection or the server, event Handler
-functions must be defined using the ``on`` decorator::
-
-    @eio.on('connect')
-    def on_connect():
-        print('I'm connected!')
-
-    @eio.on('message')
-    def on_message(data):
-        print('I received a message!')
-
-    @eio.on('disconnect')
-    def on_disconnect(reason):
-        print('I'm disconnected! reason:', reason)
-
-For the ``asyncio`` server, event handlers can be regular functions as above,
-or can also be coroutines::
-
-    @eio.on('message')
-    async def on_message(data):
-        print('I received a message!')
-
-The argument given to the ``on`` decorator is the event name. The events that
-are supported are ``connect``, ``message`` and ``disconnect``.
-
-The ``data`` argument passed to the ``'message'`` event handler contains
-application-specific data provided by the server with the event.
-
-The ``disconnect`` handler is invoked for client initiated disconnects, server
-initiated disconnects, or accidental disconnects, for example due to
-networking failures. The argument passed to this handler provides the
-disconnect reason. Example::
-
-    @eio.on('disconnect')
-    def on_disconnect(reason):
-        if reason == eio.reason.CLIENT_DISCONNECT:
-            print('client disconnection')
-        elif reason == eio.reason.SERVER_DISCONNECT:
-            print('the server kicked me out')
-        else:
-            print(f'disconnect reason: {reason}')
-
-Connecting to a Server
-----------------------
-
-The connection to a server is established by calling the ``connect()``
-method::
-
-    eio.connect('http://localhost:5000')
-
-In the case of the ``asyncio`` client, the method is a coroutine::
-
-    await eio.connect('http://localhost:5000')
-
-Upon connection, the server assigns the client a unique session identifier.
-The applicaction can find this identifier in the ``sid`` attribute::
-
-    print('my sid is', eio.sid)
-
-Sending Messages
-----------------
-
-The client can send a message to the server using the ``send()`` method::
-
-    eio.send({'foo': 'bar'})
-
-Or in the case of ``asyncio``, as a coroutine::
-
-    await eio.send({'foo': 'bar'})
-
-The single argument provided to the method is the data that is passed on
-to the server. The data can be of type ``str``, ``bytes``, ``dict`` or
-``list``. The data included inside dictionaries and lists is also
-constrained to these types.
-
-The ``send()`` method can be invoked inside an event handler as a response
-to a server event, or in any other part of the application, including in
-background tasks.
-
-Disconnecting from the Server
------------------------------
-
-At any time the client can request to be disconnected from the server by
-invoking the ``disconnect()`` method::
-
-    eio.disconnect()
-
-For the ``asyncio`` client this is a coroutine::
-
-    await eio.disconnect()
-
-Managing Background Tasks
--------------------------
-
-When a client connection to the server is established, a few background
-tasks will be spawned to keep the connection alive and handle incoming
-events. The application running on the main thread is free to do any
-work, as this is not going to prevent the functioning of the Engine.IO
-client.
-
-If the application does not have anything to do in the main thread and
-just wants to wait until the connection ends, it can call the ``wait()``
-method::
-
-    eio.wait()
-
-Or in the ``asyncio`` version::
-
-    await eio.wait()
-
-For the convenience of the application, a helper function is
-provided to start a custom background task::
-
-    def my_background_task(my_argument)
-        # do some background work here!
-        pass
-
-    eio.start_background_task(my_background_task, 123)
-
-The arguments passed to this method are the background function and any
-positional or keyword arguments to invoke the function with. 
-
-Here is the ``asyncio`` version::
-
-    async def my_background_task(my_argument)
-        # do some background work here!
-        pass
-
-    eio.start_background_task(my_background_task, 123)
-
-Note that this function is not a coroutine, since it does not wait for the
-background function to end, but the background function is.
-
-The ``sleep()`` method is a second convenience function that is provided for
-the benefit of applications working with background tasks of their own::
-
-    eio.sleep(2)
-
-Or for ``asyncio``::
-
-    await eio.sleep(2)
-
-The single argument passed to the method is the number of seconds to sleep
-for.
-
-Debugging and Troubleshooting
------------------------------
-
-To help you debug issues, the client can be configured to output logs to the
-terminal::
-
-    import engineio
-
-    # standard Python
-    eio = engineio.Client(logger=True)
-
-    # asyncio
-    eio = engineio.AsyncClient(logger=True)
-
-The ``logger`` argument controls logging behavior:
-
-* ``True``: Enables log output to ``stderr`` at the ``INFO`` level.
-* ``False``: Enables log output to ``stderr`` at the ``ERROR`` level. This is
-  the default.
-* A ``logging.Logger`` instance: Uses the provided logger without additional
-  configuration.
-
-Logging can help identify the cause of connection problems, unexpected
-disconnections and other issues.