Flask-SocketIO 5.6.1__tar.gz → 5.7.1__tar.gz

flask_socketio-5.7.1/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: Flask-SocketIO
+Version: 5.7.1
+Summary: Socket.IO integration for Flask applications
+Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
+License-Expression: MIT
+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: 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.18.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.1/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.1 → flask_socketio-5.7.1}/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.1 → flask_socketio-5.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Flask-SocketIO"
-version = "5.6.1"
+version = "5.7.1"
 authors = [
     { name = "Miguel Grinberg", email = "miguel.grinberg@gmail.com" },
 ]
@@ -9,9 +9,9 @@ classifiers = [
     "Environment :: Web Environment",
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
+license = "MIT"
 requires-python = ">=3.8"
 dependencies = [
     "blinker",
@@ -19,7 +19,7 @@ dependencies = [
     "flask",
     "Flask >= 2.1.0",
     "jinja2",
-    "python-socketio >= 5.12.0",
+    "python-socketio >= 5.18.0",
     "werkzeug",
 ]
 
@@ -28,8 +28,12 @@ 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 = [

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

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: Flask-SocketIO
+Version: 5.7.1
+Summary: Socket.IO integration for Flask applications
+Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
+License-Expression: MIT
+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: 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.18.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.1 → flask_socketio-5.7.1}/src/Flask_SocketIO.egg-info/requires.txt

@@ -3,7 +3,7 @@ click
 flask
 Flask>=2.1.0
 jinja2
-python-socketio>=5.12.0
+python-socketio>=5.18.0
 werkzeug
 
 [dev]

{flask_socketio-5.6.1 → flask_socketio-5.7.1}/src/flask_socketio/__init__.py

@@ -858,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.1 → flask_socketio-5.7.1}/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