Flask-SocketIO 5.6.0__tar.gz → 5.7.0__tar.gz

flask_socketio-5.7.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: Flask-SocketIO
+Version: 5.7.0
+Summary: Socket.IO integration for Flask applications
+Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
+Project-URL: Homepage, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio
+Project-URL: Documentation, https://flask-socketio.readthedocs.io/
+Project-URL: Source Code, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio
+Project-URL: Issue Tracker, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/issues
+Project-URL: Changelog, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/src/branch/main/CHANGES.md
+Project-URL: Funding, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio#sponsor-this-project
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: blinker
+Requires-Dist: click
+Requires-Dist: flask
+Requires-Dist: Flask>=2.1.0
+Requires-Dist: jinja2
+Requires-Dist: python-socketio>=5.12.0
+Requires-Dist: werkzeug
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: flask-login; extra == "dev"
+Requires-Dist: flask-session; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: redis; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Dynamic: license-file
+
+Flask-SocketIO
+==============
+
+[![tests](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/badges/workflows/tests.yml/badge.svg)](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/actions)
+
+Socket.IO integration for Flask applications.
+
+Installation
+------------
+
+You can install this package as usual with pip:
+
+    pip install flask-socketio
+
+Example
+-------
+
+```py
+from flask import Flask, render_template
+from flask_socketio import SocketIO, emit
+    
+app = Flask(__name__)
+app.config['SECRET_KEY'] = 'secret!'
+socketio = SocketIO(app)
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+@socketio.event
+def my_event(message):
+    emit('my response', {'data': 'got it!'})
+
+if __name__ == '__main__':
+    socketio.run(app)
+```
+
+Resources
+---------
+
+- [Tutorial](http://blog.miguelgrinberg.com/post/easy-websockets-with-flask-and-gevent)
+- [git](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio)
+- [Change Log](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/src/branch/main/CHANGES.md)
+- [Documentation](https://flask-socketio.readthedocs.io/)
+- [PyPI](https://pypi.python.org/pypi/flask-socketio)
+- [Contributor's guide](CONTRIBUTING.md)
+- [Security policy](SECURITY.md)
+
+Sponsor this project
+--------------------
+
+This project relies on contributions from its users. If you benefit from it please consider making a single or ongoing monetary contribution in one of the following platforms:
+
+- [Github Sponsors](https://github.com/sponsors/miguelgrinberg)
+- [Patreon](https://patreon.com/miguelgrinberg)
+- [Buy me a Coffee](https://buymeacoffee.com/miguelgrinberg)
+- [thanks.dev](https://thanks.dev/u/gh/miguelgrinberg)
+- [PayPal](https://paypal.me/miguelgrinberg)
+
+Thank you!

flask_socketio-5.7.0/README.md

@@ -0,0 +1,60 @@
+Flask-SocketIO
+==============
+
+[![tests](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/badges/workflows/tests.yml/badge.svg)](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/actions)
+
+Socket.IO integration for Flask applications.
+
+Installation
+------------
+
+You can install this package as usual with pip:
+
+    pip install flask-socketio
+
+Example
+-------
+
+```py
+from flask import Flask, render_template
+from flask_socketio import SocketIO, emit
+    
+app = Flask(__name__)
+app.config['SECRET_KEY'] = 'secret!'
+socketio = SocketIO(app)
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+@socketio.event
+def my_event(message):
+    emit('my response', {'data': 'got it!'})
+
+if __name__ == '__main__':
+    socketio.run(app)
+```
+
+Resources
+---------
+
+- [Tutorial](http://blog.miguelgrinberg.com/post/easy-websockets-with-flask-and-gevent)
+- [git](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio)
+- [Change Log](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/src/branch/main/CHANGES.md)
+- [Documentation](https://flask-socketio.readthedocs.io/)
+- [PyPI](https://pypi.python.org/pypi/flask-socketio)
+- [Contributor's guide](CONTRIBUTING.md)
+- [Security policy](SECURITY.md)
+
+Sponsor this project
+--------------------
+
+This project relies on contributions from its users. If you benefit from it please consider making a single or ongoing monetary contribution in one of the following platforms:
+
+- [Github Sponsors](https://github.com/sponsors/miguelgrinberg)
+- [Patreon](https://patreon.com/miguelgrinberg)
+- [Buy me a Coffee](https://buymeacoffee.com/miguelgrinberg)
+- [thanks.dev](https://thanks.dev/u/gh/miguelgrinberg)
+- [PayPal](https://paypal.me/miguelgrinberg)
+
+Thank you!

{flask_socketio-5.6.0 → flask_socketio-5.7.0}/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 = 'Flask-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': 'flask-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,

{flask_socketio-5.6.0 → flask_socketio-5.7.0}/docs/getting_started.rst

@@ -384,6 +384,17 @@ debugging outside the event handler::
         print(request.event["message"]) # "my error event"
         print(request.event["args"])    # (data,)
 
+When using class-based namespaces, an error handler for the namespace can be
+added as a method named ``error()``::
+
+    class MyCustomNamespace(Namespace):
+        # ...
+
+        def error(self, error):
+            print(f'Error {error} on event {request.event}'
+
+    socketio.on_namespace(MyCustomNamespace('/test'))
+
 Debugging and Troubleshooting
 -----------------------------
 

{flask_socketio-5.6.0 → flask_socketio-5.7.0}/docs/intro.rst

@@ -11,30 +11,28 @@ You can install this package in the usual way using ``pip``::
 Requirements
 ------------
 
-Flask-SocketIO is compatible with Python 3.6+. The asynchronous services that
+Flask-SocketIO is compatible with Python 3.8+. The asynchronous services that
 this package relies on can be selected among three choices:
 
-- `eventlet <http://eventlet.net/>`_ is the best performant option, with
-  support for long-polling and WebSocket transports.
+- The ``threading`` package from the Python standard library is the easier and
+  most compatible solution, with full support of long-polling and WebSocket
+  transports. The Flask development web server can be used during development,
+  and Gunicorn in multi-threaded mode can be used in production deployments.
 - `gevent <http://www.gevent.org/>`_ is supported in a number of different
-  configurations. The long-polling transport is fully supported with the
-  gevent package, but unlike eventlet, gevent does not have native WebSocket
-  support. To add support for WebSocket there are currently two options.
-  Installing the `gevent-websocket <https://pypi.python.org/pypi/gevent-websocket/>`_
-  package adds WebSocket support to gevent or one can use the `uWSGI
-  <https://uwsgi-docs.readthedocs.io/en/latest/>`_ web server, which
-  comes with WebSocket functionality. The use of gevent is also a performant
-  option, but slightly lower than eventlet.
-- The Flask development server based on Werkzeug can be used as well, with the
-  caveat that this web server is intended only for development use, so it
-  should only be used to simplify the development workflow and not for
-  production.
+  configurations, also with support for the long-polling and WebSocket
+  transports. The Flask development web server, gevent's own web server,
+  Gunicorn (with the gevent worker) and uWSGI (in gevent mode) are all
+  supported when using ``gevent``.
+- `eventlet <http://eventlet.net/>`_ used to be a good option with support for
+  long-polling and WebSocket transports, but it is not actively maintained
+  anymore, so ``gevent`` should be preferred. The Flask development web server,
+  eventlet's own web server and Gunicorn (with the eventlet worker) are all
+  supported when using ``eventlet``.
 
 The extension automatically detects which asynchronous framework to use based
-on what is installed. Preference is given to eventlet, followed by gevent.
-For WebSocket support in gevent, uWSGI is preferred, followed by
-gevent-websocket. If neither eventlet nor gevent are installed, then the Flask
-development server is used.
+on what is installed. Preference is given to eventlet, followed by gevent. If
+neither eventlet nor gevent are installed, Python's ``threading`` package is
+used.
 
 If using multiple processes, a message queue service must be configured to
 allow the servers to coordinate operations such as broadcasting. The supported

{flask_socketio-5.6.0 → flask_socketio-5.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Flask-SocketIO"
-version = "5.6.0"
+version = "5.7.0"
 authors = [
     { name = "Miguel Grinberg", email = "miguel.grinberg@gmail.com" },
 ]
@@ -14,8 +14,13 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
+    "blinker",
+    "click",
+    "flask",
     "Flask >= 2.1.0",
+    "jinja2",
     "python-socketio >= 5.12.0",
+    "werkzeug",
 ]
 
 [project.readme]
@@ -23,18 +28,25 @@ file = "README.md"
 content-type = "text/markdown"
 
 [project.urls]
-Homepage = "https://github.com/miguelgrinberg/flask-socketio"
-"Bug Tracker" = "https://github.com/miguelgrinberg/flask-socketio/issues"
+Homepage = "https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio"
+Documentation = "https://flask-socketio.readthedocs.io/"
+"Source Code" = "https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio"
+"Issue Tracker" = "https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/issues"
+Changelog = "https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/src/branch/main/CHANGES.md"
+Funding = "https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio#sponsor-this-project"
 
 [project.optional-dependencies]
 docs = [
     "sphinx",
+    "furo",
 ]
 dev = [
-    "tox",
+    "flask-login",
+    "flask-session",
     "pytest",
     "pytest-cov",
     "redis",
+    "tox",
 ]
 
 [tool.setuptools]

flask_socketio-5.7.0/src/Flask_SocketIO.egg-info/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: Flask-SocketIO
+Version: 5.7.0
+Summary: Socket.IO integration for Flask applications
+Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
+Project-URL: Homepage, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio
+Project-URL: Documentation, https://flask-socketio.readthedocs.io/
+Project-URL: Source Code, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio
+Project-URL: Issue Tracker, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/issues
+Project-URL: Changelog, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/src/branch/main/CHANGES.md
+Project-URL: Funding, https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio#sponsor-this-project
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: blinker
+Requires-Dist: click
+Requires-Dist: flask
+Requires-Dist: Flask>=2.1.0
+Requires-Dist: jinja2
+Requires-Dist: python-socketio>=5.12.0
+Requires-Dist: werkzeug
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: flask-login; extra == "dev"
+Requires-Dist: flask-session; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: redis; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Dynamic: license-file
+
+Flask-SocketIO
+==============
+
+[![tests](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/badges/workflows/tests.yml/badge.svg)](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/actions)
+
+Socket.IO integration for Flask applications.
+
+Installation
+------------
+
+You can install this package as usual with pip:
+
+    pip install flask-socketio
+
+Example
+-------
+
+```py
+from flask import Flask, render_template
+from flask_socketio import SocketIO, emit
+    
+app = Flask(__name__)
+app.config['SECRET_KEY'] = 'secret!'
+socketio = SocketIO(app)
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+@socketio.event
+def my_event(message):
+    emit('my response', {'data': 'got it!'})
+
+if __name__ == '__main__':
+    socketio.run(app)
+```
+
+Resources
+---------
+
+- [Tutorial](http://blog.miguelgrinberg.com/post/easy-websockets-with-flask-and-gevent)
+- [git](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio)
+- [Change Log](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio/src/branch/main/CHANGES.md)
+- [Documentation](https://flask-socketio.readthedocs.io/)
+- [PyPI](https://pypi.python.org/pypi/flask-socketio)
+- [Contributor's guide](CONTRIBUTING.md)
+- [Security policy](SECURITY.md)
+
+Sponsor this project
+--------------------
+
+This project relies on contributions from its users. If you benefit from it please consider making a single or ongoing monetary contribution in one of the following platforms:
+
+- [Github Sponsors](https://github.com/sponsors/miguelgrinberg)
+- [Patreon](https://patreon.com/miguelgrinberg)
+- [Buy me a Coffee](https://buymeacoffee.com/miguelgrinberg)
+- [thanks.dev](https://thanks.dev/u/gh/miguelgrinberg)
+- [PayPal](https://paypal.me/miguelgrinberg)
+
+Thank you!

{flask_socketio-5.6.0 → flask_socketio-5.7.0}/src/Flask_SocketIO.egg-info/requires.txt

@@ -1,11 +1,19 @@
+blinker
+click
+flask
 Flask>=2.1.0
+jinja2
 python-socketio>=5.12.0
+werkzeug
 
 [dev]
-tox
+flask-login
+flask-session
 pytest
 pytest-cov
 redis
+tox
 
 [docs]
 sphinx
+furo

{flask_socketio-5.6.0 → flask_socketio-5.7.0}/src/flask_socketio/__init__.py

@@ -84,18 +84,23 @@ class SocketIO:
     :param client_manager: The client manager instance that will manage the
                            client list. When this is omitted, the client list
                            is stored in an in-memory structure, so the use of
-                           multiple connected servers is not possible. In most
-                           cases, this argument does not need to be set
-                           explicitly.
+                           multiple connected servers is not possible.
     :param logger: To enable logging set to ``True`` or pass a logger object to
                    use. To disable logging set to ``False``. The default is
-                   ``False``. Note that fatal errors will be logged even when
+                   ``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 serializer: The serialization method to use when transmitting
+                       packets. Valid values are ``'default'``, ``'pickle'``,
+                       ``'msgpack'`` and ``'cbor'``. Alternatively, a subclass
+                       of the :class:`Packet` class with custom implementations
+                       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
                  packets. Custom json modules must have ``dumps`` and ``loads``
                  functions that are compatible with the standard library
-                 versions. To use the same json encoder and decoder as a Flask
-                 application, use ``flask.json``.
+                 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
@@ -110,17 +115,22 @@ class SocketIO:
                            connect handler and your client is confused when it
                            receives events before the connection acceptance.
                            In any other case use the default of ``False``.
+    :param namespaces: a list of namespaces that are accepted, in addition to
+                       any namespaces for which handlers have been defined. The
+                       default is `['/']`, which always accepts connections to
+                       the default namespace. Set to `'*'` to accept all
+                       namespaces.
 
     The Engine.IO server configuration supports the following settings:
 
     :param async_mode: The asynchronous model to use. See the Deployment
                        section in the documentation for a description of the
-                       available options. Valid async modes are ``threading``,
-                       ``eventlet``, ``gevent`` and ``gevent_uwsgi``. If this
-                       argument is not given, ``eventlet`` is tried first, then
-                       ``gevent_uwsgi``, then ``gevent``, and finally
-                       ``threading``. The first async mode that has all its
-                       dependencies installed is then one that is chosen.
+                       available options. Valid async modes are "threading",
+                       "eventlet", "gevent" and "gevent_uwsgi". If this
+                       argument is not given, "eventlet" is tried first, then
+                       "gevent_uwsgi", then "gevent", and finally "threading".
+                       The first async mode that has all its dependencies
+                       installed is the one that is chosen.
     :param ping_interval: The interval in seconds at which the server pings
                           the client. The default is 25 seconds. For advanced
                           control, a two element tuple can be given, where
@@ -128,10 +138,12 @@ class SocketIO:
                           is a grace period added by the server.
     :param ping_timeout: The time in seconds that the client waits for the
                          server to respond before disconnecting. The default
-                         is 5 seconds.
-    :param max_http_buffer_size: The maximum size of a message when using the
-                                 polling transport. The default is 1,000,000
-                                 bytes.
+                         is 20 seconds.
+    :param max_http_buffer_size: The maximum size that is accepted for incoming
+                                 messages.  The default is 1,000,000 bytes. In
+                                 spite of its name, the value set in this
+                                 argument is enforced for HTTP long-polling and
+                                 WebSocket connections.
     :param allow_upgrades: Whether to allow transport upgrades or not. The
                            default is ``True``.
     :param http_compression: Whether to compress packages when using the
@@ -140,7 +152,7 @@ class SocketIO:
                                   is greater than this value. The default is
                                   1024 bytes.
     :param cookie: If set to a string, it is the name of the HTTP cookie the
-                   server sends back to the client containing the client
+                   server sends back tot he client containing the client
                    session id. If set to a dictionary, the ``'name'`` key
                    contains the cookie name and other keys define cookie
                    attributes, where the value of each attribute can be a
@@ -150,15 +162,18 @@ class SocketIO:
     :param cors_allowed_origins: Origin or list of origins that are allowed to
                                  connect to this server. Only the same origin
                                  is allowed by default. Set this argument to
-                                 ``'*'`` to allow all origins, or to ``[]`` to
-                                 disable CORS handling.
+                                 ``'*'`` or ``['*']`` to allow all origins, or
+                                 to ``[]`` to disable CORS handling.
     :param cors_credentials: Whether credentials (cookies, authentication) are
-                             allowed in requests to this server. The default is
-                             ``True``.
+                             allowed in requests to this server. The default
+                             is ``True``.
     :param monitor_clients: If set to ``True``, a background task will ensure
                             inactive clients are closed. Set to ``False`` to
                             disable the monitoring task (not recommended). The
                             default is ``True``.
+    :param transports: The list of allowed transports. Valid transports
+                       are ``'polling'`` and ``'websocket'``. Defaults to
+                       ``['polling', 'websocket']``.
     :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
                             a logger object to use. To disable logging set to
                             ``False``. The default is ``False``. Note that
@@ -806,13 +821,22 @@ class SocketIO:
                     environ['saved_session'] = _ManagedSession(flask.session)
                 session_obj = environ['saved_session']
                 if hasattr(flask, 'globals') and \
-                        hasattr(flask.globals, 'request_ctx'):
-                    # update session for Flask >= 2.2
-                    ctx = flask.globals.request_ctx._get_current_object()
+                        hasattr(flask.globals, 'app_ctx'):
+                    if hasattr(flask.globals.app_ctx, 'session'):
+                        # get context for flask >= 3.2
+                        ctx = flask.globals.app_ctx._get_current_object()
+                    else:
+                        # get context for Flask >= 2.2, < 3.2
+                        ctx = flask.globals.request_ctx._get_current_object()
                 else:  # pragma: no cover
-                    # update session for Flask < 2.2
+                    # get context for Flask < 2.2
                     ctx = flask._request_ctx_stack.top
-                ctx.session = session_obj
+                if hasattr(ctx, '_session'):
+                    # update session for Flask >= 3.1.3
+                    ctx._session = session_obj
+                else:
+                    # update session for Flask < 3.1.3
+                    ctx.session = session_obj
             else:
                 # let Flask handle the user session
                 # for cookie based sessions, this effectively freezes the
@@ -834,7 +858,7 @@ class SocketIO:
                     ret = handler(*args)
             except ConnectionRefusedError:
                 raise  # let this error bubble up to python-socketio
-            except:
+            except Exception:
                 err_handler = self.exception_handlers.get(
                     namespace, self.default_exception_handler)
                 if err_handler is None:

{flask_socketio-5.6.0 → flask_socketio-5.7.0}/src/flask_socketio/namespace.py

@@ -23,13 +23,19 @@ class Namespace(_Namespace):
             return
         handler = getattr(self, handler_name)
         try:
-            return self.socketio._handle_event(handler, event, self.namespace,
-                                               *args)
-        except TypeError:
-            if event == 'disconnect':
-                # legacy disconnect events do not have the reason argument
-                return self.socketio._handle_event(
-                    handler, event, self.namespace, *args[:-1])
+            try:
+                return self.socketio._handle_event(handler, event,
+                                                   self.namespace, *args)
+            except TypeError:
+                if event == 'disconnect':
+                    # legacy disconnect events do not have the reason argument
+                    return self.socketio._handle_event(
+                        handler, event, self.namespace, *args[:-1])
+                else:
+                    raise
+        except Exception as exc:
+            if hasattr(self, 'error'):
+                return self.error(exc)
             else:
                 raise