python-socketio 5.16.0__tar.gz → 5.16.2__tar.gz

{python_socketio-5.16.0/src/python_socketio.egg-info → python_socketio-5.16.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-socketio
-Version: 5.16.0
+Version: 5.16.2
 Summary: Socket.IO server and client for Python
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 License: MIT
@@ -14,7 +14,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bidict>=0.21.0
-Requires-Dist: python-engineio>=4.11.0
+Requires-Dist: python-engineio>=4.13.2
 Provides-Extra: client
 Requires-Dist: requests>=2.21.0; extra == "client"
 Requires-Dist: websocket-client>=0.54.0; extra == "client"
@@ -24,6 +24,7 @@ Provides-Extra: dev
 Requires-Dist: tox; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
 Dynamic: license-file
 
 python-socketio

python_socketio-5.16.2/docs/api.rst

@@ -0,0 +1,12 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   api_simpleclient
+   api_client
+   api_server
+   api_middleware
+   api_namespace
+   api_manager

python_socketio-5.16.2/docs/api_client.rst

@@ -0,0 +1,11 @@
+Clients
+-------
+
+.. autoclass:: socketio.Client
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncClient
+   :members:
+   :inherited-members:
+

python_socketio-5.16.2/docs/api_manager.rst

@@ -0,0 +1,39 @@
+Managers
+--------
+
+.. autoclass:: socketio.Manager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.PubSubManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.KombuManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.RedisManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.KafkaManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.ZmqManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncRedisManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncAioPikaManager
+   :members:
+   :inherited-members:
+

python_socketio-5.16.2/docs/api_middleware.rst

@@ -0,0 +1,12 @@
+Middlewares
+-----------
+
+.. autoclass:: socketio.WSGIApp
+   :members:
+
+.. autoclass:: socketio.ASGIApp
+   :members:
+
+.. autoclass:: socketio.Middleware
+   :members:
+

python_socketio-5.16.2/docs/api_namespace.rst

@@ -0,0 +1,19 @@
+Namespaces
+----------
+
+.. autoclass:: socketio.ClientNamespace
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.Namespace
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncClientNamespace
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncNamespace
+   :members:
+   :inherited-members:
+

python_socketio-5.16.2/docs/api_server.rst

@@ -0,0 +1,14 @@
+Servers
+-------
+
+.. autoclass:: socketio.Server
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncServer
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.exceptions.ConnectionRefusedError
+   :members:
+

python_socketio-5.16.2/docs/api_simpleclient.rst

@@ -0,0 +1,11 @@
+Simple Clients
+--------------
+
+.. autoclass:: socketio.SimpleClient
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncSimpleClient
+   :members:
+   :inherited-members:
+

{python_socketio-5.16.0 → python_socketio-5.16.2}/docs/client.rst

@@ -280,7 +280,7 @@ remaining arguments are the same as for a regular event handler.
 The ``connect`` and ``disconnect`` events have to be defined explicitly and are
 not invoked on a catch-all event handler.
 
-Similarily, a "catch-all" namespace handler is invoked for any connected
+Similarly, a "catch-all" namespace handler is invoked for any connected
 namespaces that do not have an explicitly defined event handler. As with
 catch-all events, ``'*'`` is used in place of a namespace::
 

{python_socketio-5.16.0 → python_socketio-5.16.2}/docs/conf.py

@@ -77,20 +77,14 @@ pygments_style = None
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'furo'
+html_title = 'python-socketio'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 html_theme_options = {
-    'github_user': 'miguelgrinberg',
-    'github_repo': 'python-socketio',
-    'github_banner': True,
-    'github_button': True,
-    'github_type': 'star',
-    'fixed_sidebar': True,
-
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

{python_socketio-5.16.0 → python_socketio-5.16.2}/docs/index.rst

@@ -10,7 +10,7 @@ This projects implements Socket.IO clients and servers that can run standalone
 or integrated with a variety of Python web frameworks.
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    intro
    client

{python_socketio-5.16.0 → python_socketio-5.16.2}/docs/server.rst

@@ -492,7 +492,7 @@ information.
 Catch-All Namespaces
 ~~~~~~~~~~~~~~~~~~~~
 
-Similarily to catch-all event handlers, a "catch-all" namespace can be used
+Similarly to catch-all event handlers, a "catch-all" namespace can be used
 when defining event handlers for any connected namespaces that do not have an
 explicitly defined event handler. As with catch-all events, ``'*'`` is used in
 place of a namespace::

{python_socketio-5.16.0 → python_socketio-5.16.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-socketio"
-version = "5.16.0"
+version = "5.16.2"
 license = {text = "MIT"}
 authors = [
     { name = "Miguel Grinberg", email = "miguel.grinberg@gmail.com" },
@@ -15,7 +15,7 @@ classifiers = [
 requires-python = ">=3.8"
 dependencies = [
     "bidict >= 0.21.0",
-    "python-engineio >= 4.11.0",
+    "python-engineio >= 4.13.2",
 ]
 
 [project.readme]
@@ -39,6 +39,7 @@ dev = [
 ]
 docs = [
     "sphinx",
+    "furo",
 ]
 
 [tool.setuptools]

{python_socketio-5.16.0 → python_socketio-5.16.2/src/python_socketio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-socketio
-Version: 5.16.0
+Version: 5.16.2
 Summary: Socket.IO server and client for Python
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 License: MIT
@@ -14,7 +14,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bidict>=0.21.0
-Requires-Dist: python-engineio>=4.11.0
+Requires-Dist: python-engineio>=4.13.2
 Provides-Extra: client
 Requires-Dist: requests>=2.21.0; extra == "client"
 Requires-Dist: websocket-client>=0.54.0; extra == "client"
@@ -24,6 +24,7 @@ Provides-Extra: dev
 Requires-Dist: tox; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
 Dynamic: license-file
 
 python-socketio

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/python_socketio.egg-info/SOURCES.txt

@@ -5,6 +5,12 @@ pyproject.toml
 tox.ini
 docs/Makefile
 docs/api.rst
+docs/api_client.rst
+docs/api_manager.rst
+docs/api_middleware.rst
+docs/api_namespace.rst
+docs/api_server.rst
+docs/api_simpleclient.rst
 docs/client.rst
 docs/conf.py
 docs/index.rst

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/python_socketio.egg-info/requires.txt

@@ -1,5 +1,5 @@
 bidict>=0.21.0
-python-engineio>=4.11.0
+python-engineio>=4.13.2
 
 [asyncio_client]
 aiohttp>=3.4
@@ -13,3 +13,4 @@ tox
 
 [docs]
 sphinx
+furo

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/admin.py

@@ -194,6 +194,8 @@ class InstrumentedServer:
         if self.stats_task:  # pragma: no branch
             self.stop_stats_event.set()
             self.stats_task.join()
+            self.stop_stats_event.clear()
+            self.stats_task = None
 
     def _trigger_event(self, event, namespace, *args):
         t = time.time()
@@ -206,6 +208,9 @@ class InstrumentedServer:
                 serialized_socket,
                 datetime.fromtimestamp(t, timezone.utc).isoformat(),
             ), namespace=self.admin_namespace)
+            if not self.sio.eio._get_socket(eio_sid).upgraded:
+                self.sio.start_background_task(
+                    self._check_for_upgrade, eio_sid, sid, namespace)
         elif event == 'disconnect':
             del self.sio.manager._timestamps[sid]
             reason = args[1]
@@ -283,6 +288,7 @@ class InstrumentedServer:
     def _handle_eio_connect(self, eio_sid, environ):
         if self.stop_stats_event is None:
             self.stop_stats_event = self.sio.eio.create_event()
+        if self.stats_task is None:
             self.stats_task = self.sio.start_background_task(
                 self._emit_server_stats)
 

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/async_admin.py

@@ -157,9 +157,6 @@ class InstrumentedAsyncServer:
                                     namespace=self.admin_namespace)
 
         self.sio.start_background_task(config, sid)
-        self.stop_stats_event = self.sio.eio.create_event()
-        self.stats_task = self.sio.start_background_task(
-            self._emit_server_stats)
 
     async def admin_emit(self, _, namespace, room_filter, event, *data):
         await self.sio.emit(event, data, to=room_filter, namespace=namespace)
@@ -183,6 +180,8 @@ class InstrumentedAsyncServer:
         if self.stats_task:  # pragma: no branch
             self.stop_stats_event.set()
             await asyncio.gather(self.stats_task)
+            self.stats_task = None
+            self.stop_stats_event.clear()
 
     async def _trigger_event(self, event, namespace, *args):
         t = time.time()
@@ -195,6 +194,9 @@ class InstrumentedAsyncServer:
                 serialized_socket,
                 datetime.fromtimestamp(t, timezone.utc).isoformat(),
             ), namespace=self.admin_namespace)
+            if not self.sio.eio._get_socket(eio_sid).upgraded:
+                self.sio.start_background_task(
+                    self._check_for_upgrade, eio_sid, sid, namespace)
         elif event == 'disconnect':
             del self.sio.manager._timestamps[sid]
             reason = args[1]
@@ -273,6 +275,7 @@ class InstrumentedAsyncServer:
     async def _handle_eio_connect(self, eio_sid, environ):
         if self.stop_stats_event is None:
             self.stop_stats_event = self.sio.eio.create_event()
+        if self.stats_task is None:
             self.stats_task = self.sio.start_background_task(
                 self._emit_server_stats)
 

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/async_aiopika_manager.py

@@ -1,6 +1,5 @@
 import asyncio
 
-from engineio import json
 from .async_pubsub_manager import AsyncPubSubManager
 
 try:
@@ -32,18 +31,29 @@ class AsyncAioPikaManager(AsyncPubSubManager):  # pragma: no cover
                     in rabbitmq
     :param write_only: If set to ``True``, only initialize to emit events. The
                        default of ``False`` initializes the class for emitting
-                       and receiving.
+                       and receiving. A write-only instance can be used
+                       independently of the server to emit to clients from an
+                       external process.
+    :param logger: a custom logger to log it. If not given, the server logger
+                   is used.
+    :param json: An alternative JSON module to use for encoding and decoding
+                 packets. Custom json modules must have ``dumps`` and ``loads``
+                 functions that are compatible with the standard library
+                 versions. This setting is only used when ``write_only`` is set
+                 to ``True``. Otherwise the JSON module configured in the
+                 server is used.
     """
 
     name = 'asyncaiopika'
 
     def __init__(self, url='amqp://guest:guest@localhost:5672//',
-                 channel='socketio', write_only=False, logger=None):
+                 channel='socketio', write_only=False, logger=None, json=None):
         if aio_pika is None:
             raise RuntimeError('aio_pika package is not installed '
                                '(Run "pip install aio_pika" in your '
                                'virtualenv).')
-        super().__init__(channel=channel, write_only=write_only, logger=logger)
+        super().__init__(channel=channel, write_only=write_only, logger=logger,
+                         json=json)
         self.url = url
         self._lock = asyncio.Lock()
         self.publisher_connection = None
@@ -82,7 +92,7 @@ class AsyncAioPikaManager(AsyncPubSubManager):  # pragma: no cover
             try:
                 await self.publisher_exchange.publish(
                     aio_pika.Message(
-                        body=json.dumps(data).encode(),
+                        body=self.json.dumps(data).encode(),
                         delivery_mode=aio_pika.DeliveryMode.PERSISTENT
                     ), routing_key='*',
                 )

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/async_client.py

@@ -37,10 +37,11 @@ class AsyncClient(base_client.BaseClient):
                    use. To disable logging set to ``False``. The default is
                    ``False``. Note that fatal errors are logged even when
                    ``logger`` is ``False``.
-    :param json: An alternative json module to use for encoding and decoding
+    :param json: An alternative JSON module to use for encoding and decoding
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library
-                 versions.
+                 versions. This is a process-wide setting, all instantiated
+                 servers and clients must use the same JSON module.
     :param handle_sigint: Set to ``True`` to automatically handle disconnection
                           when the process is interrupted, or to ``False`` to
                           leave interrupt handling to the calling application.

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/async_pubsub_manager.py

@@ -3,8 +3,6 @@ import base64
 from functools import partial
 import uuid
 
-from engineio import json
-
 from .async_manager import AsyncManager
 from .packet import Packet
 
@@ -22,15 +20,31 @@ class AsyncPubSubManager(AsyncManager):
 
     :param channel: The channel name on which the server sends and receives
                     notifications.
+    :param write_only: If set to ``True``, only initialize to emit events. The
+                       default of ``False`` initializes the class for emitting
+                       and receiving. A write-only instance can be used
+                       independently of the server to emit to clients from an
+                       external process.
+    :param logger: a custom logger to log it. If not given, the server logger
+                   is used.
+    :param json: An alternative JSON module to use for encoding and decoding
+                 packets. Custom json modules must have ``dumps`` and ``loads``
+                 functions that are compatible with the standard library
+                 versions. This setting is only used when ``write_only`` is set
+                 to ``True``. Otherwise the JSON module configured in the
+                 server is used.
     """
     name = 'asyncpubsub'
 
-    def __init__(self, channel='socketio', write_only=False, logger=None):
+    def __init__(self, channel='socketio', write_only=False, logger=None,
+                 json=None):
         super().__init__()
         self.channel = channel
         self.write_only = write_only
         self.host_id = uuid.uuid4().hex
         self.logger = logger
+        if json is not None:
+            self.json = json
 
     def initialize(self):
         super().initialize()
@@ -221,7 +235,7 @@ class AsyncPubSubManager(AsyncManager):
                         data = message
                     else:
                         try:
-                            data = json.loads(message)
+                            data = self.json.loads(message)
                         except:
                             pass
                     if data and 'method' in data:

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/async_redis_manager.py

@@ -19,7 +19,6 @@ except ImportError:  # pragma: no cover
     aiovalkey = None
     ValkeyError = None
 
-from engineio import json
 from .async_pubsub_manager import AsyncPubSubManager
 from .redis_manager import parse_redis_sentinel_url
 
@@ -47,18 +46,29 @@ class AsyncRedisManager(AsyncPubSubManager):
                     notifications. Must be the same in all the servers.
     :param write_only: If set to ``True``, only initialize to emit events. The
                        default of ``False`` initializes the class for emitting
-                       and receiving.
+                       and receiving. A write-only instance can be used
+                       independently of the server to emit to clients from an
+                       external process.
+    :param logger: a custom logger to log it. If not given, the server logger
+                   is used.
+    :param json: An alternative JSON module to use for encoding and decoding
+                 packets. Custom json modules must have ``dumps`` and ``loads``
+                 functions that are compatible with the standard library
+                 versions. This setting is only used when ``write_only`` is set
+                 to ``True``. Otherwise the JSON module configured in the
+                 server is used.
     :param redis_options: additional keyword arguments to be passed to
                           ``Redis.from_url()`` or ``Sentinel()``.
     """
     name = 'aioredis'
 
     def __init__(self, url='redis://localhost:6379/0', channel='socketio',
-                 write_only=False, logger=None, redis_options=None):
+                 write_only=False, logger=None, json=None, redis_options=None):
         if aioredis and \
                 not hasattr(aioredis.Redis, 'from_url'):  # pragma: no cover
             raise RuntimeError('Version 2 of aioredis package is required.')
-        super().__init__(channel=channel, write_only=write_only, logger=logger)
+        super().__init__(channel=channel, write_only=write_only, logger=logger,
+                         json=json)
         self.redis_url = url
         self.redis_options = redis_options or {}
         self.connected = False
@@ -117,7 +127,7 @@ class AsyncRedisManager(AsyncPubSubManager):
                 if not self.connected:
                     self._redis_connect()
                 return await self.redis.publish(
-                    self.channel, json.dumps(data))
+                    self.channel, self.json.dumps(data))
             except error as exc:
                 if retries_left > 0:
                     self._get_logger().error(

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/async_server.py

@@ -28,10 +28,11 @@ class AsyncServer(base_server.BaseServer):
     :param logger: To enable logging set to ``True`` or pass a logger object to
                    use. To disable logging set to ``False``. Note that fatal
                    errors are logged even when ``logger`` is ``False``.
-    :param json: An alternative json module to use for encoding and decoding
+    :param json: An alternative JSON module to use for encoding and decoding
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library
-                 versions.
+                 versions. This is a process-wide setting, all instantiated
+                 servers and clients must use the same JSON module.
     :param async_handlers: If set to ``True``, event handlers for a client are
                            executed in separate threads. To run handlers for a
                            client synchronously, set to ``False``. The default
@@ -426,6 +427,8 @@ class AsyncServer(base_server.BaseServer):
         if delete_it:
             self.logger.info('Disconnecting %s [%s]', sid, namespace)
             eio_sid = self.manager.pre_disconnect(sid, namespace=namespace)
+            if eio_sid in self._binary_packet:
+                del self._binary_packet[eio_sid]
             await self._send_packet(eio_sid, self.packet_class(
                 packet.DISCONNECT, namespace=namespace))
             await self._trigger_event('disconnect', namespace, sid,
@@ -701,6 +704,9 @@ class AsyncServer(base_server.BaseServer):
                                        pkt.data)
             elif pkt.packet_type == packet.BINARY_EVENT or \
                     pkt.packet_type == packet.BINARY_ACK:
+                if not self.manager.sid_from_eio_sid(eio_sid,
+                                                     pkt.namespace or '/'):
+                    raise ValueError('Unexpected binary packet')
                 self._binary_packet[eio_sid] = pkt
             elif pkt.packet_type == packet.CONNECT_ERROR:
                 raise ValueError('Unexpected CONNECT_ERROR packet.')

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/base_manager.py

@@ -1,5 +1,6 @@
 import itertools
 import logging
+import json
 
 from bidict import bidict, ValueDuplicationError
 
@@ -14,9 +15,11 @@ class BaseManager:
         self.eio_to_sid = {}
         self.callbacks = {}
         self.pending_disconnect = {}
+        self.json = json
 
     def set_server(self, server):
         self.server = server
+        self.json = self.server.packet_class.json  # use the global JSON module
 
     def initialize(self):
         """Invoked before the first request is received. Subclasses can add

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/client.py

@@ -39,10 +39,11 @@ class Client(base_client.BaseClient):
                        of the ``encode()`` and ``decode()`` methods can be
                        provided. Client and server must use compatible
                        serializers.
-    :param json: An alternative json module to use for encoding and decoding
+    :param json: An alternative JSON module to use for encoding and decoding
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library
-                 versions.
+                 versions. This is a process-wide setting, all instantiated
+                 servers and clients must use the same JSON module.
     :param handle_sigint: Set to ``True`` to automatically handle disconnection
                           when the process is interrupted, or to ``False`` to
                           leave interrupt handling to the calling application.

{python_socketio-5.16.0 → python_socketio-5.16.2}/src/socketio/kafka_manager.py

@@ -5,7 +5,6 @@ try:
 except ImportError:
     kafka = None
 
-from engineio import json
 from .pubsub_manager import PubSubManager
 
 logger = logging.getLogger('socketio')
@@ -32,18 +31,29 @@ class KafkaManager(PubSubManager):  # pragma: no cover
                     servers.
     :param write_only: If set to ``True``, only initialize to emit events. The
                        default of ``False`` initializes the class for emitting
-                       and receiving.
+                       and receiving. A write-only instance can be used
+                       independently of the server to emit to clients from an
+                       external process.
+    :param logger: a custom logger to log it. If not given, the server logger
+                   is used.
+    :param json: An alternative JSON module to use for encoding and decoding
+                 packets. Custom json modules must have ``dumps`` and ``loads``
+                 functions that are compatible with the standard library
+                 versions. This setting is only used when ``write_only`` is set
+                 to ``True``. Otherwise the JSON module configured in the
+                 server is used.
     """
     name = 'kafka'
 
     def __init__(self, url='kafka://localhost:9092', channel='socketio',
-                 write_only=False):
+                 write_only=False, logger=None, json=None):
         if kafka is None:
             raise RuntimeError('kafka-python package is not installed '
                                '(Run "pip install kafka-python" in your '
                                'virtualenv).')
 
-        super().__init__(channel=channel, write_only=write_only)
+        super().__init__(channel=channel, write_only=write_only, logger=logger,
+                         json=json)
 
         urls = [url] if isinstance(url, str) else url
         self.kafka_urls = [url[8:] if url != 'kafka://' else 'localhost:9092'
@@ -53,7 +63,7 @@ class KafkaManager(PubSubManager):  # pragma: no cover
                                             bootstrap_servers=self.kafka_urls)
 
     def _publish(self, data):
-        self.producer.send(self.channel, value=json.dumps(data))
+        self.producer.send(self.channel, value=self.json.dumps(data))
         self.producer.flush()
 
     def _kafka_listen(self):